Skip to content
/Reference account payouts

Transactions (1.0)

Download OpenAPI description
transactions.json
transactions.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/transactions/

Cash Operations (Viacash)

Operations

Clearing transactions

Operations

Instant Top-Ups

Operations

Instant Top-Up Payment Methods

Operations

Intra-customer transfers

Operations

Prepaid accounts

Operations

Partner remittances

Operations

Reference account payouts

Operations

Initiate payout to a specific person reference account

Request

Initiates a payout to the person reference account specified in the request URL.
Note: Requests to this endpoint must be confirmed using the change request process.

Path
person_idstringrequired
account_idstringrequired
reference_account_idstringrequired
Bodyapplication/json

The content of the request.

descriptionstringrequired

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

Example: "Withdrawal SPAY - DD.MM.YYYY"
amountobjectrequired

The amount of the payout.

Example: {"value":100,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount, in Euro cents.

Example: 100
amount.​unitstring

The unit of the given value.

Example: "cents"
amount.​currencystring

The currency.

Example: "EUR"
referencestring

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

Example: "payout_unique_ref"
end_to_end_idstring

An end-to-end ID for the payout.

Example: "end_to_end_id"
instant_payment_railstring

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

Value"sepa_instant"
application/json
{
  "reference": "payout_unique_ref",
  "end_to_end_id": "end_to_end_id",
  "description": "Withdrawal SPAY - DD.MM.YYYY",
  "amount": {
    "value": 100,
    "currency": "EUR",
    "unit": "cents"
  }
}

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Index payouts to a specific person reference account

Request

Returns an array containing all payouts made to the particular reference account specified in the request URL.

Path
person_idstringrequired
reference_account_idstringrequired
account_idstringrequired
Query
page[number]integer

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[status]string

Filter on status

Enum"ACCEPTED""DECLINED""EXECUTED"
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
]
Response
application/json
[
  {
    "id": "4b157d71def54b5c9dac28ef1d04432c",
    "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
    "status": "ACCEPTED",
    "end_to_end_id": "end_to_end_ref",
    "description": "Payout description",
    "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
    "decline_reason": "instant_payment_rail_failure"
  }
]

Initiate a payout to a business' reference account

Request

Initiates a payout from a business' wallet to the specific reference account specified in the request URL. Requests to this endpoint must be confirmed using the change request process.

Path
business_idstringrequired
account_idstringrequired
reference_account_idstringrequired
Bodyapplication/json

The content of the request.

descriptionstringrequired

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

Example: "Withdrawal SPAY - DD.MM.YYYY"
amountobjectrequired

The amount of the payout.

Example: {"value":100,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount, in Euro cents.

Example: 100
amount.​unitstring

The unit of the given value.

Example: "cents"
amount.​currencystring

The currency.

Example: "EUR"
referencestring

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

Example: "payout_unique_ref"
end_to_end_idstring

An end-to-end ID for the payout.

Example: "end_to_end_id"
instant_payment_railstring

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

Value"sepa_instant"
application/json
{
  "reference": "payout_unique_ref",
  "end_to_end_id": "end_to_end_id",
  "description": "Withdrawal SPAY - DD.MM.YYYY",
  "amount": {
    "value": 100,
    "currency": "EUR",
    "unit": "cents"
  }
}

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Index reference account payouts for a business account

Request

Returns an array containing all reference account payouts for the business account specified in the request URL.

Path
business_idstringrequired
account_idstringrequired
reference_account_idstringrequired
Query
page[number]integer

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[status]string

Filter on status

Enum"ACCEPTED""DECLINED""EXECUTED"
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
]
Response
application/json
[
  {
    "id": "4b157d71def54b5c9dac28ef1d04432c",
    "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
    "status": "ACCEPTED",
    "end_to_end_id": "end_to_end_ref",
    "description": "Payout description",
    "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
    "decline_reason": "instant_payment_rail_failure"
  }
]

Initiate business reference account payout

Request

Initiates a payout from a business' wallet to its associated reference account.
Note: Requests to this endpoint must be confirmed using the change request process.

Path
business_idstringrequired
account_idstringrequired
Bodyapplication/json

The content of the request.

descriptionstringrequired

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

Example: "Withdrawal SPAY - DD.MM.YYYY"
amountobjectrequired

The amount of the payout.

Example: {"value":100,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount, in Euro cents.

Example: 100
amount.​unitstring

The unit of the given value.

Example: "cents"
amount.​currencystring

The currency.

Example: "EUR"
referencestring

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

Example: "payout_unique_ref"
end_to_end_idstring

An end-to-end ID for the payout.

Example: "end_to_end_id"
instant_payment_railstring

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

Value"sepa_instant"
application/json
{
  "reference": "payout_unique_ref",
  "end_to_end_id": "end_to_end_id",
  "description": "Withdrawal SPAY - DD.MM.YYYY",
  "amount": {
    "value": 100,
    "currency": "EUR",
    "unit": "cents"
  }
}

Responses

Successful result of the operation.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Index business reference account payouts

Request

Returns an array containing all wallet payouts to the business reference account specified in the request URL.

Path
business_idstringrequired
account_idstringrequired
Query
page[number]string

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[status]string

Filter the results by payout status.

Enum"ACCEPTED""DECLINED""EXECUTED"
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
]
Response
application/json
[
  {
    "id": "4b157d71def54b5c9dac28ef1d04432c",
    "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
    "status": "ACCEPTED",
    "end_to_end_id": "end_to_end_ref",
    "description": "Payout description",
    "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
    "decline_reason": "instant_payment_rail_failure"
  }
]

Retrieve a business reference account payout

Request

Retrieves the business reference account payout specified in the request URL.

Path
business_idstringrequired
account_idstringrequired
idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Initiate reference account payout to a person

Request

Initiates a payout from a person's wallet to their reference account.
Note: Requests to this endpoint must be confirmed using the change request process.

Path
person_idstringrequired
account_idstringrequired
Bodyapplication/json

The content of the request.

descriptionstringrequired

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

Example: "Withdrawal SPAY - DD.MM.YYYY"
amountobjectrequired

The amount of the payout.

Example: {"value":100,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount, in Euro cents.

Example: 100
amount.​unitstring

The unit of the given value.

Example: "cents"
amount.​currencystring

The currency.

Example: "EUR"
referencestring

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

Example: "payout_unique_ref"
end_to_end_idstring

An end-to-end ID for the payout.

Example: "end_to_end_id"
instant_payment_railstring

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

Value"sepa_instant"
application/json
{
  "reference": "payout_unique_ref",
  "end_to_end_id": "end_to_end_id",
  "description": "Withdrawal SPAY - DD.MM.YYYY",
  "amount": {
    "value": 100,
    "currency": "EUR",
    "unit": "cents"
  }
}

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Index reference account payouts to a person

Request

Returns an array containing all payouts to a person's reference account.

Path
person_idstringrequired
account_idstringrequired
Query
page[number]integer

The number of results pages to return.

page[size]integer

The number of results to return in each page.

filter[status]string

Filter the results by payout status.

Enum"ACCEPTED""DECLINED""EXECUTED"
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
]
Response
application/json
[
  {
    "id": "4b157d71def54b5c9dac28ef1d04432c",
    "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
    "status": "ACCEPTED",
    "end_to_end_id": "end_to_end_ref",
    "description": "Payout description",
    "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
    "decline_reason": "instant_payment_rail_failure"
  }
]

Retrieve a reference account payout to a person

Request

Returns a specific reference account payout to a person based on the ID specified in the request URL.

Path
person_idstringrequired
account_idstringrequired
idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Retrieve a payout to a person's reference account

Request

Returns a specific payout to a specific reference account.

Path
person_idstringrequired
account_idstringrequired
reference_account_idstringrequired
idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

Retrieve a payout to a business reference account

Request

Returns a specific payout to a specific reference account.

Path
business_idstringrequired
account_idstringrequired
reference_account_idstringrequired
idstringrequired
No request payload

Responses

The operation was successful.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432c"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "end_to_end_ref"
descriptionstring

A description for the payout.

Example: "Payout description"
reference_account_idstring

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

Example: "78f354e508314bb8ac982a3d7f969dde"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

instant_payment_railstring

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

Value"sepa_instant"
Response
application/json
{
  "id": "4b157d71def54b5c9dac28ef1d04432c",
  "reference": "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669",
  "status": "ACCEPTED",
  "end_to_end_id": "end_to_end_ref",
  "description": "Payout description",
  "reference_account_id": "78f354e508314bb8ac982a3d7f969dde",
  "decline_reason": "instant_payment_rail_failure"
}

(New) Initiate a payout to a reference account

Request

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 replaces old Reference Account Payouts endpoints which will be deprecated soon.

Path
account_idstringrequired
Bodyapplication/json

The content of the request.

descriptionstring<= 140 charactersrequired

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

Example: "Withdrawal SPAY - DD.MM.YYYY"
amountobjectrequired

The amount of the payout.

Example: {"value":100,"currency":"EUR","unit":"cents"}
amount.​valueinteger

The amount, in Euro cents.

Example: 100
amount.​unitstring

The unit of the given value.

Example: "cents"
amount.​currencystring

The currency.

Example: "EUR"
reference_account_idstringrequired

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.

Example: "ee4cc80bee604de09d036d8b7a9b6cb0"
authorized_person_idstring

ID of the person who can authorise the payout

referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
end_to_end_idstring<= 35 characters

An end-to-end ID for the payout.

Example: "RF3-202101-123456"
use_creditboolean

If true, the payout will include credit available to associated account when validating amout against balance.

Default false
Example: true
instant_payment_railstring

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

Value"sepa_instant"
Example: "sepa_instant"
application/json
{
  "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"
  }
}

Responses

Successful creation of a payout transaction.

Bodyapplication/json
idstring

Unique ID of the payout.

Example: "4b157d71def54b5c9dac28ef1d04432csctp"
referencestring

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

Example: "9d2b59c2-c68f-413c-b2a9-a2f5bfd3f669"
authorized_person_idstring

ID of the person who can authorise the payout

statusstring

Current status of the payout.

Enum"ACCEPTED""DECLINED""EXECUTED"
Example: "ACCEPTED"
end_to_end_idstring

End-to-end ID of the payout.

Example: "RF3-202101-123456"
descriptionstring

A description for the payout.

Example: "Payout for January 2021"
reference_account_idstring

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

Example: "d5325027ca2840d4b3a97b8ec8b837f0racc"
decline_reasonstring

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

Example: "instant_payment_rail_failure"
decline_reason_detailsstring

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

amountobject

Amount of the payout.

Example: {"currency":"EUR","value":100}
instant_payment_railstring

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

Value"sepa_instant"
Example: "sepa_instant"
Response
application/json
{
  "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
  }
}

Transfer requests

Operations

(Legacy) Money Transfer

Operations