v21

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-1682897.0 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.