Skip to main content

StandingOrderDTO

payment objectrequired

Payment details for standing order

schemestring

Specifies payment scheme for processing.

instructedAmount objectrequired
currencystringrequired

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

amountstringrequired

The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.

Possible values: non-empty and <= 12 characters

debtorAccount objectrequired

Settlement account used when settlement method is INDA/INGA.

identification objectrequired

Unique and unambiguous identification for the account.

ibanstring

International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.

Possible values: >= 15 characters and <= 34 characters

other object

Unique identification of an account, as assigned by the account servicer, using any other identification scheme.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

creditorAccount objectrequired

Settlement account used when settlement method is INDA/INGA.

identification objectrequired

Unique and unambiguous identification for the account.

ibanstring

International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.

Possible values: >= 15 characters and <= 34 characters

other object

Unique identification of an account, as assigned by the account servicer, using any other identification scheme.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

creditorNamestringrequired

The Party whose account is credited with the payment. Must not exceed 70 characters.

Possible values: non-empty and <= 70 characters

debtorNamestringrequired

The full name of the debtor. Must not exceed 70 characters.

Possible values: non-empty and <= 70 characters

remittanceInformationUnstructuredstring

Payment details. Free text, one occurrence (max 140 characters). Payment reason (according to current recurrent payment standard) can be given in this element.

Possible values: non-empty and <= 140 characters

settlementInformation object

Specifies the details on how the settlement of the transaction(s) between the instructing agent and the instructed agent is completed.

settlementMethodstringrequired

Method used to settle the payment: INDA (instructed agent), INGA (instructing agent), CLRG (clearing system)

settlementAccount object

Settlement account used when settlement method is INDA/INGA.

identification objectrequired

Unique and unambiguous identification for the account.

ibanstring

International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.

Possible values: >= 15 characters and <= 34 characters

other object

Unique identification of an account, as assigned by the account servicer, using any other identification scheme.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

clearingSystemstring

Clearing system when settlement method is CLRG.

startDatestring<date>required

Standing order start date

frequencystringrequired

Standing order frequency

Possible values: [DAILY, WEEKLY, MONTHLY]

endDatestring<date>

Standing order end date

ownerIdstringrequired

Standing order owner id

Possible values: non-empty and <= 36 characters

retryPolicy objectrequired

Failing standing orders retry policy

retryCountinteger<int32>

Specifies how many times the failing standing order will be retried

StandingOrderDTO
{
  "payment": {
    "scheme": "string",
    "instructedAmount": {
      "currency": "string",
      "amount": "string"
    },
    "debtorAccount": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "scheme": "string"
        }
      },
      "currency": "string"
    },
    "creditorAccount": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "scheme": "string"
        }
      },
      "currency": "string"
    },
    "creditorName": "string",
    "debtorName": "string",
    "remittanceInformationUnstructured": "string",
    "settlementInformation": {
      "settlementMethod": "string",
      "settlementAccount": {
        "identification": {
          "iban": "string",
          "other": {
            "identification": "string",
            "scheme": "string"
          }
        },
        "currency": "string"
      },
      "clearingSystem": "string"
    }
  },
  "startDate": "2024-07-29",
  "frequency": "DAILY, WEEKLY, MONTHLY",
  "endDate": "2024-07-29",
  "ownerId": "string",
  "retryPolicy": {
    "retryCount": 0
  }
}