Disburse Funds

Endpoint

POST {{}}/v1/payout/disburse

Description

This endpoint is used to transfer funds from the organisations account to a specified recipient.

Request Body

The request body should be a JSON object containing the following fields:

• amount: 300

• beneficiaryFullName: "John Doe"

• destinationIBAN: "GB1204550505050563"

• destinationBIC: "5050563"

• destinationCountry: "United Kingdom"

• destinationBank: "Standard Chartered"

• reference: "550505050563"

• reason: "Salary 3 payments"

Example Request

{
    "amount": 300,
    "beneficiaryFullName": "John Doe",
    "destinationIBAN": "GB1204550505050563",
    "destinationBIC": "5050563",
    "destinationCountry": "United Kingdom",
    "destinationBank": "Standard Chartered",
    "reference": "550505050563",
    "reason": "Salary 3 payments"
}

Response

On success, the API will return a JSON object containing a success message.

Important Note:

Payout processing depends on the trust status of a business's account. Trusted accounts have their payout transactions processed automatically. For untrusted accounts, the super admin must manually approve each payout transaction before it can be processed.

Trusted Account Response

{
    "status": true,
    "message": "Transfer initiated successfully",
    "data": {
        "id": "86ca8722-d56c-449d-8afc-1b57b23342e9",
        "createdAt": "2024-10-30T15:16:17.058Z",
        "dpsId": 478,
        "centrolinkRef": "ARPY478",
        "recipientBankAddress": "Standard Chartered",
        "recipientBankCountry": "United Kingdom",
        "recipientBic": "EJXEAMK1",
        "recipientIban": "GB1204550505050563",
        "recipientName": "Mrs. Grace Mayert",
        "reference": "2cf20ad4-a3e9-4173-98a6-cb4b608e0df5",
        "senderBic": "ARPYGB21XXX",
        "senderIban": "GB12045505050505153",
        "senderName": "C80 Limited",
        "status": "PENDING",
        "type": "DEBIT",
        "amount": 20,
        "payoutAccountId": "ede43b86-701c-4779-9617-865a3c79a8a3"
    },
    "code": 200
}

Untrusted Account Response

{
    "status": true,
    "message": "A disbursement request has been created",
    "data": {
        "id": "76901e1e-81dd-4eca-b270-ecea522eb75a",
        "beneficiaryFullName": "Hattie Bernier",
        "destinationIBAN": "GB1204550505050563",
        "destinationBIC": "MPPESVL1",
        "destinationCountry": "United Kingdom",
        "destinationBank": "Standard Chartered",
        "reference": "d2cd098f-f790-411a-a87b-c53036e9fb00",
        "amount": 20,
        "reason": "programming the panel won't do anything, we need to hack the haptic EXE application!",
        "createdAt": "2024-10-30T15:19:18.146Z",
        "status": "PENDING",
        "payoutAccountId": "ede43b86-701c-4779-9617-865a3c79a8a3"
    },
    "code": 200
}

Error

Include common error responses and their meanings.

• 400 Bad Request: User account not found.

• 500 Internal Server Error: An error occurred on the server.