Send Money from Account

Endpoint

POST {{}}/v1/accounts/send

Description

This endpoint allows the organisation to trigger transfer of funds from a user account to a specified recipient.

Request Body

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

• account: "GB1204550505050592"

• amount: 300

• beneficiaryFullName: "John Doe"

• destinationIBAN: "GB1204550505050563"

• destinationBIC: "5050563"

• destinationCountry: "United Kingdom"

• destinationBank: "Standard Chartered"

• reference: "550505050563"

• reason: "Salary 3 payments"

• debtorFullName : "Innovate Solutions Ltd"

• debtorAddress : "80 Technology Street, Innovation District"

• debtorCountryCode : "DE"

• debtorPostCode : "10115"

• debtorState : "Berlin"

• debtorType: "Company"

• debtorCity : "London"

• debtorWebsite : "www.innovatesolutions.eu"

• debtorBusinessRegNo : "HRB123456"

• debtorIdType : "passport", (See list of acceptable ID Types by country)

• debtorIdNumber : "DE123456789"

Important Notes

• The debtorType field accepts two values: "Company" or "Individual"

• For Company debtors, either the debtorWebsite or debtorBusinessRegNo field must be provided

• For Individual debtors, the debtorIdType and debtorIdNumber fields are both required

Example Request

{
    "account": "GB1204550505050598",
    "amount": 100,    
    "beneficiaryFullName": "Alize Breitenberg",
    "destinationIBAN": "GB12045505050505341",
    "destinationBIC": "ARPYGB21XXX",
    "destinationCountry": "United Kingdom",
    "destinationBank": "Prune Payments LTD",
    "reference": "{{$randomUUID}}",
    "reason": "Salary 5 payments",
    // Debtor details
    "debtorFullName": "Innovate Solutions Ltd",
    "debtorAddress": "80 Technology Street, Innovation District",
    "debtorCountryCode": "DE",
    "debtorPostCode": "10115",
    "debtorCity": "Berlin",
    "debtorType": "COMPANY",
    "debtorWebsite": "www.innovatesolutions.eu", 
    "debtorBusinessRegNo": "",
    "debtorIdType": "",
    "debtorIdNumber": "" 
}

Response

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

{
    "status": true,
    "message": "Transfer Initiated Successfully",
    "data": {
        "id": 121,
        "senderIban": "GB1204550505050575",
        "senderName": "Gabriella Anyiam",
        "senderBic": "",
        "recipientIban": "GB1204550505050574",
        "recipientName": "John Doe",
        "recipientBic": "ARPYGBP25050XXX",
        "recipientBankAddress": "Standard Chartered",
        "recipientBankCountry": "United Kingdom",
        "amount": 500,
        "reference": "96bdf533-e53f-4617-a266-1fcfa25736fb",
        "narration": "Salary 5 payments",
        "type": "DEBIT",
        "centrolinkRef": "ARPY121",
        "status": "PENDING",
        "createdAt": "2024-04-14T15:43:26.2817785Z",
    },
    "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.