Disbursement Request Status

Endpoint

GET {{base_url}}/v1/payout/disburse/requests/<request_id>/status

Description

This endpoint is used to get the status of a disbursement request.

URL Parameters

request-id (string): The request ID of the disbursement request you want to retrieve.

Response

On success, the API will return a JSON object containing the status of a single request.

{
    "status": true,
    "message": "Disbursement request status fetched",
    "data": {
        "trxRequest": {
            "id": "6f5f5d6f-effd-4b82-8dfc-a973bc9012ca",
            "beneficiaryFullName": "Claudia Champlin",
            "destinationIBAN": "GB1204550505050563",
            "destinationBIC": "CIDAYEO1",
            "destinationCountry": "United Kingdom",
            "destinationBank": "Standard Chartered",
            "reference": "525c27c6-6e8d-4421-9b9e-8e4899294c28",
            "amount": 200,
            "reason": "we need to compress the online THX microchip!",
            "createdAt": "2024-11-22T16:00:45.271Z",
            "status": "PENDING",
            "payoutAccountId": "ede43b86-701c-4779-9617-865a3c79a8a3"
        }
    },
    "code": 200
}