Disburse Funds

How to Access and Use the Service

Before you can start making payouts using our API, you’ll need to complete a few setup steps to ensure your account is properly configured and approved for transactions.

Step 1: Request for the Account Service (Payout Service)

To access the Payout Service, you must first request activation from your dashboard. This enables your business to create and manage payout transactions directly through the platform.

To Request payout access:

1: Log in to your Dashboard and navigate to the "Payout Menu". 2: On the right-hand side, click Request Payout Account to initiate your access request.

Step 2: Request for a Payout Account

Once the Payout Service has been activated, you’ll need to request a Payout Account in your preferred currency (GBP, EUR, or GHS).

To request payout account :

1: Log in to your Dashboard and navigate to the Account menu. 2: Click Request Account. 3: Under Select Payment Type, choose Payout Account. 4: Select the account type you want to request and provide a reason for the request. 5: Submit the request for review.

Each payout account request must be reviewed and approved by an Admin before it becomes active. After approval, you’ll be able to initiate both test and live payouts from your account.

Step 3: Configure Your Webhook and API Keys

To receive real-time transaction updates and status notifications:

• Go to your Dashboard → Settings → API Keys & Webhooks.

• Add your Webhook URL, where transaction events (e.g., successful payout, failed transaction) will be sent.

• Retrieve your API Keys (Test and Live) — you’ll need these credentials to authenticate your API requests.

🔹 Use your Test API Key during sandbox testing. 🔹 Once testing is complete, request activation of your Live Key for production use.

Disburse Endpoint:

POST {{base_url}}/v1/payout/disburse

Description

This endpoint is used to transfer funds from the organization's payout account ( see Organization Dashboard ) to a specified recipient.

Request Body

EUR

{
"amount": 2,
"beneficiaryFullName": "Prune Payment",
"destinationIBAN": "GB31ARPY04281809885512",
"destinationBIC": "ARPYGB21",
"destinationCountry": "GB",
"destinationBank": "Standard Chartered",
"reference": "6fr6tyye09",
"reason": "test transaction",
"currency": "EUR"
}

GBP

GHS

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.

EUR

{
    "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
}

GBP

GHS Bank Transfer

GHS Mobile Money

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.