EPC API for calling Electrum (15.2.0)

The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.

Download OpenAPI description

bpp-elpapi.json

bpp-elpapi.yaml

Overview

URL https://electrum.co.za

Electrum Support support@electrum.co.za

License proprietary

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/

Payments API sandbox

https://example.com/path/payments/api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

Schema

traceparent

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

string(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

"string"

tracestate

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

string(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

"string"

MessageIdentifiers

Holds a point-to-point unique message identification string as well as a message's creation date time.

creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

{
  "creationDateTime": "2019-08-24T14:15:22Z",
  "messageIdentification": "string"
}

SupplementaryData

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

property name*stringadditional property

{
  "property1": "string",
  "property2": "string"
}

BaseMessage

A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  }
}

BaseResponseMessage

An extension of BaseMessage which includes additional information pertinent to an asynchronous response message. In particular, original message identifiers.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

originalMessageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalMessageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  }
}

TransactionIdentifiers

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre- agreed period.

uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

{
  "endToEndIdentification": "string",
  "transactionIdentification": "string",
  "uetr": "string"
}

BaseTransactionResponseMessage

An extension of BaseTransactionMessage which includes additional information pertinent to an asynchronous response message. In particular, original message identifiers.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

originalMessageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalMessageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

transactionIdentifiers.transactionIdentificationstring<= 35 characters

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  }
}

CustomIdentifier

namespacestring[ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

ZA_RPP

schemastring

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

valuestring[ 1 .. 2048 ] charactersrequired

{
  "namespace": "string",
  "schema": "CUSTOM",
  "value": "string"
}

NonBankingIdentifier

namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

schemastring

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

valuestring[ 1 .. 2048 ] charactersrequired

{
  "namespace": "string",
  "schema": "CUSTOM",
  "value": "string"
}

PhoneNumber

string(PhoneNumber)^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

"string"

MobileNumberIdentifier

namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

schemastring

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

valuestring[ 1 .. 2048 ] charactersrequired

{
  "namespace": "string",
  "schema": "CUSTOM",
  "value": "string"
}

FinancialInstitutionIdentifier

bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

memberIdstring<= 35 characters

Identification of a member of a clearing system.

namespacesArray of strings

schemastringrequired

Indicates the account identifier is a Financial Institution Identifier, always FII

{
  "bicfi": "string",
  "memberId": "string",
  "namespaces": [
    "string"
  ],
  "schema": "string"
}

ExternalAccountIdentificationCode

AIIN: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).
BBAN: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
CUID: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.
UPIC: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.

string(ExternalAccountIdentificationCode)

AIIN: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).
BBAN: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
CUID: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.
UPIC: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.

Enum"AIIN""BBAN""CUID""UPIC"

"AIIN"

GenericAccountIdentificationSchemeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestring(ExternalAccountIdentificationCode)required

AIIN: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).
BBAN: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
CUID: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.
UPIC: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.

Enum"AIIN""BBAN""CUID""UPIC"

{
  "schema": "string",
  "value": "AIIN"
}

ProprietaryValueLiteral

A proprietary value.

string(ProprietaryValueLiteral)<= 35 characters

A proprietary value.

"string"

ProprietaryValue

A model that describes a proprietary value assigned by some party, the purpose of which is to provide for the possibility of parties using values that are not standardised.

schemastringrequired

Identifies the value as being proprietary (i.e. not published in an external list). Always PROPRIETARY

valuestring(ProprietaryValueLiteral)<= 35 charactersrequired

A proprietary value.

{
  "schema": "string",
  "value": "string"
}

GenericAccountIdentificationScheme

Identifies the scheme that defines the identification of a generic account.

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestring(ExternalAccountIdentificationCode)required

AIIN: Issuer Identification Number - identifies a card issuing institution in an international interchange environment. Issued by ABA (American Bankers Association).
BBAN: Basic Bank Account Number - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
CUID: (United States) Clearing House Interbank Payments System (CHIPS) Universal Identification (UID) - identifies entities that own accounts at CHIPS participating financial institutions, through which CHIPS payments are effected. The CHIPS UID is assigned by the New York Clearing House.
UPIC: Universal Payment Identification Code - identifier used by the New York Clearing House to mask confidential data, such as bank accounts and bank routing numbers. UPIC numbers remain with business customers, regardless of banking relationship changes.

Enum"AIIN""BBAN""CUID""UPIC"

{
  "schema": "CODE",
  "value": "AIIN"
}

GenericAccountIdentifier

issuerstring<= 35 characters

The entity that assigns the identification

schemastringrequired

Identifies this account identifier as generic, always GENERIC

schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

valuestring[ 1 .. 40 ] charactersrequired

{
  "issuer": "string",
  "schema": "string",
  "scheme": {
    "schema": "string",
    "value": "AIIN"
  },
  "value": "string"
}

IBAN

An identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616: 2007

string(IBAN)[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

"string"

IBANIdentifier

schemastringrequired

Indicates the account identifier is an IBAN, always IBAN

valuestring(IBAN)[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}required

{
  "schema": "string",
  "value": "string"
}

AccountIdentifier

namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

schemastring

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

valuestring[ 1 .. 2048 ] charactersrequired

{
  "namespace": "string",
  "schema": "CUSTOM",
  "value": "string"
}

PaymentSchemeName

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

string(PaymentSchemeName)

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

"ZA_RTC"

AccountIdentification

Holds details pertaining to an identifier of an account or store of value.

accountKnownAsstring<= 40 characters

A name or label of the account.

identifierobject(AccountIdentifier)required

identifier.namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

identifier.schemastring

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

identifier.valuestring[ 1 .. 2048 ] charactersrequired

registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

Items Enum"ZA_RTC""ZA_RPP""ZA_EFT"

{
  "accountKnownAs": "string",
  "identifier": {
    "schema": "string",
    "value": "string"
  },
  "registeredSchemes": [
    "ZA_RTC"
  ]
}

AddressTypeCode

ADDR: A postal address.
PBOX: A postal office (PO) box address.
HOME: A (residential) home address.
BIZZ: A business address.
MLTO: Address to which mail is sent.
DLVY: Address to which delivery is to take place

string(AddressTypeCode)

ADDR: A postal address.
PBOX: A postal office (PO) box address.
HOME: A (residential) home address.
BIZZ: A business address.
MLTO: Address to which mail is sent.
DLVY: Address to which delivery is to take place

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"

"ADDR"

CountryCode

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

string(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

"string"

PostalAddress

addressLineArray of strings[ 0 .. 7 ] items

addressTypestring(AddressTypeCode)

ADDR: A postal address.
PBOX: A postal office (PO) box address.
HOME: A (residential) home address.
BIZZ: A business address.
MLTO: Address to which mail is sent.
DLVY: Address to which delivery is to take place

Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"

buildingNamestring[ 1 .. 35 ] characters

buildingNumberstring[ 1 .. 16 ] characters

countrystring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

countrySubDivisionstring[ 1 .. 35 ] characters

departmentstring[ 1 .. 70 ] characters

districtNamestring[ 1 .. 35 ] characters

floorstring[ 1 .. 70 ] characters

postBoxstring[ 1 .. 16 ] characters

postCodestring[ 1 .. 16 ] characters

streetNamestring[ 1 .. 70 ] characters

townLocationNamestring[ 1 .. 35 ] characters

townNamestring[ 1 .. 35 ] characters

{
  "addressLine": [
    "string"
  ],
  "addressType": "ADDR",
  "buildingName": "string",
  "buildingNumber": "string",
  "country": "string",
  "countrySubDivision": "string",
  "department": "string",
  "districtName": "string",
  "floor": "string",
  "postBox": "string",
  "postCode": "string",
  "streetName": "string",
  "townLocationName": "string",
  "townName": "string"
}

BranchIdentification

addressobject(PostalAddress)

identificationstringrequired

Unique and unambiguous identification of a branch of a financial institution.

namestring<= 140 characters

The name by which this branch is known and is usually used to identify the branch.

{
  "address": {
    "addressLine": [ … ],
    "addressType": "ADDR",
    "buildingName": "string",
    "buildingNumber": "string",
    "country": "string",
    "countrySubDivision": "string",
    "department": "string",
    "districtName": "string",
    "floor": "string",
    "postBox": "string",
    "postCode": "string",
    "streetName": "string",
    "townLocationName": "string",
    "townName": "string"
  },
  "identification": "string",
  "name": "string"
}

InstitutionIdentification

additionalIdentificationsArray of objects(AccountIdentification)

bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

branchobject(BranchIdentification)

companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

memberIdstring<= 35 characters

Identification of a member of a clearing system.

namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

{
  "additionalIdentifications": [
    { … }
  ],
  "bicfi": "string",
  "branch": {
    "address": { … },
    "identification": "string",
    "name": "string"
  },
  "companyRegistration": "string",
  "lei": "string",
  "memberId": "string",
  "name": "string"
}

Amount

currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

{
  "currency": "string",
  "value": 0.1
}

TransactionAmounts

bankSettlementAmountobject(Amount)required

bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

bankSettlementAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

instructedAmountobject(Amount)

{
  "bankSettlementAmount": {
    "currency": "string",
    "value": 0.1
  },
  "instructedAmount": {
    "currency": "string",
    "value": 0.1
  }
}

ContactDetails

emailAddressstring(email)

mobileNumberstring(PhoneNumber)^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

phoneNumberstring(PhoneNumber)^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

{
  "emailAddress": "user@example.com",
  "mobileNumber": "string",
  "phoneNumber": "string"
}

OrganisationIdentifierBic

An organisation identified by a code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - Banking - Banking telecommunication messages - Business identifier code (BIC).

BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

{
  "BIC": "string",
  "schema": "string"
}

OrganisationIdentifierLei

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

LEIstring[A-Z0-9]{18,18}[0-9]{2,2}required

schemastringrequired

Indicates the identifier as a LEI organisation identifier, always LEI

{
  "LEI": "string",
  "schema": "string"
}

OrganisationIdentificationCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired

BANK : BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
CBID : CentralBankIdentificationNumber. A unique identification number assigned by a central bank to identify an organisation.
CHID : ClearingIdentificationNumber. A unique identification number assigned by a clearing house to identify an organisation
CINC : CertificateOfIncorporationNumber. A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.
COID : CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)
CUST : CustomerNumber. Number assigned by an issuer to identify a customer or number assigned by a party to identify a creditor or debtor relationship.
DUNS : DataUniversalNumberingSystem. A unique identification number provided by Dun & Bradstreet to identify an organisation.
EMPL : EmployerIdentificationNumber. Number assigned by a registration authority to an employer.
GS1G : GS1GLNIdentifier. Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.
SREN : SIREN. The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
SRET : SIRET. The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity
TXID : TaxIdentificationNumber. Number assigned by a tax authority to identify an organisation.
BDID : BusinessDomainIdentifier. Identifier of the business domain in which the organisation is active.
BOID : BusinessOtherIdentification. Other identification of the organisation.

Enum"BANK""CBID""CHID""CINC""COID""CUST""DUNS""EMPL""GS1G""SREN"

{
  "schema": "string",
  "value": "BANK"
}

OrganisationIdentifierScheme

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestringrequired

BANK : BankPartyIdentification. Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
CBID : CentralBankIdentificationNumber. A unique identification number assigned by a central bank to identify an organisation.
CHID : ClearingIdentificationNumber. A unique identification number assigned by a clearing house to identify an organisation
CINC : CertificateOfIncorporationNumber. A unique identification number assigned by a designated authority to a certificate of incorporation and used to identify an organisation.
COID : CountryIdentificationCode. Country authority given organisation identification (e.g., corporate registration number)
CUST : CustomerNumber. Number assigned by an issuer to identify a customer or number assigned by a party to identify a creditor or debtor relationship.
DUNS : DataUniversalNumberingSystem. A unique identification number provided by Dun & Bradstreet to identify an organisation.
EMPL : EmployerIdentificationNumber. Number assigned by a registration authority to an employer.
GS1G : GS1GLNIdentifier. Global Location Number. A non-significant reference number used to identify legal entities, functional entities, or physical entities according to GS1 numbering scheme rules.The number is used to retrieve detailed information that is linked to it.
SREN : SIREN. The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
SRET : SIRET. The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity
TXID : TaxIdentificationNumber. Number assigned by a tax authority to identify an organisation.
BDID : BusinessDomainIdentifier. Identifier of the business domain in which the organisation is active.
BOID : BusinessOtherIdentification. Other identification of the organisation.

Enum"BANK""CBID""CHID""CINC""COID""CUST""DUNS""EMPL""GS1G""SREN"

{
  "schema": "CODE",
  "value": "BANK"
}

OrganisationIdentifierOther

A unique identification of an organisation, as assigned by an institution, using an identification scheme.

identificationstring<= 35 charactersrequired

issuerstring<= 35 characters

The name of the entity that assigns the identification

schemastringrequired

Indicates the identifier as a unique identification of an organisation, as assigned by an institution. Always OTHER

schemeobject(OrganisationIdentifierScheme)

{
  "identification": "string",
  "issuer": "string",
  "schema": "string",
  "scheme": {
    "schema": "string",
    "value": "BANK"
  }
}

OrganisationIdentifier

Holds identification details for an organisation.

BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

{
  "BIC": "string",
  "schema": "BIC"
}

OrganisationIdentification

identifiersArray of objects(OrganisationIdentifier)required

identifiers[].BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

identifiers[].schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

schemastringrequired

Identifies the party as an organisation, always ORGANISATION

{
  "identifiers": [
    { … }
  ],
  "schema": "string"
}

PersonIdentificationCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired

ARNU: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.
CCPT: PassportNumber. A number assigned by an authority to identify the passport number of a person.
CUST: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.
DRLC: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.
EMPL: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.
NIDN: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.
SOSE: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.
TELE: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.
TXID: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.
POID: PersonOtherIdentification. Other identification of the person.

Enum"ARNU""CCPT""CUST""DRLC""EMPL""NIDN""SOSE""TELE""TXID""POID"

{
  "schema": "string",
  "value": "ARNU"
}

PersonIdentifierScheme

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestringrequired

ARNU: AlienRegistrationNumber. A number assigned by a social security agency to identify a non-resident person.
CCPT: PassportNumber. A number assigned by an authority to identify the passport number of a person.
CUST: CustomerIdentificationNumber. A number assigned by an issuer to identify a customer.
DRLC: DriversLicenseNumber. A number assigned by an authority to identify a driver's license.
EMPL: EmployeeIdentificationNumber. A number assigned by a registration authority to an employee.
NIDN: NationalIdentityNumber. A number assigned by an authority to identify the national identity number of a person.
SOSE: SocialSecurityNumber. A number assigned by an authority to identify the social security number of a person.
TELE: TelephoneNumber. A number assigned by a telephone or mobile phone operator to identify a person. A person may have multiple phone numbers.
TXID: TaxIdentificationNumber. A number assigned by a tax authority to identify a person.
POID: PersonOtherIdentification. Other identification of the person.

Enum"ARNU""CCPT""CUST""DRLC""EMPL""NIDN""SOSE""TELE""TXID""POID"

{
  "schema": "CODE",
  "value": "ARNU"
}

PersonIdentifier

identificationstring<= 35 charactersrequired

Unique and unambiguous identification of a person, for example a passport.

issuerstring<= 35 characters

The entity that assigns the identification

schemeobject(PersonIdentifierScheme)

{
  "identification": "string",
  "issuer": "string",
  "scheme": {
    "schema": "string",
    "value": "ARNU"
  }
}

PersonIdentification

identifiersArray of objects(PersonIdentifier)required

identifiers[].identificationstring<= 35 charactersrequired

Unique and unambiguous identification of a person, for example a passport.

identifiers[].issuerstring<= 35 characters

The entity that assigns the identification

identifiers[].schemeobject(PersonIdentifierScheme)

schemastringrequired

Identifies the party as a person, always PERSON

{
  "identifiers": [
    { … }
  ],
  "schema": "string"
}

PartyIdentification

The identification of a party, either a person or an organisation.

identifiersArray of objects(OrganisationIdentifier)required

identifiers[].BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

identifiers[].schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

schemastringrequired

Identifies the party as an organisation, always ORGANISATION

Discriminator

{
  "identifiers": [
    { … }
  ],
  "schema": "ORGANISATION"
}

Party

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

addressobject(PostalAddress)

contactDetailsobject(ContactDetails)

countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

{
  "address": {
    "addressLine": [ … ],
    "addressType": "ADDR",
    "buildingName": "string",
    "buildingNumber": "string",
    "country": "string",
    "countrySubDivision": "string",
    "department": "string",
    "districtName": "string",
    "floor": "string",
    "postBox": "string",
    "postCode": "string",
    "streetName": "string",
    "townLocationName": "string",
    "townName": "string"
  },
  "contactDetails": {
    "emailAddress": "user@example.com",
    "mobileNumber": "string",
    "phoneNumber": "string"
  },
  "countryOfResidence": "string",
  "identification": {
    "identifiers": [ … ],
    "schema": "string"
  },
  "knownAsName": "string",
  "legalName": "string"
}

BankingIdentifier

issuerstring<= 35 characters

The entity that assigns the identification

schemastringrequired

Identifies this account identifier as generic, always GENERIC

Discriminator

schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

valuestring[ 1 .. 40 ] charactersrequired

{
  "issuer": "string",
  "schema": "GENERIC",
  "scheme": {
    "schema": "string",
    "value": "AIIN"
  },
  "value": "string"
}

ExternalCashAccountType1Code

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

string(ExternalCashAccountType1Code)

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

"CACC"

AccountTypeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestring(ExternalCashAccountType1Code)required

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

{
  "schema": "string",
  "value": "CACC"
}

AccountType

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestring(ExternalCashAccountType1Code)required

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

{
  "schema": "CODE",
  "value": "CACC"
}

PaymentAccount

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

identificationobject(BankingIdentifier)

namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

proxyobject(NonBankingIdentifier)

typeobject(AccountType)

{
  "currency": "string",
  "identification": {
    "schema": "string",
    "value": "string"
  },
  "name": "string",
  "proxy": {
    "namespace": "string",
    "schema": "string"
  },
  "type": {
    "schema": "string",
    "value": "CACC"
  }
}

LocalInstrumentTypeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired

0000 - BusinessPayment
0001 - ConvertedBankPayment
0002 - StandingOrder
0090 - MassPaymentBeneficiary
0091 - MassPaymentOurs
0092 - MassPaymentShared
0220 - StandingAuthorisationGeneral
0221 - OneOffAuthorisation
0222 - StandingAuthorisationCompanies
0223 - StandingAuthorisationLotteries
0224 - OneOffAuthorisationCharities
0225 - OneOffAuthorisationTuitionFees
0226 - OneOffAuthorisationConstructionIndustry
0227 - StandingAuthorisationCompaniesWithoutDebtorRevocationRight
04 - PreauthorisedDirectDebitDE
05 - NonPreauthorisedDirectDebitDE
08 - PreauthorisedDirectDebitOrdinaireNormalClearing4Day
19 - BusinessToCustomerDirectDebit
58 - BusinessToBusinessDirectDebit
60 - RecoveredBillofExchangeorPromissoryNote
82 - NonPreauthorisedDirectDebitAT
83 - PreauthorisedDirectDebitAT
85 - PreauthorisedDirectDebitAccéléréAcceleratedClearing2DayOrdinaireNormalClearing4Day
89 - PreauthorisedDirectDebitVérifiéVerifiedClearing
AC01 - IncorrectAccountNumber
ACCEPT - PaymentViaAcceptgiroOwnedByCurrence
ADD - AuthenticatedDirectDebit
ARC - AccountsReceivableCheck
ASTI - AncillarySystemTransferInitiation
B2B - SEPABusinessToBusinessDirectDebit
B2BAMIPM - SEPAB2BDirectDebitAMI
BACP - BackupPayment
BPA - BatchPaymentsAruba
BSE - PaperlessChequeCollection
BTR - BankTransfer
CARD - CardClearing
CCD - CashConcentrationOrDisbursementCorporateCounterparty
CCI - CashConcentrationIntragroup
CHN - TruncatedChecks
CIE - CustomerInitiatedEntry
CKS - CheckSameDaySettlementWire
CLSCCPERX - CLSClearedFXForEurex
CLSCCPLCH - CLSClearedFXForLCH
COR1 - SEPADirectDebit1DaySettlement
CORAMIPM - SEPACoreDirectDebitAMI
CORE - SEPADirectDebitCore
CPP - CashPerPost
CR1AMIPM - SEPACoreD1DirectDebitAMI
CRP - CreditTransferPreferred
CTP - CustomerTransferPlus
CTR - CustomerTransfer
CTX - CorporateTradeExchange
DDFA - DirectDebitFixedAmount
DDMC - DirectDebitConfirmedElectronicMandate
DDMP - DirectDebitPaperMandateWithPaperAuthorisation
DDMU - DirectDebitUnconfirmedElectronicMandate
DDNR - CoreNoRefund
DDT - DirectDebits
DEP - DepositToSendersAccount
DRB - BankToBankDrawdownRequestOrResponseNonvalue
DRC - CustomerOrCorporateDrawdownRequestOrResponseNonvalue
DRW - DrawdownResponseValueToHonorADrawdownRequest
FADAMIPM - SEPAFADirectDebitAMI
FFR - FedFundsReturned
FFS - FedFundsSold
GST - TruncatedCreditTransfers
IAT - InternationalACH
ICMC - IncidentManagementCorrection
IDEAL - PaymentsViaInternetOwnedByCurrence
IN - CrossBorderCustomerCreditTransfer
INST - InstantCreditTransfer
INSTIDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransfer
INSTNT01 - InstantCreditTransferNotTimeCritical
INSTNT01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferNotTimeCritical
INSTTC01 - InstantCreditTransferTimeCritical
INSTTC01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferTimeCritical
IPA - InstantPaymentsAruba
ISE - ImageBasedChequeCollection
ITP - InstantCreditTransferPreferred
MANP - MandatedPayment
NLDO - DutchDomesticBulkPayment
NLGOV - DirectDebitInitiatedByTheGovernmentWithSpecialConditions
NLUP - DutchUrgentPayment
ONCL - Overnight
PERI - PaymentWithERI
POP - PointOfPurchase
POS - PointOfSale
PPD - PrearrangedPaymentOrDepositConsumerCounterparty
RCK - RepresentedCheckEntry
RDD - ReturnedDirectDebits
RIBA - NonPreauthorisedDirectDebitRIBA
RIDO - PreauthorisedRevocableDirectDebit
RIDV - PreauthorisedRevocableUrgentDirectDebit
RTR - ReturnedCreditTransfers
SBTI - SettlementBankTransferInitiation
SCN - RevokedTruncatedChecks
SDCL - SameDayClearedPayments
SDD - RevokedDirectDebits
SDN - PaymentsViaStandaardDigitaleNota
SGT - RevokedTruncatedCreditTransfers
SRD - RevokedReturnedDirectDebits
SRT - RevokedReturnedCreditTransfers
STR - RevokedCreditTransfers
SVC - NonValueServiceMessage
TEL - TelephoneInitiatedEntry
TRF - CreditTransfers
UDD - UnauthenticatedDirectDebit
WEB - InternetInitiatedEntry

Enum"0000""0001""0002"909192"0220""0221""0222""0223"

{
  "schema": "string",
  "value": "0000"
}

LocalInstrumentType

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestringrequired

0000 - BusinessPayment
0001 - ConvertedBankPayment
0002 - StandingOrder
0090 - MassPaymentBeneficiary
0091 - MassPaymentOurs
0092 - MassPaymentShared
0220 - StandingAuthorisationGeneral
0221 - OneOffAuthorisation
0222 - StandingAuthorisationCompanies
0223 - StandingAuthorisationLotteries
0224 - OneOffAuthorisationCharities
0225 - OneOffAuthorisationTuitionFees
0226 - OneOffAuthorisationConstructionIndustry
0227 - StandingAuthorisationCompaniesWithoutDebtorRevocationRight
04 - PreauthorisedDirectDebitDE
05 - NonPreauthorisedDirectDebitDE
08 - PreauthorisedDirectDebitOrdinaireNormalClearing4Day
19 - BusinessToCustomerDirectDebit
58 - BusinessToBusinessDirectDebit
60 - RecoveredBillofExchangeorPromissoryNote
82 - NonPreauthorisedDirectDebitAT
83 - PreauthorisedDirectDebitAT
85 - PreauthorisedDirectDebitAccéléréAcceleratedClearing2DayOrdinaireNormalClearing4Day
89 - PreauthorisedDirectDebitVérifiéVerifiedClearing
AC01 - IncorrectAccountNumber
ACCEPT - PaymentViaAcceptgiroOwnedByCurrence
ADD - AuthenticatedDirectDebit
ARC - AccountsReceivableCheck
ASTI - AncillarySystemTransferInitiation
B2B - SEPABusinessToBusinessDirectDebit
B2BAMIPM - SEPAB2BDirectDebitAMI
BACP - BackupPayment
BPA - BatchPaymentsAruba
BSE - PaperlessChequeCollection
BTR - BankTransfer
CARD - CardClearing
CCD - CashConcentrationOrDisbursementCorporateCounterparty
CCI - CashConcentrationIntragroup
CHN - TruncatedChecks
CIE - CustomerInitiatedEntry
CKS - CheckSameDaySettlementWire
CLSCCPERX - CLSClearedFXForEurex
CLSCCPLCH - CLSClearedFXForLCH
COR1 - SEPADirectDebit1DaySettlement
CORAMIPM - SEPACoreDirectDebitAMI
CORE - SEPADirectDebitCore
CPP - CashPerPost
CR1AMIPM - SEPACoreD1DirectDebitAMI
CRP - CreditTransferPreferred
CTP - CustomerTransferPlus
CTR - CustomerTransfer
CTX - CorporateTradeExchange
DDFA - DirectDebitFixedAmount
DDMC - DirectDebitConfirmedElectronicMandate
DDMP - DirectDebitPaperMandateWithPaperAuthorisation
DDMU - DirectDebitUnconfirmedElectronicMandate
DDNR - CoreNoRefund
DDT - DirectDebits
DEP - DepositToSendersAccount
DRB - BankToBankDrawdownRequestOrResponseNonvalue
DRC - CustomerOrCorporateDrawdownRequestOrResponseNonvalue
DRW - DrawdownResponseValueToHonorADrawdownRequest
FADAMIPM - SEPAFADirectDebitAMI
FFR - FedFundsReturned
FFS - FedFundsSold
GST - TruncatedCreditTransfers
IAT - InternationalACH
ICMC - IncidentManagementCorrection
IDEAL - PaymentsViaInternetOwnedByCurrence
IN - CrossBorderCustomerCreditTransfer
INST - InstantCreditTransfer
INSTIDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransfer
INSTNT01 - InstantCreditTransferNotTimeCritical
INSTNT01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferNotTimeCritical
INSTTC01 - InstantCreditTransferTimeCritical
INSTTC01IDEAL - PaymentsViaInternetOwnedByCurrenceUsingInstantCreditTransferTimeCritical
IPA - InstantPaymentsAruba
ISE - ImageBasedChequeCollection
ITP - InstantCreditTransferPreferred
MANP - MandatedPayment
NLDO - DutchDomesticBulkPayment
NLGOV - DirectDebitInitiatedByTheGovernmentWithSpecialConditions
NLUP - DutchUrgentPayment
ONCL - Overnight
PERI - PaymentWithERI
POP - PointOfPurchase
POS - PointOfSale
PPD - PrearrangedPaymentOrDepositConsumerCounterparty
RCK - RepresentedCheckEntry
RDD - ReturnedDirectDebits
RIBA - NonPreauthorisedDirectDebitRIBA
RIDO - PreauthorisedRevocableDirectDebit
RIDV - PreauthorisedRevocableUrgentDirectDebit
RTR - ReturnedCreditTransfers
SBTI - SettlementBankTransferInitiation
SCN - RevokedTruncatedChecks
SDCL - SameDayClearedPayments
SDD - RevokedDirectDebits
SDN - PaymentsViaStandaardDigitaleNota
SGT - RevokedTruncatedCreditTransfers
SRD - RevokedReturnedDirectDebits
SRT - RevokedReturnedCreditTransfers
STR - RevokedCreditTransfers
SVC - NonValueServiceMessage
TEL - TelephoneInitiatedEntry
TRF - CreditTransfers
UDD - UnauthenticatedDirectDebit
WEB - InternetInitiatedEntry

Enum"0000""0001""0002"909192"0220""0221""0222""0223"

{
  "schema": "CODE",
  "value": "0000"
}

PaymentTypeInformation

localInstrumentobject(LocalInstrumentType)

{
  "localInstrument": {
    "schema": "string",
    "value": "0000"
  }
}

CreditorReferenceType

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
DISP (DispatchAdvice): Document is a dispatch advice.
PUOR (PurchaseOrder): Document is a purchase order.
SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.

Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

CreditorReferenceTypeCode

Specifies the type of creditor reference.

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
DISP (DispatchAdvice): Document is a dispatch advice.
PUOR (PurchaseOrder): Document is a purchase order.
SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.

Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

CreditorReferenceTypeProprietary

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
DISP (DispatchAdvice): Document is a dispatch advice.
PUOR (PurchaseOrder): Document is a purchase order.
SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.

Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

CreditorReference

referencestring<= 35 characters

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

typeobject(CreditorReferenceType)

{
  "reference": "string",
  "type": {
    "issuer": "string",
    "schema": "CODE"
  }
}

ReferredDocumentAmount

duePayableAmountobject(Amount)

remittedAmountobject(Amount)

{
  "duePayableAmount": {
    "currency": "string",
    "value": 0.1
  },
  "remittedAmount": {
    "currency": "string",
    "value": 0.1
  }
}

ReferredDocumentType

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

AROI : AccountReceivableOpenItem
BOLD : BillOfLading
CINV : CommercialInvoice
CMCN : CommercialContract
CNFA : CreditNoteRelatedToFinancialAdjustment
CREN : CreditNote
DEBN : DebitNote
DISP : DispatchAdvice
DNFA : DebitNoteRelatedToFinancialAdjustment
HIRI : HireInvoice
MSIN : MeteredServiceInvoice
PUOR : PurchaseOrder
SBIN : SelfBilledInvoice
SOAC : StatementOfAccount
TSUT : TradeServicesUtilityTransaction
VCHR : Voucher

Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocumentTypeCode

Specifies the type of referred document

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

AROI : AccountReceivableOpenItem
BOLD : BillOfLading
CINV : CommercialInvoice
CMCN : CommercialContract
CNFA : CreditNoteRelatedToFinancialAdjustment
CREN : CreditNote
DEBN : DebitNote
DISP : DispatchAdvice
DNFA : DebitNoteRelatedToFinancialAdjustment
HIRI : HireInvoice
MSIN : MeteredServiceInvoice
PUOR : PurchaseOrder
SBIN : SelfBilledInvoice
SOAC : StatementOfAccount
TSUT : TradeServicesUtilityTransaction
VCHR : Voucher

Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocumentTypeProprietary

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

AROI : AccountReceivableOpenItem
BOLD : BillOfLading
CINV : CommercialInvoice
CMCN : CommercialContract
CNFA : CreditNoteRelatedToFinancialAdjustment
CREN : CreditNote
DEBN : DebitNote
DISP : DispatchAdvice
DNFA : DebitNoteRelatedToFinancialAdjustment
HIRI : HireInvoice
MSIN : MeteredServiceInvoice
PUOR : PurchaseOrder
SBIN : SelfBilledInvoice
SOAC : StatementOfAccount
TSUT : TradeServicesUtilityTransaction
VCHR : Voucher

Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocument

documentIdentifierstring<= 35 characters

typeobject(ReferredDocumentType)

{
  "documentIdentifier": "string",
  "type": {
    "issuer": "string",
    "schema": "CODE"
  }
}

StructuredRemittanceInformation

additionalRemittanceInformationArray of strings<= 3 items

creditorReferenceobject(CreditorReference)

originatorReferencestring<= 35 characters

An explanation of the transaction, this field may be used to capture the information which may then be displayed on the payment originator's bank statement (ie. the debtor for a credit transfer or the creditor for a direct debit). This field is not supported by all Electrum partner implementations, and will be ignored if provided in an unsupported use-case.

referredDocumentAmountobject(ReferredDocumentAmount)

referredDocumentsArray of objects(ReferredDocument)

{
  "additionalRemittanceInformation": [
    "string"
  ],
  "creditorReference": {
    "reference": "string",
    "type": { … }
  },
  "originatorReference": "string",
  "referredDocumentAmount": {
    "duePayableAmount": { … },
    "remittedAmount": { … }
  },
  "referredDocuments": [
    { … }
  ]
}

RemittanceInformation

structuredArray of objects(StructuredRemittanceInformation)

unstructuredArray of strings

{
  "structured": [
    { … }
  ],
  "unstructured": [
    "string"
  ]
}

OriginalTransactionData

Contains key elements related to the original transaction that is being referred to.

amountsobject(TransactionAmounts)

creditorobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAgentobject(InstitutionIdentification)

debtorobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)

paymentMethodstring

Specifies the means of payment for the original transaction.

Enum"CreditTransfer""DirectDebit"

paymentTypeInformationobject(PaymentTypeInformation)

remittanceInformationobject(RemittanceInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

{
  "amounts": {
    "bankSettlementAmount": { … },
    "instructedAmount": { … }
  },
  "creditor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "bicfi": "string",
    "branch": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "bicfi": "string",
    "branch": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "paymentMethod": "CreditTransfer",
  "paymentTypeInformation": {
    "localInstrument": { … }
  },
  "remittanceInformation": {
    "structured": [ … ],
    "unstructured": [ … ]
  },
  "settlementDate": "2019-08-24",
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  }
}

ZaEftPaymentStatusReportPaymentScheme

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

{
  "schema": "ZA_RTC"
}

ZaRppPaymentStatusReportPaymentScheme

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

{
  "schema": "ZA_RTC"
}

ZaRtcCreditTransferPaymentSchemeData

businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

{
  "businessReference": "string",
  "originatorEchoData": "string",
  "userReference": "string"
}

ZaRtcPaymentStatusReportPaymentSchemeData

authorisationIdstring<= 6 characters^[\dA-z ]*$

A unique number assigned by the beneficiary bank to identify the transaction if it is approved. Must remain unaltered by the originator.

beneficiaryEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for beneficiary use. Must remain unaltered by the originator.

{
  "authorisationId": "string",
  "beneficiaryEchoData": "string"
}

ZaRtcPaymentStatusReportPaymentScheme

originalSchemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

originalSchemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

originalSchemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

originalSchemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

schemeDataobject(ZaRtcPaymentStatusReportPaymentSchemeData)required

schemeData.authorisationIdstring<= 6 characters^[\dA-z ]*$

A unique number assigned by the beneficiary bank to identify the transaction if it is approved. Must remain unaltered by the originator.

schemeData.beneficiaryEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for beneficiary use. Must remain unaltered by the originator.

{
  "originalSchemeData": {
    "businessReference": "string",
    "originatorEchoData": "string",
    "userReference": "string"
  },
  "schema": "ZA_RTC",
  "schemeData": {
    "authorisationId": "string",
    "beneficiaryEchoData": "string"
  }
}

PaymentStatusReportPaymentScheme

Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

{
  "schema": "ZA_EFT"
}

StatusReasonTypeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired

ACCP: AcceptedCustomerProfile
ACCC: AcceptedSettlementCompletedCreditorAccount
ACSC: AcceptedSettlementCompletedDebtorAccount
ACSP: AcceptedSettlementInProcess
ACTC: AcceptedTechnicalValidation
ACWC: AcceptedWithChange
ACWP: AcceptedWithoutPosting
AB01 : AbortedClearingTimeout
AB02 : AbortedClearingFatalError
AB03 : AbortedSettlementTimeout
AB04 : AbortedSettlementFatalError
AB05 : TimeoutCreditorAgent
AB06 : TimeoutInstructedAgent
AB07 : OfflineAgent
AB08 : OfflineCreditorAgent
AB09 : ErrorCreditorAgent
AB10 : ErrorInstructedAgent
AB11 : TimeoutDebtorAgent
ACC : SuccessfulVerboseCdvOutcome
AC01 : IncorrectAccountNumber
AC02 : InvalidDebtorAccountNumber
AC03 : InvalidCreditorAccountNumber
AC04 : ClosedAccountNumber
AC05 : ClosedDebtorAccountNumber
AC06 : BlockedAccount
AC07 : ClosedCreditorAccountNumber
AC08 : InvalidBranchCode
AC09 : InvalidAccountCurrency
AC10 : InvalidDebtorAccountCurrency
AC11 : InvalidCreditorAccountCurrency
AC12 : InvalidAccountType
AC13 : InvalidDebtorAccountType
AC14 : InvalidCreditorAccountType
AC15 : AccountDetailsChanged
AC16 : CardNumberInvalid
AC17 : AccountInLiquidation
AEXR : AlreadyExpiredRTP
AG01 : TransactionForbidden
AG02 : InvalidBankOperationCode
AG03 : TransactionNotSupported
AG04 : InvalidAgentCountry
AG05 : InvalidDebtorAgentCountry
AG06 : InvalidCreditorAgentCountry
AG07 : UnsuccessfulDirectDebit
AG08 : InvalidAccessRights
AG09 : PaymentNotReceived
AG10 : AgentSuspended
AG11 : CreditorAgentSuspended
AG12 : NotAllowedBookTransfer
AG13 : ForbiddenReturnPayment
AGNT : IncorrectAgent
ALAC : AlreadyAcceptedRTP
AM01 : ZeroAmount
AM02 : NotAllowedAmount
AM03 : NotAllowedCurrency
AM04 : InsufficientFunds
AM05 : Duplication
AM06 : TooLowAmount
AM07 : BlockedAmount
AM09 : WrongAmount
AM10 : InvalidControlSum
AM11 : InvalidTransactionCurrency
AM12 : InvalidAmount
AM13 : AmountExceedsClearingSystemLimit
AM14 : AmountExceedsAgreedLimit
AM15 : AmountBelowClearingSystemMinimum
AM16 : InvalidGroupControlSum
AM17 : InvalidPaymentInfoControlSum
AM18 : InvalidNumberOfTransactions
AM19 : InvalidGroupNumberOfTransactions
AM20 : InvalidPaymentInfoNumberOfTransactions
AM21 : LimitExceeded
AM22 : ZeroAmountNotApplied
AM23 : AmountExceedsSettlementLimit
APAR : AlreadyPaidRTP
ARDT : AlreadyReturnedTransaction
ARFR : AlreadyRefusedRTP
ARJR : AlreadyRejectedRTP
ATNS : AttachmentsNotSupported
BE01 : InconsistentWithEndCustomer
BE04 : MissingCreditorAddress
BE05 : UnrecognisedInitiatingParty
BE06 : UnknownEndCustomer
BE07 : MissingDebtorAddress
BE08 : MissingDebtorName
BE09 : InvalidCountry
BE10 : InvalidDebtorCountry
BE11 : InvalidCreditorCountry
BE12 : InvalidCountryOfResidence
BE13 : InvalidDebtorCountryOfResidence
BE14 : InvalidCreditorCountryOfResidence
BE15 : InvalidIdentificationCode
BE16 : InvalidDebtorIdentificationCode
BE17 : InvalidCreditorIdentificationCode
BE18 : InvalidContactDetails
BE19 : InvalidChargeBearerCode
BE20 : InvalidNameLength
BE21 : MissingName
BE22 : MissingCreditorName
BE23 : AccountProxyInvalid
CERI : CheckERI
CH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture
CH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast
CH07 : ElementIsNotToBeUsedAtB-andC-Level
CH09 : MandateChangesNotAllowed
CH10 : InformationOnMandateChangesMissing
CH11 : CreditorIdentifierIncorrect
CH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-Level
CH13 : OriginalDebtorAccountIsNotToBeUsed
CH14 : OriginalDebtorAgentIsNotToBeUsed
CH15 : ElementContentIncludesMoreThan140Characters
CH16 : ElementContentFormallyIncorrect
CH17 : ElementNotAdmitted
CH19 : ValuesWillBeSetToNextTARGETday
CH20 : DecimalPointsNotCompatibleWithCurrency
CH21 : RequiredCompulsoryElementMissing
CH22 : COREandB2BwithinOnemessage
CHQC : ChequeSettledOnCreditorAccount
CN01 : AuthorisationCancelled
CNOR : CreditorBankIsNotRegistered
CURR : IncorrectCurrency
CUST : RequestedByCustomer
DNOR : DebtorBankIsNotRegistered
DS01 : ElectronicSignaturesCorrect
DS02 : OrderCancelled
DS03 : OrderNotCancelled
DS04 : OrderRejected
DS05 : OrderForwardedForPostprocessing
DS06 : TransferOrder
DS07 : ProcessingOK
DS08 : DecompressionError
DS09 : DecryptionError
DS0A : DataSignRequested
DS0B : UnknownDataSignFormat
DS0C : SignerCertificateRevoked
DS0D : SignerCertificateNotValid
DS0E : IncorrectSignerCertificate
DS0F : SignerCertificationAuthoritySignerNotValid
DS0G : NotAllowedPayment
DS0H : NotAllowedAccount
DS0K : NotAllowedNumberOfTransaction
DS10 : Signer1CertificateRevoked
DS11 : Signer1CertificateNotValid
DS12 : IncorrectSigner1Certificate
DS13 : SignerCertificationAuthoritySigner1NotValid
DS14 : UserDoesNotExist
DS15 : IdenticalSignatureFound
DS16 : PublicKeyVersionIncorrect
DS17 : DifferentOrderDataInSignatures
DS18 : RepeatOrder
DS19 : ElectronicSignatureRightsInsufficient
DS20 : Signer2CertificateRevoked
DS21 : Signer2CertificateNotValid
DS22 : IncorrectSigner2Certificate
DS23 : SignerCertificationAuthoritySigner2NotValid
DS24 : WaitingTimeExpired
DS25 : OrderFileDeleted
DS26 : UserSignedMultipleTimes
DS27 : UserNotYetActivated
DT01 : InvalidDate
DT02 : InvalidCreationDate
DT03 : InvalidNonProcessingDate
DT04 : FutureDateNotSupported
DT05 : InvalidCutOffDate
DT06 : ExecutionDateChanged
DU01 : DuplicateMessageID
DU02 : DuplicatePaymentInformationID
DU03 : DuplicateTransaction
DU04 : DuplicateEndToEndID
DU05 : DuplicateInstructionID
DUPL : DuplicatePayment
ED01 : CorrespondentBankNotPossible
ED03 : BalanceInfoRequest
ED05 : SettlementFailed
ED06 : SettlementSystemNotAvailable
EDTL : ExpiryDateTooLong
EDTR : ExpiryDateTimeReached
ERIN : ERIOptionNotSupported
FF01 : InvalidFileFormat
FF02 : SyntaxError
FF03 : InvalidPaymentTypeInformation
FF04 : InvalidServiceLevelCode
FF05 : InvalidLocalInstrumentCode
FF06 : InvalidCategoryPurposeCode
FF07 : InvalidPurpose
FF08 : InvalidEndToEndId
FF09 : InvalidChequeNumber
FF10 : BankSystemProcessingError
FF11 : ClearingRequestAborted
FF12 : OriginalTransactionNotEligibleForRequestedReturn
FF13 : RequestForCancellationNotFound
FOCR : FollowingCancellationRequest
FR01 : Fraud
FRAD : FraudulentOrigin
G000 : PaymentTransferredAndTracked
G001 : PaymentTransferredAndNotTracked
G002 : CreditDebitNotConfirmed
G003 : CreditPendingDocuments
G004 : CreditPendingFunds
G005 : DeliveredWithServiceLevel
G006 : DeliveredWithoutServiceLevel
ID01 : CorrespondingOriginalFileStillNotSent
IEDT : IncorrectExpiryDateTime
IRNR : InitialRTPNeverReceived
MD01 : NoMandate
MD02 : MissingMandatoryInformationInMandate
MD05 : CollectionNotDue
MD06 : RefundRequestByEndCustomer
MD07 : EndCustomerDeceased
MS02 : NotSpecifiedReasonCustomerGenerated
MS03 : NotSpecifiedReasonAgentGenerated
NARR : Narrative
NERI : NoERI
NOAR : NonAgreedRTP
NOAS : NoAnswerFromCustomer
NOCM : NotCompliantGeneric
NOOR : NoOriginalTransactionReceived
NOPG : NoPaymentGuarantee
NRCH : PayerOrPayerRTPSPNotReachable
PART : PartiallyAccepted
PINS : TypeOfPaymentInstrumentNotSupported
RC01 : BankIdentifierIncorrect
RC02 : InvalidBankIdentifier
RC03 : InvalidDebtorBankIdentifier
RC04 : InvalidCreditorBankIdentifier
RC05 : InvalidBICIdentifier
RC06 : InvalidDebtorBICIdentifier
RC07 : InvalidCreditorBICIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RC09 : InvalidDebtorClearingSystemMemberIdentifier
RC10 : InvalidCreditorClearingSystemMemberIdentifier
RC11 : InvalidIntermediaryAgent
RC12 : MissingCreditorSchemeId
RCON : RMessageConflict
RECI : ReceiverCustomerInformation
REPR : RTPReceivedCanBeProcessed
RF01 : NotUniqueTransactionReference
RR01 : MissingDebtorAccountOrIdentification
RR02 : MissingDebtorNameOrAddress
RR03 : MissingCreditorNameOrAddress
RR04 : RegulatoryReason
RR05 : RegulatoryInformationInvalid
RR06 : TaxInformationInvalid
RR07 : RemittanceInformationInvalid
RR08 : RemittanceInformationTruncated
RR09 : InvalidStructuredCreditorReference
RR10 : InvalidCharacterSet
RR11 : InvalidDebtorAgentServiceID
RR12 : InvalidPartyID
RTNS : RTPNotSupportedForDebtor
RUTA : ReturnUponUnableToApply
S000 : ValidRequestForCancellationAcknowledged
S001 : UETRFlaggedForCancellation
S002 : NetworkStopOfUETR
S003 : RequestForCancellationForwarded
S004 : RequestForCancellationDeliveryAcknowledgement
SL01 : SpecificServiceOfferedByDebtorAgent
SL02 : SpecificServiceOfferedByCreditorAgent
SL03 : ServiceofClearingSystem
SL11 : CreditorNotOnWhitelistOfDebtor
SL12 : CreditorOnBlacklistOfDebtor
SL13 : MaximumNumberOfDirectDebitTransactionsExceeded
SL14 : MaximumDirectDebitTransactionAmountExceeded
SP01 : PaymentStopped
SP02 : PreviouslyStopped
SPII : RTPServiceProviderIdentifierIncorrect
TA01 : TransmissionAborted
TD01 : NoDataAvailable
TD02 : FileNonReadable
TD03 : IncorrectFileStructure
TK01 : TokenInvalid
TK02 : SenderTokenNotFound
TK03 : ReceiverTokenNotFound
TK09 : TokenMissing
TKCM : TokenCounterpartyMismatch
TKSG : TokenSingleUse
TKSP : TokenSuspended
TKVE : TokenValueLimitExceeded
TKXP : TokenExpired
TM01 : InvalidCutOffTime
TS01 : TransmissionSuccessful
TS04 : TransferToSignByHand
UCRD : UnknownCreditor
UPAY : UnduePayment

Enum"ACCC""ACCP""ACSC""ACTC""ACWP""AB01""AB02""AB03""AB04""AB05"

{
  "schema": "string",
  "value": "ACCC"
}

StatusReasonType

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestringrequired

ACCP: AcceptedCustomerProfile
ACCC: AcceptedSettlementCompletedCreditorAccount
ACSC: AcceptedSettlementCompletedDebtorAccount
ACSP: AcceptedSettlementInProcess
ACTC: AcceptedTechnicalValidation
ACWC: AcceptedWithChange
ACWP: AcceptedWithoutPosting
AB01 : AbortedClearingTimeout
AB02 : AbortedClearingFatalError
AB03 : AbortedSettlementTimeout
AB04 : AbortedSettlementFatalError
AB05 : TimeoutCreditorAgent
AB06 : TimeoutInstructedAgent
AB07 : OfflineAgent
AB08 : OfflineCreditorAgent
AB09 : ErrorCreditorAgent
AB10 : ErrorInstructedAgent
AB11 : TimeoutDebtorAgent
ACC : SuccessfulVerboseCdvOutcome
AC01 : IncorrectAccountNumber
AC02 : InvalidDebtorAccountNumber
AC03 : InvalidCreditorAccountNumber
AC04 : ClosedAccountNumber
AC05 : ClosedDebtorAccountNumber
AC06 : BlockedAccount
AC07 : ClosedCreditorAccountNumber
AC08 : InvalidBranchCode
AC09 : InvalidAccountCurrency
AC10 : InvalidDebtorAccountCurrency
AC11 : InvalidCreditorAccountCurrency
AC12 : InvalidAccountType
AC13 : InvalidDebtorAccountType
AC14 : InvalidCreditorAccountType
AC15 : AccountDetailsChanged
AC16 : CardNumberInvalid
AC17 : AccountInLiquidation
AEXR : AlreadyExpiredRTP
AG01 : TransactionForbidden
AG02 : InvalidBankOperationCode
AG03 : TransactionNotSupported
AG04 : InvalidAgentCountry
AG05 : InvalidDebtorAgentCountry
AG06 : InvalidCreditorAgentCountry
AG07 : UnsuccessfulDirectDebit
AG08 : InvalidAccessRights
AG09 : PaymentNotReceived
AG10 : AgentSuspended
AG11 : CreditorAgentSuspended
AG12 : NotAllowedBookTransfer
AG13 : ForbiddenReturnPayment
AGNT : IncorrectAgent
ALAC : AlreadyAcceptedRTP
AM01 : ZeroAmount
AM02 : NotAllowedAmount
AM03 : NotAllowedCurrency
AM04 : InsufficientFunds
AM05 : Duplication
AM06 : TooLowAmount
AM07 : BlockedAmount
AM09 : WrongAmount
AM10 : InvalidControlSum
AM11 : InvalidTransactionCurrency
AM12 : InvalidAmount
AM13 : AmountExceedsClearingSystemLimit
AM14 : AmountExceedsAgreedLimit
AM15 : AmountBelowClearingSystemMinimum
AM16 : InvalidGroupControlSum
AM17 : InvalidPaymentInfoControlSum
AM18 : InvalidNumberOfTransactions
AM19 : InvalidGroupNumberOfTransactions
AM20 : InvalidPaymentInfoNumberOfTransactions
AM21 : LimitExceeded
AM22 : ZeroAmountNotApplied
AM23 : AmountExceedsSettlementLimit
APAR : AlreadyPaidRTP
ARDT : AlreadyReturnedTransaction
ARFR : AlreadyRefusedRTP
ARJR : AlreadyRejectedRTP
ATNS : AttachmentsNotSupported
BE01 : InconsistentWithEndCustomer
BE04 : MissingCreditorAddress
BE05 : UnrecognisedInitiatingParty
BE06 : UnknownEndCustomer
BE07 : MissingDebtorAddress
BE08 : MissingDebtorName
BE09 : InvalidCountry
BE10 : InvalidDebtorCountry
BE11 : InvalidCreditorCountry
BE12 : InvalidCountryOfResidence
BE13 : InvalidDebtorCountryOfResidence
BE14 : InvalidCreditorCountryOfResidence
BE15 : InvalidIdentificationCode
BE16 : InvalidDebtorIdentificationCode
BE17 : InvalidCreditorIdentificationCode
BE18 : InvalidContactDetails
BE19 : InvalidChargeBearerCode
BE20 : InvalidNameLength
BE21 : MissingName
BE22 : MissingCreditorName
BE23 : AccountProxyInvalid
CERI : CheckERI
CH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture
CH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast
CH07 : ElementIsNotToBeUsedAtB-andC-Level
CH09 : MandateChangesNotAllowed
CH10 : InformationOnMandateChangesMissing
CH11 : CreditorIdentifierIncorrect
CH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-Level
CH13 : OriginalDebtorAccountIsNotToBeUsed
CH14 : OriginalDebtorAgentIsNotToBeUsed
CH15 : ElementContentIncludesMoreThan140Characters
CH16 : ElementContentFormallyIncorrect
CH17 : ElementNotAdmitted
CH19 : ValuesWillBeSetToNextTARGETday
CH20 : DecimalPointsNotCompatibleWithCurrency
CH21 : RequiredCompulsoryElementMissing
CH22 : COREandB2BwithinOnemessage
CHQC : ChequeSettledOnCreditorAccount
CN01 : AuthorisationCancelled
CNOR : CreditorBankIsNotRegistered
CURR : IncorrectCurrency
CUST : RequestedByCustomer
DNOR : DebtorBankIsNotRegistered
DS01 : ElectronicSignaturesCorrect
DS02 : OrderCancelled
DS03 : OrderNotCancelled
DS04 : OrderRejected
DS05 : OrderForwardedForPostprocessing
DS06 : TransferOrder
DS07 : ProcessingOK
DS08 : DecompressionError
DS09 : DecryptionError
DS0A : DataSignRequested
DS0B : UnknownDataSignFormat
DS0C : SignerCertificateRevoked
DS0D : SignerCertificateNotValid
DS0E : IncorrectSignerCertificate
DS0F : SignerCertificationAuthoritySignerNotValid
DS0G : NotAllowedPayment
DS0H : NotAllowedAccount
DS0K : NotAllowedNumberOfTransaction
DS10 : Signer1CertificateRevoked
DS11 : Signer1CertificateNotValid
DS12 : IncorrectSigner1Certificate
DS13 : SignerCertificationAuthoritySigner1NotValid
DS14 : UserDoesNotExist
DS15 : IdenticalSignatureFound
DS16 : PublicKeyVersionIncorrect
DS17 : DifferentOrderDataInSignatures
DS18 : RepeatOrder
DS19 : ElectronicSignatureRightsInsufficient
DS20 : Signer2CertificateRevoked
DS21 : Signer2CertificateNotValid
DS22 : IncorrectSigner2Certificate
DS23 : SignerCertificationAuthoritySigner2NotValid
DS24 : WaitingTimeExpired
DS25 : OrderFileDeleted
DS26 : UserSignedMultipleTimes
DS27 : UserNotYetActivated
DT01 : InvalidDate
DT02 : InvalidCreationDate
DT03 : InvalidNonProcessingDate
DT04 : FutureDateNotSupported
DT05 : InvalidCutOffDate
DT06 : ExecutionDateChanged
DU01 : DuplicateMessageID
DU02 : DuplicatePaymentInformationID
DU03 : DuplicateTransaction
DU04 : DuplicateEndToEndID
DU05 : DuplicateInstructionID
DUPL : DuplicatePayment
ED01 : CorrespondentBankNotPossible
ED03 : BalanceInfoRequest
ED05 : SettlementFailed
ED06 : SettlementSystemNotAvailable
EDTL : ExpiryDateTooLong
EDTR : ExpiryDateTimeReached
ERIN : ERIOptionNotSupported
FF01 : InvalidFileFormat
FF02 : SyntaxError
FF03 : InvalidPaymentTypeInformation
FF04 : InvalidServiceLevelCode
FF05 : InvalidLocalInstrumentCode
FF06 : InvalidCategoryPurposeCode
FF07 : InvalidPurpose
FF08 : InvalidEndToEndId
FF09 : InvalidChequeNumber
FF10 : BankSystemProcessingError
FF11 : ClearingRequestAborted
FF12 : OriginalTransactionNotEligibleForRequestedReturn
FF13 : RequestForCancellationNotFound
FOCR : FollowingCancellationRequest
FR01 : Fraud
FRAD : FraudulentOrigin
G000 : PaymentTransferredAndTracked
G001 : PaymentTransferredAndNotTracked
G002 : CreditDebitNotConfirmed
G003 : CreditPendingDocuments
G004 : CreditPendingFunds
G005 : DeliveredWithServiceLevel
G006 : DeliveredWithoutServiceLevel
ID01 : CorrespondingOriginalFileStillNotSent
IEDT : IncorrectExpiryDateTime
IRNR : InitialRTPNeverReceived
MD01 : NoMandate
MD02 : MissingMandatoryInformationInMandate
MD05 : CollectionNotDue
MD06 : RefundRequestByEndCustomer
MD07 : EndCustomerDeceased
MS02 : NotSpecifiedReasonCustomerGenerated
MS03 : NotSpecifiedReasonAgentGenerated
NARR : Narrative
NERI : NoERI
NOAR : NonAgreedRTP
NOAS : NoAnswerFromCustomer
NOCM : NotCompliantGeneric
NOOR : NoOriginalTransactionReceived
NOPG : NoPaymentGuarantee
NRCH : PayerOrPayerRTPSPNotReachable
PART : PartiallyAccepted
PINS : TypeOfPaymentInstrumentNotSupported
RC01 : BankIdentifierIncorrect
RC02 : InvalidBankIdentifier
RC03 : InvalidDebtorBankIdentifier
RC04 : InvalidCreditorBankIdentifier
RC05 : InvalidBICIdentifier
RC06 : InvalidDebtorBICIdentifier
RC07 : InvalidCreditorBICIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RC09 : InvalidDebtorClearingSystemMemberIdentifier
RC10 : InvalidCreditorClearingSystemMemberIdentifier
RC11 : InvalidIntermediaryAgent
RC12 : MissingCreditorSchemeId
RCON : RMessageConflict
RECI : ReceiverCustomerInformation
REPR : RTPReceivedCanBeProcessed
RF01 : NotUniqueTransactionReference
RR01 : MissingDebtorAccountOrIdentification
RR02 : MissingDebtorNameOrAddress
RR03 : MissingCreditorNameOrAddress
RR04 : RegulatoryReason
RR05 : RegulatoryInformationInvalid
RR06 : TaxInformationInvalid
RR07 : RemittanceInformationInvalid
RR08 : RemittanceInformationTruncated
RR09 : InvalidStructuredCreditorReference
RR10 : InvalidCharacterSet
RR11 : InvalidDebtorAgentServiceID
RR12 : InvalidPartyID
RTNS : RTPNotSupportedForDebtor
RUTA : ReturnUponUnableToApply
S000 : ValidRequestForCancellationAcknowledged
S001 : UETRFlaggedForCancellation
S002 : NetworkStopOfUETR
S003 : RequestForCancellationForwarded
S004 : RequestForCancellationDeliveryAcknowledgement
SL01 : SpecificServiceOfferedByDebtorAgent
SL02 : SpecificServiceOfferedByCreditorAgent
SL03 : ServiceofClearingSystem
SL11 : CreditorNotOnWhitelistOfDebtor
SL12 : CreditorOnBlacklistOfDebtor
SL13 : MaximumNumberOfDirectDebitTransactionsExceeded
SL14 : MaximumDirectDebitTransactionAmountExceeded
SP01 : PaymentStopped
SP02 : PreviouslyStopped
SPII : RTPServiceProviderIdentifierIncorrect
TA01 : TransmissionAborted
TD01 : NoDataAvailable
TD02 : FileNonReadable
TD03 : IncorrectFileStructure
TK01 : TokenInvalid
TK02 : SenderTokenNotFound
TK03 : ReceiverTokenNotFound
TK09 : TokenMissing
TKCM : TokenCounterpartyMismatch
TKSG : TokenSingleUse
TKSP : TokenSuspended
TKVE : TokenValueLimitExceeded
TKXP : TokenExpired
TM01 : InvalidCutOffTime
TS01 : TransmissionSuccessful
TS04 : TransferToSignByHand
UCRD : UnknownCreditor
UPAY : UnduePayment

Enum"ACCC""ACCP""ACSC""ACTC""ACWP""AB01""AB02""AB03""AB04""AB05"

{
  "schema": "CODE",
  "value": "ACCC"
}

StatusReasonInfo

Provides detailed information on a status reason.

additionalInformationstring

A human friendly description of the status reason including any further details if applicable.

reasonobject(StatusReasonType)required

reason.schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

reason.valuestringrequired

ACCP: AcceptedCustomerProfile
ACCC: AcceptedSettlementCompletedCreditorAccount
ACSC: AcceptedSettlementCompletedDebtorAccount
ACSP: AcceptedSettlementInProcess
ACTC: AcceptedTechnicalValidation
ACWC: AcceptedWithChange
ACWP: AcceptedWithoutPosting
AB01 : AbortedClearingTimeout
AB02 : AbortedClearingFatalError
AB03 : AbortedSettlementTimeout
AB04 : AbortedSettlementFatalError
AB05 : TimeoutCreditorAgent
AB06 : TimeoutInstructedAgent
AB07 : OfflineAgent
AB08 : OfflineCreditorAgent
AB09 : ErrorCreditorAgent
AB10 : ErrorInstructedAgent
AB11 : TimeoutDebtorAgent
ACC : SuccessfulVerboseCdvOutcome
AC01 : IncorrectAccountNumber
AC02 : InvalidDebtorAccountNumber
AC03 : InvalidCreditorAccountNumber
AC04 : ClosedAccountNumber
AC05 : ClosedDebtorAccountNumber
AC06 : BlockedAccount
AC07 : ClosedCreditorAccountNumber
AC08 : InvalidBranchCode
AC09 : InvalidAccountCurrency
AC10 : InvalidDebtorAccountCurrency
AC11 : InvalidCreditorAccountCurrency
AC12 : InvalidAccountType
AC13 : InvalidDebtorAccountType
AC14 : InvalidCreditorAccountType
AC15 : AccountDetailsChanged
AC16 : CardNumberInvalid
AC17 : AccountInLiquidation
AEXR : AlreadyExpiredRTP
AG01 : TransactionForbidden
AG02 : InvalidBankOperationCode
AG03 : TransactionNotSupported
AG04 : InvalidAgentCountry
AG05 : InvalidDebtorAgentCountry
AG06 : InvalidCreditorAgentCountry
AG07 : UnsuccessfulDirectDebit
AG08 : InvalidAccessRights
AG09 : PaymentNotReceived
AG10 : AgentSuspended
AG11 : CreditorAgentSuspended
AG12 : NotAllowedBookTransfer
AG13 : ForbiddenReturnPayment
AGNT : IncorrectAgent
ALAC : AlreadyAcceptedRTP
AM01 : ZeroAmount
AM02 : NotAllowedAmount
AM03 : NotAllowedCurrency
AM04 : InsufficientFunds
AM05 : Duplication
AM06 : TooLowAmount
AM07 : BlockedAmount
AM09 : WrongAmount
AM10 : InvalidControlSum
AM11 : InvalidTransactionCurrency
AM12 : InvalidAmount
AM13 : AmountExceedsClearingSystemLimit
AM14 : AmountExceedsAgreedLimit
AM15 : AmountBelowClearingSystemMinimum
AM16 : InvalidGroupControlSum
AM17 : InvalidPaymentInfoControlSum
AM18 : InvalidNumberOfTransactions
AM19 : InvalidGroupNumberOfTransactions
AM20 : InvalidPaymentInfoNumberOfTransactions
AM21 : LimitExceeded
AM22 : ZeroAmountNotApplied
AM23 : AmountExceedsSettlementLimit
APAR : AlreadyPaidRTP
ARDT : AlreadyReturnedTransaction
ARFR : AlreadyRefusedRTP
ARJR : AlreadyRejectedRTP
ATNS : AttachmentsNotSupported
BE01 : InconsistentWithEndCustomer
BE04 : MissingCreditorAddress
BE05 : UnrecognisedInitiatingParty
BE06 : UnknownEndCustomer
BE07 : MissingDebtorAddress
BE08 : MissingDebtorName
BE09 : InvalidCountry
BE10 : InvalidDebtorCountry
BE11 : InvalidCreditorCountry
BE12 : InvalidCountryOfResidence
BE13 : InvalidDebtorCountryOfResidence
BE14 : InvalidCreditorCountryOfResidence
BE15 : InvalidIdentificationCode
BE16 : InvalidDebtorIdentificationCode
BE17 : InvalidCreditorIdentificationCode
BE18 : InvalidContactDetails
BE19 : InvalidChargeBearerCode
BE20 : InvalidNameLength
BE21 : MissingName
BE22 : MissingCreditorName
BE23 : AccountProxyInvalid
CERI : CheckERI
CH03 : RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture
CH04 : RequestedExecutionDateOrRequestedCollectionDateTooFarInPast
CH07 : ElementIsNotToBeUsedAtB-andC-Level
CH09 : MandateChangesNotAllowed
CH10 : InformationOnMandateChangesMissing
CH11 : CreditorIdentifierIncorrect
CH12 : CreditorIdentifierNotUnambiguouslyAtTransaction-Level
CH13 : OriginalDebtorAccountIsNotToBeUsed
CH14 : OriginalDebtorAgentIsNotToBeUsed
CH15 : ElementContentIncludesMoreThan140Characters
CH16 : ElementContentFormallyIncorrect
CH17 : ElementNotAdmitted
CH19 : ValuesWillBeSetToNextTARGETday
CH20 : DecimalPointsNotCompatibleWithCurrency
CH21 : RequiredCompulsoryElementMissing
CH22 : COREandB2BwithinOnemessage
CHQC : ChequeSettledOnCreditorAccount
CN01 : AuthorisationCancelled
CNOR : CreditorBankIsNotRegistered
CURR : IncorrectCurrency
CUST : RequestedByCustomer
DNOR : DebtorBankIsNotRegistered
DS01 : ElectronicSignaturesCorrect
DS02 : OrderCancelled
DS03 : OrderNotCancelled
DS04 : OrderRejected
DS05 : OrderForwardedForPostprocessing
DS06 : TransferOrder
DS07 : ProcessingOK
DS08 : DecompressionError
DS09 : DecryptionError
DS0A : DataSignRequested
DS0B : UnknownDataSignFormat
DS0C : SignerCertificateRevoked
DS0D : SignerCertificateNotValid
DS0E : IncorrectSignerCertificate
DS0F : SignerCertificationAuthoritySignerNotValid
DS0G : NotAllowedPayment
DS0H : NotAllowedAccount
DS0K : NotAllowedNumberOfTransaction
DS10 : Signer1CertificateRevoked
DS11 : Signer1CertificateNotValid
DS12 : IncorrectSigner1Certificate
DS13 : SignerCertificationAuthoritySigner1NotValid
DS14 : UserDoesNotExist
DS15 : IdenticalSignatureFound
DS16 : PublicKeyVersionIncorrect
DS17 : DifferentOrderDataInSignatures
DS18 : RepeatOrder
DS19 : ElectronicSignatureRightsInsufficient
DS20 : Signer2CertificateRevoked
DS21 : Signer2CertificateNotValid
DS22 : IncorrectSigner2Certificate
DS23 : SignerCertificationAuthoritySigner2NotValid
DS24 : WaitingTimeExpired
DS25 : OrderFileDeleted
DS26 : UserSignedMultipleTimes
DS27 : UserNotYetActivated
DT01 : InvalidDate
DT02 : InvalidCreationDate
DT03 : InvalidNonProcessingDate
DT04 : FutureDateNotSupported
DT05 : InvalidCutOffDate
DT06 : ExecutionDateChanged
DU01 : DuplicateMessageID
DU02 : DuplicatePaymentInformationID
DU03 : DuplicateTransaction
DU04 : DuplicateEndToEndID
DU05 : DuplicateInstructionID
DUPL : DuplicatePayment
ED01 : CorrespondentBankNotPossible
ED03 : BalanceInfoRequest
ED05 : SettlementFailed
ED06 : SettlementSystemNotAvailable
EDTL : ExpiryDateTooLong
EDTR : ExpiryDateTimeReached
ERIN : ERIOptionNotSupported
FF01 : InvalidFileFormat
FF02 : SyntaxError
FF03 : InvalidPaymentTypeInformation
FF04 : InvalidServiceLevelCode
FF05 : InvalidLocalInstrumentCode
FF06 : InvalidCategoryPurposeCode
FF07 : InvalidPurpose
FF08 : InvalidEndToEndId
FF09 : InvalidChequeNumber
FF10 : BankSystemProcessingError
FF11 : ClearingRequestAborted
FF12 : OriginalTransactionNotEligibleForRequestedReturn
FF13 : RequestForCancellationNotFound
FOCR : FollowingCancellationRequest
FR01 : Fraud
FRAD : FraudulentOrigin
G000 : PaymentTransferredAndTracked
G001 : PaymentTransferredAndNotTracked
G002 : CreditDebitNotConfirmed
G003 : CreditPendingDocuments
G004 : CreditPendingFunds
G005 : DeliveredWithServiceLevel
G006 : DeliveredWithoutServiceLevel
ID01 : CorrespondingOriginalFileStillNotSent
IEDT : IncorrectExpiryDateTime
IRNR : InitialRTPNeverReceived
MD01 : NoMandate
MD02 : MissingMandatoryInformationInMandate
MD05 : CollectionNotDue
MD06 : RefundRequestByEndCustomer
MD07 : EndCustomerDeceased
MS02 : NotSpecifiedReasonCustomerGenerated
MS03 : NotSpecifiedReasonAgentGenerated
NARR : Narrative
NERI : NoERI
NOAR : NonAgreedRTP
NOAS : NoAnswerFromCustomer
NOCM : NotCompliantGeneric
NOOR : NoOriginalTransactionReceived
NOPG : NoPaymentGuarantee
NRCH : PayerOrPayerRTPSPNotReachable
PART : PartiallyAccepted
PINS : TypeOfPaymentInstrumentNotSupported
RC01 : BankIdentifierIncorrect
RC02 : InvalidBankIdentifier
RC03 : InvalidDebtorBankIdentifier
RC04 : InvalidCreditorBankIdentifier
RC05 : InvalidBICIdentifier
RC06 : InvalidDebtorBICIdentifier
RC07 : InvalidCreditorBICIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RC09 : InvalidDebtorClearingSystemMemberIdentifier
RC10 : InvalidCreditorClearingSystemMemberIdentifier
RC11 : InvalidIntermediaryAgent
RC12 : MissingCreditorSchemeId
RCON : RMessageConflict
RECI : ReceiverCustomerInformation
REPR : RTPReceivedCanBeProcessed
RF01 : NotUniqueTransactionReference
RR01 : MissingDebtorAccountOrIdentification
RR02 : MissingDebtorNameOrAddress
RR03 : MissingCreditorNameOrAddress
RR04 : RegulatoryReason
RR05 : RegulatoryInformationInvalid
RR06 : TaxInformationInvalid
RR07 : RemittanceInformationInvalid
RR08 : RemittanceInformationTruncated
RR09 : InvalidStructuredCreditorReference
RR10 : InvalidCharacterSet
RR11 : InvalidDebtorAgentServiceID
RR12 : InvalidPartyID
RTNS : RTPNotSupportedForDebtor
RUTA : ReturnUponUnableToApply
S000 : ValidRequestForCancellationAcknowledged
S001 : UETRFlaggedForCancellation
S002 : NetworkStopOfUETR
S003 : RequestForCancellationForwarded
S004 : RequestForCancellationDeliveryAcknowledgement
SL01 : SpecificServiceOfferedByDebtorAgent
SL02 : SpecificServiceOfferedByCreditorAgent
SL03 : ServiceofClearingSystem
SL11 : CreditorNotOnWhitelistOfDebtor
SL12 : CreditorOnBlacklistOfDebtor
SL13 : MaximumNumberOfDirectDebitTransactionsExceeded
SL14 : MaximumDirectDebitTransactionAmountExceeded
SP01 : PaymentStopped
SP02 : PreviouslyStopped
SPII : RTPServiceProviderIdentifierIncorrect
TA01 : TransmissionAborted
TD01 : NoDataAvailable
TD02 : FileNonReadable
TD03 : IncorrectFileStructure
TK01 : TokenInvalid
TK02 : SenderTokenNotFound
TK03 : ReceiverTokenNotFound
TK09 : TokenMissing
TKCM : TokenCounterpartyMismatch
TKSG : TokenSingleUse
TKSP : TokenSuspended
TKVE : TokenValueLimitExceeded
TKXP : TokenExpired
TM01 : InvalidCutOffTime
TS01 : TransmissionSuccessful
TS04 : TransferToSignByHand
UCRD : UnknownCreditor
UPAY : UnduePayment

Enum"ACCC""ACCP""ACSC""ACTC""ACWP""AB01""AB02""AB03""AB04""AB05"

{
  "additionalInformation": "string",
  "reason": {
    "schema": "string",
    "value": "ACCC"
  }
}

Status

outcomestringrequired

APPROVED: The instruction has been approved.
CANCELLED: The instruction has been cancelled.
PENDING: The instruction is pending.
REJECTED: The instruction has been rejected.

Enum"APPROVED""CANCELLED""PENDING""REJECTED"

reasonInfoArray of objects(StatusReasonInfo)non-empty

A list of StatusReasonInfo values providing detailed reason information for the outcome.

{
  "outcome": "APPROVED",
  "reasonInfo": [
    { … }
  ]
}

PaymentStatusReport