Sign in
latestOpenAPI 3.0.12026-08-104242199.9 KB

8df83424e244

Reference account payouts

Initiate a payout to a reference account

Initiates a payout to the reference account specified in the request payout. The specified reference account must be associated with the account specified in the request path. Payout will be executed after 2FA confirmation. This endpoint allows the payout from reference account without scoping to a person or business id. Also, this endpoint allows the use of credit line balance when set up in the partner configuration.

post/v1/accounts/{account_id}/reference_account_payouts

Path parameters

account_idstring required

Request body

descriptionstring required

A description for the payout, which is visible ot the customer.

reference_account_idstring required

ID of the reference account to which the payout is directed. The reference account must be associated with the account specified in the request path.

authorized_person_idstring

ID of the person who can authorise the payout

referencestring

A unique reference for the payout. Used as an idempotency key.

end_to_end_idstring

An end-to-end ID for the payout.

use_creditboolean

If true, the payout will use credit available to associated account when validating amount against balance. Only the following account types can use this feature: CREDITCARD_PERSONAL, CREDITCARD_BUSINESS, CREDITCARD_FREELANCER

instant_payment_rail'sepa_instant'

The payment rail to use for an instant payout. If not specified, a regular SEPA Credit Transfer is used.

Example request

{
  "reference_account_id": "ee4cc80bee604de09d036d8b7a9b6cb0",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "end_to_end_id": "RF3-202101-123456",
  "description": "Withdrawal SPAY - DD.MM.YYYY",
  "use_credit": true,
  "instant_payment_rail": "sepa_instant",
  "amount": {
    "value": 100,
    "currency": "EUR",
    "unit": "cents"
  }
}

Response

Successful creation of a payout transaction.

idstring

Unique ID of the payout.

referencestring

A unique reference for the payout. Used as an idempotency key.

authorized_person_idstring

ID of the person who can authorise the payout

status'ACCEPTED' | 'DECLINED' | 'EXECUTED'

Current status of the payout.

end_to_end_idstring

End-to-end ID of the payout.

descriptionstring

A description for the payout.

reference_account_idstring

ID of the reference account to which the payout is directed.

decline_reasonstring

Contains a technical code for the payout if the status is DECLINED. Check decline_reason_details for more information.

decline_reason_detailsstring

Contains a detailed reason why the payout was declined if the status is DECLINED.

instant_payment_rail'sepa_instant'

The payment rail used to make this an instant payout. If not present, the payout was done as a regular SEPA Credit Transfer.

use_creditboolean

If true, the payout will include credit available to associated account when validating amount against balance. If null, the payout was not eligible to use credit available to associated account.

Example response

{
  "id": "4b157d71def54b5c9dac28ef1d04432csctp",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "RF3-202101-123456",
  "description": "Payout for January 2021",
  "reference_account_id": "d5325027ca2840d4b3a97b8ec8b837f0racc",
  "decline_reason": "instant_payment_rail_failure",
  "instant_payment_rail": "sepa_instant",
  "use_credit": true,
  "amount": {
    "currency": "EUR",
    "value": 100
  }
}