Sign in

v1

latestOpenAPI 3.1.02026-07-2083190.2 KB
General

Designate a beneficiary account and transfer the benefactor's current balance

Defines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. A series of benefactor/beneficiaries may not exceed four beneficiaries and may not have a cycle in it.

post/setupBeneficiary

Request body

destinationAccountCodestring required

The destination account code.

merchantReferencestring

A value that can be supplied at the discretion of the executing user.

sourceAccountCodestring required

The benefactor account.

Response

OK - the request has succeeded.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.