Trustcrow API v1
  • Introduction
  • Authentication
  • Errors
  • API Reference
    • User Management
      • Create a user
      • Fetch users
      • Fetch user's wallet
    • Transaction
      • Create a transaction
      • Fetch transactions
      • Fetch milestones
      • Fund milestone
      • Deliver item
      • Accept item delivery
      • Reject item delivery
      • Approve returned item
      • Disapprove returned item
    • Dispute Management
      • Create a dispute
      • Fetch dispute
      • Add dispute amount
      • Approve dispute amount
      • Disapprove dispute amount
    • Disbursement
    • Other tools
      • Bank verification
      • File Upload
Powered by GitBook
On this page
  • To deliver a milestone
  • cURL Request

Was this helpful?

  1. API Reference
  2. Transaction

Deliver item

PreviousFund milestoneNextAccept item delivery

Last updated 1 year ago

Was this helpful?

Once the milestone has been funded, the seller is expected to deliver the milestone. When a seller ships or deliver a milestone, such seller is expected to notify the escrow system and proof of delivery.

To deliver a milestone

POST {{api_url}}/v1/milestones/{milestone_id}/deliver

Query Parameters

Name
Type
Description

milestone_id*

string

specify the milestone id

Headers

Name
Type
Description

Authorization*

string

your Trustcrow API keys to authorize customers

Request Body

Name
Type
Description

seller_id*

string

input the seller's ID

proofs_of_completion*

string

Upload proof of completion

{
    "status": true,
    "message": "Milestone delivered successfully",
    "data": {
        "id": "b3c1349e-04cd-4554-b73e-a224e5f702d7",
        "title": "testing milestone title",
        "description": "testing milestone description",
        "amount": 500,
        "is_milestone_funded": true,
        "position_in_transaction": 1,
        "is_delivered": true,
        "is_completed": false,
        "delivery_rejection_reason": null,
        "is_delivery_rejected": false,
        "is_return_proof_sent": false,
        "is_return_approved": false,
        "is_return_rejected": false,
        "due_date_type": "DEADLINE_DATE",
        "due_date": "2023-12-31T00:00:00.000Z",
        "execution_timeline": null,
        "status": "UNDER_INSPECTION",
        "commission_payer": "SELLER_100",
        "discount_code": null,
        "milestone_fee": 16.25,
        "transaction_id": "d209c389-45c6-4f78-92c2-26f23db95d96",
        "inspection_duration": 2,
        "inspection_end_date": "2023-12-29T19:14:07.613Z",
        "return_deadline_date": null,
        "current_extension_index": null,
        "milestone_escrow_id": "d73605dc-467f-46ed-bbd1-9e63154c7ba2",
        "rate_used": 1,
        "created_at": "2023-12-27T14:48:32.423Z",
        "updated_at": "2023-12-27T19:14:07.619Z",
        "transaction": {
            "id": "d209c389-45c6-4f78-92c2-26f23db95d96",
            "title": "sales of team",
            "description": "Sales of heavy agricultural produce",
            "currency": "NGN",
            "location_type": "LOCAL",
            "category": "GOODS",
            "sub_category": "Food/beverage/agriculture",
            "transaction_contract_url": "https://trustcrow-dev-docs.s3.amazonaws.com/",
            "status": "MILESTONE_IN_PROGRESS",
            "transaction_originator": "BUYER",
            "buyer_id": "524c35c9-ef73-4a4d-a4ab-97146f3cff95",
            "seller_id": "eeae27bc-3e12-47f4-a6cb-fceaa3013629",
            "source": "api",
            "clientId": "ec5fe1cf-dcf3-48b9-b003-7417fea0c0f1",
            "transaction_amount": 500,
            "total_amount_funded": 500,
            "total_amount_refunded": 0,
            "total_amount_disbursed": 0,
            "current_milestone_id": "b3c1349e-04cd-4554-b73e-a224e5f702d7",
            "job_id": null,
            "decline_reason": null,
            "is_completed": false,
            "has_buyer_rated": false,
            "on_last_milestone": true,
            "has_seller_rated": false,
            "discount_code": null,
            "declined_at": null,
            "approved_at": null,
            "created_by": "ec5fe1cf-dcf3-48b9-b003-7417fea0c0f1",
            "updated_by": null,
            "date_canceled": null,
            "created_at": "2023-12-27T14:48:32.423Z",
            "updated_at": "2023-12-27T19:13:26.439Z",
            "buyer": {
                "id": "524c35c9-ef73-4a4d-a4ab-97146f3cff95",
                "user_id": "369ea20c-212b-4b2a-9f87-31c7b11dec58",
                "organisation_id": "7019af1c-5762-443a-880f-6d950f31ce9f",
                "role": "SUPER ADMIN",
                "created_at": "2023-12-26T09:03:18.782Z",
                "updated_at": "2023-12-26T09:03:18.782Z",
                "organisation": {
                    "id": "7019af1c-5762-443a-880f-6d950f31ce9f",
                    "name": "Haleemah Opeyemi's Organisation",
                    "wallet_id": "b78ec8db-4bab-43c3-84a1-a9d55d036d54",
                    "paystack_customer_code": null,
                    "account_kyc_type": "INDIVIDUAL",
                    "is_kyc_completed": true,
                    "is_kyc_submitted": true,
                    "is_kyc_approved": true,
                    "is_kyc_declined": false,
                    "kyc_decline_reason": null,
                    "kyc_completed_at": "2023-12-27T18:56:53.228Z",
                    "created_by": "369ea20c-212b-4b2a-9f87-31c7b11dec58",
                    "kyc_approved_by": "796171ea-00fe-4894-9626-3245c5581643",
                    "kyc_declined_by": null,
                    "location_type": "LOCAL",
                    "updated_by": null,
                    "created_at": "2023-12-26T09:03:18.775Z",
                    "updated_at": "2023-12-27T18:57:16.394Z"
                },
                "user": {
                    "id": "369ea20c-212b-4b2a-9f87-31c7b11dec58",
                    "first_name": "Haleemah",
                    "last_name": "Opeyemi",
                    "user_name": "haopho31079",
                    "email": "haleemahfolag@yopmail.com",
                    "default_email": "ec5fe1cf-dcf3-48b9-b003-7417fea0c0f1_haleemahfolag@yopmail.com",
                    "phone": null,
                    "password": "$2b$10$H0xNaaLKERiHLvWsLQQLXegJtcBZvq64wAgfB5Yo53OzAsa8COM0C",
                    "is_account_verified": true,
                    "password_reset": false,
                    "role": "USER",
                    "referredById": null,
                    "referral_code": null,
                    "clientId": "ec5fe1cf-dcf3-48b9-b003-7417fea0c0f1",
                    "source": "THIRD_PARTY",
                    "public_key": null,
                    "secret_key": null,
                    "api_enabled": false,
                    "password_created": false,
                    "last_logged_in_at": "2023-12-27T18:55:47.527Z",
                    "created_at": "2023-12-26T09:03:18.766Z",
                    "updated_at": "2023-12-27T18:55:47.532Z"
                }
            },
            "seller": {
                "id": "eeae27bc-3e12-47f4-a6cb-fceaa3013629",
                "user_id": "7c4e5b33-eb74-41fd-8f07-230cfaeb2439",
                "organisation_id": "9876d61f-ad34-4d5a-be9d-46bee63c8c4a",
                "role": "SUPER ADMIN",
                "created_at": "2023-12-26T09:56:54.276Z",
                "updated_at": "2023-12-26T09:56:54.276Z",
                "organisation": {
                    "id": "9876d61f-ad34-4d5a-be9d-46bee63c8c4a",
                    "name": "John Doe's Organisation",
                    "wallet_id": "6ba37133-a54b-42d2-af1d-d20e1ed7a13a",
                    "paystack_customer_code": null,
                    "account_kyc_type": "INDIVIDUAL",
                    "is_kyc_completed": true,
                    "is_kyc_submitted": true,
                    "is_kyc_approved": true,
                    "is_kyc_declined": false,
                    "kyc_decline_reason": null,
                    "kyc_completed_at": "2023-12-27T17:54:04.786Z",
                    "created_by": "7c4e5b33-eb74-41fd-8f07-230cfaeb2439",
                    "kyc_approved_by": "796171ea-00fe-4894-9626-3245c5581643",
                    "kyc_declined_by": null,
                    "location_type": "LOCAL",
                    "updated_by": null,
                    "created_at": "2023-12-26T09:56:54.268Z",
                    "updated_at": "2023-12-27T17:54:35.700Z"
                },
                "user": {
                    "id": "7c4e5b33-eb74-41fd-8f07-230cfaeb2439",
                    "first_name": "John",
                    "last_name": "Doe",
                    "user_name": "jodojd30278",
                    "email": "joe@yopmail.com",
                    "default_email": "ec5fe1cf-dcf3-48b9-b003-7417fea0c0f1_joe@yopmail.com",
                    "phone": null,
                    "password": "$2b$10$.z0AxFZGE5rNdmxW0IJ3Zuu6TszOe.1Azqyx0RC71uQ20QvX6TTGO",
                    "is_account_verified": true,
                    "password_reset": false,
                    "role": "USER",
                    "referredById": null,
                    "referral_code": null,
                    "clientId": "ec5fe1cf-dcf3-48b9-b003-7417fea0c0f1",
                    "source": "THIRD_PARTY",
                    "public_key": null,
                    "secret_key": null,
                    "api_enabled": false,
                    "password_created": false,
                    "last_logged_in_at": "2023-12-27T17:52:27.017Z",
                    "created_at": "2023-12-26T09:56:54.249Z",
                    "updated_at": "2023-12-27T17:52:27.030Z"
                }
            }
        },
        "milestone_escrow": {
            "id": "d73605dc-467f-46ed-bbd1-9e63154c7ba2",
            "balance": 500,
            "created_at": "2023-12-27T14:48:32.423Z",
            "updated_at": "2023-12-27T19:13:26.454Z"
        }
    }
}

cURL Request

curl --location 'http://trustcrow-api-sandbox.us-east-1.elasticbeanstalk.com/v1/milestones/b3c1349e-04cd-4554-b73e-a224e5f702d7/deliver' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{secret_key}}' \
--data '{
    "seller_id": "7c4e5b33-eb74-41fd-8f07-230cfaeb2439",
    "proofs_of_completion": ["https://google.com"]
}'

Only when a milestone has been funded does the buyer protection begins, and the seller is instructed to go ahead and ship the products or service.

The upload endpoint can be used to upload the file for the proof of completion.

After an item has been delivered, status of the milestone transaction changes to "UNDER_INSPECTION".

submit