Page cover

Send Money from Account

Endpoint

POST {{base_url}}/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:

  • currency: "GBP"

  • account: "00002570"

  • amount: 300

  • beneficiaryFullName: "John Doe"

  • destinationIBAN : "GB1204550505050563" (EUR only)

  • destinationBIC: "5050563" (EUR only)

  • destinationAccountNumber : "62947XXX" (GBP only)

  • destinationSortCode: "041075" (GBP only)

  • 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"

circle-info

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

  • EUR requests should contain destinationIBAN & destinationBIC in the request body

  • GBP requests should contain destinationAccountNumber & destinationSortCode in the request body

Example Request

Response

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

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.

Last updated