SEPA Credit Transfer Gateway API 1.9.2 documentation

SEPA Credit Transfer Gateway API 1.9.2

application/json

SEPA Gateway API provides an access to the SEPA 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 Credit 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 SCT 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

Allows to create a new outgoing payment.

Operation IDcreateNewOutgoingPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
OutgoingPaymentMessageoutgoingPaymentMessage
Contains details of outgoing payment creation request
application/json
Message IDoutgoingPaymentMessage
object
messageType
required
string
Const:"OutgoingPaymentMessage"
required
array<object>
1 items
object
wbUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is internal to the API and will not be forwarded to the external party. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

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

endToEndId
string
[ 1 .. 35 ] characters
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

allOf
Payment creation timestamp from the payer’s perspective. It will be used as a payment settlement date if possible.

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Debtor information. Party that owes an amount of money to the Creditor

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
allOf
Creditor information. Party to which an amount of money is due.

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
allOf
Amount of the payment

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.
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

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "OutgoingPaymentMessage", "data": [ { "wbUid": "string", "msgId": "string", "txId": "string", "endToEndId": "string", "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" } } } }, "client": { "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" } } } }, "amount": { "currency": "EUR", "value": 0.01 }, "purpose": "string", "categoryPurpose": "BONU" } ] }

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

Allows to reject (return) previously received incoming payment either by inability to deliver funds to beneficiary or by confirming previously received payment cancellation request.

Operation IDrejectPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RejectPaymentMessagerejectPaymentMessage
Contains details of incoming payment return request
application/json
Message IDrejectPaymentMessage
object
messageType
required
string
Const:"RejectPaymentMessage"
required
array<object>
1 items
object
internalSepaMmsPaymentUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

ACCOUNT_NUMBER_PROBLEM -- Incorrect Account Number or the Account Number does not exist

CLOSED_ACCOUNT -- The account is closed

BLOCKED_ACCOUNT -- The account is blocked; the reason is not specified

WRONG_ACCOUNT_TYPE -- For this type of account credit transfers are forbidden (e.g. a time deposit account)

DUPLICATE -- Duplication

CREDITOR_ADDRESS_PROBLEM -- Missing Creditor Address

FOLLOWING_CANCELLATION_REQUEST -- Following Cancellation Request

DECEASED_CUSTOMER -- End Customer Deceased

NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

REGULATORY_REASON -- Regulatory reason.

Allowed values:
"ACCOUNT_NUMBER_PROBLEM"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"WRONG_ACCOUNT_TYPE"
"DUPLICATE"
"CREDITOR_ADDRESS_PROBLEM"
"FOLLOWING_CANCELLATION_REQUEST"
"DECEASED_CUSTOMER"
"NOT_SPECIFIED_BY_CUSTOMER"
allOf
How much money was charged from recipient (in cases when it is allowed to do so). This field is only allowed when reasonCode is FOLLOWING_CANCELLATION_REQUEST

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.
originatorName
string
<= 70 characters
Rejection originator name

string allOf
Rejection originator BIC

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"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RejectPaymentMessage", "data": [ { "internalSepaMmsPaymentUid": "string", "msgId": "string", "txId": "string", "reasonCode": "ACCOUNT_NUMBER_PROBLEM", "chargeAmount": { "currency": "EUR", "value": 0.01 }, "originatorName": "string", "originatorBic": "TESTLT21" } ] }

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

Allows to cancel previously sent outgoing payment by client or backend operator request.

Operation IDcancelPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
CancelPaymentMessagecancelPaymentMessage
Contains details of outgoing payment cancellation request
application/json
Message IDcancelPaymentMessage
object
messageType
required
string
Const:"CancelPaymentMessage"
required
array<object>
1 items
object
internalUid
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 transaction

reasonCode
required
string

DUPLICATE -- Payment was duplicated

REQUESTED_BY_ORIGINATOR -- Originator of payment requested its cancellation

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

Allowed values:
"DUPLICATE"
"REQUESTED_BY_ORIGINATOR"
"FRAUD"
"TECHNICAL_ISSUE"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Can only be specified if reasonCode is FRAUD

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "CancelPaymentMessage", "data": [ { "internalUid": "string", "msgId": "string", "txId": "string", "reasonCode": "DUPLICATE", "additionalInfo": "string" } ] }

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

Allows to send a negative response (also known as “Resolution of investigation”) on previously received cancellation request.

Operation IDretainPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RetainPaymentMessageretainPaymentMessage
Contains details of incoming payment retainment decision
application/json
Message IDretainPaymentMessage
object
messageType
required
string
Const:"RetainPaymentMessage"
required
array<object>
1 items
object
internalSepaMmsAppUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

INSUFFICIENT_FUNDS -- There are insufficient funds on the account

CLOSED_ACCOUNT -- The account is closed

LEGAL_REASONS -- For legal reasons, specifying the reason in clear text

REFUSAL -- Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR -- No answer is received from the Creditor

NO_FUNDS_RECEIVED -- The funds were not received

ALREADY_RETURNED -- The funds have already been returned

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
legalInfo
required
string
<= 210 characters
Additional retention information

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RetainPaymentMessage", "data": [ { "internalSepaMmsAppUid": "string", "msgId": "string", "txId": "string", "reasonCode": "INSUFFICIENT_FUNDS", "legalInfo": "string" } ] }

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

Allows to send a non-receipt claim for previously sent payment message, initiate an investigation for missing funds at the creditor or at agent along the processing chain.

Operation IDclaimNonReceipt
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
ClaimNonReceiptMessageclaimNonReceiptMessage
Contains details of payment non-receipt claim
application/json
Message IDclaimNonReceiptMessage
object
messageType
required
string
Const:"ClaimNonReceiptMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "ClaimNonReceiptMessage", "data": [ { "paymentUid": "string", "msgId": "string", "txId": "string", "additionalInstructions": "string" } ] }

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

Allows to send a request to modify date and time at which the payment assignment was created

Operation IDclaimDateCorrection
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
ClaimDateCorrectionMessageclaimDateCorrectionMessage
Contains details of payment date correction claim
application/json
Message IDclaimDateCorrectionMessage
object
messageType
required
string
Const:"ClaimDateCorrectionMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
required
string
<= 140 characters
Additional instructions

required
allOf
Claimed new payment settlement date

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "ClaimDateCorrectionMessage", "data": [ { "paymentUid": "string", "msgId": "string", "txId": "string", "additionalInstructions": "string", "claimedSettlementDate": "2019-11-21T16:32:59" } ] }

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

Allows to send a message by a case assignee to a case creator/case assigner. This message is used to inform of the resolution of a case, and optionally provides details about the corrective action undertaken by the case assignee - information on the return where applicable

Operation IDresolveClaim
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
ResolveClaimMessageresolveClaimMessage
Contains details of positive or negative resolution of incoming claim
application/json
Message IDresolveClaimMessage
object
messageType
required
string
Const:"ResolveClaimMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
reasonCode
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
allOf
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
allOf
Transaction charges to be paid by the charge bearer. Can be only specified when resolution type is one of: ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION

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.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "ResolveClaimMessage", "data": [ { "paymentUid": "string", "msgId": "string", "txId": "string", "resolution": "ACCEPTED_NON_RECEIPT", "reasonCode": "ORIGINAL_TX_NOT_RECEIVED", "newSettlementDate": "2019-11-21T16:32:59", "chargeAmount": { "currency": "EUR", "value": 0.01 } } ] }

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

Allows to request a status of previously sent payment non-receipt claim.

Operation IDrequestNonReceiptClaimStatus
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RequestNonReceiptClaimStatusMessagerequestNonReceiptClaimStatusMessage
Contains details of outgoing payment non-receipt claim status request
application/json
Message IDrequestNonReceiptClaimStatusMessage
object
messageType
required
string
Const:"RequestNonReceiptClaimStatusMessage"
required
array<object>
1 items
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RequestNonReceiptClaimStatusMessage", "data": [ { "claimedPaymentUid": "string" } ] }

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

Allows to request a status of previously sent payment date correction claim.

Operation IDrequestDateCorrectionClaimStatus
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RequestDateCorrectionClaimStatusMessagerequestDateCorrectionClaimStatusMessage
Contains details of outgoing payment date correction claim status request
application/json
Message IDrequestDateCorrectionClaimStatusMessage
object
messageType
required
string
Const:"RequestDateCorrectionClaimStatusMessage"
required
array<object>
1 items
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RequestDateCorrectionClaimStatusMessage", "data": [ { "claimedPaymentUid": "string" } ] }

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

This operation is invoked when new incoming payment is received

Operation IDlistenPaymentReceived
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
PaymentReceivedMessagepaymentReceivedMessage
Contains details of received incoming payment
application/json
Message IDpaymentReceivedMessage
object
messageType
required
string
Const:"PaymentReceivedMessage"
required
array<object>
non-empty
object
smaUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is generated by the API. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

endToEndId
string
<= 35 characters
Unique identifier assigned by the payment initiating party

object
Technical details of CENTROlink message

type
required
string
<= 8 characters
Type of message

required
allOf
BIC of the agent from which the message was received

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"
docNo
required
string
<= 16 characters
Document identifier

priority
required
string
<= 2 characters
Priority of the message

required
allOf
Date of formation of the message

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
required
allOf
Date and time at which payment message was received

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentInstructionNo
string
<= 35 characters
Unique identification as assigned by an instructing party

msgId
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 payment identifier as assigned by first instructing agent

paymentCode
string
<= 4 characters
ISO20022 purpose code of the payment

required
allOf
Creditor information. Party to which an amount of money is due.

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.
allOf
Ultimate party to which an amount of money is due

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
allOf
Debtor information. Party that owes an amount of money to the Creditor.

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.
allOf
Initial party that owes an amount of money to the (ultimate) creditor.

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
allOf
Amount of the payment

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.
purpose
string
Remittance information provided by the Debtor

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "PaymentReceivedMessage", "data": [ { "smaUid": "string", "endToEndId": "string", "message": { "type": "FFCCTRNS", "sender": "TESTLT21", "docNo": "string", "priority": 51, "docCreated": "2019-11-21T16:32:59" }, "paymentTimestamp": "2019-11-21T16:32:59", "paymentInstructionNo": "string", "msgId": "string", "txId": "string", "paymentCode": "stri", "recipient": { "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" } } } }, "ultimateRecipient": { "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" }, "payer": { "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" } } } }, "initialPayer": { "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" }, "amount": { "currency": "EUR", "value": 0.01 }, "purpose": "string", "categoryPurpose": "BONU" } ] }

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

Received when outgoing payment request was confirmed by the CENTROlink system and successfully settled

Operation IDlistenPaymentSettled
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
PaymentSettledMessagepaymentSettledMessage
Contains details of settled incoming payment
application/json
Message IDpaymentSettledMessage
object
messageType
required
string
Const:"PaymentSettledMessage"
required
array<object>
non-empty
object
internalId
required
string
<= 255 characters
Unique internal identifier of the original payment

msgId
string
<= 35 characters
Unique identifier of the original payment message (pacs.008)

txId
string
<= 35 characters
Unique payment identifier under which the payment is known to the external parties

paymentType
required
string
A type of previously sent payment that was confirmed (settled)

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "PaymentSettledMessage", "data": [ { "internalId": "string", "msgId": "string", "txId": "string", "paymentType": "OUTGOING_PAYMENT" } ] }

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

This operation is invoked when previously received incoming payment is requested to be cancelled by beneficiary or beneficiary bank

Operation IDlistenPaymentCancelled
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
PaymentCancelledMessagepaymentCancelledMessage
Contains details of incoming payment cancellation request
application/json
Message IDpaymentCancelledMessage
object
messageType
required
string
Const:"PaymentCancelledMessage"
required
array<object>
non-empty
object
originalSmaUid
required
string
<= 255 characters
Unique internal identifier of the original incoming payment

cancellationId
required
string
<= 35 characters
Unique identifier of cancellation request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

settlementDate
required
string
format: date
Date, as provided in the original transaction, on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment cancellation reason code (ISO20022)

Examples values:
"AC03"
"AM09"
"FRAD"
"TECH"
"CUST"
"DUPL"
additionalInfo
string
<= 105 characters
Additional information on payment cancellation

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "PaymentCancelledMessage", "data": [ { "originalSmaUid": "string", "cancellationId": "string", "originalMsgId": "string", "e2eId": "string", "msgId": "string", "txId": "string", "settlementDate": "2019-08-24", "amount": { "currency": "EUR", "value": 0.01 }, "reasonCode": "AC03", "additionalInfo": "string" } ] }

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

This operation is invoked when when previously sent outgoing cancellation request was declined by beneficiary

Operation IDlistenPaymentRetained
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
PaymentRetainedMessagepaymentRetainedMessage
Contains details of outgoing payment retention
application/json
Message IDpaymentRetainedMessage
object
messageType
required
string
Const:"PaymentRetainedMessage"
required
array<object>
non-empty
object
wbUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

retentionId
required
string
<= 35 characters
Unique identifier of retention request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment retention reason code (ISO20022)

Examples values:
"LEGL"
"CUST"
additionalInfo
string
<= 105 characters
Additional retention information

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "PaymentRetainedMessage", "data": [ { "wbUid": "string", "retentionId": "string", "originalMsgId": "string", "e2eId": "string", "msgId": "string", "txId": "string", "amount": { "currency": "EUR", "value": 0.01 }, "reasonCode": "LEGL", "additionalInfo": "string" } ] }

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

This operation is invoked when previously sent outgoing payment was returned by beneficiary bank

Operation IDlistenPaymentReturned
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
PaymentReturnedMessagepaymentReturnedMessage
Contains details of outgoing payment return
application/json
Message IDpaymentReturnedMessage
object
messageType
required
string
Const:"PaymentReturnedMessage"
required
array<object>
non-empty
object
originalWbUid
required
string
<= 255 characters
Unique internal identifier of original incoming payment

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

originalMessageType
string
Type of the payment being returned

Allowed values:
"OUTGOING_PAYMENT"
"PAYMENT_REJECTION"
returnId
required
string
<= 35 characters
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the returned transaction

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money provided in the original payment

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.
required
allOf
Amount of money returned to debtor

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.
reasonCode
required
string
<= 4 characters
Payment return reason code (ISO20022)

Examples values:
"CNOR"
"ERIN"
"AC01"
"AC04"
"AC06"
"AG01"
"AG02"
"AM05"
"BE04"
"FOCR"
"MD07"
"MS02"
"RC01"
"RR01"
"RR02"
"RR03"
"RR04"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "PaymentReturnedMessage", "data": [ { "originalWbUid": "string", "originalMsgId": "string", "originalMessageType": "OUTGOING_PAYMENT", "returnId": "string", "e2eId": "string", "msgId": "string", "txId": "string", "originalAmount": { "currency": "EUR", "value": 0.01 }, "returnedAmount": { "currency": "EUR", "value": 0.01 }, "reasonCode": "CNOR" } ] }

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

This message is received when previously sent payment was rejected by the CENTROlink system. This means that corresponding operation was unsuccessful

Operation IDlistenPaymentRejected
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
PaymentRejectedMessagepaymentRejectedMessage
Contains details of outgoing payment rejection
application/json
Message IDpaymentRejectedMessage
object
messageType
required
string
Const:"PaymentRejectedMessage"
required
array<object>
non-empty
object
originalInternalId
required
string
<= 255 characters
Unique internal identifier of the original 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 transaction

paymentType
required
string
A type of previously sent payment message that was rejected

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

CANCELLED_OUTGOING_PAYMENT -- Outgoing payment cancellation request

NON_RECEIPT_CLAIM -- Payment non-receipt claim

DATE_CORRECTION_CLAIM -- Payment date correction claim

CLAIM_RESOLUTION -- Payment claim resolution

STATUS_REQUEST -- Payment claim status request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
"CANCELLED_OUTGOING_PAYMENT"
"NON_RECEIPT_CLAIM"
"DATE_CORRECTION_CLAIM"
"CLAIM_RESOLUTION"
"STATUS_REQUEST"
rejectionReason
required
string
A reason for payment rejection.

ZERO_AMOUNT -- Zero Amount

NOT_ALLOWED_AMOUNT -- Not allowed amount

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement failed

UNKNOWN_BIC -- Unknown BIC in in the directory of participants

INVALID_IBAN -- Invalid IBAN format (not compliant with ISO 13616 format)

INVALID_DATA_FORMAT -- Invalid data format

INVALID_COUNTRY_CODE -- Invalid country code (is not on the list of the codes of SWIFT countries)

INVALID_ORIGINAL_TRANSACTION_STATUS -- Invalid original transaction status; action required

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- Invalid original transaction status; no action required

ORIGINAL_AMOUNT_MISMATCH -- Original Amount mismatch (in the R-message)

SETTLEMENT_CYCLE_NOT_AVAILABLE -- No settlement cycle available on the current business date for both Debtor and Creditor agents

EXPIRED_CANCELLATION_TIME_LIMIT -- Payment cancellation request rejected due to expired time limit for the credit transfer cancellation

AGENT_MISMATCH_TO_ORIGINAL -- R-msg transaction not following the same DP route / sending DP not identical to the Instructing / Instructed Agent of the original transaction

INVALID_TECH_BIC -- Invalid use of technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- The country code in the CreditorAgent BIC is one of the following: 'PF', 'NC' or 'WF', while the country code in the Debtor Agent BIC is not one of the following: 'FR', 'GP', 'RE', 'MQ', 'GF', 'PM', 'PF', 'NC', 'WF', 'BL', 'MF' or 'YT'.

SENDER_SUSPENDED -- The sending participant suspended

RECEIVER_SUSPENDED -- The receiving participant suspended

SEPA_SYNTAX_ERROR -- Syntax error

SEPA_CONTEXT_ERROR -- Business error

CANCELLED_BEFORE_CLEARING -- Request for cancellation of the credit transfer received prior to its execution. The credit transfer was not settled

Allowed values:
"ZERO_AMOUNT"
"NOT_ALLOWED_AMOUNT"
"DUPLICATION"
"SETTLEMENT_FAILED"
"UNKNOWN_BIC"
"INVALID_IBAN"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"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_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
string allOf
Rejection originator BIC

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"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "PaymentRejectedMessage", "data": [ { "originalInternalId": "string", "msgId": "string", "txId": "string", "paymentType": "OUTGOING_PAYMENT", "rejectionReason": "ZERO_AMOUNT", "originatorBic": "TESTLT21" } ] }

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

This operation is invoked when new payment non receipt claim is received

Operation IDlistenNonReceiptClaim
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
NonReceiptClaimMessagenonReceiptClaimMessage
Contains details of payment non-receipt claim
application/json
Message IDnonReceiptClaimMessage
object
messageType
required
string
Const:"NonReceiptClaimMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment

claimId
required
string
<= 35 characters
Unique identifier of the claim

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

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "NonReceiptClaimMessage", "data": [ { "originalPaymentUid": "string", "claimId": "string", "msgId": "string", "txId": "string", "additionalInstructions": "string" } ] }

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

This operation is invoked when new payment date correction claim is received

Operation IDlistenDateCorrectionClaim
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
DateCorrectionClaimMessagedateCorrectionClaimMessage
Contains details of payment date correction claim
application/json
Message IDdateCorrectionClaimMessage
object
messageType
required
string
Const:"DateCorrectionClaimMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique 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 transaction

additionalInfo
string
<= 140 characters
Additional instructions

claimId
required
string
<= 35 characters
Unique identifier of the claim

claimedSettlementDate
required
string
format: date
Claimed new payment settlement date

originalSettlementDate
required
string
format: date
Original payment settlement date

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DateCorrectionClaimMessage", "data": [ { "originalPaymentUid": "string", "msgId": "string", "txId": "string", "additionalInfo": "string", "claimId": "string", "claimedSettlementDate": "2019-08-24", "originalSettlementDate": "2019-08-24" } ] }

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

This operation is invoked when previously sent payment date correction or payment non receipt claim was resolved

Operation IDlistenClaimResolution
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
ClaimResolutionMessageclaimResolutionMessage
Contains details of claim resolution result
application/json
Message IDclaimResolutionMessage
object
messageType
required
string
Const:"ClaimResolutionMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
resolutionId
required
string
<= 35 characters
Unique id of the claim resolution

allOf
One of possible claim rejection reasons. Applicable only for negative resolutions of payment non-receipt claims

Consists of:
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
claimedSettlementDate
string
format: date
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

allOf
Transaction charges to be paid by the charge bearer.

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.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "ClaimResolutionMessage", "data": [ { "originalPaymentUid": "string", "msgId": "string", "txId": "string", "resolution": "ACCEPTED_NON_RECEIPT", "resolutionId": "string", "rejectionReason": "ORIGINAL_TX_NOT_RECEIVED", "claimedSettlementDate": "2019-08-24", "chargeAmount": { "currency": "EUR", "value": 0.01 } } ] }

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

This operation allows to receive information about incoming and outgoing transactions committed during business day

Operation IDlistenTransactionsReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
TransactionsReportMessagetransactionsReportMessage
Contains details of daily transactions report
application/json
Message IDtransactionsReportMessage
object
messageType
required
string
Const:"TransactionsReportMessage"
required
array<object>
non-empty
object
reportMsgId
required
string
<= 16 characters
Unique identifier of report message

pageNumber
integer
Number of page (In case pagination is used)

last
boolean
Indicator of the last page (In case pagination is used)

transactionCount
required
integer
Number of transactions in given report

totalCreditDebitIndicator
required
string
Indicator of net amount of transactions in the given report

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Net amount of transactions in the given report

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.
array<object>
object
creditDebitIndicator
required
string
Debit/credit indicator of transaction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Amount of transaction

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.
required
allOf
Information on debtor's account

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"
Additional properties are allowed.
required
allOf
Information on creditor's account

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"
Additional properties are allowed.
required
allOf
Date and time when the payment was accepted

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Date and time of the payment

Consists of:
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
Date when the payment was settled

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "TransactionsReportMessage", "data": [ { "reportMsgId": "string", "pageNumber": 0, "last": true, "transactionCount": 0, "totalCreditDebitIndicator": "DEBIT", "totalAmount": { "currency": "EUR", "value": 0.01 }, "transactions": [ { "creditDebitIndicator": "DEBIT", "amount": { "currency": "EUR", "value": 0.01 }, "debtor": { "iban": "LT121000011101001000", "bic": "TESTLT21" }, "creditor": { "iban": "LT121000011101001000", "bic": "TESTLT21" }, "acceptanceDateTime": "2019-11-21T16:32:59", "transactionDateTime": "2019-11-21T16:32:59", "settlementDate": "2019-08-24" } ] } ] }

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

This operation is invoked when a previously sent outgoing message did not pass syntax validation check.

Operation IDlistenInvalidPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InvalidPaymentMessageinvalidPaymentMessage
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

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

additionalInfo
required
string
Description of validation error(s)

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InvalidPayment", "data": [ { "internalId": "string", "msgId": "string", "txId": "string", "additionalInfo": "string" } ] }

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

This operation allows to receive incoming status requests related to previously received payment non-receipt claim

Operation IDlistenNonReceiptClaimStatusRequest
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
NonReceiptClaimStatusRequestMessagenonReceiptClaimStatusRequestMessage
Contains details of incoming payment non-receipt claim status request
application/json
Message IDnonReceiptClaimStatusRequestMessage
object
messageType
required
string
Const:"NonReceiptClaimStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "NonReceiptClaimStatusRequestMessage", "data": [ { "originalPaymentUid": "string", "statusRequestId": "string" } ] }

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

This operation allows to receive incoming status requests related to previously received payment date correction claim

Operation IDlistenDateCorrectionClaimStatusRequest
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
DateCorrectionClaimStatusRequestMessagedateCorrectionClaimStatusRequestMessage
Contains details of incoming payment date correction claim status request
application/json
Message IDdateCorrectionClaimStatusRequestMessage
object
messageType
required
string
Const:"DateCorrectionClaimStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "DateCorrectionClaimStatusRequestMessage", "data": [ { "originalPaymentUid": "string", "statusRequestId": "string" } ] }

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

This operation allows to receive information regarding liquidity account(s) balance position during daily operations specifying turnovers with specific counterparties

Operation IDlistenSepaCreditAccountStatementReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
SepaCreditAccountStatementReportMessagesepaCreditAccountStatementReportMessage
Contains details of incoming account statement report
application/json
Message IDsepaCreditAccountStatementReportMessage
object
messageType
required
string
Const:"SepaCreditAccountStatementReportMessage"
required
array<object>
non-empty
object
msgId
required
string
<= 16 characters
Unique identifier of report message

documentId
required
string
<= 16 characters
Unique identifier of the document

required
allOf
Document forming timestamp

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Account owner’s BIC

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"
required
allOf
Account number

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
Account currency

Consists of:
string
must match: [A-Z]{3,3}
Currency code (ISO 4217)

Examples values:
"EUR"
"USD"
required
allOf
Balance on account at the beginning of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
required
allOf
Balance on account at the end of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
array<object>
Information about turnover by each counterparty

object
Information about turnover by counterparty

required
allOf
BIC of the counterparty

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"
required
allOf
Account number of the counterparty

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
array<object>
Information about transactions of specific direction

object
Information about transactions of specific direction

type
required
string
Type of direction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Total amount of transactions

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

transactionCount
required
integer
Transaction count

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "SepaCreditAccountStatementReportMessage", "data": [ { "msgId": "string", "documentId": "string", "documentDateTime": "2019-11-21T16:32:59", "bic": "TESTLT21", "account": "LT121000011101001000", "currency": "EUR", "openingBalance": { "balance": 0.01, "availableBalance": 0.01 }, "closingBalance": { "balance": 0.01, "availableBalance": 0.01 }, "turnoversByParticipant": [ { "bic": "TESTLT21", "account": "LT121000011101001000", "directions": [ { "type": "DEBIT", "amount": 0.01, "transactionCount": 0 } ] } ] } ] }

This example has been generated automatically.

Messages

#1OutgoingPaymentMessageoutgoingPaymentMessage
Contains details of outgoing payment creation request
- application/json
Message IDoutgoingPaymentMessage
object
messageType
required
string
Const:"OutgoingPaymentMessage"
required
array<object>
1 items
object
wbUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is internal to the API and will not be forwarded to the external party. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

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

endToEndId
string
[ 1 .. 35 ] characters
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

allOf
Payment creation timestamp from the payer’s perspective. It will be used as a payment settlement date if possible.

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Debtor information. Party that owes an amount of money to the Creditor

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
allOf
Creditor information. Party to which an amount of money is due.

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
allOf
Amount of the payment

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.
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

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
Additional properties are allowed.
#2RejectPaymentMessagerejectPaymentMessage
Contains details of incoming payment return request
- application/json
Message IDrejectPaymentMessage
object
messageType
required
string
Const:"RejectPaymentMessage"
required
array<object>
1 items
object
internalSepaMmsPaymentUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

ACCOUNT_NUMBER_PROBLEM -- Incorrect Account Number or the Account Number does not exist

CLOSED_ACCOUNT -- The account is closed

BLOCKED_ACCOUNT -- The account is blocked; the reason is not specified

WRONG_ACCOUNT_TYPE -- For this type of account credit transfers are forbidden (e.g. a time deposit account)

DUPLICATE -- Duplication

CREDITOR_ADDRESS_PROBLEM -- Missing Creditor Address

FOLLOWING_CANCELLATION_REQUEST -- Following Cancellation Request

DECEASED_CUSTOMER -- End Customer Deceased

NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

REGULATORY_REASON -- Regulatory reason.

Allowed values:
"ACCOUNT_NUMBER_PROBLEM"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"WRONG_ACCOUNT_TYPE"
"DUPLICATE"
"CREDITOR_ADDRESS_PROBLEM"
"FOLLOWING_CANCELLATION_REQUEST"
"DECEASED_CUSTOMER"
"NOT_SPECIFIED_BY_CUSTOMER"
allOf
How much money was charged from recipient (in cases when it is allowed to do so). This field is only allowed when reasonCode is FOLLOWING_CANCELLATION_REQUEST

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.
originatorName
string
<= 70 characters
Rejection originator name

string allOf
Rejection originator BIC

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"
Additional properties are allowed.
Additional properties are allowed.
#3CancelPaymentMessagecancelPaymentMessage
Contains details of outgoing payment cancellation request
- application/json
Message IDcancelPaymentMessage
object
messageType
required
string
Const:"CancelPaymentMessage"
required
array<object>
1 items
object
internalUid
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 transaction

reasonCode
required
string

DUPLICATE -- Payment was duplicated

REQUESTED_BY_ORIGINATOR -- Originator of payment requested its cancellation

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

Allowed values:
"DUPLICATE"
"REQUESTED_BY_ORIGINATOR"
"FRAUD"
"TECHNICAL_ISSUE"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Can only be specified if reasonCode is FRAUD

Additional properties are allowed.
Additional properties are allowed.
#4RetainPaymentMessageretainPaymentMessage
Contains details of incoming payment retainment decision
- application/json
Message IDretainPaymentMessage
object
messageType
required
string
Const:"RetainPaymentMessage"
required
array<object>
1 items
object
internalSepaMmsAppUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

INSUFFICIENT_FUNDS -- There are insufficient funds on the account

CLOSED_ACCOUNT -- The account is closed

LEGAL_REASONS -- For legal reasons, specifying the reason in clear text

REFUSAL -- Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR -- No answer is received from the Creditor

NO_FUNDS_RECEIVED -- The funds were not received

ALREADY_RETURNED -- The funds have already been returned

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
legalInfo
required
string
<= 210 characters
Additional retention information

Additional properties are allowed.
Additional properties are allowed.
#5ClaimNonReceiptMessageclaimNonReceiptMessage
Contains details of payment non-receipt claim
- application/json
Message IDclaimNonReceiptMessage
object
messageType
required
string
Const:"ClaimNonReceiptMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
Additional properties are allowed.
#6ClaimDateCorrectionMessageclaimDateCorrectionMessage
Contains details of payment date correction claim
- application/json
Message IDclaimDateCorrectionMessage
object
messageType
required
string
Const:"ClaimDateCorrectionMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
required
string
<= 140 characters
Additional instructions

required
allOf
Claimed new payment settlement date

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
Additional properties are allowed.
#7ResolveClaimMessageresolveClaimMessage
Contains details of positive or negative resolution of incoming claim
- application/json
Message IDresolveClaimMessage
object
messageType
required
string
Const:"ResolveClaimMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
reasonCode
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
allOf
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
allOf
Transaction charges to be paid by the charge bearer. Can be only specified when resolution type is one of: ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION

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.
Additional properties are allowed.
Additional properties are allowed.
#8RequestNonReceiptClaimStatusMessagerequestNonReceiptClaimStatusMessage
Contains details of outgoing payment non-receipt claim status request
- application/json
Message IDrequestNonReceiptClaimStatusMessage
object
messageType
required
string
Const:"RequestNonReceiptClaimStatusMessage"
required
array<object>
1 items
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
Additional properties are allowed.
#9RequestDateCorrectionClaimStatusMessagerequestDateCorrectionClaimStatusMessage
Contains details of outgoing payment date correction claim status request
- application/json
Message IDrequestDateCorrectionClaimStatusMessage
object
messageType
required
string
Const:"RequestDateCorrectionClaimStatusMessage"
required
array<object>
1 items
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
Additional properties are allowed.
#10PaymentReceivedMessagepaymentReceivedMessage
Contains details of received incoming payment
- application/json
Message IDpaymentReceivedMessage
object
messageType
required
string
Const:"PaymentReceivedMessage"
required
array<object>
non-empty
object
smaUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is generated by the API. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

endToEndId
string
<= 35 characters
Unique identifier assigned by the payment initiating party

object
Technical details of CENTROlink message

type
required
string
<= 8 characters
Type of message

required
allOf
BIC of the agent from which the message was received

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"
docNo
required
string
<= 16 characters
Document identifier

priority
required
string
<= 2 characters
Priority of the message

required
allOf
Date of formation of the message

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
required
allOf
Date and time at which payment message was received

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentInstructionNo
string
<= 35 characters
Unique identification as assigned by an instructing party

msgId
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 payment identifier as assigned by first instructing agent

paymentCode
string
<= 4 characters
ISO20022 purpose code of the payment

required
allOf
Creditor information. Party to which an amount of money is due.

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.
allOf
Ultimate party to which an amount of money is due

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
allOf
Debtor information. Party that owes an amount of money to the Creditor.

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.
allOf
Initial party that owes an amount of money to the (ultimate) creditor.

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
allOf
Amount of the payment

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.
purpose
string
Remittance information provided by the Debtor

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
Additional properties are allowed.
#11PaymentSettledMessagepaymentSettledMessage
Contains details of settled incoming payment
- application/json
Message IDpaymentSettledMessage
object
messageType
required
string
Const:"PaymentSettledMessage"
required
array<object>
non-empty
object
internalId
required
string
<= 255 characters
Unique internal identifier of the original payment

msgId
string
<= 35 characters
Unique identifier of the original payment message (pacs.008)

txId
string
<= 35 characters
Unique payment identifier under which the payment is known to the external parties

paymentType
required
string
A type of previously sent payment that was confirmed (settled)

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
Additional properties are allowed.
Additional properties are allowed.
#12PaymentRejectedMessagepaymentRejectedMessage
Contains details of outgoing payment rejection
- application/json
Message IDpaymentRejectedMessage
object
messageType
required
string
Const:"PaymentRejectedMessage"
required
array<object>
non-empty
object
originalInternalId
required
string
<= 255 characters
Unique internal identifier of the original 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 transaction

paymentType
required
string
A type of previously sent payment message that was rejected

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

CANCELLED_OUTGOING_PAYMENT -- Outgoing payment cancellation request

NON_RECEIPT_CLAIM -- Payment non-receipt claim

DATE_CORRECTION_CLAIM -- Payment date correction claim

CLAIM_RESOLUTION -- Payment claim resolution

STATUS_REQUEST -- Payment claim status request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
"CANCELLED_OUTGOING_PAYMENT"
"NON_RECEIPT_CLAIM"
"DATE_CORRECTION_CLAIM"
"CLAIM_RESOLUTION"
"STATUS_REQUEST"
rejectionReason
required
string
A reason for payment rejection.

ZERO_AMOUNT -- Zero Amount

NOT_ALLOWED_AMOUNT -- Not allowed amount

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement failed

UNKNOWN_BIC -- Unknown BIC in in the directory of participants

INVALID_IBAN -- Invalid IBAN format (not compliant with ISO 13616 format)

INVALID_DATA_FORMAT -- Invalid data format

INVALID_COUNTRY_CODE -- Invalid country code (is not on the list of the codes of SWIFT countries)

INVALID_ORIGINAL_TRANSACTION_STATUS -- Invalid original transaction status; action required

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- Invalid original transaction status; no action required

ORIGINAL_AMOUNT_MISMATCH -- Original Amount mismatch (in the R-message)

SETTLEMENT_CYCLE_NOT_AVAILABLE -- No settlement cycle available on the current business date for both Debtor and Creditor agents

EXPIRED_CANCELLATION_TIME_LIMIT -- Payment cancellation request rejected due to expired time limit for the credit transfer cancellation

AGENT_MISMATCH_TO_ORIGINAL -- R-msg transaction not following the same DP route / sending DP not identical to the Instructing / Instructed Agent of the original transaction

INVALID_TECH_BIC -- Invalid use of technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- The country code in the CreditorAgent BIC is one of the following: 'PF', 'NC' or 'WF', while the country code in the Debtor Agent BIC is not one of the following: 'FR', 'GP', 'RE', 'MQ', 'GF', 'PM', 'PF', 'NC', 'WF', 'BL', 'MF' or 'YT'.

SENDER_SUSPENDED -- The sending participant suspended

RECEIVER_SUSPENDED -- The receiving participant suspended

SEPA_SYNTAX_ERROR -- Syntax error

SEPA_CONTEXT_ERROR -- Business error

CANCELLED_BEFORE_CLEARING -- Request for cancellation of the credit transfer received prior to its execution. The credit transfer was not settled

Allowed values:
"ZERO_AMOUNT"
"NOT_ALLOWED_AMOUNT"
"DUPLICATION"
"SETTLEMENT_FAILED"
"UNKNOWN_BIC"
"INVALID_IBAN"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"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_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
string allOf
Rejection originator BIC

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"
Additional properties are allowed.
Additional properties are allowed.
#13PaymentReturnedMessagepaymentReturnedMessage
Contains details of outgoing payment return
- application/json
Message IDpaymentReturnedMessage
object
messageType
required
string
Const:"PaymentReturnedMessage"
required
array<object>
non-empty
object
originalWbUid
required
string
<= 255 characters
Unique internal identifier of original incoming payment

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

originalMessageType
string
Type of the payment being returned

Allowed values:
"OUTGOING_PAYMENT"
"PAYMENT_REJECTION"
returnId
required
string
<= 35 characters
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the returned transaction

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money provided in the original payment

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.
required
allOf
Amount of money returned to debtor

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.
reasonCode
required
string
<= 4 characters
Payment return reason code (ISO20022)

Examples values:
"CNOR"
"ERIN"
"AC01"
"AC04"
"AC06"
"AG01"
"AG02"
"AM05"
"BE04"
"FOCR"
"MD07"
"MS02"
"RC01"
"RR01"
"RR02"
"RR03"
"RR04"
Additional properties are allowed.
Additional properties are allowed.
#14PaymentCancelledMessagepaymentCancelledMessage
Contains details of incoming payment cancellation request
- application/json
Message IDpaymentCancelledMessage
object
messageType
required
string
Const:"PaymentCancelledMessage"
required
array<object>
non-empty
object
originalSmaUid
required
string
<= 255 characters
Unique internal identifier of the original incoming payment

cancellationId
required
string
<= 35 characters
Unique identifier of cancellation request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

settlementDate
required
string
format: date
Date, as provided in the original transaction, on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment cancellation reason code (ISO20022)

Examples values:
"AC03"
"AM09"
"FRAD"
"TECH"
"CUST"
"DUPL"
additionalInfo
string
<= 105 characters
Additional information on payment cancellation

Additional properties are allowed.
Additional properties are allowed.
#15PaymentRetainedMessagepaymentRetainedMessage
Contains details of outgoing payment retention
- application/json
Message IDpaymentRetainedMessage
object
messageType
required
string
Const:"PaymentRetainedMessage"
required
array<object>
non-empty
object
wbUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

retentionId
required
string
<= 35 characters
Unique identifier of retention request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment retention reason code (ISO20022)

Examples values:
"LEGL"
"CUST"
additionalInfo
string
<= 105 characters
Additional retention information

Additional properties are allowed.
Additional properties are allowed.
#16NonReceiptClaimMessagenonReceiptClaimMessage
Contains details of payment non-receipt claim
- application/json
Message IDnonReceiptClaimMessage
object
messageType
required
string
Const:"NonReceiptClaimMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment

claimId
required
string
<= 35 characters
Unique identifier of the claim

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

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
Additional properties are allowed.
#17DateCorrectionClaimMessagedateCorrectionClaimMessage
Contains details of payment date correction claim
- application/json
Message IDdateCorrectionClaimMessage
object
messageType
required
string
Const:"DateCorrectionClaimMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique 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 transaction

additionalInfo
string
<= 140 characters
Additional instructions

claimId
required
string
<= 35 characters
Unique identifier of the claim

claimedSettlementDate
required
string
format: date
Claimed new payment settlement date

originalSettlementDate
required
string
format: date
Original payment settlement date

Additional properties are allowed.
Additional properties are allowed.
#18ClaimResolutionMessageclaimResolutionMessage
Contains details of claim resolution result
- application/json
Message IDclaimResolutionMessage
object
messageType
required
string
Const:"ClaimResolutionMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
resolutionId
required
string
<= 35 characters
Unique id of the claim resolution

allOf
One of possible claim rejection reasons. Applicable only for negative resolutions of payment non-receipt claims

Consists of:
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
claimedSettlementDate
string
format: date
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

allOf
Transaction charges to be paid by the charge bearer.

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.
Additional properties are allowed.
Additional properties are allowed.
#19TransactionsReportMessagetransactionsReportMessage
Contains details of daily transactions report
- application/json
Message IDtransactionsReportMessage
object
messageType
required
string
Const:"TransactionsReportMessage"
required
array<object>
non-empty
object
reportMsgId
required
string
<= 16 characters
Unique identifier of report message

pageNumber
integer
Number of page (In case pagination is used)

last
boolean
Indicator of the last page (In case pagination is used)

transactionCount
required
integer
Number of transactions in given report

totalCreditDebitIndicator
required
string
Indicator of net amount of transactions in the given report

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Net amount of transactions in the given report

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.
array<object>
object
creditDebitIndicator
required
string
Debit/credit indicator of transaction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Amount of transaction

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.
required
allOf
Information on debtor's account

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"
Additional properties are allowed.
required
allOf
Information on creditor's account

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"
Additional properties are allowed.
required
allOf
Date and time when the payment was accepted

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Date and time of the payment

Consists of:
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
Date when the payment was settled

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#20InvalidPaymentMessageinvalidPaymentMessage
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

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

additionalInfo
required
string
Description of validation error(s)

Additional properties are allowed.
Additional properties are allowed.
#21NonReceiptClaimStatusRequestMessagenonReceiptClaimStatusRequestMessage
Contains details of incoming payment non-receipt claim status request
- application/json
Message IDnonReceiptClaimStatusRequestMessage
object
messageType
required
string
Const:"NonReceiptClaimStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
Additional properties are allowed.
#22DateCorrectionClaimStatusRequestMessagedateCorrectionClaimStatusRequestMessage
Contains details of incoming payment date correction claim status request
- application/json
Message IDdateCorrectionClaimStatusRequestMessage
object
messageType
required
string
Const:"DateCorrectionClaimStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
Additional properties are allowed.
#23SepaCreditAccountStatementReportMessagesepaCreditAccountStatementReportMessage
Contains details of incoming account statement report
- application/json
Message IDsepaCreditAccountStatementReportMessage
object
messageType
required
string
Const:"SepaCreditAccountStatementReportMessage"
required
array<object>
non-empty
object
msgId
required
string
<= 16 characters
Unique identifier of report message

documentId
required
string
<= 16 characters
Unique identifier of the document

required
allOf
Document forming timestamp

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Account owner’s BIC

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"
required
allOf
Account number

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
Account currency

Consists of:
string
must match: [A-Z]{3,3}
Currency code (ISO 4217)

Examples values:
"EUR"
"USD"
required
allOf
Balance on account at the beginning of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
required
allOf
Balance on account at the end of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
array<object>
Information about turnover by each counterparty

object
Information about turnover by counterparty

required
allOf
BIC of the counterparty

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"
required
allOf
Account number of the counterparty

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
array<object>
Information about transactions of specific direction

object
Information about transactions of specific direction

type
required
string
Type of direction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Total amount of transactions

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

transactionCount
required
integer
Transaction count

Additional properties are allowed.
Additional properties are allowed.
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.
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"
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.
categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
paymentReturnReasonCode
string

ACCOUNT_NUMBER_PROBLEM -- Incorrect Account Number or the Account Number does not exist

CLOSED_ACCOUNT -- The account is closed

BLOCKED_ACCOUNT -- The account is blocked; the reason is not specified

WRONG_ACCOUNT_TYPE -- For this type of account credit transfers are forbidden (e.g. a time deposit account)

DUPLICATE -- Duplication

CREDITOR_ADDRESS_PROBLEM -- Missing Creditor Address

FOLLOWING_CANCELLATION_REQUEST -- Following Cancellation Request

DECEASED_CUSTOMER -- End Customer Deceased

NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

REGULATORY_REASON -- Regulatory reason.

Allowed values:
"ACCOUNT_NUMBER_PROBLEM"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"WRONG_ACCOUNT_TYPE"
"DUPLICATE"
"CREDITOR_ADDRESS_PROBLEM"
"FOLLOWING_CANCELLATION_REQUEST"
"DECEASED_CUSTOMER"
"NOT_SPECIFIED_BY_CUSTOMER"
iso20022PaymentReturnReasonCode
string
<= 4 characters
Payment return reason code (ISO20022)

Examples values:
"CNOR"
"ERIN"
"AC01"
"AC04"
"AC06"
"AG01"
"AG02"
"AM05"
"BE04"
"FOCR"
"MD07"
"MS02"
"RC01"
"RR01"
"RR02"
"RR03"
"RR04"
paymentRejectionReasonCode
string
A reason for payment rejection.

ZERO_AMOUNT -- Zero Amount

NOT_ALLOWED_AMOUNT -- Not allowed amount

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement failed

UNKNOWN_BIC -- Unknown BIC in in the directory of participants

INVALID_IBAN -- Invalid IBAN format (not compliant with ISO 13616 format)

INVALID_DATA_FORMAT -- Invalid data format

INVALID_COUNTRY_CODE -- Invalid country code (is not on the list of the codes of SWIFT countries)

INVALID_ORIGINAL_TRANSACTION_STATUS -- Invalid original transaction status; action required

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- Invalid original transaction status; no action required

ORIGINAL_AMOUNT_MISMATCH -- Original Amount mismatch (in the R-message)

SETTLEMENT_CYCLE_NOT_AVAILABLE -- No settlement cycle available on the current business date for both Debtor and Creditor agents

EXPIRED_CANCELLATION_TIME_LIMIT -- Payment cancellation request rejected due to expired time limit for the credit transfer cancellation

AGENT_MISMATCH_TO_ORIGINAL -- R-msg transaction not following the same DP route / sending DP not identical to the Instructing / Instructed Agent of the original transaction

INVALID_TECH_BIC -- Invalid use of technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- The country code in the CreditorAgent BIC is one of the following: 'PF', 'NC' or 'WF', while the country code in the Debtor Agent BIC is not one of the following: 'FR', 'GP', 'RE', 'MQ', 'GF', 'PM', 'PF', 'NC', 'WF', 'BL', 'MF' or 'YT'.

SENDER_SUSPENDED -- The sending participant suspended

RECEIVER_SUSPENDED -- The receiving participant suspended

SEPA_SYNTAX_ERROR -- Syntax error

SEPA_CONTEXT_ERROR -- Business error

CANCELLED_BEFORE_CLEARING -- Request for cancellation of the credit transfer received prior to its execution. The credit transfer was not settled

Allowed values:
"ZERO_AMOUNT"
"NOT_ALLOWED_AMOUNT"
"DUPLICATION"
"SETTLEMENT_FAILED"
"UNKNOWN_BIC"
"INVALID_IBAN"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"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_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
paymentCancellationReasonCode
string

DUPLICATE -- Payment was duplicated

REQUESTED_BY_ORIGINATOR -- Originator of payment requested its cancellation

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

Allowed values:
"DUPLICATE"
"REQUESTED_BY_ORIGINATOR"
"FRAUD"
"TECHNICAL_ISSUE"
iso20022PaymentCancellationReasonCode
string
<= 4 characters
Payment cancellation reason code (ISO20022)

Examples values:
"AC03"
"AM09"
"FRAD"
"TECH"
"CUST"
"DUPL"
paymentRetentionReasonCode
string

INSUFFICIENT_FUNDS -- There are insufficient funds on the account

CLOSED_ACCOUNT -- The account is closed

LEGAL_REASONS -- For legal reasons, specifying the reason in clear text

REFUSAL -- Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR -- No answer is received from the Creditor

NO_FUNDS_RECEIVED -- The funds were not received

ALREADY_RETURNED -- The funds have already been returned

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
iso20022PaymentRetentionReasonCode
string
<= 4 characters
Payment retention reason code (ISO20022)

Examples values:
"LEGL"
"CUST"
claimResolutionTypeCode
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
claimRejectionReasonCode
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
object
Technical details of CENTROlink message

type
required
string
<= 8 characters
Type of message

required
allOf
BIC of the agent from which the message was received

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"
docNo
required
string
<= 16 characters
Document identifier

priority
required
string
<= 2 characters
Priority of the message

required
allOf
Date of formation of the message

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
object
messageType
required
string
Const:"OutgoingPaymentMessage"
required
array<object>
1 items
object
wbUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is internal to the API and will not be forwarded to the external party. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

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

endToEndId
string
[ 1 .. 35 ] characters
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

allOf
Payment creation timestamp from the payer’s perspective. It will be used as a payment settlement date if possible.

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Debtor information. Party that owes an amount of money to the Creditor

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
allOf
Creditor information. Party to which an amount of money is due.

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
allOf
Amount of the payment

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.
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

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
Additional properties are allowed.
object
wbUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is internal to the API and will not be forwarded to the external party. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

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

endToEndId
string
[ 1 .. 35 ] characters
Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

allOf
Payment creation timestamp from the payer’s perspective. It will be used as a payment settlement date if possible.

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Debtor information. Party that owes an amount of money to the Creditor

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
allOf
Creditor information. Party to which an amount of money is due.

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
allOf
Amount of the payment

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.
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

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
object
messageType
required
string
Const:"RejectPaymentMessage"
required
array<object>
1 items
object
internalSepaMmsPaymentUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

ACCOUNT_NUMBER_PROBLEM -- Incorrect Account Number or the Account Number does not exist

CLOSED_ACCOUNT -- The account is closed

BLOCKED_ACCOUNT -- The account is blocked; the reason is not specified

WRONG_ACCOUNT_TYPE -- For this type of account credit transfers are forbidden (e.g. a time deposit account)

DUPLICATE -- Duplication

CREDITOR_ADDRESS_PROBLEM -- Missing Creditor Address

FOLLOWING_CANCELLATION_REQUEST -- Following Cancellation Request

DECEASED_CUSTOMER -- End Customer Deceased

NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

REGULATORY_REASON -- Regulatory reason.

Allowed values:
"ACCOUNT_NUMBER_PROBLEM"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"WRONG_ACCOUNT_TYPE"
"DUPLICATE"
"CREDITOR_ADDRESS_PROBLEM"
"FOLLOWING_CANCELLATION_REQUEST"
"DECEASED_CUSTOMER"
"NOT_SPECIFIED_BY_CUSTOMER"
allOf
How much money was charged from recipient (in cases when it is allowed to do so). This field is only allowed when reasonCode is FOLLOWING_CANCELLATION_REQUEST

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.
originatorName
string
<= 70 characters
Rejection originator name

string allOf
Rejection originator BIC

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"
Additional properties are allowed.
Additional properties are allowed.
object
internalSepaMmsPaymentUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

ACCOUNT_NUMBER_PROBLEM -- Incorrect Account Number or the Account Number does not exist

CLOSED_ACCOUNT -- The account is closed

BLOCKED_ACCOUNT -- The account is blocked; the reason is not specified

WRONG_ACCOUNT_TYPE -- For this type of account credit transfers are forbidden (e.g. a time deposit account)

DUPLICATE -- Duplication

CREDITOR_ADDRESS_PROBLEM -- Missing Creditor Address

FOLLOWING_CANCELLATION_REQUEST -- Following Cancellation Request

DECEASED_CUSTOMER -- End Customer Deceased

NOT_SPECIFIED_BY_CUSTOMER -- Not Specified Reason Customer Generated

NOT_SPECIFIED_BY_AGENT -- Not Specified Reason Agent Generated

REGULATORY_REASON -- Regulatory reason.

Allowed values:
"ACCOUNT_NUMBER_PROBLEM"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"WRONG_ACCOUNT_TYPE"
"DUPLICATE"
"CREDITOR_ADDRESS_PROBLEM"
"FOLLOWING_CANCELLATION_REQUEST"
"DECEASED_CUSTOMER"
"NOT_SPECIFIED_BY_CUSTOMER"
allOf
How much money was charged from recipient (in cases when it is allowed to do so). This field is only allowed when reasonCode is FOLLOWING_CANCELLATION_REQUEST

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.
originatorName
string
<= 70 characters
Rejection originator name

string allOf
Rejection originator BIC

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"
Additional properties are allowed.
object
messageType
required
string
Const:"CancelPaymentMessage"
required
array<object>
1 items
object
internalUid
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 transaction

reasonCode
required
string

DUPLICATE -- Payment was duplicated

REQUESTED_BY_ORIGINATOR -- Originator of payment requested its cancellation

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

Allowed values:
"DUPLICATE"
"REQUESTED_BY_ORIGINATOR"
"FRAUD"
"TECHNICAL_ISSUE"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Can only be specified if reasonCode is FRAUD

Additional properties are allowed.
Additional properties are allowed.
object
internalUid
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 transaction

reasonCode
required
string

DUPLICATE -- Payment was duplicated

REQUESTED_BY_ORIGINATOR -- Originator of payment requested its cancellation

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

Allowed values:
"DUPLICATE"
"REQUESTED_BY_ORIGINATOR"
"FRAUD"
"TECHNICAL_ISSUE"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Can only be specified if reasonCode is FRAUD

Additional properties are allowed.
object
messageType
required
string
Const:"RetainPaymentMessage"
required
array<object>
1 items
object
internalSepaMmsAppUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

INSUFFICIENT_FUNDS -- There are insufficient funds on the account

CLOSED_ACCOUNT -- The account is closed

LEGAL_REASONS -- For legal reasons, specifying the reason in clear text

REFUSAL -- Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR -- No answer is received from the Creditor

NO_FUNDS_RECEIVED -- The funds were not received

ALREADY_RETURNED -- The funds have already been returned

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
legalInfo
required
string
<= 210 characters
Additional retention information

Additional properties are allowed.
Additional properties are allowed.
object
internalSepaMmsAppUid
required
string
<= 255 characters
Unique 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 transaction

reasonCode
required
string

INSUFFICIENT_FUNDS -- There are insufficient funds on the account

CLOSED_ACCOUNT -- The account is closed

LEGAL_REASONS -- For legal reasons, specifying the reason in clear text

REFUSAL -- Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR -- No answer is received from the Creditor

NO_FUNDS_RECEIVED -- The funds were not received

ALREADY_RETURNED -- The funds have already been returned

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
legalInfo
required
string
<= 210 characters
Additional retention information

Additional properties are allowed.
object
messageType
required
string
Const:"ClaimNonReceiptMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
Additional properties are allowed.
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
object
messageType
required
string
Const:"ClaimDateCorrectionMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
required
string
<= 140 characters
Additional instructions

required
allOf
Claimed new payment settlement date

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
Additional properties are allowed.
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the 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 transaction

additionalInstructions
required
string
<= 140 characters
Additional instructions

required
allOf
Claimed new payment settlement date

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
object
messageType
required
string
Const:"ResolveClaimMessage"
required
array<object>
1 items
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
reasonCode
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
allOf
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
allOf
Transaction charges to be paid by the charge bearer. Can be only specified when resolution type is one of: ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION

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.
Additional properties are allowed.
Additional properties are allowed.
object
paymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
reasonCode
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
allOf
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
allOf
Transaction charges to be paid by the charge bearer. Can be only specified when resolution type is one of: ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION

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.
Additional properties are allowed.
object
messageType
required
string
Const:"RequestNonReceiptClaimStatusMessage"
required
array<object>
1 items
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"RequestDateCorrectionClaimStatusMessage"
required
array<object>
1 items
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
Additional properties are allowed.
object
claimedPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

Additional properties are allowed.
object
messageType
required
string
Const:"PaymentReceivedMessage"
required
array<object>
non-empty
object
smaUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is generated by the API. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

endToEndId
string
<= 35 characters
Unique identifier assigned by the payment initiating party

object
Technical details of CENTROlink message

type
required
string
<= 8 characters
Type of message

required
allOf
BIC of the agent from which the message was received

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"
docNo
required
string
<= 16 characters
Document identifier

priority
required
string
<= 2 characters
Priority of the message

required
allOf
Date of formation of the message

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
required
allOf
Date and time at which payment message was received

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentInstructionNo
string
<= 35 characters
Unique identification as assigned by an instructing party

msgId
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 payment identifier as assigned by first instructing agent

paymentCode
string
<= 4 characters
ISO20022 purpose code of the payment

required
allOf
Creditor information. Party to which an amount of money is due.

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.
allOf
Ultimate party to which an amount of money is due

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
allOf
Debtor information. Party that owes an amount of money to the Creditor.

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.
allOf
Initial party that owes an amount of money to the (ultimate) creditor.

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
allOf
Amount of the payment

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.
purpose
string
Remittance information provided by the Debtor

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
Additional properties are allowed.
object
smaUid
required
string
<= 255 characters
Unique internal identifier of the payment. This identifier is generated by the API. It is used to provide a consistent payment reference accross the API messages and protect against payment duplication.

endToEndId
string
<= 35 characters
Unique identifier assigned by the payment initiating party

object
Technical details of CENTROlink message

type
required
string
<= 8 characters
Type of message

required
allOf
BIC of the agent from which the message was received

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"
docNo
required
string
<= 16 characters
Document identifier

priority
required
string
<= 2 characters
Priority of the message

required
allOf
Date of formation of the message

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
Additional properties are allowed.
required
allOf
Date and time at which payment message was received

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentInstructionNo
string
<= 35 characters
Unique identification as assigned by an instructing party

msgId
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 payment identifier as assigned by first instructing agent

paymentCode
string
<= 4 characters
ISO20022 purpose code of the payment

required
allOf
Creditor information. Party to which an amount of money is due.

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.
allOf
Ultimate party to which an amount of money is due

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
allOf
Debtor information. Party that owes an amount of money to the Creditor.

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.
allOf
Initial party that owes an amount of money to the (ultimate) creditor.

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
allOf
Amount of the payment

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.
purpose
string
Remittance information provided by the Debtor

categoryPurpose
string
Category purpose of the payment

BONU -- BonusPayment

CASH -- CashManagementTransfer

CBLK -- CardBulkClearing

CCRD -- CreditCardPayment

CORT -- TradeSettlementPayment

DCRD -- DebitCardPayment

DIVI -- Dividend

DVPM -- DeliverAgainstPayment

EPAY -- Epayment

FCIN -- FeeCollectionAndInterest

FCOL -- FeeCollection

GP2P -- PersontoPersonPayment

GOVT -- GovernmentPayment

HEDG -- Hedging

ICCP -- IrrevocableCreditCardPayment

IDCP -- IrrevocableDebitCardPayment

INTC -- IntraCompanyPayment

INTE -- Interest

LBOX -- LockboxTransactions

LOAN -- Loan

MP2B -- Commercial

MP2P -- Consumer

OTHR -- OtherPayment

PENS -- PensionPayment

RPRE -- Represented

RRCT -- ReimbursementReceivedCreditTransfer

RVPM -- ReceiveAgainstPayment

SALA -- SalaryPayment

SECU -- Securities

SSBE -- SocialSecurityBenefit

SUPP -- SupplierPayment

TAXS -- TaxPayment

TRAD -- Trade

TREA -- TreasuryPayment

VATX -- ValueAddedTaxPayment

WHLD -- WithHolding

Allowed values:
"BONU"
"CASH"
"CBLK"
"CCRD"
"CORT"
"DCRD"
"DIVI"
"DVPM"
"EPAY"
"FCIN"
"FCOL"
"GP2P"
"GOVT"
"HEDG"
"ICCP"
"IDCP"
"INTC"
"INTE"
"LBOX"
"LOAN"
"MP2B"
"MP2P"
"OTHR"
"PENS"
"RPRE"
"RRCT"
"RVPM"
"SALA"
"SECU"
"SSBE"
"SUPP"
"TAXS"
"TRAD"
"TREA"
"VATX"
"WHLD"
Additional properties are allowed.
object
messageType
required
string
Const:"PaymentSettledMessage"
required
array<object>
non-empty
object
internalId
required
string
<= 255 characters
Unique internal identifier of the original payment

msgId
string
<= 35 characters
Unique identifier of the original payment message (pacs.008)

txId
string
<= 35 characters
Unique payment identifier under which the payment is known to the external parties

paymentType
required
string
A type of previously sent payment that was confirmed (settled)

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
Additional properties are allowed.
Additional properties are allowed.
object
internalId
required
string
<= 255 characters
Unique internal identifier of the original payment

msgId
string
<= 35 characters
Unique identifier of the original payment message (pacs.008)

txId
string
<= 35 characters
Unique payment identifier under which the payment is known to the external parties

paymentType
required
string
A type of previously sent payment that was confirmed (settled)

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
Additional properties are allowed.
object
messageType
required
string
Const:"PaymentRejectedMessage"
required
array<object>
non-empty
object
originalInternalId
required
string
<= 255 characters
Unique internal identifier of the original 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 transaction

paymentType
required
string
A type of previously sent payment message that was rejected

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

CANCELLED_OUTGOING_PAYMENT -- Outgoing payment cancellation request

NON_RECEIPT_CLAIM -- Payment non-receipt claim

DATE_CORRECTION_CLAIM -- Payment date correction claim

CLAIM_RESOLUTION -- Payment claim resolution

STATUS_REQUEST -- Payment claim status request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
"CANCELLED_OUTGOING_PAYMENT"
"NON_RECEIPT_CLAIM"
"DATE_CORRECTION_CLAIM"
"CLAIM_RESOLUTION"
"STATUS_REQUEST"
rejectionReason
required
string
A reason for payment rejection.

ZERO_AMOUNT -- Zero Amount

NOT_ALLOWED_AMOUNT -- Not allowed amount

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement failed

UNKNOWN_BIC -- Unknown BIC in in the directory of participants

INVALID_IBAN -- Invalid IBAN format (not compliant with ISO 13616 format)

INVALID_DATA_FORMAT -- Invalid data format

INVALID_COUNTRY_CODE -- Invalid country code (is not on the list of the codes of SWIFT countries)

INVALID_ORIGINAL_TRANSACTION_STATUS -- Invalid original transaction status; action required

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- Invalid original transaction status; no action required

ORIGINAL_AMOUNT_MISMATCH -- Original Amount mismatch (in the R-message)

SETTLEMENT_CYCLE_NOT_AVAILABLE -- No settlement cycle available on the current business date for both Debtor and Creditor agents

EXPIRED_CANCELLATION_TIME_LIMIT -- Payment cancellation request rejected due to expired time limit for the credit transfer cancellation

AGENT_MISMATCH_TO_ORIGINAL -- R-msg transaction not following the same DP route / sending DP not identical to the Instructing / Instructed Agent of the original transaction

INVALID_TECH_BIC -- Invalid use of technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- The country code in the CreditorAgent BIC is one of the following: 'PF', 'NC' or 'WF', while the country code in the Debtor Agent BIC is not one of the following: 'FR', 'GP', 'RE', 'MQ', 'GF', 'PM', 'PF', 'NC', 'WF', 'BL', 'MF' or 'YT'.

SENDER_SUSPENDED -- The sending participant suspended

RECEIVER_SUSPENDED -- The receiving participant suspended

SEPA_SYNTAX_ERROR -- Syntax error

SEPA_CONTEXT_ERROR -- Business error

CANCELLED_BEFORE_CLEARING -- Request for cancellation of the credit transfer received prior to its execution. The credit transfer was not settled

Allowed values:
"ZERO_AMOUNT"
"NOT_ALLOWED_AMOUNT"
"DUPLICATION"
"SETTLEMENT_FAILED"
"UNKNOWN_BIC"
"INVALID_IBAN"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"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_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
string allOf
Rejection originator BIC

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"
Additional properties are allowed.
Additional properties are allowed.
object
originalInternalId
required
string
<= 255 characters
Unique internal identifier of the original 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 transaction

paymentType
required
string
A type of previously sent payment message that was rejected

OUTGOING_PAYMENT -- Outgoing payment

REJECTED_RECEIVED_PAYMENT -- Incoming payment rejection request

CANCELLED_OUTGOING_PAYMENT -- Outgoing payment cancellation request

NON_RECEIPT_CLAIM -- Payment non-receipt claim

DATE_CORRECTION_CLAIM -- Payment date correction claim

CLAIM_RESOLUTION -- Payment claim resolution

STATUS_REQUEST -- Payment claim status request

Allowed values:
"OUTGOING_PAYMENT"
"REJECTED_RECEIVED_PAYMENT"
"CANCELLED_OUTGOING_PAYMENT"
"NON_RECEIPT_CLAIM"
"DATE_CORRECTION_CLAIM"
"CLAIM_RESOLUTION"
"STATUS_REQUEST"
rejectionReason
required
string
A reason for payment rejection.

ZERO_AMOUNT -- Zero Amount

NOT_ALLOWED_AMOUNT -- Not allowed amount

DUPLICATION -- Duplication

SETTLEMENT_FAILED -- Settlement failed

UNKNOWN_BIC -- Unknown BIC in in the directory of participants

INVALID_IBAN -- Invalid IBAN format (not compliant with ISO 13616 format)

INVALID_DATA_FORMAT -- Invalid data format

INVALID_COUNTRY_CODE -- Invalid country code (is not on the list of the codes of SWIFT countries)

INVALID_ORIGINAL_TRANSACTION_STATUS -- Invalid original transaction status; action required

INVALID_ORIGINAL_TRANSACTION_STATUS2 -- Invalid original transaction status; no action required

ORIGINAL_AMOUNT_MISMATCH -- Original Amount mismatch (in the R-message)

SETTLEMENT_CYCLE_NOT_AVAILABLE -- No settlement cycle available on the current business date for both Debtor and Creditor agents

EXPIRED_CANCELLATION_TIME_LIMIT -- Payment cancellation request rejected due to expired time limit for the credit transfer cancellation

AGENT_MISMATCH_TO_ORIGINAL -- R-msg transaction not following the same DP route / sending DP not identical to the Instructing / Instructed Agent of the original transaction

INVALID_TECH_BIC -- Invalid use of technical BIC

INVALID_CREDITOR_DEBTOR_BIC_COMBINATION -- The country code in the CreditorAgent BIC is one of the following: 'PF', 'NC' or 'WF', while the country code in the Debtor Agent BIC is not one of the following: 'FR', 'GP', 'RE', 'MQ', 'GF', 'PM', 'PF', 'NC', 'WF', 'BL', 'MF' or 'YT'.

SENDER_SUSPENDED -- The sending participant suspended

RECEIVER_SUSPENDED -- The receiving participant suspended

SEPA_SYNTAX_ERROR -- Syntax error

SEPA_CONTEXT_ERROR -- Business error

CANCELLED_BEFORE_CLEARING -- Request for cancellation of the credit transfer received prior to its execution. The credit transfer was not settled

Allowed values:
"ZERO_AMOUNT"
"NOT_ALLOWED_AMOUNT"
"DUPLICATION"
"SETTLEMENT_FAILED"
"UNKNOWN_BIC"
"INVALID_IBAN"
"INVALID_DATA_FORMAT"
"INVALID_COUNTRY_CODE"
"INVALID_ORIGINAL_TRANSACTION_STATUS"
"INVALID_ORIGINAL_TRANSACTION_STATUS2"
"ORIGINAL_AMOUNT_MISMATCH"
"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_CONTEXT_ERROR"
"CANCELLED_BEFORE_CLEARING"
string allOf
Rejection originator BIC

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"
Additional properties are allowed.
object
messageType
required
string
Const:"PaymentReturnedMessage"
required
array<object>
non-empty
object
originalWbUid
required
string
<= 255 characters
Unique internal identifier of original incoming payment

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

originalMessageType
string
Type of the payment being returned

Allowed values:
"OUTGOING_PAYMENT"
"PAYMENT_REJECTION"
returnId
required
string
<= 35 characters
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the returned transaction

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money provided in the original payment

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.
required
allOf
Amount of money returned to debtor

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.
reasonCode
required
string
<= 4 characters
Payment return reason code (ISO20022)

Examples values:
"CNOR"
"ERIN"
"AC01"
"AC04"
"AC06"
"AG01"
"AG02"
"AM05"
"BE04"
"FOCR"
"MD07"
"MS02"
"RC01"
"RR01"
"RR02"
"RR03"
"RR04"
Additional properties are allowed.
Additional properties are allowed.
object
originalWbUid
required
string
<= 255 characters
Unique internal identifier of original incoming payment

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

originalMessageType
string
Type of the payment being returned

Allowed values:
"OUTGOING_PAYMENT"
"PAYMENT_REJECTION"
returnId
required
string
<= 35 characters
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the returned transaction

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money provided in the original payment

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.
required
allOf
Amount of money returned to debtor

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.
reasonCode
required
string
<= 4 characters
Payment return reason code (ISO20022)

Examples values:
"CNOR"
"ERIN"
"AC01"
"AC04"
"AC06"
"AG01"
"AG02"
"AM05"
"BE04"
"FOCR"
"MD07"
"MS02"
"RC01"
"RR01"
"RR02"
"RR03"
"RR04"
Additional properties are allowed.
object
messageType
required
string
Const:"PaymentCancelledMessage"
required
array<object>
non-empty
object
originalSmaUid
required
string
<= 255 characters
Unique internal identifier of the original incoming payment

cancellationId
required
string
<= 35 characters
Unique identifier of cancellation request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

settlementDate
required
string
format: date
Date, as provided in the original transaction, on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment cancellation reason code (ISO20022)

Examples values:
"AC03"
"AM09"
"FRAD"
"TECH"
"CUST"
"DUPL"
additionalInfo
string
<= 105 characters
Additional information on payment cancellation

Additional properties are allowed.
Additional properties are allowed.
object
originalSmaUid
required
string
<= 255 characters
Unique internal identifier of the original incoming payment

cancellationId
required
string
<= 35 characters
Unique identifier of cancellation request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

settlementDate
required
string
format: date
Date, as provided in the original transaction, on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment cancellation reason code (ISO20022)

Examples values:
"AC03"
"AM09"
"FRAD"
"TECH"
"CUST"
"DUPL"
additionalInfo
string
<= 105 characters
Additional information on payment cancellation

Additional properties are allowed.
object
messageType
required
string
Const:"PaymentRetainedMessage"
required
array<object>
non-empty
object
wbUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

retentionId
required
string
<= 35 characters
Unique identifier of retention request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment retention reason code (ISO20022)

Examples values:
"LEGL"
"CUST"
additionalInfo
string
<= 105 characters
Additional retention information

Additional properties are allowed.
Additional properties are allowed.
object
wbUid
required
string
<= 255 characters
Unique internal identifier of outgoing payment

retentionId
required
string
<= 35 characters
Unique identifier of retention request as assigned by the assigner

originalMsgId
string
<= 35 characters
Point to point reference assigned by the original instructing party to unambiguously identify the original group of individual transactions

e2eId
string
<= 35 characters
Unique identification, as assigned by the original initiating party, to unambiguously identify the original transaction.

msgId
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, as assigned by the original first instructing agent, to unambiguously identify the transaction.

required
allOf
Amount of money, as provided in the original transaction

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.
reasonCode
required
string
<= 4 characters
Payment retention reason code (ISO20022)

Examples values:
"LEGL"
"CUST"
additionalInfo
string
<= 105 characters
Additional retention information

Additional properties are allowed.
object
messageType
required
string
Const:"NonReceiptClaimMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment

claimId
required
string
<= 35 characters
Unique identifier of the claim

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

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment

claimId
required
string
<= 35 characters
Unique identifier of the claim

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

additionalInstructions
string
<= 140 characters
Additional instructions

Additional properties are allowed.
object
messageType
required
string
Const:"DateCorrectionClaimMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique 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 transaction

additionalInfo
string
<= 140 characters
Additional instructions

claimId
required
string
<= 35 characters
Unique identifier of the claim

claimedSettlementDate
required
string
format: date
Claimed new payment settlement date

originalSettlementDate
required
string
format: date
Original payment settlement date

Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Unique 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 transaction

additionalInfo
string
<= 140 characters
Additional instructions

claimId
required
string
<= 35 characters
Unique identifier of the claim

claimedSettlementDate
required
string
format: date
Claimed new payment settlement date

originalSettlementDate
required
string
format: date
Original payment settlement date

Additional properties are allowed.
object
messageType
required
string
Const:"ClaimResolutionMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
resolutionId
required
string
<= 35 characters
Unique id of the claim resolution

allOf
One of possible claim rejection reasons. Applicable only for negative resolutions of payment non-receipt claims

Consists of:
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
claimedSettlementDate
string
format: date
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

allOf
Transaction charges to be paid by the charge bearer.

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.
Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment referenced by the claim being resolved

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

resolution
required
string

ACCEPTED_NON_RECEIPT -- Non receipt claim is accepted

REJECTED_NON_RECEIPT -- Non receipt claim is rejected

ACKNOWLEDGED_DATE_MODIFICATION -- Claimed payment date correction is acknowledged

APPLIED_DATE_MODIFICATION -- New payment settlement date is applied

REJECTED_DATE_MODIFICATION -- Payment date correction claim is rejected

PROHIBITED_DATE_MODIFICATION -- Payment date correction is prohibited

Allowed values:
"ACCEPTED_NON_RECEIPT"
"REJECTED_NON_RECEIPT"
"ACKNOWLEDGED_DATE_MODIFICATION"
"APPLIED_DATE_MODIFICATION"
"REJECTED_DATE_MODIFICATION"
"PROHIBITED_DATE_MODIFICATION"
resolutionId
required
string
<= 35 characters
Unique id of the claim resolution

allOf
One of possible claim rejection reasons. Applicable only for negative resolutions of payment non-receipt claims

Consists of:
string
Applicable only for negative resolutions of payment non-receipt claims. Possible values:

ORIGINAL_TX_NOT_RECEIVED -- Original payment was not received

ORIGINAL_TX_NOT_PROCESSABLE -- Original payment is not processable

ALREADY_REJECTED -- Payment has already been rejected

ALREADY_RETURNED -- Payment has already been returned

REGULATORY -- Regulatory reason

Allowed values:
"ORIGINAL_TX_NOT_RECEIVED"
"ORIGINAL_TX_NOT_PROCESSABLE"
"ALREADY_REJECTED"
"ALREADY_RETURNED"
"REGULATORY"
claimedSettlementDate
string
format: date
New payment settlement date. Mandatory for positive payment date correction claim resolutions (ACKNOWLEDGED_DATE_MODIFICATION, APPLIED_DATE_MODIFICATION), optional otherwise

allOf
Transaction charges to be paid by the charge bearer.

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.
Additional properties are allowed.
object
messageType
required
string
Const:"TransactionsReportMessage"
required
array<object>
non-empty
object
reportMsgId
required
string
<= 16 characters
Unique identifier of report message

pageNumber
integer
Number of page (In case pagination is used)

last
boolean
Indicator of the last page (In case pagination is used)

transactionCount
required
integer
Number of transactions in given report

totalCreditDebitIndicator
required
string
Indicator of net amount of transactions in the given report

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Net amount of transactions in the given report

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.
array<object>
object
creditDebitIndicator
required
string
Debit/credit indicator of transaction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Amount of transaction

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.
required
allOf
Information on debtor's account

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"
Additional properties are allowed.
required
allOf
Information on creditor's account

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"
Additional properties are allowed.
required
allOf
Date and time when the payment was accepted

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Date and time of the payment

Consists of:
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
Date when the payment was settled

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
reportMsgId
required
string
<= 16 characters
Unique identifier of report message

pageNumber
integer
Number of page (In case pagination is used)

last
boolean
Indicator of the last page (In case pagination is used)

transactionCount
required
integer
Number of transactions in given report

totalCreditDebitIndicator
required
string
Indicator of net amount of transactions in the given report

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Net amount of transactions in the given report

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.
array<object>
object
creditDebitIndicator
required
string
Debit/credit indicator of transaction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Amount of transaction

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.
required
allOf
Information on debtor's account

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"
Additional properties are allowed.
required
allOf
Information on creditor's account

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"
Additional properties are allowed.
required
allOf
Date and time when the payment was accepted

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Date and time of the payment

Consists of:
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
Date when the payment was settled

Additional properties are allowed.
Additional properties are allowed.
object
creditDebitIndicator
required
string
Debit/credit indicator of transaction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Amount of transaction

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.
required
allOf
Information on debtor's account

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"
Additional properties are allowed.
required
allOf
Information on creditor's account

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"
Additional properties are allowed.
required
allOf
Date and time when the payment was accepted

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Date and time of the payment

Consists of:
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
Date when the payment was settled

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

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

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

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

additionalInfo
required
string
Description of validation error(s)

Additional properties are allowed.
object
messageType
required
string
Const:"NonReceiptClaimStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
object
messageType
required
string
Const:"DateCorrectionClaimStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the payment the original claim is related to

statusRequestId
required
string
Reference of the status request

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"SepaCreditAccountStatementReportMessage"
required
array<object>
non-empty
object
msgId
required
string
<= 16 characters
Unique identifier of report message

documentId
required
string
<= 16 characters
Unique identifier of the document

required
allOf
Document forming timestamp

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Account owner’s BIC

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"
required
allOf
Account number

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
Account currency

Consists of:
string
must match: [A-Z]{3,3}
Currency code (ISO 4217)

Examples values:
"EUR"
"USD"
required
allOf
Balance on account at the beginning of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
required
allOf
Balance on account at the end of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
array<object>
Information about turnover by each counterparty

object
Information about turnover by counterparty

required
allOf
BIC of the counterparty

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"
required
allOf
Account number of the counterparty

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
array<object>
Information about transactions of specific direction

object
Information about transactions of specific direction

type
required
string
Type of direction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Total amount of transactions

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

transactionCount
required
integer
Transaction count

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
msgId
required
string
<= 16 characters
Unique identifier of report message

documentId
required
string
<= 16 characters
Unique identifier of the document

required
allOf
Document forming timestamp

Consists of:
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
allOf
Account owner’s BIC

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"
required
allOf
Account number

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
allOf
Account currency

Consists of:
string
must match: [A-Z]{3,3}
Currency code (ISO 4217)

Examples values:
"EUR"
"USD"
required
allOf
Balance on account at the beginning of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
required
allOf
Balance on account at the end of business day

object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
array<object>
Information about turnover by each counterparty

object
Information about turnover by counterparty

required
allOf
BIC of the counterparty

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"
required
allOf
Account number of the counterparty

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
array<object>
Information about transactions of specific direction

object
Information about transactions of specific direction

type
required
string
Type of direction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Total amount of transactions

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

transactionCount
required
integer
Transaction count

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
required
allOf
Amount of money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

required
allOf
Amount of available money on account

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

Additional properties are allowed.
object
Information about turnover by counterparty

required
allOf
BIC of the counterparty

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"
required
allOf
Account number of the counterparty

Consists of:
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
array<object>
Information about transactions of specific direction

object
Information about transactions of specific direction

type
required
string
Type of direction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Total amount of transactions

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

transactionCount
required
integer
Transaction count

Additional properties are allowed.
Additional properties are allowed.
object
Information about transactions of specific direction

type
required
string
Type of direction

Allowed values:
"DEBIT"
"CREDIT"
required
allOf
Total amount of transactions

Consists of:
number
[ 0.01 .. 999999999.99 ]
Monetary amount. Length of fractional part is 2 digits

transactionCount
required
integer
Transaction count

Additional properties are allowed.

SEPA Credit Transfer Gateway API 1.9.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.

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.

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.

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