SEPA Direct Debit Transfer Gateway API 1.4.2 documentation

SEPA Direct Debit Transfer Gateway API 1.4.2

application/json

SEPA Gateway API provides an access to the SEPA Direct Debit compliant messaging systems, offering the simplified (yet fully functional) JSON message format instead of ISO 20022 XMLs.

The JSON API abstracts away most of the low level technical details like message IDs and duplicated reference data. This approach allows to simplify integration and significantly reduce the amount of data being transferred over the wire.

Feature highlights:

Provides a full specter of SEPA Direct Debit scheme functionality offered by the Bank of Lithuania
Comprehensive and straightforward JSON API
Automatic handling of ISO 20022 XML messages (including formation, parsing, signing, etc)
Automatic adjustment of payment settlement date based on TARGET2 business calendar and Bank of Lithuania's SDD cut-off time
Automatic conversion of Unicode characters for outgoing messages according to SEPA requirements

Download AsyncAPI specification

Servers

amqps://sepagateway.live.thefintechlab.com/amqps 0.9.1production
Security:
User/Password
Provide your username and password for SASL/PLAIN
amqp://sepagateway.stage.thefintechlab.com/amqp 0.9.1stage
Security:
User/Password
Provide your username and password for SASL/PLAIN

Operations

SEND outgoing_payments
Message queue to send messages to

Operation IDsendDirectDebit
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
OutgoingDirectDebitMessageoutgoingDirectDebitMessage
Request to initiate an outgoing direct debit payment
application/json
Message IDoutgoingDirectDebitMessage
object
messageType
required
string
Const:"OutgoingDirectDebitMessage"
required
array<object>
1 items
object
Allows to create a new outgoing direct debit payment.

settlementDate
required
string
format: date
Desired settlement date

directDebitUid
required
string
<= 255 characters
Unique identification of the message

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
paymentDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
paymentCode
required
string
[ 1 .. 4 ] characters
Possible values: ACCT

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "OutgoingDirectDebitMessage", "data": [ { "settlementDate": "2019-08-24", "directDebitUid": "string", "msgId": "string", "txId": "string", "sequenceType": "FIRST", "creditorSchemeId": "string", "mandate": { "id": "string", "signatureDate": "2019-08-24", "amendment": true, "amendmentDetails": { "originalId": "string", "originalCreditorSchemeId": "string", "originalPayerAccountSameMandate": true, "originalPayerAccount": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "electronicSignature": "string" }, "amount": { "currency": "EUR", "value": 0.01 }, "paymentDate": "2019-11-21T16:32:59", "debtor": { "person": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "account": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "creditor": { "person": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "account": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "ultimateDebtor": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "ultimateCreditor": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "paymentCode": "stri", "purpose": "string" } ] }

This example has been generated automatically.
SEND outgoing_payments
Message queue to send messages to

Operation IDsendDirectDebitRejection
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
DirectDebitRejectionMessageoutgoingDirectDebitRejectionMessage
Request to initiate an outgoing direct debit payment reject
application/json
Message IDoutgoingDirectDebitRejectionMessage
object
messageType
required
string
Const:"DirectDebitRejectionMessage"
required
array<object>
1 items
object
Allows rejecting previously received incoming payment by the inability to deliver funds to the beneficiary.

directDebitUid
required
string
<= 255 characters
Internal identifier of the incoming payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for rejecting a direct debit payment

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

CLOSED_ACCOUNT -- Closed Account Number

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

INSUFFICIENT_FUND -- Insufficient Funds

DUPLICATION -- Duplication

CREDITOR_BANK_NOT_REGISTERED -- Creditor Bank is not registered under this BIC in the CSM

DEBTOR_BANK_NOT_REGISTERED -- Debtor Bank is not registered under this BIC in the CSM

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

NO_MANDATE -- No valid Mandate

MISSING_MANDATORY_INFORMATION_IN_MANDATE -- Missing Mandatory Information in Mandate

END_CUSTOMER_DECEASED -- End Customer Deceased

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

NOT_SPECIFIED_REASON_AGENT_GENERATED -- Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION -- Missing Debtor Account or Identification (used for regulatory reasons)

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address (used for regulatory reasons)

MISSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address (used for regulatory reasons)

REGULATORY_REASON -- Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT -- Specific Service offered by Debtor Bank

UNRECOGNISED_INITIATING_PARTY -- Unrecognized Initiating Party (Identifier of the Creditor Incorrect)

SETTLEMENT_FAILED -- Settlement failed

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUND"
"DUPLICATION"
"CREDITOR_BANK_NOT_REGISTERED"
"DEBTOR_BANK_NOT_REGISTERED"
"INVALID_MESSAGE"
"NO_MANDATE"
"MISSING_MANDATORY_INFORMATION_IN_MANDATE"
"END_CUSTOMER_DECEASED"
"CUSTOMER_NOT_SPECIFIED_REASON"
"NOT_SPECIFIED_REASON_AGENT_GENERATED"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"UNRECOGNISED_INITIATING_PARTY"
"SETTLEMENT_FAILED"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name. Overrides originatorBic if present

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DirectDebitRejectionMessage", "data": [ { "directDebitUid": "string", "msgId": "string", "txId": "string", "reasonCode": "INCORRECT_ACCOUNT_NUMBER", "originatorBic": "string", "originatorName": "string" } ] }

This example has been generated automatically.
SEND outgoing_payments
Message queue to send messages to

Operation IDsendDirectDebitCancellation
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
OutgoingDirectDebitCancellationMessageoutgoingDirectDebitCancellationMessage
Request to cancel previously sent outgoing direct debit payment
application/json
Message IDoutgoingDirectDebitCancellationMessage
object
messageType
required
string
Const:"OutgoingDirectDebitCancellationMessage"
required
array<object>
1 items
object
Allows to cancel previously sent outgoing payment by client or backend operator request.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
string
<= 255 characters
Optional additional information about the cancellation reason

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "OutgoingDirectDebitCancellationMessage", "data": [ { "directDebitUid": "string", "msgId": "string", "txId": "string", "reasonCode": "FRAUDULENT_TRANSACTION", "additionalInfo": "string" } ] }

This example has been generated automatically.
SEND outgoing_payments
Message queue to send messages to

Operation IDsendDirectDebitReversal
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
OutgoingDirectDebitReversalMessageoutgoingDirectDebitReversalMessage
Request to reverse previously sent outgoing direct debit payment
application/json
Message IDoutgoingDirectDebitReversalMessage
object
messageType
required
string
Const:"OutgoingDirectDebitReversalMessage"
required
array<object>
1 items
object
Allows reversal of a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of the original outgoing direct debit payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "OutgoingDirectDebitReversalMessage", "data": [ { "directDebitUid": "string", "msgId": "string", "txId": "string", "reasonCode": "NOT_SPECIFIED_BY_CUSTOMER" } ] }

This example has been generated automatically.
SEND outgoing_payments
Message queue to send messages to

Operation IDsendDirectDebitReturn
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
OutgoingDirectDebitReturnMessageoutgoingDirectDebitReturnMessage
Request to return previously sent outgoing direct debit payment
application/json
Message IDoutgoingDirectDebitReturnMessage
object
messageType
required
string
Const:"OutgoingDirectDebitReturnMessage"
required
array<object>
1 items
object
Request to return a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for returning an outgoing direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Payment was duplicated

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
additionalInfo
string
Additional information about the return reason

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "OutgoingDirectDebitReturnMessage", "data": [ { "directDebitUid": "string", "msgId": "string", "txId": "string", "reasonCode": "NOT_SPECIFIED_BY_CUSTOMER", "additionalInfo": "string" } ] }

This example has been generated automatically.
RECEIVE incoming_payments
Message queue to receive messages from

Operation IDlistenDirectDebit
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
Direct debit received paymentdirectDebitReceivedMessage
Payment received via direct debit enables the possibility of refunding a previously sent outgoing payment.
application/json
Message IDdirectDebitReceivedMessage
object
messageType
required
string
Type of the message. Only 'DirectDebitReceivedMessage' is allowed.

Const:"DirectDebitReceivedMessage"
required
array<object>
1 items
Information about incoming direct debit payment

object
Payment received via direct debit enables the possibility of refunding a previously sent outgoing payment upon request from the client or backend operator.

directDebitUid
required
string
<= 255 characters
Unique identification of the message.

directDebitTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
settlementDate
required
string
format: date
Settlement date.

dueDate
required
string
format: date
The original Requested Collection Date.

required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
msgId
required
string
Message identifier.

txId
required
string
Transaction identifier.

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information.

paymentCode
required
string
[ 1 .. 4 ] characters
Payment code. Possible values: ACCT.

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person.

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DirectDebitReceivedMessage", "data": [ { "directDebitUid": "string", "directDebitTimestamp": "2019-11-21T16:32:59", "settlementDate": "2019-08-24", "dueDate": "2019-08-24", "amount": { "currency": "EUR", "value": 0.01 }, "msgId": "string", "txId": "string", "purpose": "string", "paymentCode": "stri", "sequenceType": "FIRST", "creditorSchemeId": "string", "mandate": { "id": "string", "signatureDate": "2019-08-24", "amendment": true, "amendmentDetails": { "originalId": "string", "originalCreditorSchemeId": "string", "originalPayerAccountSameMandate": true, "originalPayerAccount": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "electronicSignature": "string" }, "debtor": { "person": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "account": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "creditor": { "person": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "account": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "ultimateDebtor": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "ultimateCreditor": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" } } ] }

This example has been generated automatically.
RECEIVE incoming_payments
Message queue to receive messages from

Operation IDlistenDirectDebitSettled
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
Direct Debit Settled MessagedirectDebitSettledMessage
Settled message received. Allows to retrieve information about previously sent messages.
application/json
Message IDdirectDebitSettledMessage
object
messageType
required
string
Only “DirectDebitSettledMessage” is allowed. Type of the message.

Const:"DirectDebitSettledMessage"
required
array<object>
1 items
List of settled messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
msgId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DirectDebitSettledMessage", "data": [ { "directDebitUid": "string", "directDebitType": "OUTGOING_DIRECT_DEBIT", "msgId": "string", "txId": "string" } ] }

This example has been generated automatically.
RECEIVE incoming_payments
Message queue to receive messages from

Operation IDlistenDirectDebitCancelled
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
Direct Debit Cancelled MessagedirectDebitCancelledMessage
Direct debit canceled message. Allows to retrieve information about canceled direct debit message.
application/json
Message IDdirectDebitCancelledMessage
object
messageType
required
string
Only “DirectDebitCancelledMessage” is allowed. Type of the message.

Const:"DirectDebitCancelledMessage"
required
array<object>
1 items
List of canceled direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
required
string
Additional info

originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

cancellationId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the cancellation message

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DirectDebitCancelledMessage", "data": [ { "directDebitUid": "string", "reasonCode": "FRAUDULENT_TRANSACTION", "additionalInfo": "string", "originalMsgId": "string", "originalTxId": "string", "cancellationId": "string" } ] }

This example has been generated automatically.
RECEIVE incoming_payments
Message queue to receive messages from

Operation IDlistenDirectDebitReturned
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
Direct Debit Returned MessagedirectDebitReturnedMessage
Direct debit returned message. Allows to retrieve information about the returned direct debit message.
application/json
Message IDdirectDebitReturnedMessage
object
messageType
required
string
Only “DirectDebitReturnedMessage” is allowed. Type of the message.

Const:"DirectDebitReturnedMessage"
required
array<object>
1 items
List of returned direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for returning a direct debit payment

INCORRECT_ACCOUNT_NUMBER – Incorrect Account Number

CLOSED_ACCOUNT – Closed Account Number

BLOCKED_ACCOUNT – Blocked Account

TRANSACTION_FORBIDDEN – Transaction Forbidden

INVALID_BANK_OPERATION_CODE – Invalid Bank Operation Code

INSUFFICIENT_FUNDS – Insufficient Funds

DUPLICATE – Duplication

UNAUTHORIZED_TRANSACTION – Unauthorized Transaction

REQUESTED_BY_END_CUSTOMER – Disputed authorized transaction (Only for Refunds)

DECEASED_CUSTOMER – End Customer Deceased

BY_ORDER_OF_THE_BENEFICIARY – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT – Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION – Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS – Missing Debtor Name or Address

MISSING_CREDITOR_NAME_OR_ADDRESS – Missing Creditor Name or Address

REGULATORY_REASON – Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT – Specific Service offered by Debtor Bank

NOT_RECOGNISED_BY_END_CUSTOMER – Unrecognized Initiating Party (Creditor Identifier Incorrect)

UNKNOWN – Not supported return code

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUNDS"
"DUPLICATE"
"UNAUTHORIZED_TRANSACTION"
"REQUESTED_BY_END_CUSTOMER"
"DECEASED_CUSTOMER"
"BY_ORDER_OF_THE_BENEFICIARY"
"NOT_SPECIFIED_BY_AGENT"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"NOT_RECOGNISED_BY_END_CUSTOMER"
"UNKNOWN"
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
compensation
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DirectDebitReturnedMessage", "data": [ { "directDebitUid": "string", "reasonCode": "INCORRECT_ACCOUNT_NUMBER", "amount": 0.01, "charges": { "amount": 0.01, "institutionBic": "string" }, "compensation": 0.01, "msgId": "string", "txId": "string" } ] }

This example has been generated automatically.
RECEIVE incoming_payments
Message queue to receive messages from

Operation IDlistenDirectDebitReversed
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
Direct Debit Reversed MessagedirectDebitReversedMessage
Direct debit reversed message. Allows to retrieve information about the reversed direct debit message.
application/json
Message IDdirectDebitReversedMessage
object
messageType
required
string
Only “DirectDebitReversedMessage” is allowed. Type of the message.

Const:"DirectDebitReversedMessage"
required
array<object>
1 items
List of reversed direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
required
object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

reversalId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the reversal transaction

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DirectDebitReversedMessage", "data": [ { "directDebitUid": "string", "reasonCode": "NOT_SPECIFIED_BY_CUSTOMER", "charges": { "amount": 0.01, "institutionBic": "string" }, "originalMsgId": "string", "originalTxId": "string", "reversalId": "string" } ] }

This example has been generated automatically.

Messages

#1OutgoingDirectDebitMessageoutgoingDirectDebitMessage
Request to initiate an outgoing direct debit payment
- application/json
Message IDoutgoingDirectDebitMessage
object
messageType
required
string
Const:"OutgoingDirectDebitMessage"
required
array<object>
1 items
object
Allows to create a new outgoing direct debit payment.

settlementDate
required
string
format: date
Desired settlement date

directDebitUid
required
string
<= 255 characters
Unique identification of the message

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
paymentDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
paymentCode
required
string
[ 1 .. 4 ] characters
Possible values: ACCT

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information

Additional properties are allowed.
Additional properties are allowed.
#2DirectDebitRejectionMessageoutgoingDirectDebitRejectionMessage
Request to initiate an outgoing direct debit payment reject
- application/json
Message IDoutgoingDirectDebitRejectionMessage
object
messageType
required
string
Const:"DirectDebitRejectionMessage"
required
array<object>
1 items
object
Allows rejecting previously received incoming payment by the inability to deliver funds to the beneficiary.

directDebitUid
required
string
<= 255 characters
Internal identifier of the incoming payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for rejecting a direct debit payment

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

CLOSED_ACCOUNT -- Closed Account Number

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

INSUFFICIENT_FUND -- Insufficient Funds

DUPLICATION -- Duplication

CREDITOR_BANK_NOT_REGISTERED -- Creditor Bank is not registered under this BIC in the CSM

DEBTOR_BANK_NOT_REGISTERED -- Debtor Bank is not registered under this BIC in the CSM

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

NO_MANDATE -- No valid Mandate

MISSING_MANDATORY_INFORMATION_IN_MANDATE -- Missing Mandatory Information in Mandate

END_CUSTOMER_DECEASED -- End Customer Deceased

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

NOT_SPECIFIED_REASON_AGENT_GENERATED -- Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION -- Missing Debtor Account or Identification (used for regulatory reasons)

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address (used for regulatory reasons)

MISSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address (used for regulatory reasons)

REGULATORY_REASON -- Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT -- Specific Service offered by Debtor Bank

UNRECOGNISED_INITIATING_PARTY -- Unrecognized Initiating Party (Identifier of the Creditor Incorrect)

SETTLEMENT_FAILED -- Settlement failed

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUND"
"DUPLICATION"
"CREDITOR_BANK_NOT_REGISTERED"
"DEBTOR_BANK_NOT_REGISTERED"
"INVALID_MESSAGE"
"NO_MANDATE"
"MISSING_MANDATORY_INFORMATION_IN_MANDATE"
"END_CUSTOMER_DECEASED"
"CUSTOMER_NOT_SPECIFIED_REASON"
"NOT_SPECIFIED_REASON_AGENT_GENERATED"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"UNRECOGNISED_INITIATING_PARTY"
"SETTLEMENT_FAILED"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name. Overrides originatorBic if present

Additional properties are allowed.
Additional properties are allowed.
#3OutgoingDirectDebitCancellationMessageoutgoingDirectDebitCancellationMessage
Request to cancel previously sent outgoing direct debit payment
- application/json
Message IDoutgoingDirectDebitCancellationMessage
object
messageType
required
string
Const:"OutgoingDirectDebitCancellationMessage"
required
array<object>
1 items
object
Allows to cancel previously sent outgoing payment by client or backend operator request.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
string
<= 255 characters
Optional additional information about the cancellation reason

Additional properties are allowed.
Additional properties are allowed.
#4OutgoingDirectDebitReversalMessageoutgoingDirectDebitReversalMessage
Request to reverse previously sent outgoing direct debit payment
- application/json
Message IDoutgoingDirectDebitReversalMessage
object
messageType
required
string
Const:"OutgoingDirectDebitReversalMessage"
required
array<object>
1 items
object
Allows reversal of a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of the original outgoing direct debit payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
Additional properties are allowed.
Additional properties are allowed.
#5OutgoingDirectDebitReturnMessageoutgoingDirectDebitReturnMessage
Request to return previously sent outgoing direct debit payment
- application/json
Message IDoutgoingDirectDebitReturnMessage
object
messageType
required
string
Const:"OutgoingDirectDebitReturnMessage"
required
array<object>
1 items
object
Request to return a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for returning an outgoing direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Payment was duplicated

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
additionalInfo
string
Additional information about the return reason

Additional properties are allowed.
Additional properties are allowed.
#6Direct debit received paymentdirectDebitReceivedMessage
Payment received via direct debit enables the possibility of refunding a previously sent outgoing payment.
- application/json
Message IDdirectDebitReceivedMessage
object
messageType
required
string
Type of the message. Only 'DirectDebitReceivedMessage' is allowed.

Const:"DirectDebitReceivedMessage"
required
array<object>
1 items
Information about incoming direct debit payment

object
Payment received via direct debit enables the possibility of refunding a previously sent outgoing payment upon request from the client or backend operator.

directDebitUid
required
string
<= 255 characters
Unique identification of the message.

directDebitTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
settlementDate
required
string
format: date
Settlement date.

dueDate
required
string
format: date
The original Requested Collection Date.

required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
msgId
required
string
Message identifier.

txId
required
string
Transaction identifier.

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information.

paymentCode
required
string
[ 1 .. 4 ] characters
Payment code. Possible values: ACCT.

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person.

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#7Direct Debit Settled MessagedirectDebitSettledMessage
Settled message received. Allows to retrieve information about previously sent messages.
- application/json
Message IDdirectDebitSettledMessage
object
messageType
required
string
Only “DirectDebitSettledMessage” is allowed. Type of the message.

Const:"DirectDebitSettledMessage"
required
array<object>
1 items
List of settled messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
msgId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
#8Direct Debit Rejected MessagedirectDebitRejectedMessage
Direct debit rejected message. Allows to retrieve information about rejected direct debit message.
- application/json
Message IDdirectDebitRejectedMessage
object
messageType
required
string
Only “DirectDebitRejectedMessage” is allowed. Type of the message.

Const:"DirectDebitRejectedMessage"
required
array<object>
1 items
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
rejectionReason
required
string
Reason for rejecting a direct debit instruction

TRANSACTION_COUNT_MISMATCH -- Number of transactions mismatch

AMOUNT_SUM_MISMATCH -- Total amount mismatch

INSTRUCTING_AGENT_AND_SENDER_MISMATCH -- Instructing Agent mismatch

INSTRUCTED_AGENT_IN_GROUP_HEADER -- Invalid use of Instructed Agent

INVALID_ASSIGNER_OR_ASSIGNEE -- Invalid Use of Assgnr/Assgnee

DUPLICATE_MSGID -- Duplicate MessageID

INVALID_SETTLEMENT_DATE_RANGE -- Invalid Settlement Date

REJECTED_DUE_REJECTED_TRANSACTION -- All transactions rejected

INVALID_SETTLEMENT_INFO_DETAILS -- Invalid Settlement Info details

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

MISSING_DEBTOR_NAME_ADDRESS -- Missing debtor address name

MISSING_CREDITOR_NAME_ADDRESS -- Missing creditor address name

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement Failed

INVALID_IBAN -- Invalid IBAN format (ISO 13616 failure)

UNSUPPORTED_XML_FIELD -- Unsupported XML field or missing mandatory field

INVALID_DATA_FORMAT -- At least one XML element is in the wrong format

INVALID_COUNTRY_CODE -- Invalid ISO3166 country code

INVALID_ORIGINAL_TRANSACTION_STATUS -- Action required for original transaction status

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- No action required for invalid original status

ORIGINAL_AMOUNT_MISMATCH -- Interbank Settlement Amount differs from original debit

ONLY_SEPA_FIELDS_ALLOWED -- Non-SEPA field used without prior agreement

SETTLEMENT_CYCLE_NOT_AVAILABLE -- Invalid Settlement Cycle

EXPIRED_CANCELLATION_TIME_LIMIT -- Time limit for cancellation expired

AGENT_MISMATCH_TO_ORIGINAL -- Sending agent differs from original transaction agent

INVALID_TECH_BIC -- Invalid use of Technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- BIC not allowed in SEPACOM CUG

SENDER_SUSPENDED -- Sender suspended

RECEIVER_SUSPENDED -- Receiver suspended

SEPA_SYNTAX_ERROR -- SEPA syntax error

SEPA_AUTHENTICATION_ERROR -- SEPA authentication error

SEPA_CONTEXT_ERROR -- SEPA context error

CANCELLED_BEFORE_CLEARING -- Cancelled before clearing

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

REASON_NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

INCORRECT_BIX -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID -- Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address

MISSSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address

REGULATORY_REASON -- Regulatory Reason

TIMEOUT_CREDITOR_AGENT -- Timeout creditor agent

TIMEOUT_INSTRUCTED_AGENT -- Timeout instructed agent

OFFLINE_AGENT -- Offline agent

ERROR_CREDITOR_AGENT -- Error creditor agent

CLOSED_ACCOUNT_NUMBER -- Closed Account Number

ERROR_INSTRUCTED_AGENT -- Error instructed agent

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

PAYMENT_NOT_RECEIVED -- Payment not received

AGENT_SUSPENDED -- Agent suspended

CREDITOR_AGENT_SUSPENDED -- Creditor agent suspended

AMOUNT_EXCEEDS_SETTLEMENT_LIMIT -- Amount exceeds settlement limit

MISSING_CREDITOR_ADDRESS -- Missing creditor address

END_CUSTOMER_DECEASED -- End Customer Deceased

DEBTOR_BANK_NOT_REGISTERED -- Debtor bank not registered

REASON_NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

CREDITOR_BANK_NOT_REGISTERED -- Creditor bank not registered under this BIC

CREDIT_AGENT_TIMEOUT -- Credit agent timeout

INSTRUCTING_AGENT_TIMEOUT -- Instructing agent timeout

INSTRUCTING_AGENT_UNAVAILABLE -- Instructing agent unavailable

CREDIT_AGENT_UNAVAILABLE -- Credit agent unavailable

CREDIT_AGENT_PROCESS_ERROR -- Credit agent process error

INSTRUCTING_AGENT_PROCESS_ERROR -- Instructing agent process error

INCORRECT_IBAN -- Incorrect IBAN

CLOSED_ACCOUNT -- Account closed

ORIGINAL_PAYMENT_NOT_RECEIVED -- Original payment not received

INSTRUCTING_AGENT_SUSPENDED -- Instructing agent suspended

CREDIT_AGENT_SUSPENDED -- Credit agent suspended

INSUFFICIENT_FUND -- Insufficient funds

WRONG_AMOUNT -- Wrong amount

AMOUNT_EXCEEDS_LIMIT -- Amount exceeds limit

ALREADY_RETURNED_TRANSACTION -- Already returned transaction

REQUESTED_BY_CUSTOMER -- Cancellation requested by the debtor

DUPLICATE_PAYMENT -- Duplicate Payment

FOLLOWING_CANCELLATION_REQUEST -- Following cancellation request

FRAUDULENT_TRANSACTION -- Fraudulent Originated Direct Debit

LEGAL_DECISION -- Legal decision

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

AGENT_NOT_SPECIFIED_REASON -- Not Specified Reason Agent Generated

NO_ANSWER_FROM_CUSTOMER -- No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED -- Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION -- Bank Identifier Incorrect

TECHNICAL_ERROR -- Technical problems resulting in erroneous SDDs

CUT_OFF_TIME -- Cut-off time

INSUFFICIENT_LIQUIDITY -- Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME -- Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP -- Debtor Agent not allowed to receive DD

CREDIT_AGENT_NOT_ALLOWED_SEND_IP -- Creditor Agent not allowed to send DD

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED -- Participant product usage not allowed

BULK_TOTALLY_ACCEPTED -- Bulk totally accepted

BULK_PARTIALLY_ACCEPTED -- Bulk partially accepted

MAXIMUM_NUMBER_BULKS_EXCEEDED -- Maximum number of bulks in a file exceeded

MANY_CONSECUTIVE_REJECTED_TRANSACTIONS -- Too many consecutive rejected transactions

INVALID_ORIGINATOR -- Invalid Originator

BULK_CANCELLATION_REJECTED -- DPWS Bulk Cancellation Rejected

UNAUTHORIZED_TRANSACTION -- Unauthorized Transaction

MISSING_MANDATORY_INFORMATION_MANDATE -- Missing Mandatory Information Mandate

SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK -- Specific Service offered by Debtor Bank

UNRECOGNIZED_INITIATING_PARTY -- Unrecognized Initiating Party

Allowed values:
"TRANSACTION_COUNT_MISMATCH"
"AMOUNT_SUM_MISMATCH"
"INSTRUCTING_AGENT_AND_SENDER_MISMATCH"
"INSTRUCTED_AGENT_IN_GROUP_HEADER"
"INVALID_ASSIGNER_OR_ASSIGNEE"
"DUPLICATE_MSGID"
"INVALID_SETTLEMENT_DATE_RANGE"
"REJECTED_DUE_REJECTED_TRANSACTION"
"INVALID_SETTLEMENT_INFO_DETAILS"
"INVALID_MESSAGE"
"MISSING_DEBTOR_NAME_ADDRESS"
"MISSING_CREDITOR_NAME_ADDRESS"
"DUPLICATION"
"SETTLEMENT_FAILED"
"INVALID_IBAN"
"UNSUPPORTED_XML_FIELD"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"ONLY_SEPA_FIELDS_ALLOWED"
"SETTLEMENT_CYCLE_NOT_AVAILABLE"
"EXPIRED_CANCELLATION_TIME_LIMIT"
"AGENT_MISMATCH_TO_ORIGINAL"
"INVALID_TECH_BIC"
"INVALID_CREDITOR_DEBTOR_BIC_COMBINATION"
"SENDER_SUSPENDED"
"RECEIVER_SUSPENDED"
"SEPA_SYNTAX_ERROR"
"SEPA_AUTHENTICATION_ERROR"
"SEPA_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
"INCORRECT_ACCOUNT_NUMBER"
"INVALID_BANK_OPERATION_CODE"
"REASON_NOT_SPECIFIED_BY_AGENT"
"INCORRECT_BIX"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TIMEOUT_CREDITOR_AGENT"
"TIMEOUT_INSTRUCTED_AGENT"
"OFFLINE_AGENT"
"ERROR_CREDITOR_AGENT"
"CLOSED_ACCOUNT_NUMBER"
"ERROR_INSTRUCTED_AGENT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"PAYMENT_NOT_RECEIVED"
"AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"AMOUNT_EXCEEDS_SETTLEMENT_LIMIT"
"MISSING_CREDITOR_ADDRESS"
"END_CUSTOMER_DECEASED"
"DEBTOR_BANK_NOT_REGISTERED"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"CREDITOR_BANK_NOT_REGISTERED"
"CREDIT_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_UNAVAILABLE"
"CREDIT_AGENT_UNAVAILABLE"
"CREDIT_AGENT_PROCESS_ERROR"
"INSTRUCTING_AGENT_PROCESS_ERROR"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDIT_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"BULK_TOTALLY_ACCEPTED"
"BULK_PARTIALLY_ACCEPTED"
"MAXIMUM_NUMBER_BULKS_EXCEEDED"
"MANY_CONSECUTIVE_REJECTED_TRANSACTIONS"
"INVALID_ORIGINATOR"
"BULK_CANCELLATION_REJECTED"
"UNAUTHORIZED_TRANSACTION"
"MISSING_MANDATORY_INFORMATION_MANDATE"
"SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK"
"UNRECOGNIZED_INITIATING_PARTY"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
#9Direct Debit Cancelled MessagedirectDebitCancelledMessage
Direct debit canceled message. Allows to retrieve information about canceled direct debit message.
- application/json
Message IDdirectDebitCancelledMessage
object
messageType
required
string
Only “DirectDebitCancelledMessage” is allowed. Type of the message.

Const:"DirectDebitCancelledMessage"
required
array<object>
1 items
List of canceled direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
required
string
Additional info

originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

cancellationId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the cancellation message

Additional properties are allowed.
Additional properties are allowed.
#10Direct Debit Returned MessagedirectDebitReturnedMessage
Direct debit returned message. Allows to retrieve information about the returned direct debit message.
- application/json
Message IDdirectDebitReturnedMessage
object
messageType
required
string
Only “DirectDebitReturnedMessage” is allowed. Type of the message.

Const:"DirectDebitReturnedMessage"
required
array<object>
1 items
List of returned direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for returning a direct debit payment

INCORRECT_ACCOUNT_NUMBER – Incorrect Account Number

CLOSED_ACCOUNT – Closed Account Number

BLOCKED_ACCOUNT – Blocked Account

TRANSACTION_FORBIDDEN – Transaction Forbidden

INVALID_BANK_OPERATION_CODE – Invalid Bank Operation Code

INSUFFICIENT_FUNDS – Insufficient Funds

DUPLICATE – Duplication

UNAUTHORIZED_TRANSACTION – Unauthorized Transaction

REQUESTED_BY_END_CUSTOMER – Disputed authorized transaction (Only for Refunds)

DECEASED_CUSTOMER – End Customer Deceased

BY_ORDER_OF_THE_BENEFICIARY – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT – Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION – Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS – Missing Debtor Name or Address

MISSING_CREDITOR_NAME_OR_ADDRESS – Missing Creditor Name or Address

REGULATORY_REASON – Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT – Specific Service offered by Debtor Bank

NOT_RECOGNISED_BY_END_CUSTOMER – Unrecognized Initiating Party (Creditor Identifier Incorrect)

UNKNOWN – Not supported return code

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUNDS"
"DUPLICATE"
"UNAUTHORIZED_TRANSACTION"
"REQUESTED_BY_END_CUSTOMER"
"DECEASED_CUSTOMER"
"BY_ORDER_OF_THE_BENEFICIARY"
"NOT_SPECIFIED_BY_AGENT"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"NOT_RECOGNISED_BY_END_CUSTOMER"
"UNKNOWN"
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
compensation
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
#11Direct Debit Reversed MessagedirectDebitReversedMessage
Direct debit reversed message. Allows to retrieve information about the reversed direct debit message.
- application/json
Message IDdirectDebitReversedMessage
object
messageType
required
string
Only “DirectDebitReversedMessage” is allowed. Type of the message.

Const:"DirectDebitReversedMessage"
required
array<object>
1 items
List of reversed direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
required
object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

reversalId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the reversal transaction

Additional properties are allowed.
Additional properties are allowed.
#12InvalidPaymentMessageinvalidPaymentMessage
Contains details of outgoing payment validation errors
- application/json
Message IDinvalidPaymentMessage
object
messageType
required
string
Const:"InvalidPayment"
required
array<object>
non-empty
object
internalId
required
string
<= 255 characters
Unique internal identifier of the payment

additionalInfo
required
string
Description of validation error(s)

Additional properties are allowed.
Additional properties are allowed.

Schemas

bic
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
iban
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
localDateTime
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
currency
string
must match: [A-Z]{3,3}
Currency code (ISO 4217)

Examples values:
"EUR"
"USD"
countryCode
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
monetaryAmount
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
directDebitRejectionReason
string
Reason for rejecting a direct debit instruction

TRANSACTION_COUNT_MISMATCH -- Number of transactions mismatch

AMOUNT_SUM_MISMATCH -- Total amount mismatch

INSTRUCTING_AGENT_AND_SENDER_MISMATCH -- Instructing Agent mismatch

INSTRUCTED_AGENT_IN_GROUP_HEADER -- Invalid use of Instructed Agent

INVALID_ASSIGNER_OR_ASSIGNEE -- Invalid Use of Assgnr/Assgnee

DUPLICATE_MSGID -- Duplicate MessageID

INVALID_SETTLEMENT_DATE_RANGE -- Invalid Settlement Date

REJECTED_DUE_REJECTED_TRANSACTION -- All transactions rejected

INVALID_SETTLEMENT_INFO_DETAILS -- Invalid Settlement Info details

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

MISSING_DEBTOR_NAME_ADDRESS -- Missing debtor address name

MISSING_CREDITOR_NAME_ADDRESS -- Missing creditor address name

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement Failed

INVALID_IBAN -- Invalid IBAN format (ISO 13616 failure)

UNSUPPORTED_XML_FIELD -- Unsupported XML field or missing mandatory field

INVALID_DATA_FORMAT -- At least one XML element is in the wrong format

INVALID_COUNTRY_CODE -- Invalid ISO3166 country code

INVALID_ORIGINAL_TRANSACTION_STATUS -- Action required for original transaction status

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- No action required for invalid original status

ORIGINAL_AMOUNT_MISMATCH -- Interbank Settlement Amount differs from original debit

ONLY_SEPA_FIELDS_ALLOWED -- Non-SEPA field used without prior agreement

SETTLEMENT_CYCLE_NOT_AVAILABLE -- Invalid Settlement Cycle

EXPIRED_CANCELLATION_TIME_LIMIT -- Time limit for cancellation expired

AGENT_MISMATCH_TO_ORIGINAL -- Sending agent differs from original transaction agent

INVALID_TECH_BIC -- Invalid use of Technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- BIC not allowed in SEPACOM CUG

SENDER_SUSPENDED -- Sender suspended

RECEIVER_SUSPENDED -- Receiver suspended

SEPA_SYNTAX_ERROR -- SEPA syntax error

SEPA_AUTHENTICATION_ERROR -- SEPA authentication error

SEPA_CONTEXT_ERROR -- SEPA context error

CANCELLED_BEFORE_CLEARING -- Cancelled before clearing

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

REASON_NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

INCORRECT_BIX -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID -- Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address

MISSSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address

REGULATORY_REASON -- Regulatory Reason

TIMEOUT_CREDITOR_AGENT -- Timeout creditor agent

TIMEOUT_INSTRUCTED_AGENT -- Timeout instructed agent

OFFLINE_AGENT -- Offline agent

ERROR_CREDITOR_AGENT -- Error creditor agent

CLOSED_ACCOUNT_NUMBER -- Closed Account Number

ERROR_INSTRUCTED_AGENT -- Error instructed agent

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

PAYMENT_NOT_RECEIVED -- Payment not received

AGENT_SUSPENDED -- Agent suspended

CREDITOR_AGENT_SUSPENDED -- Creditor agent suspended

AMOUNT_EXCEEDS_SETTLEMENT_LIMIT -- Amount exceeds settlement limit

MISSING_CREDITOR_ADDRESS -- Missing creditor address

END_CUSTOMER_DECEASED -- End Customer Deceased

DEBTOR_BANK_NOT_REGISTERED -- Debtor bank not registered

REASON_NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

CREDITOR_BANK_NOT_REGISTERED -- Creditor bank not registered under this BIC

CREDIT_AGENT_TIMEOUT -- Credit agent timeout

INSTRUCTING_AGENT_TIMEOUT -- Instructing agent timeout

INSTRUCTING_AGENT_UNAVAILABLE -- Instructing agent unavailable

CREDIT_AGENT_UNAVAILABLE -- Credit agent unavailable

CREDIT_AGENT_PROCESS_ERROR -- Credit agent process error

INSTRUCTING_AGENT_PROCESS_ERROR -- Instructing agent process error

INCORRECT_IBAN -- Incorrect IBAN

CLOSED_ACCOUNT -- Account closed

ORIGINAL_PAYMENT_NOT_RECEIVED -- Original payment not received

INSTRUCTING_AGENT_SUSPENDED -- Instructing agent suspended

CREDIT_AGENT_SUSPENDED -- Credit agent suspended

INSUFFICIENT_FUND -- Insufficient funds

WRONG_AMOUNT -- Wrong amount

AMOUNT_EXCEEDS_LIMIT -- Amount exceeds limit

ALREADY_RETURNED_TRANSACTION -- Already returned transaction

REQUESTED_BY_CUSTOMER -- Cancellation requested by the debtor

DUPLICATE_PAYMENT -- Duplicate Payment

FOLLOWING_CANCELLATION_REQUEST -- Following cancellation request

FRAUDULENT_TRANSACTION -- Fraudulent Originated Direct Debit

LEGAL_DECISION -- Legal decision

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

AGENT_NOT_SPECIFIED_REASON -- Not Specified Reason Agent Generated

NO_ANSWER_FROM_CUSTOMER -- No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED -- Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION -- Bank Identifier Incorrect

TECHNICAL_ERROR -- Technical problems resulting in erroneous SDDs

CUT_OFF_TIME -- Cut-off time

INSUFFICIENT_LIQUIDITY -- Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME -- Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP -- Debtor Agent not allowed to receive DD

CREDIT_AGENT_NOT_ALLOWED_SEND_IP -- Creditor Agent not allowed to send DD

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED -- Participant product usage not allowed

BULK_TOTALLY_ACCEPTED -- Bulk totally accepted

BULK_PARTIALLY_ACCEPTED -- Bulk partially accepted

MAXIMUM_NUMBER_BULKS_EXCEEDED -- Maximum number of bulks in a file exceeded

MANY_CONSECUTIVE_REJECTED_TRANSACTIONS -- Too many consecutive rejected transactions

INVALID_ORIGINATOR -- Invalid Originator

BULK_CANCELLATION_REJECTED -- DPWS Bulk Cancellation Rejected

UNAUTHORIZED_TRANSACTION -- Unauthorized Transaction

MISSING_MANDATORY_INFORMATION_MANDATE -- Missing Mandatory Information Mandate

SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK -- Specific Service offered by Debtor Bank

UNRECOGNIZED_INITIATING_PARTY -- Unrecognized Initiating Party

Allowed values:
"TRANSACTION_COUNT_MISMATCH"
"AMOUNT_SUM_MISMATCH"
"INSTRUCTING_AGENT_AND_SENDER_MISMATCH"
"INSTRUCTED_AGENT_IN_GROUP_HEADER"
"INVALID_ASSIGNER_OR_ASSIGNEE"
"DUPLICATE_MSGID"
"INVALID_SETTLEMENT_DATE_RANGE"
"REJECTED_DUE_REJECTED_TRANSACTION"
"INVALID_SETTLEMENT_INFO_DETAILS"
"INVALID_MESSAGE"
"MISSING_DEBTOR_NAME_ADDRESS"
"MISSING_CREDITOR_NAME_ADDRESS"
"DUPLICATION"
"SETTLEMENT_FAILED"
"INVALID_IBAN"
"UNSUPPORTED_XML_FIELD"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"ONLY_SEPA_FIELDS_ALLOWED"
"SETTLEMENT_CYCLE_NOT_AVAILABLE"
"EXPIRED_CANCELLATION_TIME_LIMIT"
"AGENT_MISMATCH_TO_ORIGINAL"
"INVALID_TECH_BIC"
"INVALID_CREDITOR_DEBTOR_BIC_COMBINATION"
"SENDER_SUSPENDED"
"RECEIVER_SUSPENDED"
"SEPA_SYNTAX_ERROR"
"SEPA_AUTHENTICATION_ERROR"
"SEPA_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
"INCORRECT_ACCOUNT_NUMBER"
"INVALID_BANK_OPERATION_CODE"
"REASON_NOT_SPECIFIED_BY_AGENT"
"INCORRECT_BIX"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TIMEOUT_CREDITOR_AGENT"
"TIMEOUT_INSTRUCTED_AGENT"
"OFFLINE_AGENT"
"ERROR_CREDITOR_AGENT"
"CLOSED_ACCOUNT_NUMBER"
"ERROR_INSTRUCTED_AGENT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"PAYMENT_NOT_RECEIVED"
"AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"AMOUNT_EXCEEDS_SETTLEMENT_LIMIT"
"MISSING_CREDITOR_ADDRESS"
"END_CUSTOMER_DECEASED"
"DEBTOR_BANK_NOT_REGISTERED"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"CREDITOR_BANK_NOT_REGISTERED"
"CREDIT_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_UNAVAILABLE"
"CREDIT_AGENT_UNAVAILABLE"
"CREDIT_AGENT_PROCESS_ERROR"
"INSTRUCTING_AGENT_PROCESS_ERROR"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDIT_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"BULK_TOTALLY_ACCEPTED"
"BULK_PARTIALLY_ACCEPTED"
"MAXIMUM_NUMBER_BULKS_EXCEEDED"
"MANY_CONSECUTIVE_REJECTED_TRANSACTIONS"
"INVALID_ORIGINATOR"
"BULK_CANCELLATION_REJECTED"
"UNAUTHORIZED_TRANSACTION"
"MISSING_MANDATORY_INFORMATION_MANDATE"
"SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK"
"UNRECOGNIZED_INITIATING_PARTY"
object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
paymentRejectionReason
string
Reason for rejecting a direct debit payment

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

CLOSED_ACCOUNT -- Closed Account Number

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

INSUFFICIENT_FUND -- Insufficient Funds

DUPLICATION -- Duplication

CREDITOR_BANK_NOT_REGISTERED -- Creditor Bank is not registered under this BIC in the CSM

DEBTOR_BANK_NOT_REGISTERED -- Debtor Bank is not registered under this BIC in the CSM

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

NO_MANDATE -- No valid Mandate

MISSING_MANDATORY_INFORMATION_IN_MANDATE -- Missing Mandatory Information in Mandate

END_CUSTOMER_DECEASED -- End Customer Deceased

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

NOT_SPECIFIED_REASON_AGENT_GENERATED -- Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION -- Missing Debtor Account or Identification (used for regulatory reasons)

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address (used for regulatory reasons)

MISSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address (used for regulatory reasons)

REGULATORY_REASON -- Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT -- Specific Service offered by Debtor Bank

UNRECOGNISED_INITIATING_PARTY -- Unrecognized Initiating Party (Identifier of the Creditor Incorrect)

SETTLEMENT_FAILED -- Settlement failed

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUND"
"DUPLICATION"
"CREDITOR_BANK_NOT_REGISTERED"
"DEBTOR_BANK_NOT_REGISTERED"
"INVALID_MESSAGE"
"NO_MANDATE"
"MISSING_MANDATORY_INFORMATION_IN_MANDATE"
"END_CUSTOMER_DECEASED"
"CUSTOMER_NOT_SPECIFIED_REASON"
"NOT_SPECIFIED_REASON_AGENT_GENERATED"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"UNRECOGNISED_INITIATING_PARTY"
"SETTLEMENT_FAILED"
directDebitReturnedReason
string
Reason for returning a direct debit payment

INCORRECT_ACCOUNT_NUMBER – Incorrect Account Number

CLOSED_ACCOUNT – Closed Account Number

BLOCKED_ACCOUNT – Blocked Account

TRANSACTION_FORBIDDEN – Transaction Forbidden

INVALID_BANK_OPERATION_CODE – Invalid Bank Operation Code

INSUFFICIENT_FUNDS – Insufficient Funds

DUPLICATE – Duplication

UNAUTHORIZED_TRANSACTION – Unauthorized Transaction

REQUESTED_BY_END_CUSTOMER – Disputed authorized transaction (Only for Refunds)

DECEASED_CUSTOMER – End Customer Deceased

BY_ORDER_OF_THE_BENEFICIARY – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT – Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION – Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS – Missing Debtor Name or Address

MISSING_CREDITOR_NAME_OR_ADDRESS – Missing Creditor Name or Address

REGULATORY_REASON – Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT – Specific Service offered by Debtor Bank

NOT_RECOGNISED_BY_END_CUSTOMER – Unrecognized Initiating Party (Creditor Identifier Incorrect)

UNKNOWN – Not supported return code

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUNDS"
"DUPLICATE"
"UNAUTHORIZED_TRANSACTION"
"REQUESTED_BY_END_CUSTOMER"
"DECEASED_CUSTOMER"
"BY_ORDER_OF_THE_BENEFICIARY"
"NOT_SPECIFIED_BY_AGENT"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"NOT_RECOGNISED_BY_END_CUSTOMER"
"UNKNOWN"
object
messageType
required
string
Const:"OutgoingDirectDebitMessage"
required
array<object>
1 items
object
Allows to create a new outgoing direct debit payment.

settlementDate
required
string
format: date
Desired settlement date

directDebitUid
required
string
<= 255 characters
Unique identification of the message

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
paymentDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
paymentCode
required
string
[ 1 .. 4 ] characters
Possible values: ACCT

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"DirectDebitRejectionMessage"
required
array<object>
1 items
object
Allows rejecting previously received incoming payment by the inability to deliver funds to the beneficiary.

directDebitUid
required
string
<= 255 characters
Internal identifier of the incoming payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for rejecting a direct debit payment

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

CLOSED_ACCOUNT -- Closed Account Number

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

INSUFFICIENT_FUND -- Insufficient Funds

DUPLICATION -- Duplication

CREDITOR_BANK_NOT_REGISTERED -- Creditor Bank is not registered under this BIC in the CSM

DEBTOR_BANK_NOT_REGISTERED -- Debtor Bank is not registered under this BIC in the CSM

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

NO_MANDATE -- No valid Mandate

MISSING_MANDATORY_INFORMATION_IN_MANDATE -- Missing Mandatory Information in Mandate

END_CUSTOMER_DECEASED -- End Customer Deceased

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

NOT_SPECIFIED_REASON_AGENT_GENERATED -- Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION -- Missing Debtor Account or Identification (used for regulatory reasons)

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address (used for regulatory reasons)

MISSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address (used for regulatory reasons)

REGULATORY_REASON -- Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT -- Specific Service offered by Debtor Bank

UNRECOGNISED_INITIATING_PARTY -- Unrecognized Initiating Party (Identifier of the Creditor Incorrect)

SETTLEMENT_FAILED -- Settlement failed

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUND"
"DUPLICATION"
"CREDITOR_BANK_NOT_REGISTERED"
"DEBTOR_BANK_NOT_REGISTERED"
"INVALID_MESSAGE"
"NO_MANDATE"
"MISSING_MANDATORY_INFORMATION_IN_MANDATE"
"END_CUSTOMER_DECEASED"
"CUSTOMER_NOT_SPECIFIED_REASON"
"NOT_SPECIFIED_REASON_AGENT_GENERATED"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"UNRECOGNISED_INITIATING_PARTY"
"SETTLEMENT_FAILED"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name. Overrides originatorBic if present

Additional properties are allowed.
Additional properties are allowed.
object
Allows to create a new outgoing direct debit payment.

settlementDate
required
string
format: date
Desired settlement date

directDebitUid
required
string
<= 255 characters
Unique identification of the message

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
paymentDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
paymentCode
required
string
[ 1 .. 4 ] characters
Possible values: ACCT

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information

Additional properties are allowed.
object
Allows rejecting previously received incoming payment by the inability to deliver funds to the beneficiary.

directDebitUid
required
string
<= 255 characters
Internal identifier of the incoming payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for rejecting a direct debit payment

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

CLOSED_ACCOUNT -- Closed Account Number

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

INSUFFICIENT_FUND -- Insufficient Funds

DUPLICATION -- Duplication

CREDITOR_BANK_NOT_REGISTERED -- Creditor Bank is not registered under this BIC in the CSM

DEBTOR_BANK_NOT_REGISTERED -- Debtor Bank is not registered under this BIC in the CSM

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

NO_MANDATE -- No valid Mandate

MISSING_MANDATORY_INFORMATION_IN_MANDATE -- Missing Mandatory Information in Mandate

END_CUSTOMER_DECEASED -- End Customer Deceased

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

NOT_SPECIFIED_REASON_AGENT_GENERATED -- Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION -- Missing Debtor Account or Identification (used for regulatory reasons)

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address (used for regulatory reasons)

MISSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address (used for regulatory reasons)

REGULATORY_REASON -- Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT -- Specific Service offered by Debtor Bank

UNRECOGNISED_INITIATING_PARTY -- Unrecognized Initiating Party (Identifier of the Creditor Incorrect)

SETTLEMENT_FAILED -- Settlement failed

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUND"
"DUPLICATION"
"CREDITOR_BANK_NOT_REGISTERED"
"DEBTOR_BANK_NOT_REGISTERED"
"INVALID_MESSAGE"
"NO_MANDATE"
"MISSING_MANDATORY_INFORMATION_IN_MANDATE"
"END_CUSTOMER_DECEASED"
"CUSTOMER_NOT_SPECIFIED_REASON"
"NOT_SPECIFIED_REASON_AGENT_GENERATED"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"UNRECOGNISED_INITIATING_PARTY"
"SETTLEMENT_FAILED"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name. Overrides originatorBic if present

Additional properties are allowed.
object
messageType
required
string
Const:"OutgoingDirectDebitCancellationMessage"
required
array<object>
1 items
object
Allows to cancel previously sent outgoing payment by client or backend operator request.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
string
<= 255 characters
Optional additional information about the cancellation reason

Additional properties are allowed.
Additional properties are allowed.
object
Allows to cancel previously sent outgoing payment by client or backend operator request.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
string
<= 255 characters
Optional additional information about the cancellation reason

Additional properties are allowed.
directDebitCancellationReason
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
object
messageType
required
string
Const:"OutgoingDirectDebitReversalMessage"
required
array<object>
1 items
object
Allows reversal of a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of the original outgoing direct debit payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
Additional properties are allowed.
Additional properties are allowed.
object
Allows reversal of a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of the original outgoing direct debit payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
Additional properties are allowed.
directDebitReversalReason
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
object
messageType
required
string
Const:"OutgoingDirectDebitReturnMessage"
required
array<object>
1 items
object
Request to return a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for returning an outgoing direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Payment was duplicated

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
additionalInfo
string
Additional information about the return reason

Additional properties are allowed.
Additional properties are allowed.
object
Request to return a previously sent outgoing direct debit payment.

directDebitUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the related original transaction

reasonCode
required
string
Reason for returning an outgoing direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Payment was duplicated

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
additionalInfo
string
Additional information about the return reason

Additional properties are allowed.
directDebitReturnReason
string
Reason for returning an outgoing direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Payment was duplicated

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
object
messageType
required
string
Type of the message. Only 'DirectDebitReceivedMessage' is allowed.

Const:"DirectDebitReceivedMessage"
required
array<object>
1 items
Information about incoming direct debit payment

object
Payment received via direct debit enables the possibility of refunding a previously sent outgoing payment upon request from the client or backend operator.

directDebitUid
required
string
<= 255 characters
Unique identification of the message.

directDebitTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
settlementDate
required
string
format: date
Settlement date.

dueDate
required
string
format: date
The original Requested Collection Date.

required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
msgId
required
string
Message identifier.

txId
required
string
Transaction identifier.

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information.

paymentCode
required
string
[ 1 .. 4 ] characters
Payment code. Possible values: ACCT.

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person.

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
Payment received via direct debit enables the possibility of refunding a previously sent outgoing payment upon request from the client or backend operator.

directDebitUid
required
string
<= 255 characters
Unique identification of the message.

directDebitTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
settlementDate
required
string
format: date
Settlement date.

dueDate
required
string
format: date
The original Requested Collection Date.

required
object
currency
required
string
Currency of the money

Allowed values:
"EUR"
value
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
msgId
required
string
Message identifier.

txId
required
string
Transaction identifier.

purpose
string
<= 105 characters
The purpose of the payment. If category purpose is specified and has one of the values: FCIN, INTE, FCOL, then this field is mandatory and should contain a Creditor Reference Information.

paymentCode
required
string
[ 1 .. 4 ] characters
Payment code. Possible values: ACCT.

sequenceType
required
string
Sequence type.

Allowed values:
"FIRST"
"ONE_OFF"
"RECURRING"
"FINAL"
creditorSchemeId
required
string
[ 1 .. 35 ] characters
Unique and unambiguous identification of a person.

required
object
id
required
string
[ 1 .. 35 ] characters
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

signatureDate
required
string
format: date
Date on which the direct debit mandate has been signed by the debtor.

amendment
required
boolean
Indicator notifying whether the underlying mandate is amended or not.

If set to true, at least one of the following six fields must be present. Otherwise, error code XT13 applies.

If set to false, none of the following six fields must be present. Otherwise, error code XT13 applies.

This field is used to flag mandate amendment status and enforce business rule validation.

required
object
originalId
string
must match: ([A-Za-z0-9+?/\-:().,' ]){1,35}
The original Mandate ID.

Mandatory if changes occur in Mandate Identification; otherwise, this field must not be used.

Conditional on the Amendment Indicator being true. Violation triggers error code XT13.

A unique identifier assigned by the creditor to unambiguously identify the original mandate.

originalCreditorSchemeId
string
<= 35 characters
Original Creditor Scheme Identification.

Mandatory if changes occur in either Creditor SchemeIdentification or Name; otherwise, this field must not be used.

Used to indicate that the original creditor scheme identification has been modified.

originalPayerAccountSameMandate
boolean
Indicates whether the original payer account is the same as in the current mandate.

Mandatory.

If set to false, the debtor is identified by IBAN.

If set to true, a generic account identification with value SMNDA is used instead.

In most cases, this value should be false.

object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
electronicSignature
required
string
[ 1 .. 1025 ] characters
Placeholder for Electronic Signature.

If the direct debit is based on an EPC electronic mandate, this field must contain AT-60, which refers to the Mandate Acceptance Report issued by the Debtor Bank.

Must not be used if the mandate is a paper mandate.

This field is not validated by the STEP2 Clearing System (CS).

Represents additional security provisions, such as a digital signature, as provided by the debtor.

Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s account

required
allOf
Number of the party’s account

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
BIC code of the party’s agent

Consists of:
string
must match: [A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
Examples values:
"TESTLT21"
"TESTLT21XXX"
object
Proxy of party’s account

id
string
<= 320 characters
object
Proxy type on party’s personal details

code
required
string
[ 1 .. 4 ] characters
Proxy type code on party’s account

proprietary
string
<= 35 characters
Proxy type proprietary on party’s personal details

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

Allowed values:
"ORG"
"PRIVATE"
"UNKNOWN"
"NONE"
name
required
string
<= 70 characters
The name of the party

id
string
<= 35 characters
Identifier of the party (e.g. national id, corporate registration number, etc). Mandatory if payment category purpose is specified and equal to one of the values: FCIN, INTE, FCOL

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

Consists of:
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
fullAddress
deprecated
string
<= 140 characters
Full address. Can be provided in free format.

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

buildingNumber
string
<= 16 characters
Number that identifies the position of a building on a street.

buildingName
string
<= 35 characters
Name of the building or house.

floor
string
<= 70 characters
Floor

postBox
string
<= 16 characters
Numbered boxes in a post office, assigned to a person or organization, where letters are kept until called for.

room
string
<= 70 characters
Room

postCode
string
<= 16 characters
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

country
string
must match: [A-Z]{2,2}
Country code (ISO 3166-1 alpha-2)

Examples values:
"LT"
"DE"
Additional properties are allowed.
identityType
string
The type of the 'Identifier of the party'.

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
directDebitType
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
object
messageType
required
string
Only “DirectDebitSettledMessage” is allowed. Type of the message.

Const:"DirectDebitSettledMessage"
required
array<object>
1 items
List of settled messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
msgId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
msgId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
required
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
object
messageType
required
string
Only “DirectDebitRejectedMessage” is allowed. Type of the message.

Const:"DirectDebitRejectedMessage"
required
array<object>
1 items
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
rejectionReason
required
string
Reason for rejecting a direct debit instruction

TRANSACTION_COUNT_MISMATCH -- Number of transactions mismatch

AMOUNT_SUM_MISMATCH -- Total amount mismatch

INSTRUCTING_AGENT_AND_SENDER_MISMATCH -- Instructing Agent mismatch

INSTRUCTED_AGENT_IN_GROUP_HEADER -- Invalid use of Instructed Agent

INVALID_ASSIGNER_OR_ASSIGNEE -- Invalid Use of Assgnr/Assgnee

DUPLICATE_MSGID -- Duplicate MessageID

INVALID_SETTLEMENT_DATE_RANGE -- Invalid Settlement Date

REJECTED_DUE_REJECTED_TRANSACTION -- All transactions rejected

INVALID_SETTLEMENT_INFO_DETAILS -- Invalid Settlement Info details

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

MISSING_DEBTOR_NAME_ADDRESS -- Missing debtor address name

MISSING_CREDITOR_NAME_ADDRESS -- Missing creditor address name

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement Failed

INVALID_IBAN -- Invalid IBAN format (ISO 13616 failure)

UNSUPPORTED_XML_FIELD -- Unsupported XML field or missing mandatory field

INVALID_DATA_FORMAT -- At least one XML element is in the wrong format

INVALID_COUNTRY_CODE -- Invalid ISO3166 country code

INVALID_ORIGINAL_TRANSACTION_STATUS -- Action required for original transaction status

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- No action required for invalid original status

ORIGINAL_AMOUNT_MISMATCH -- Interbank Settlement Amount differs from original debit

ONLY_SEPA_FIELDS_ALLOWED -- Non-SEPA field used without prior agreement

SETTLEMENT_CYCLE_NOT_AVAILABLE -- Invalid Settlement Cycle

EXPIRED_CANCELLATION_TIME_LIMIT -- Time limit for cancellation expired

AGENT_MISMATCH_TO_ORIGINAL -- Sending agent differs from original transaction agent

INVALID_TECH_BIC -- Invalid use of Technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- BIC not allowed in SEPACOM CUG

SENDER_SUSPENDED -- Sender suspended

RECEIVER_SUSPENDED -- Receiver suspended

SEPA_SYNTAX_ERROR -- SEPA syntax error

SEPA_AUTHENTICATION_ERROR -- SEPA authentication error

SEPA_CONTEXT_ERROR -- SEPA context error

CANCELLED_BEFORE_CLEARING -- Cancelled before clearing

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

REASON_NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

INCORRECT_BIX -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID -- Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address

MISSSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address

REGULATORY_REASON -- Regulatory Reason

TIMEOUT_CREDITOR_AGENT -- Timeout creditor agent

TIMEOUT_INSTRUCTED_AGENT -- Timeout instructed agent

OFFLINE_AGENT -- Offline agent

ERROR_CREDITOR_AGENT -- Error creditor agent

CLOSED_ACCOUNT_NUMBER -- Closed Account Number

ERROR_INSTRUCTED_AGENT -- Error instructed agent

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

PAYMENT_NOT_RECEIVED -- Payment not received

AGENT_SUSPENDED -- Agent suspended

CREDITOR_AGENT_SUSPENDED -- Creditor agent suspended

AMOUNT_EXCEEDS_SETTLEMENT_LIMIT -- Amount exceeds settlement limit

MISSING_CREDITOR_ADDRESS -- Missing creditor address

END_CUSTOMER_DECEASED -- End Customer Deceased

DEBTOR_BANK_NOT_REGISTERED -- Debtor bank not registered

REASON_NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

CREDITOR_BANK_NOT_REGISTERED -- Creditor bank not registered under this BIC

CREDIT_AGENT_TIMEOUT -- Credit agent timeout

INSTRUCTING_AGENT_TIMEOUT -- Instructing agent timeout

INSTRUCTING_AGENT_UNAVAILABLE -- Instructing agent unavailable

CREDIT_AGENT_UNAVAILABLE -- Credit agent unavailable

CREDIT_AGENT_PROCESS_ERROR -- Credit agent process error

INSTRUCTING_AGENT_PROCESS_ERROR -- Instructing agent process error

INCORRECT_IBAN -- Incorrect IBAN

CLOSED_ACCOUNT -- Account closed

ORIGINAL_PAYMENT_NOT_RECEIVED -- Original payment not received

INSTRUCTING_AGENT_SUSPENDED -- Instructing agent suspended

CREDIT_AGENT_SUSPENDED -- Credit agent suspended

INSUFFICIENT_FUND -- Insufficient funds

WRONG_AMOUNT -- Wrong amount

AMOUNT_EXCEEDS_LIMIT -- Amount exceeds limit

ALREADY_RETURNED_TRANSACTION -- Already returned transaction

REQUESTED_BY_CUSTOMER -- Cancellation requested by the debtor

DUPLICATE_PAYMENT -- Duplicate Payment

FOLLOWING_CANCELLATION_REQUEST -- Following cancellation request

FRAUDULENT_TRANSACTION -- Fraudulent Originated Direct Debit

LEGAL_DECISION -- Legal decision

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

AGENT_NOT_SPECIFIED_REASON -- Not Specified Reason Agent Generated

NO_ANSWER_FROM_CUSTOMER -- No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED -- Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION -- Bank Identifier Incorrect

TECHNICAL_ERROR -- Technical problems resulting in erroneous SDDs

CUT_OFF_TIME -- Cut-off time

INSUFFICIENT_LIQUIDITY -- Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME -- Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP -- Debtor Agent not allowed to receive DD

CREDIT_AGENT_NOT_ALLOWED_SEND_IP -- Creditor Agent not allowed to send DD

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED -- Participant product usage not allowed

BULK_TOTALLY_ACCEPTED -- Bulk totally accepted

BULK_PARTIALLY_ACCEPTED -- Bulk partially accepted

MAXIMUM_NUMBER_BULKS_EXCEEDED -- Maximum number of bulks in a file exceeded

MANY_CONSECUTIVE_REJECTED_TRANSACTIONS -- Too many consecutive rejected transactions

INVALID_ORIGINATOR -- Invalid Originator

BULK_CANCELLATION_REJECTED -- DPWS Bulk Cancellation Rejected

UNAUTHORIZED_TRANSACTION -- Unauthorized Transaction

MISSING_MANDATORY_INFORMATION_MANDATE -- Missing Mandatory Information Mandate

SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK -- Specific Service offered by Debtor Bank

UNRECOGNIZED_INITIATING_PARTY -- Unrecognized Initiating Party

Allowed values:
"TRANSACTION_COUNT_MISMATCH"
"AMOUNT_SUM_MISMATCH"
"INSTRUCTING_AGENT_AND_SENDER_MISMATCH"
"INSTRUCTED_AGENT_IN_GROUP_HEADER"
"INVALID_ASSIGNER_OR_ASSIGNEE"
"DUPLICATE_MSGID"
"INVALID_SETTLEMENT_DATE_RANGE"
"REJECTED_DUE_REJECTED_TRANSACTION"
"INVALID_SETTLEMENT_INFO_DETAILS"
"INVALID_MESSAGE"
"MISSING_DEBTOR_NAME_ADDRESS"
"MISSING_CREDITOR_NAME_ADDRESS"
"DUPLICATION"
"SETTLEMENT_FAILED"
"INVALID_IBAN"
"UNSUPPORTED_XML_FIELD"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"ONLY_SEPA_FIELDS_ALLOWED"
"SETTLEMENT_CYCLE_NOT_AVAILABLE"
"EXPIRED_CANCELLATION_TIME_LIMIT"
"AGENT_MISMATCH_TO_ORIGINAL"
"INVALID_TECH_BIC"
"INVALID_CREDITOR_DEBTOR_BIC_COMBINATION"
"SENDER_SUSPENDED"
"RECEIVER_SUSPENDED"
"SEPA_SYNTAX_ERROR"
"SEPA_AUTHENTICATION_ERROR"
"SEPA_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
"INCORRECT_ACCOUNT_NUMBER"
"INVALID_BANK_OPERATION_CODE"
"REASON_NOT_SPECIFIED_BY_AGENT"
"INCORRECT_BIX"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TIMEOUT_CREDITOR_AGENT"
"TIMEOUT_INSTRUCTED_AGENT"
"OFFLINE_AGENT"
"ERROR_CREDITOR_AGENT"
"CLOSED_ACCOUNT_NUMBER"
"ERROR_INSTRUCTED_AGENT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"PAYMENT_NOT_RECEIVED"
"AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"AMOUNT_EXCEEDS_SETTLEMENT_LIMIT"
"MISSING_CREDITOR_ADDRESS"
"END_CUSTOMER_DECEASED"
"DEBTOR_BANK_NOT_REGISTERED"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"CREDITOR_BANK_NOT_REGISTERED"
"CREDIT_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_UNAVAILABLE"
"CREDIT_AGENT_UNAVAILABLE"
"CREDIT_AGENT_PROCESS_ERROR"
"INSTRUCTING_AGENT_PROCESS_ERROR"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDIT_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"BULK_TOTALLY_ACCEPTED"
"BULK_PARTIALLY_ACCEPTED"
"MAXIMUM_NUMBER_BULKS_EXCEEDED"
"MANY_CONSECUTIVE_REJECTED_TRANSACTIONS"
"INVALID_ORIGINATOR"
"BULK_CANCELLATION_REJECTED"
"UNAUTHORIZED_TRANSACTION"
"MISSING_MANDATORY_INFORMATION_MANDATE"
"SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK"
"UNRECOGNIZED_INITIATING_PARTY"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

directDebitType
required
string
Type of Direct Debit

Allowed values:
"OUTGOING_DIRECT_DEBIT"
"INCOMING_DIRECT_DEBIT"
"OUTGOING_DIRECT_DEBIT_REVERSAL"
"OUTGOING_DIRECT_DEBIT_RETURN"
"INCOMING_DIRECT_DEBIT_RETURN"
rejectionReason
required
string
Reason for rejecting a direct debit instruction

TRANSACTION_COUNT_MISMATCH -- Number of transactions mismatch

AMOUNT_SUM_MISMATCH -- Total amount mismatch

INSTRUCTING_AGENT_AND_SENDER_MISMATCH -- Instructing Agent mismatch

INSTRUCTED_AGENT_IN_GROUP_HEADER -- Invalid use of Instructed Agent

INVALID_ASSIGNER_OR_ASSIGNEE -- Invalid Use of Assgnr/Assgnee

DUPLICATE_MSGID -- Duplicate MessageID

INVALID_SETTLEMENT_DATE_RANGE -- Invalid Settlement Date

REJECTED_DUE_REJECTED_TRANSACTION -- All transactions rejected

INVALID_SETTLEMENT_INFO_DETAILS -- Invalid Settlement Info details

INVALID_MESSAGE -- Operation/transaction code incorrect, invalid file format

MISSING_DEBTOR_NAME_ADDRESS -- Missing debtor address name

MISSING_CREDITOR_NAME_ADDRESS -- Missing creditor address name

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement Failed

INVALID_IBAN -- Invalid IBAN format (ISO 13616 failure)

UNSUPPORTED_XML_FIELD -- Unsupported XML field or missing mandatory field

INVALID_DATA_FORMAT -- At least one XML element is in the wrong format

INVALID_COUNTRY_CODE -- Invalid ISO3166 country code

INVALID_ORIGINAL_TRANSACTION_STATUS -- Action required for original transaction status

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- No action required for invalid original status

ORIGINAL_AMOUNT_MISMATCH -- Interbank Settlement Amount differs from original debit

ONLY_SEPA_FIELDS_ALLOWED -- Non-SEPA field used without prior agreement

SETTLEMENT_CYCLE_NOT_AVAILABLE -- Invalid Settlement Cycle

EXPIRED_CANCELLATION_TIME_LIMIT -- Time limit for cancellation expired

AGENT_MISMATCH_TO_ORIGINAL -- Sending agent differs from original transaction agent

INVALID_TECH_BIC -- Invalid use of Technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- BIC not allowed in SEPACOM CUG

SENDER_SUSPENDED -- Sender suspended

RECEIVER_SUSPENDED -- Receiver suspended

SEPA_SYNTAX_ERROR -- SEPA syntax error

SEPA_AUTHENTICATION_ERROR -- SEPA authentication error

SEPA_CONTEXT_ERROR -- SEPA context error

CANCELLED_BEFORE_CLEARING -- Cancelled before clearing

INCORRECT_ACCOUNT_NUMBER -- Incorrect Account Number

INVALID_BANK_OPERATION_CODE -- Invalid Bank Operation Code

REASON_NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

INCORRECT_BIX -- Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID -- Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS -- Missing Debtor Name or Address

MISSSING_CREDITOR_NAME_OR_ADDRESS -- Missing Creditor Name or Address

REGULATORY_REASON -- Regulatory Reason

TIMEOUT_CREDITOR_AGENT -- Timeout creditor agent

TIMEOUT_INSTRUCTED_AGENT -- Timeout instructed agent

OFFLINE_AGENT -- Offline agent

ERROR_CREDITOR_AGENT -- Error creditor agent

CLOSED_ACCOUNT_NUMBER -- Closed Account Number

ERROR_INSTRUCTED_AGENT -- Error instructed agent

BLOCKED_ACCOUNT -- Blocked Account

TRANSACTION_FORBIDDEN -- Transaction Forbidden

PAYMENT_NOT_RECEIVED -- Payment not received

AGENT_SUSPENDED -- Agent suspended

CREDITOR_AGENT_SUSPENDED -- Creditor agent suspended

AMOUNT_EXCEEDS_SETTLEMENT_LIMIT -- Amount exceeds settlement limit

MISSING_CREDITOR_ADDRESS -- Missing creditor address

END_CUSTOMER_DECEASED -- End Customer Deceased

DEBTOR_BANK_NOT_REGISTERED -- Debtor bank not registered

REASON_NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

CREDITOR_BANK_NOT_REGISTERED -- Creditor bank not registered under this BIC

CREDIT_AGENT_TIMEOUT -- Credit agent timeout

INSTRUCTING_AGENT_TIMEOUT -- Instructing agent timeout

INSTRUCTING_AGENT_UNAVAILABLE -- Instructing agent unavailable

CREDIT_AGENT_UNAVAILABLE -- Credit agent unavailable

CREDIT_AGENT_PROCESS_ERROR -- Credit agent process error

INSTRUCTING_AGENT_PROCESS_ERROR -- Instructing agent process error

INCORRECT_IBAN -- Incorrect IBAN

CLOSED_ACCOUNT -- Account closed

ORIGINAL_PAYMENT_NOT_RECEIVED -- Original payment not received

INSTRUCTING_AGENT_SUSPENDED -- Instructing agent suspended

CREDIT_AGENT_SUSPENDED -- Credit agent suspended

INSUFFICIENT_FUND -- Insufficient funds

WRONG_AMOUNT -- Wrong amount

AMOUNT_EXCEEDS_LIMIT -- Amount exceeds limit

ALREADY_RETURNED_TRANSACTION -- Already returned transaction

REQUESTED_BY_CUSTOMER -- Cancellation requested by the debtor

DUPLICATE_PAYMENT -- Duplicate Payment

FOLLOWING_CANCELLATION_REQUEST -- Following cancellation request

FRAUDULENT_TRANSACTION -- Fraudulent Originated Direct Debit

LEGAL_DECISION -- Legal decision

CUSTOMER_NOT_SPECIFIED_REASON -- Not Specified Reason Customer Generated

AGENT_NOT_SPECIFIED_REASON -- Not Specified Reason Agent Generated

NO_ANSWER_FROM_CUSTOMER -- No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED -- Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION -- Bank Identifier Incorrect

TECHNICAL_ERROR -- Technical problems resulting in erroneous SDDs

CUT_OFF_TIME -- Cut-off time

INSUFFICIENT_LIQUIDITY -- Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME -- Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP -- Debtor Agent not allowed to receive DD

CREDIT_AGENT_NOT_ALLOWED_SEND_IP -- Creditor Agent not allowed to send DD

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED -- Participant product usage not allowed

BULK_TOTALLY_ACCEPTED -- Bulk totally accepted

BULK_PARTIALLY_ACCEPTED -- Bulk partially accepted

MAXIMUM_NUMBER_BULKS_EXCEEDED -- Maximum number of bulks in a file exceeded

MANY_CONSECUTIVE_REJECTED_TRANSACTIONS -- Too many consecutive rejected transactions

INVALID_ORIGINATOR -- Invalid Originator

BULK_CANCELLATION_REJECTED -- DPWS Bulk Cancellation Rejected

UNAUTHORIZED_TRANSACTION -- Unauthorized Transaction

MISSING_MANDATORY_INFORMATION_MANDATE -- Missing Mandatory Information Mandate

SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK -- Specific Service offered by Debtor Bank

UNRECOGNIZED_INITIATING_PARTY -- Unrecognized Initiating Party

Allowed values:
"TRANSACTION_COUNT_MISMATCH"
"AMOUNT_SUM_MISMATCH"
"INSTRUCTING_AGENT_AND_SENDER_MISMATCH"
"INSTRUCTED_AGENT_IN_GROUP_HEADER"
"INVALID_ASSIGNER_OR_ASSIGNEE"
"DUPLICATE_MSGID"
"INVALID_SETTLEMENT_DATE_RANGE"
"REJECTED_DUE_REJECTED_TRANSACTION"
"INVALID_SETTLEMENT_INFO_DETAILS"
"INVALID_MESSAGE"
"MISSING_DEBTOR_NAME_ADDRESS"
"MISSING_CREDITOR_NAME_ADDRESS"
"DUPLICATION"
"SETTLEMENT_FAILED"
"INVALID_IBAN"
"UNSUPPORTED_XML_FIELD"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"ONLY_SEPA_FIELDS_ALLOWED"
"SETTLEMENT_CYCLE_NOT_AVAILABLE"
"EXPIRED_CANCELLATION_TIME_LIMIT"
"AGENT_MISMATCH_TO_ORIGINAL"
"INVALID_TECH_BIC"
"INVALID_CREDITOR_DEBTOR_BIC_COMBINATION"
"SENDER_SUSPENDED"
"RECEIVER_SUSPENDED"
"SEPA_SYNTAX_ERROR"
"SEPA_AUTHENTICATION_ERROR"
"SEPA_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
"INCORRECT_ACCOUNT_NUMBER"
"INVALID_BANK_OPERATION_CODE"
"REASON_NOT_SPECIFIED_BY_AGENT"
"INCORRECT_BIX"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TIMEOUT_CREDITOR_AGENT"
"TIMEOUT_INSTRUCTED_AGENT"
"OFFLINE_AGENT"
"ERROR_CREDITOR_AGENT"
"CLOSED_ACCOUNT_NUMBER"
"ERROR_INSTRUCTED_AGENT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"PAYMENT_NOT_RECEIVED"
"AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"AMOUNT_EXCEEDS_SETTLEMENT_LIMIT"
"MISSING_CREDITOR_ADDRESS"
"END_CUSTOMER_DECEASED"
"DEBTOR_BANK_NOT_REGISTERED"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"CREDITOR_BANK_NOT_REGISTERED"
"CREDIT_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_TIMEOUT"
"INSTRUCTING_AGENT_UNAVAILABLE"
"CREDIT_AGENT_UNAVAILABLE"
"CREDIT_AGENT_PROCESS_ERROR"
"INSTRUCTING_AGENT_PROCESS_ERROR"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDIT_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"BULK_TOTALLY_ACCEPTED"
"BULK_PARTIALLY_ACCEPTED"
"MAXIMUM_NUMBER_BULKS_EXCEEDED"
"MANY_CONSECUTIVE_REJECTED_TRANSACTIONS"
"INVALID_ORIGINATOR"
"BULK_CANCELLATION_REJECTED"
"UNAUTHORIZED_TRANSACTION"
"MISSING_MANDATORY_INFORMATION_MANDATE"
"SPECIFIC_SERVICE_OFFERED_DEBTOR_BANK"
"UNRECOGNIZED_INITIATING_PARTY"
originatorBic
string
Rejection originator BIC

originatorName
string
<= 70 characters
Rejection originator name

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
object
messageType
required
string
Only “DirectDebitCancelledMessage” is allowed. Type of the message.

Const:"DirectDebitCancelledMessage"
required
array<object>
1 items
List of canceled direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
required
string
Additional info

originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

cancellationId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the cancellation message

Additional properties are allowed.
Additional properties are allowed.
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for cancellation of a direct debit payment

FRAUDULENT_TRANSACTION – Fraudulent transaction detected

TECHNICAL_PROBLEM – Technical problems

BY_CUSTOMER – Cancellation requested by the debtor

DUPLICATE – Duplicate transaction

Allowed values:
"FRAUDULENT_TRANSACTION"
"TECHNICAL_PROBLEM"
"BY_CUSTOMER"
"DUPLICATE"
additionalInfo
required
string
Additional info

originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

cancellationId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the cancellation message

Additional properties are allowed.
object
messageType
required
string
Only “DirectDebitReturnedMessage” is allowed. Type of the message.

Const:"DirectDebitReturnedMessage"
required
array<object>
1 items
List of returned direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for returning a direct debit payment

INCORRECT_ACCOUNT_NUMBER – Incorrect Account Number

CLOSED_ACCOUNT – Closed Account Number

BLOCKED_ACCOUNT – Blocked Account

TRANSACTION_FORBIDDEN – Transaction Forbidden

INVALID_BANK_OPERATION_CODE – Invalid Bank Operation Code

INSUFFICIENT_FUNDS – Insufficient Funds

DUPLICATE – Duplication

UNAUTHORIZED_TRANSACTION – Unauthorized Transaction

REQUESTED_BY_END_CUSTOMER – Disputed authorized transaction (Only for Refunds)

DECEASED_CUSTOMER – End Customer Deceased

BY_ORDER_OF_THE_BENEFICIARY – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT – Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION – Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS – Missing Debtor Name or Address

MISSING_CREDITOR_NAME_OR_ADDRESS – Missing Creditor Name or Address

REGULATORY_REASON – Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT – Specific Service offered by Debtor Bank

NOT_RECOGNISED_BY_END_CUSTOMER – Unrecognized Initiating Party (Creditor Identifier Incorrect)

UNKNOWN – Not supported return code

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUNDS"
"DUPLICATE"
"UNAUTHORIZED_TRANSACTION"
"REQUESTED_BY_END_CUSTOMER"
"DECEASED_CUSTOMER"
"BY_ORDER_OF_THE_BENEFICIARY"
"NOT_SPECIFIED_BY_AGENT"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"NOT_RECOGNISED_BY_END_CUSTOMER"
"UNKNOWN"
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
compensation
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
Additional properties are allowed.
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for returning a direct debit payment

INCORRECT_ACCOUNT_NUMBER – Incorrect Account Number

CLOSED_ACCOUNT – Closed Account Number

BLOCKED_ACCOUNT – Blocked Account

TRANSACTION_FORBIDDEN – Transaction Forbidden

INVALID_BANK_OPERATION_CODE – Invalid Bank Operation Code

INSUFFICIENT_FUNDS – Insufficient Funds

DUPLICATE – Duplication

UNAUTHORIZED_TRANSACTION – Unauthorized Transaction

REQUESTED_BY_END_CUSTOMER – Disputed authorized transaction (Only for Refunds)

DECEASED_CUSTOMER – End Customer Deceased

BY_ORDER_OF_THE_BENEFICIARY – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

BANK_IDENTIFIER_INCORRECT – Bank Identifier Incorrect

MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION – Missing Debtor Account or Identification

MISSING_DEBTOR_NAME_OR_ADDRESS – Missing Debtor Name or Address

MISSING_CREDITOR_NAME_OR_ADDRESS – Missing Creditor Name or Address

REGULATORY_REASON – Regulatory Reason

SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT – Specific Service offered by Debtor Bank

NOT_RECOGNISED_BY_END_CUSTOMER – Unrecognized Initiating Party (Creditor Identifier Incorrect)

UNKNOWN – Not supported return code

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"INSUFFICIENT_FUNDS"
"DUPLICATE"
"UNAUTHORIZED_TRANSACTION"
"REQUESTED_BY_END_CUSTOMER"
"DECEASED_CUSTOMER"
"BY_ORDER_OF_THE_BENEFICIARY"
"NOT_SPECIFIED_BY_AGENT"
"BANK_IDENTIFIER_INCORRECT"
"MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_AGENT"
"NOT_RECOGNISED_BY_END_CUSTOMER"
"UNKNOWN"
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
compensation
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

msgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

txId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

Additional properties are allowed.
object
messageType
required
string
Only “DirectDebitReversedMessage” is allowed. Type of the message.

Const:"DirectDebitReversedMessage"
required
array<object>
1 items
List of reversed direct debit messages

object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
required
object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

reversalId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the reversal transaction

Additional properties are allowed.
Additional properties are allowed.
object
directDebitUid
required
string
<= 255 characters
Unique internal identifier of the message

reasonCode
required
string
Reason for reversal of a direct debit payment

NOT_SPECIFIED_BY_CUSTOMER – Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT – Not Specified Reason Agent Generated

DUPLICATION – Duplication

Allowed values:
"NOT_SPECIFIED_BY_CUSTOMER"
"NOT_SPECIFIED_BY_AGENT"
"DUPLICATION"
required
object
amount
required
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

institutionBic
required
string
BIC of the institution charging the fee

Additional properties are allowed.
originalMsgId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the message

originalTxId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the transaction

reversalId
string
must match: ^[0-9a-zA-Z\-?:()., '+ ]{1,35}$
Unique identification of the reversal transaction

Additional properties are allowed.
object
messageType
required
string
Const:"InvalidPayment"
required
array<object>
non-empty
object
internalId
required
string
<= 255 characters
Unique internal identifier of the payment

additionalInfo
required
string
Description of validation error(s)

Additional properties are allowed.
Additional properties are allowed.
object
internalId
required
string
<= 255 characters
Unique internal identifier of the payment

additionalInfo
required
string
Description of validation error(s)

Additional properties are allowed.

SEPA Direct Debit Transfer Gateway API 1.4.2

Feature highlights:

Servers

Security:

Security:

Operations

SEND outgoing_payments

Examples

This example has been generated automatically.

SEND outgoing_payments

Examples

This example has been generated automatically.

SEND outgoing_payments

Examples

This example has been generated automatically.

SEND outgoing_payments

Examples

This example has been generated automatically.

SEND outgoing_payments

Examples

This example has been generated automatically.

RECEIVE incoming_payments

Examples

This example has been generated automatically.

RECEIVE incoming_payments

Examples

This example has been generated automatically.

RECEIVE incoming_payments

Examples

This example has been generated automatically.

RECEIVE incoming_payments

Examples

This example has been generated automatically.

RECEIVE incoming_payments

Examples

This example has been generated automatically.

Messages

Schemas