Fetch transactions

Fetching information about a transaction is straightforward using the GET request. You are only able to see the transaction if you are the buyer or seller in the transaction.

Note

The data that is returned may be different depending on the user accessing the transaction. This can happen in multiple scenarios, such as the buyer funding the transaction that is not visible to the seller.

Fetch all transactions

GET {{api_url}}/v1/transactions

Headers

{
    "status": true,
    "message": "Transactions retreived successfully",
    "data": {
        "transactions": [
            {
                "id": "8aa7e335-9f9f-4992-816e-acc1ea338850",
                "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_RETURN_APPROVED",
                "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": 500,
                "total_amount_disbursed": 0,
                "current_milestone_id": "a33123ae-8e93-4f58-b380-2010c4bc2e04",
                "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-28T08:25:33.837Z",
                "updated_at": "2023-12-28T09:27:19.357Z"
            },
            {
                "id": "426eb1d5-9a90-4929-9b5c-d31d6dad6d8a",
                "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_RETURN_APPROVED",
                "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": 500,
                "total_amount_disbursed": 0,
                "current_milestone_id": "7dfb0828-db57-4b76-a23c-92bf91a3a622",
                "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-27T18:26:15.520Z",
                "updated_at": "2023-12-27T18:51:24.978Z"
            },
            {
                "id": "a9ce3351-b4b3-4e06-831c-49aae3f9b2ed",
                "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": "COMPLETED",
                "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": 500,
                "current_milestone_id": null,
                "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-27T17:48:32.226Z",
                "updated_at": "2023-12-27T17:50:47.378Z"
            },
            {
                "id": "a307913c-69e3-46be-9bbd-a6b782b16d4e",
                "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": "COMPLETED",
                "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": 500,
                "current_milestone_id": null,
                "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-27T17:17:59.091Z",
                "updated_at": "2023-12-27T17:26:33.703Z"
            },
            {
                "id": "fceaaa11-413a-4bed-a2ad-06a9b9a18e56",
                "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": "COMPLETED",
                "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": 500,
                "current_milestone_id": null,
                "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-27T17:11:30.322Z",
                "updated_at": "2023-12-27T17:15:13.486Z"
            },
            {
                "id": "ff44f7c8-252d-4132-9fc4-b62675c6e933",
                "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": "COMPLETED",
                "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": 500,
                "current_milestone_id": null,
                "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-27T17:02:50.831Z",
                "updated_at": "2023-12-27T17:07:56.300Z"
            },
            {
                "id": "be8232a0-af40-4dd5-9370-041153200cb9",
                "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": "RECIPIENT_APPROVED_AWAITING_FUNDING",
                "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": 0,
                "total_amount_refunded": 0,
                "total_amount_disbursed": 0,
                "current_milestone_id": null,
                "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-27T15:32:44.884Z",
                "updated_at": "2023-12-27T15:32:44.884Z"
            },
            {
                "id": "1e2c3aad-2374-42f1-922d-7dd49c4d0d6c",
                "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": "COMPLETED",
                "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": null,
                "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-27T15:23:28.733Z",
                "updated_at": "2023-12-27T15:26:20.842Z"
            },
            {
                "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_RETURN_REJECTED",
                "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:59:37.742Z"
            },
            {
                "id": "6be1331c-ebf9-49d9-b1b7-399df023b622",
                "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": "COMPLETED",
                "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": null,
                "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:22:21.795Z",
                "updated_at": "2023-12-27T14:57:43.074Z"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 10,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1,
            "total": 10,
            "pageCount": 1,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": false
        }
    }
}

Fetch transaction by ID

GET {{api_url}}/v1/transactions/{transaction_id}

Query Parameters

Headers

{
    "status": true,
    "message": "Transaction info returned successfully",
    "data": {
        "id": "2a3799a7-4dc2-4081-94eb-770bc6048a48",
        "title": "Bag of cement",
        "description": "Purchase of 3 bags of cements",
        "category": "GOODS",
        "sub_category": "Food/beverage/agriculture",
        "transaction_contract_url": "https://trustcrow-dev-docs.s3.amazonaws.com/",
        "status": "RECIPIENT_APPROVED_AWAITING_FUNDING",
        "transaction_originator": "BUYER",
        "buyer_id": "524c35c9-ef73-4a4d-a4ab-97146f3cff95",
        "seller_id": "eeae27bc-3e12-47f4-a6cb-fceaa3013629",
        "source": "api",
        "clientId": "dd2f3541-9047-46e1-b117-6ca8584ea0bd",
        "transaction_amount": 500000,
        "total_amount_funded": 0,
        "total_amount_refunded": 0,
        "total_amount_disbursed": 0,
        "current_milestone_id": null,
        "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": "369ea20c-212b-4b2a-9f87-31c7b11dec58",
        "updated_by": null,
        "date_canceled": null,
        "created_at": "2023-12-26T10:02:35.691Z",
        "updated_at": "2023-12-26T10:02:35.691Z"
    }
}

For example, to fetch a transaction that has an id 2a3799a7-4dc2-4081-94eb-770bc6048a48, simply make a GET request to the endpoint like this:

https://api.gotrustcrow.com/v1/transactions/2a3799a7-4dc2-4081-94eb-770bc6048a48

Last updated