Sign in
latestOpenAPI 3.1.02026-08-105546268.4 KB

f1fef352d976

(Legacy) Standing orders

Index standing orders

Returns an array containing all standing orders for your customers.

get/v1/standing_orders

Query parameters

page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

filter[transaction_type]string

Filter the results by transaction type.

filter[next_occurrence]string required

Filters the results to include only standing orders that are scheduled to execute on a given date.

Response

Successful result of the operation

idstring

Unique ID of the standing order.

status'ACTIVE' | 'INACTIVE' | 'CANCELED'

The status of the standing order.

booking_type'SEPA_CREDIT_TRANSFER' | 'CREDIT_CLEARING_TRANSACTION' | 'CRYPTO_EXCHANGE'

The booking type to use in this standing order's transaction.

transaction_type'SEPA_CREDIT_TRANSFER' | 'CREDIT_CLEARING_TRANSACTION'

The type of transaction to be executed by the standing order.

recipient_ibanstring

The recipient's IBAN.

recipient_namestring

The recipient's name.

recipient_bicstring

The recipient's BIC.

referencestring

Optional reference for the transaction. Will act as an idempotency key.

descriptionstring

Optional description for the transaction, which will be visible to the recipient. Limited to 140 characters.

first_execution_datestring date

The date on which to execute the standing order for the first time.

last_execution_datestring date

The date on which to execute the standing order for the last time.

reoccurrence'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'EVERY_SIX_MONTHS' | 'ANNUALLY'

The frequency at which to execute the standing order.

end_to_end_idstring

SEPA identifier provided by the transaction initiator, which will be routed throughout the whole payment process.

month_end_executionboolean

Flag to indicate whether the standing order should be executed at the end of the month (for monthly standing orders).

next_occurrencestring date

Next occurrence for this standing order

Example response

[
  {
    "id": "f874b3102718a4d757a6b6e4d599607ccsto",
    "status": "ACTIVE",
    "booking_type": "SEPA_CREDIT_TRANSFER",
    "transaction_type": "SEPA_CREDIT_TRANSFER",
    "recipient_iban": "DE87110101001000057123",
    "recipient_name": "Hans Mustermann",
    "recipient_bic": "COBADEFFXXX",
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "amount": {
      "value": 1000,
      "unit": "cents",
      "currency": "EUR"
    },
    "first_execution_date": "2021-09-01",
    "last_execution_date": "2025-09-01",
    "reoccurrence": "MONTHLY",
    "end_to_end_id": "END2ENDREJ",
    "month_end_execution": true,
    "next_occurrence": "2021-10-01"
  }
]