ADadyen
General

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

Changed on

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

  • Base URL
    https://cal-test.adyen.com/cal/services/Fund/v5
  • URL
    https://cal-test.adyen.com/cal/services/Fund/v5/setupBeneficiary
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

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.

Changes

  • v56eb6183e18c1Revision changes
    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

  • v5f513591a2ef7Revision changes
    • warning

      added the new payoutMethod enum value to the /// response property for the response status

    • warning

      added the new payoutMethod enum value to the /// response property for the response status