SEPA Instant Transfer Gateway API 1.7.1 documentation

SEPA Instant Transfer Gateway API 1.7.1

application/json

SEPA Gateway API provides an access to the SEPA Instant 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 Instant 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 SICT cut-off time
Automatic conversion of Unicode characters for outgoing messages according to SEPA requirements

Download AsyncAPI specification

Servers

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

Operations

SEND outgoing_payments
Message queue to send messages to

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

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

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

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
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
<= 140 characters
The purpose of the payment. If the text is longer, it will be trimmed automatically.

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
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "OutgoingInstantPaymentMessage", "data": [ { "paymentUid": "string", "endToEndId": "string", "msgId": "string", "txId": "string", "debtor": { "person": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "account": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "creditor": { "person": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "account": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } } }, "amount": { "currency": "EUR", "value": 0.01 }, "purpose": "string", "ultimateDebtor": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" }, "ultimateCreditor": { "type": "ORG", "name": "string", "id": "string", "countryCode": "LT", "fullAddress": "string", "address": { "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "postBox": "string", "room": "string", "postCode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "country": "LT" }, "identityType": "ANY_BIC" } } ] }

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

Operation IDrejectInstantPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RejectInstantPaymentMessagerejectInstantPaymentMessage
Rejects a previously received incoming instant payment.
application/json
Message IDrejectInstantPaymentMessage
object
messageType
required
string
Const:"RejectInstantPaymentMessage"
required
array<object>
1 items
object
Rejects a previously received incoming instant payment.

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

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

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

reasonCode
required
string
Reason for rejection of the instant payment.

CLEARING_TIMEOUT (AB05) – Clearing timeout

CREDITOR_AGENT_NOT_AVAILABLE (AB08) – Creditor agent not available

ERROR_AT_CREDITOR_AGENT (AB09) – Error at creditor agent

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

FORBIDDEN_TRANSACTION (AG01) – Forbidden transaction

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

NOT_ALLOWED_AMOUNT (AM02) – Not allowed amount

DUPLICATE (AM05) – Duplicate

MISSING_CREDITOR_ADDRESS (BE04) – Missing creditor address

DECEASED_CUSTOMER (MD07) – Deceased customer

REASON_NOT_SPECIFIED_BY_CUSTOMER (MS02) – Not specified reason by customer

REASON_NOT_SPECIFIED_BY_AGENT (MS03) – Not specified reason by agent

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or ID

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (PR04) – Regulatory reason

Allowed values:
"CLEARING_TIMEOUT"
"CREDITOR_AGENT_NOT_AVAILABLE"
"ERROR_AT_CREDITOR_AGENT"
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"FORBIDDEN_TRANSACTION"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"NOT_ALLOWED_AMOUNT"
"DUPLICATE"
"MISSING_CREDITOR_ADDRESS"
"DECEASED_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_AGENT"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
originatorBic
string
Rejection originator BIC.

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

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RejectInstantPaymentMessage", "data": [ { "paymentUid": "string", "msgId": "string", "txId": "string", "reasonCode": "CLEARING_TIMEOUT", "originatorBic": "string", "originatorName": "string" } ] }

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

Operation IDconfirmInstantPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
ConfirmInstantPaymentMessageconfirmInstantPaymentMessage
Confirms a previously received incoming instant payment.
application/json
Message IDconfirmInstantPaymentMessage
object
messageType
required
string
Const:"ConfirmInstantPaymentMessage"
required
array<object>
1 items
object
Confirms a previously received incoming instant payment.

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

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

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

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

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

Operation IDcancelInstantPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
CancelInstantPaymentMessagecancelInstantPaymentMessage
Request cancellation of a previously sent outgoing payment.
application/json
Message IDcancelInstantPaymentMessage
object
messageType
required
string
Const:"CancelInstantPaymentMessage"
required
array<object>
1 items
object
Cancel a previously sent outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Will be trimmed if exceeds the limit.

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

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

Operation IDreturnInstantPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
ReturnInstantPaymentMessagereturnInstantPaymentMessage
Return a previously received incoming payment.
application/json
Message IDreturnInstantPaymentMessage
object
messageType
required
string
Const:"ReturnInstantPaymentMessage"
required
array<object>
1 items
object
Return a previously received instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment to be returned.

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

txId
string
must match: ^[0-9a-zA-Z\-?:().,'+ ]{1,35}$
Unique identification of the related 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.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "ReturnInstantPaymentMessage", "data": [ { "paymentUid": "string", "msgId": "string", "txId": "string", "chargeAmount": { "currency": "EUR", "value": 0.01 } } ] }

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

Operation IDretainInstantPayment
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RetainInstantPaymentMessageretainInstantPaymentMessage
Do not return funds for a cancelled incoming payment.
application/json
Message IDretainInstantPaymentMessage
object
messageType
required
string
Const:"RetainInstantPaymentMessage"
required
array<object>
1 items
object
Do not return funds for a previously received payment cancellation.

paymentUid
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 related original message

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

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional retention information (optional comment or justification).

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RetainInstantPaymentMessage", "data": [ { "paymentUid": "string", "msgId": "string", "txId": "string", "reasonCode": "INSUFFICIENT_FUNDS", "additionalInfo": "string" } ] }

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

Operation IDsendLiquidityTransfer
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
LiquidityTransferRequestMessageliquidityTransferMessage
Send liquidity transfer request between internal accounts.
application/json
Message IDliquidityTransferMessage
object
messageType
required
string
Const:"LiquidityTransferRequestMessage"
required
array<object>
1 items
object
Request for liquidity transfer between internal accounts.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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"
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"
Additional properties are allowed.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "LiquidityTransferRequestMessage", "data": [ { "paymentUid": "string", "creditor": { "iban": "LT121000011101001000", "bic": "TESTLT21" }, "debtor": { "iban": "LT121000011101001000", "bic": "TESTLT21" }, "amount": { "currency": "EUR", "value": 0.01 } } ] }

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

Operation IDsendInstantCancellationStatusRequest
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
RequestInstantCancellationStatusMessageinstantCancellationStatusRequestMessage
Request status of an outgoing instant payment cancellation.
application/json
Message IDinstantCancellationStatusRequestMessage
object
messageType
required
string
Const:"RequestInstantCancellationStatusMessage"
required
array<object>
1 items
object
Request for the status of an outgoing instant payment cancellation.

cancelledPaymentUid
required
string
<= 255 characters
Unique identifier of the payment being checked for cancellation status.

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

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

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "RequestInstantCancellationStatusMessage", "data": [ { "cancelledPaymentUid": "string", "msgId": "string", "txId": "string" } ] }

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

Operation IDsendSystemUnavailabilityReport
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
SystemUnavailabilityReportMessagesystemUnavailabilityReportMessage
Notification about temporary system unavailability.
application/json
Message IDsystemUnavailabilityReportMessage
object
messageType
required
string
Const:"SystemUnavailabilityReportMessage"
required
array<object>
1 items
object
System unavailability report details.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of unavailability.

unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "SystemUnavailabilityReportMessage", "data": [ { "unavailabilityUid": "string", "unavailabilityStart": "2019-11-21T16:32:59", "unavailabilityEnd": "2019-11-21T16:32:59", "description": "string" } ] }

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

Operation IDsendCancelSystemUnavailabilityReport
Available only on servers:
- production
- stage
object
is
queue
object
name
outgoing_payments
durable
true
vhost
/
Accepts the following message:
CancelSystemUnavailabilityReportMessagecancelSystemUnavailabilityReportMessage
Cancel a previously sent system unavailability report.
application/json
Message IDcancelSystemUnavailabilityReportMessage
object
messageType
required
string
Const:"CancelSystemUnavailabilityReportMessage"
required
array<object>
1 items
object
Payload for cancelling a previously sent system unavailability report.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of previously sent unavailability.

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

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

Operation IDlistenInstantMessageAccepted
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantMessageAcceptedinstantMessageAcceptedMessage
Outgoing payment confirmed and settled by CENTROlink
application/json
Message IDinstantMessageAcceptedMessage
object
messageType
required
string
Const:"InstantMessageAccepted"
required
array<object>
non-empty
object
Payload of accepted instant message

originalMessageUid
required
string
Unique internal identifier of the outgoing payment

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

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

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantMessageAccepted", "data": [ { "originalMessageUid": "string", "msgId": "string", "txId": "string", "messageType": "INCOMING_PAYMENT" } ] }

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

Operation IDlistenInstantMessageRejected
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantMessageRejectedinstantMessageRejectedMessage
Outgoing payment was rejected by CENTROlink
application/json
Message IDinstantMessageRejectedMessage
object
messageType
required
string
Const:"InstantMessageRejected"
required
array<object>
non-empty
object
Payload of rejected instant message

originalMessageUid
required
string
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 related original transaction

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
rejectionReason
required
string
Reason for instant payment rejection

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

INCORRECT_IBAN (AC03) – Incorrect IBAN

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

TRANSACTION_FORBIDDEN (AG01) – Transaction forbidden

INVALID_BANK_OPERATION_CODE (AG02) – Invalid bank operation code

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

INSTRUCTING_AGENT_SUSPENDED (AG10) – Instructing agent suspended

CREDITOR_AGENT_SUSPENDED (AG11) – Creditor agent suspended

INSUFFICIENT_FUND (AM04) – Insufficient funds

WRONG_AMOUNT (AM09) – Wrong amount

AMOUNT_EXCEEDS_LIMIT (AM23) – Amount exceeds settlement limit

ALREADY_RETURNED_TRANSACTION (ARDT) – Already returned transaction

REQUESTED_BY_CUSTOMER (CUST) – Requested by customer

DUPLICATE_PAYMENT (DUPL) – Duplicate payment

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation request

FRAUDULENT_TRANSACTION (FRAD) – Fraudulent transaction

LEGAL_DECISION (LEGL) – Legal decision

CUSTOMER_NOT_SPECIFIED_REASON (MS02) – Not specified reason (customer)

AGENT_NOT_SPECIFIED_REASON (MS03) – Not specified reason (agent)

NO_ANSWER_FROM_CUSTOMER (NOAS) – No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED (NOOR) – Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION (RC01) – Bank identifier incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or identification

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (RR04) – Regulatory reason

TECHNICAL_ERROR (TECH) – Technical error

CUT_OFF_TIME (TM01) – Invalid cut-off time

INSUFFICIENT_LIQUIDITY (XT04) – Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME (XT06) – Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP (XT79) – Debtor agent not allowed to send IP

CREDIT_AGENT_NOT_ALLOWED_SEND_IP (XT80) – Creditor agent not allowed to receive IP

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED (XT83) – Product usage not allowed

UNKNOWN (UNKNOWN) – Unknown reason

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"UNKNOWN"
originatorBic
string
Rejection originator BIC

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

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantMessageRejected", "data": [ { "originalMessageUid": "string", "msgId": "string", "txId": "string", "messageType": "INCOMING_PAYMENT", "rejectionReason": "INCORRECT_ACCOUNT_NUMBER", "originatorBic": "string", "originatorName": "string" } ] }

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

Operation IDlistenInstantPaymentCancelled
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentCancelledMessageinstantPaymentCancelledMessage
Previously sent instant payment was cancelled.
application/json
Message IDinstantPaymentCancelledMessage
object
messageType
required
string
Const:"InstantPaymentCancelledMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment.

additionalReasonInfo
string
<= 105 characters
Additional information provided with the cancellation.

originalMsgId
required
string
<= 35 characters
Original message ID.

cancellationId
string
<= 35 characters
Cancellation message ID.

originalTxId
string
<= 35 characters
Original transaction ID.

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantPaymentCancelledMessage", "data": [ { "originalPaymentUid": "string", "additionalReasonInfo": "string", "originalMsgId": "string", "cancellationId": "string", "originalTxId": "string", "reasonCode": "DUPLICATE" } ] }

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

Operation IDlistenLiquidityTransferReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
LiquidityTransferReportMessageliquidityTransferReportMessage
Notification about successfully processed liquidity transfer
application/json
Message IDliquidityTransferReportMessage
object
messageType
required
string
Const:"LiquidityTransferReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Incoming message identifier.

transactionId
required
string
Liquidity transfer transaction ID.

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.
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.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "LiquidityTransferReportMessage", "data": [ { "msgId": "string", "transactionId": "string", "debtor": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } }, "creditor": { "iban": "LT121000011101001000", "bic": "TESTLT21", "proxy": { "id": "string", "proxyType": { "code": "stri", "proprietary": "string" } } }, "transferredAmount": { "currency": "EUR", "value": 0.01 } } ] }

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

Operation IDlistenAccountStatementReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
AccountStatementReportMessageaccountStatementReportMessage
Incoming message about account statement balances
application/json
Message IDaccountStatementReportMessage
object
messageType
required
string
Const:"AccountStatementReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Message identifier

pageNumber
required
integer
format: int64
The number of the page

last
required
boolean
Is this page last?

required
array<object>
The array of account balances

object
transactionType
required
string
Type of the transaction

Allowed values:
"CREDIT"
"DEBIT"
balanceType
required
string
Type of account balance message

Allowed values:
"START_OF_DAY"
"END_OF_DAY"
"TRANSACTION"
relatedParticipantIndicator
required
string
Indicator of related participant

required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
transactionDate
required
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.
Additional properties are allowed.
Examples
{ "messageType": "AccountStatementReportMessage", "data": [ { "msgId": "string", "pageNumber": 0, "last": true, "balances": [ { "transactionType": "CREDIT", "balanceType": "START_OF_DAY", "relatedParticipantIndicator": "string", "amount": { "currency": "EUR", "value": 0.01 }, "transactionDate": "2019-11-21T16:32:59" } ] } ] }

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

Operation IDlistenInstantPaymentReceived
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentReceivedMessageinstantPaymentReceivedMessage
Callback with new incoming payment
application/json
Message IDinstantPaymentReceivedMessage
object
messageType
required
string
Const:"InstantPaymentReceivedMessage"
required
array<object>
non-empty
object
paymentUid
required
string
Internal identifier of the payment.

paymentTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentTimestampTZ
string
format: date-time
Date and time with timezone at which payment message was received.

msgId
required
string
Message identifier.

txId
required
string
<= 35 characters
Unique payment identifier as assigned by first instructing agent.

purpose
string
Remittance information provided by the Creditor.

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
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
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
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
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": "InstantPaymentReceivedMessage", "data": [ { "paymentUid": "string", "paymentTimestamp": "2019-11-21T16:32:59", "paymentTimestampTZ": "2019-08-24T14:15:22Z", "msgId": "string", "txId": "string", "purpose": "string", "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 } } ] }

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

Operation IDlistenInstantPaymentReturned
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentReturnedMessageinstantPaymentReturnedMessage
Notification that previously sent payment has been returned
application/json
Message IDinstantPaymentReturnedMessage
object
messageType
required
string
Const:"InstantPaymentReturnedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

returnId
required
string
Return transaction ID

originalMsgId
required
string
Message ID of original payment

originalTxId
required
string
Transaction ID of original payment

reasonCode
required
string
Reason for returned instant payment.

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"FOLLOWING_CANCELLATION_REQUEST"
"UNKNOWN"
additionalInfo
required
string
Additional information for return reason

required
object
currency
required
string
Currency of the money

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantPaymentReturnedMessage", "data": [ { "originalPaymentUid": "string", "returnId": "string", "originalMsgId": "string", "originalTxId": "string", "reasonCode": "FOLLOWING_CANCELLATION_REQUEST", "additionalInfo": "string", "originalAmount": { "currency": "EUR", "value": 0.01 }, "returnedAmount": { "currency": "EUR", "value": 0.01 } } ] }

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

Operation IDreceiveInstantPaymentDebited
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentDebitedMessageinstantPaymentDebitedMessage
Incoming instant payment was debited (recalled) by Bank of Lithuania
application/json
Message IDinstantPaymentDebitedMessage
object
messageType
required
string
Const:"InstantPaymentDebitedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment.

returnId
required
string
<= 255 characters
ID of the returned payment.

originalMsgId
required
string
<= 35 characters
Message ID of original payment.

originalTxId
required
string
<= 35 characters
Transaction ID of original payment.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantPaymentDebitedMessage", "data": [ { "originalPaymentUid": "string", "returnId": "string", "originalMsgId": "string", "originalTxId": "string" } ] }

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

Operation IDreceiveLiquidityPositionReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
LiquidityPositionReportMessageliquidityPositionReportMessage
Liquidity position report from Bank of Lithuania
application/json
Message IDliquidityPositionReportMessage
object
messageType
required
string
Const:"LiquidityPositionReportMessage"
required
array<object>
non-empty
object
reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
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.
identificationCode
required
string
Indicates direction of the liquidity position (CREDIT or DEBIT).

Allowed values:
"CREDIT"
"DEBIT"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "LiquidityPositionReportMessage", "data": [ { "reportDate": "2019-11-21T16:32:59", "amount": { "currency": "EUR", "value": 0.01 }, "identificationCode": "CREDIT" } ] }

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

Operation IDreceiveInstantPaymentTransactionsReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentTransactionsReportMessageinstantPaymentTransactionsReportMessage
Report of SEPA Instant transactions from Bank of Lithuania
application/json
Message IDinstantPaymentTransactionsReportMessage
object
messageType
required
string
Const:"InstantPaymentTransactionsReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Message identifier

reportId
required
string
Identifier of the report

pageNumber
required
integer
The number of the page

last
required
boolean
Whether this is the last page

reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
accountIban
required
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
array<object>
object
transactionType
required
string
Transaction type (CREDIT or DEBIT)

Allowed values:
"CREDIT"
"DEBIT"
debtorBic
required
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"
creditorBic
required
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
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.
originalPaymentTxId
required
string
Transaction ID of the original payment

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantPaymentTransactionsReportMessage", "data": [ { "msgId": "string", "reportId": "string", "pageNumber": 0, "last": true, "reportDate": "2019-11-21T16:32:59", "accountIban": "LT121000011101001000", "transactions": [ { "transactionType": "CREDIT", "debtorBic": "TESTLT21", "creditorBic": "TESTLT21", "amount": { "currency": "EUR", "value": 0.01 }, "originalPaymentTxId": "string" } ] } ] }

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

Operation IDreceiveInstantPaymentStatusRequest
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentStatusRequestMessageinstantPaymentStatusRequestMessage
Notification about current state of the payment
application/json
Message IDinstantPaymentStatusRequestMessage
object
messageType
required
string
Const:"InstantPaymentStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

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

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

statusRequestId
required
string
Identifier of status request

messageType
required
string
Type of the message for which the status was requested:

PAYMENT – Outgoing instant payment

CANCELLATION – Payment cancellation

UNKNOWN – Unknown type

Allowed values:
"PAYMENT"
"CANCELLATION"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantPaymentStatusRequestMessage", "data": [ { "originalPaymentUid": "string", "msgId": "string", "txId": "string", "statusRequestId": "string", "messageType": "PAYMENT" } ] }

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

Operation IDreceiveInstantPaymentRetained
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
InstantPaymentRetainedMessageinstantPaymentRetainedMessage
Notification about denying to return funds on cancellation
application/json
Message IDinstantPaymentRetainedMessage
object
messageType
required
string
Const:"InstantPaymentRetainedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

retentionId
required
string
ID of the retained payment

originalMsgId
required
string
Original message ID

originalTxId
required
string
Original transaction ID

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional information about the retention

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "InstantPaymentRetainedMessage", "data": [ { "originalPaymentUid": "string", "retentionId": "string", "originalMsgId": "string", "originalTxId": "string", "reasonCode": "INSUFFICIENT_FUNDS", "additionalInfo": "string" } ] }

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

Operation IDreceiveParticipantUnavailabilityReport
Available only on servers:
- production
- stage
object
is
queue
object
name
incoming_payments
durable
true
vhost
/
Accepts the following message:
ParticipantUnavailabilityReportMessageparticipantUnavailabilityReportMessage
Notification about temporary unavailability of a participant
application/json
Message IDparticipantUnavailabilityReportMessage
object
messageType
required
string
Const:"ParticipantUnavailabilityReportMessage"
required
array<object>
non-empty
object
internalUid
required
string
<= 255 characters
Unique identifier of unavailability

participantBic
required
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"
unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "messageType": "ParticipantUnavailabilityReportMessage", "data": [ { "internalUid": "string", "participantBic": "TESTLT21", "unavailabilityStart": "2019-11-21T16:32:59", "unavailabilityEnd": "2019-11-21T16:32:59", "description": "string" } ] }

This example has been generated automatically.

Messages

#1OutgoingInstantPaymentMessageoutgoingInstantPaymentMessage
Request to initiate an outgoing instant payment
- application/json
Message IDoutgoingInstantPaymentMessage
object
messageType
required
string
Const:"OutgoingInstantPaymentMessage"
required
array<object>
1 items
object
Allows to create a new outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

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

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
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
<= 140 characters
The purpose of the payment. If the text is longer, it will be trimmed automatically.

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
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#2RejectInstantPaymentMessagerejectInstantPaymentMessage
Rejects a previously received incoming instant payment.
- application/json
Message IDrejectInstantPaymentMessage
object
messageType
required
string
Const:"RejectInstantPaymentMessage"
required
array<object>
1 items
object
Rejects a previously received incoming instant payment.

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

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

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

reasonCode
required
string
Reason for rejection of the instant payment.

CLEARING_TIMEOUT (AB05) – Clearing timeout

CREDITOR_AGENT_NOT_AVAILABLE (AB08) – Creditor agent not available

ERROR_AT_CREDITOR_AGENT (AB09) – Error at creditor agent

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

FORBIDDEN_TRANSACTION (AG01) – Forbidden transaction

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

NOT_ALLOWED_AMOUNT (AM02) – Not allowed amount

DUPLICATE (AM05) – Duplicate

MISSING_CREDITOR_ADDRESS (BE04) – Missing creditor address

DECEASED_CUSTOMER (MD07) – Deceased customer

REASON_NOT_SPECIFIED_BY_CUSTOMER (MS02) – Not specified reason by customer

REASON_NOT_SPECIFIED_BY_AGENT (MS03) – Not specified reason by agent

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or ID

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (PR04) – Regulatory reason

Allowed values:
"CLEARING_TIMEOUT"
"CREDITOR_AGENT_NOT_AVAILABLE"
"ERROR_AT_CREDITOR_AGENT"
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"FORBIDDEN_TRANSACTION"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"NOT_ALLOWED_AMOUNT"
"DUPLICATE"
"MISSING_CREDITOR_ADDRESS"
"DECEASED_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_AGENT"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
originatorBic
string
Rejection originator BIC.

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

Additional properties are allowed.
Additional properties are allowed.
#3ConfirmInstantPaymentMessageconfirmInstantPaymentMessage
Confirms a previously received incoming instant payment.
- application/json
Message IDconfirmInstantPaymentMessage
object
messageType
required
string
Const:"ConfirmInstantPaymentMessage"
required
array<object>
1 items
object
Confirms a previously received incoming instant payment.

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

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

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

Additional properties are allowed.
Additional properties are allowed.
#4CancelInstantPaymentMessagecancelInstantPaymentMessage
Request cancellation of a previously sent outgoing payment.
- application/json
Message IDcancelInstantPaymentMessage
object
messageType
required
string
Const:"CancelInstantPaymentMessage"
required
array<object>
1 items
object
Cancel a previously sent outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Will be trimmed if exceeds the limit.

Additional properties are allowed.
Additional properties are allowed.
#5ReturnInstantPaymentMessagereturnInstantPaymentMessage
Return a previously received incoming payment.
- application/json
Message IDreturnInstantPaymentMessage
object
messageType
required
string
Const:"ReturnInstantPaymentMessage"
required
array<object>
1 items
object
Return a previously received instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment to be returned.

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

txId
string
must match: ^[0-9a-zA-Z\-?:().,'+ ]{1,35}$
Unique identification of the related 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.
Additional properties are allowed.
Additional properties are allowed.
#6RetainInstantPaymentMessageretainInstantPaymentMessage
Do not return funds for a cancelled incoming payment.
- application/json
Message IDretainInstantPaymentMessage
object
messageType
required
string
Const:"RetainInstantPaymentMessage"
required
array<object>
1 items
object
Do not return funds for a previously received payment cancellation.

paymentUid
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 related original message

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

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional retention information (optional comment or justification).

Additional properties are allowed.
Additional properties are allowed.
#7LiquidityTransferRequestMessageliquidityTransferMessage
Send liquidity transfer request between internal accounts.
- application/json
Message IDliquidityTransferMessage
object
messageType
required
string
Const:"LiquidityTransferRequestMessage"
required
array<object>
1 items
object
Request for liquidity transfer between internal accounts.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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"
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"
Additional properties are allowed.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#8RequestInstantCancellationStatusMessageinstantCancellationStatusRequestMessage
Request status of an outgoing instant payment cancellation.
- application/json
Message IDinstantCancellationStatusRequestMessage
object
messageType
required
string
Const:"RequestInstantCancellationStatusMessage"
required
array<object>
1 items
object
Request for the status of an outgoing instant payment cancellation.

cancelledPaymentUid
required
string
<= 255 characters
Unique identifier of the payment being checked for cancellation status.

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

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

Additional properties are allowed.
Additional properties are allowed.
#9SystemUnavailabilityReportMessagesystemUnavailabilityReportMessage
Notification about temporary system unavailability.
- application/json
Message IDsystemUnavailabilityReportMessage
object
messageType
required
string
Const:"SystemUnavailabilityReportMessage"
required
array<object>
1 items
object
System unavailability report details.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of unavailability.

unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability.

Additional properties are allowed.
Additional properties are allowed.
#10CancelSystemUnavailabilityReportMessagecancelSystemUnavailabilityReportMessage
Cancel a previously sent system unavailability report.
- application/json
Message IDcancelSystemUnavailabilityReportMessage
object
messageType
required
string
Const:"CancelSystemUnavailabilityReportMessage"
required
array<object>
1 items
object
Payload for cancelling a previously sent system unavailability report.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of previously sent unavailability.

Additional properties are allowed.
Additional properties are allowed.
#11InstantMessageAcceptedinstantMessageAcceptedMessage
Outgoing payment confirmed and settled by CENTROlink
- application/json
Message IDinstantMessageAcceptedMessage
object
messageType
required
string
Const:"InstantMessageAccepted"
required
array<object>
non-empty
object
Payload of accepted instant message

originalMessageUid
required
string
Unique internal identifier of the outgoing payment

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

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

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
Additional properties are allowed.
Additional properties are allowed.
#12InstantMessageRejectedinstantMessageRejectedMessage
Outgoing payment was rejected by CENTROlink
- application/json
Message IDinstantMessageRejectedMessage
object
messageType
required
string
Const:"InstantMessageRejected"
required
array<object>
non-empty
object
Payload of rejected instant message

originalMessageUid
required
string
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 related original transaction

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
rejectionReason
required
string
Reason for instant payment rejection

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

INCORRECT_IBAN (AC03) – Incorrect IBAN

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

TRANSACTION_FORBIDDEN (AG01) – Transaction forbidden

INVALID_BANK_OPERATION_CODE (AG02) – Invalid bank operation code

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

INSTRUCTING_AGENT_SUSPENDED (AG10) – Instructing agent suspended

CREDITOR_AGENT_SUSPENDED (AG11) – Creditor agent suspended

INSUFFICIENT_FUND (AM04) – Insufficient funds

WRONG_AMOUNT (AM09) – Wrong amount

AMOUNT_EXCEEDS_LIMIT (AM23) – Amount exceeds settlement limit

ALREADY_RETURNED_TRANSACTION (ARDT) – Already returned transaction

REQUESTED_BY_CUSTOMER (CUST) – Requested by customer

DUPLICATE_PAYMENT (DUPL) – Duplicate payment

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation request

FRAUDULENT_TRANSACTION (FRAD) – Fraudulent transaction

LEGAL_DECISION (LEGL) – Legal decision

CUSTOMER_NOT_SPECIFIED_REASON (MS02) – Not specified reason (customer)

AGENT_NOT_SPECIFIED_REASON (MS03) – Not specified reason (agent)

NO_ANSWER_FROM_CUSTOMER (NOAS) – No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED (NOOR) – Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION (RC01) – Bank identifier incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or identification

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (RR04) – Regulatory reason

TECHNICAL_ERROR (TECH) – Technical error

CUT_OFF_TIME (TM01) – Invalid cut-off time

INSUFFICIENT_LIQUIDITY (XT04) – Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME (XT06) – Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP (XT79) – Debtor agent not allowed to send IP

CREDIT_AGENT_NOT_ALLOWED_SEND_IP (XT80) – Creditor agent not allowed to receive IP

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED (XT83) – Product usage not allowed

UNKNOWN (UNKNOWN) – Unknown reason

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"UNKNOWN"
originatorBic
string
Rejection originator BIC

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

Additional properties are allowed.
Additional properties are allowed.
#13InstantPaymentCancelledMessageinstantPaymentCancelledMessage
Previously sent instant payment was cancelled.
- application/json
Message IDinstantPaymentCancelledMessage
object
messageType
required
string
Const:"InstantPaymentCancelledMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment.

additionalReasonInfo
string
<= 105 characters
Additional information provided with the cancellation.

originalMsgId
required
string
<= 35 characters
Original message ID.

cancellationId
string
<= 35 characters
Cancellation message ID.

originalTxId
string
<= 35 characters
Original transaction ID.

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
#14LiquidityTransferReportMessageliquidityTransferReportMessage
Notification about successfully processed liquidity transfer
- application/json
Message IDliquidityTransferReportMessage
object
messageType
required
string
Const:"LiquidityTransferReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Incoming message identifier.

transactionId
required
string
Liquidity transfer transaction ID.

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.
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.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#15AccountStatementReportMessageaccountStatementReportMessage
Incoming message about account statement balances
- application/json
Message IDaccountStatementReportMessage
object
messageType
required
string
Const:"AccountStatementReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Message identifier

pageNumber
required
integer
format: int64
The number of the page

last
required
boolean
Is this page last?

required
array<object>
The array of account balances

object
transactionType
required
string
Type of the transaction

Allowed values:
"CREDIT"
"DEBIT"
balanceType
required
string
Type of account balance message

Allowed values:
"START_OF_DAY"
"END_OF_DAY"
"TRANSACTION"
relatedParticipantIndicator
required
string
Indicator of related participant

required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
transactionDate
required
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.
Additional properties are allowed.
#16InstantPaymentReceivedMessageinstantPaymentReceivedMessage
Callback with new incoming payment
- application/json
Message IDinstantPaymentReceivedMessage
object
messageType
required
string
Const:"InstantPaymentReceivedMessage"
required
array<object>
non-empty
object
paymentUid
required
string
Internal identifier of the payment.

paymentTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentTimestampTZ
string
format: date-time
Date and time with timezone at which payment message was received.

msgId
required
string
Message identifier.

txId
required
string
<= 35 characters
Unique payment identifier as assigned by first instructing agent.

purpose
string
Remittance information provided by the Creditor.

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
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
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
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
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.
#17InstantPaymentReturnedMessageinstantPaymentReturnedMessage
Notification that previously sent payment has been returned
- application/json
Message IDinstantPaymentReturnedMessage
object
messageType
required
string
Const:"InstantPaymentReturnedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

returnId
required
string
Return transaction ID

originalMsgId
required
string
Message ID of original payment

originalTxId
required
string
Transaction ID of original payment

reasonCode
required
string
Reason for returned instant payment.

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"FOLLOWING_CANCELLATION_REQUEST"
"UNKNOWN"
additionalInfo
required
string
Additional information for return reason

required
object
currency
required
string
Currency of the money

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#18InstantPaymentDebitedMessageinstantPaymentDebitedMessage
Incoming instant payment was debited (recalled) by Bank of Lithuania
- application/json
Message IDinstantPaymentDebitedMessage
object
messageType
required
string
Const:"InstantPaymentDebitedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment.

returnId
required
string
<= 255 characters
ID of the returned payment.

originalMsgId
required
string
<= 35 characters
Message ID of original payment.

originalTxId
required
string
<= 35 characters
Transaction ID of original payment.

Additional properties are allowed.
Additional properties are allowed.
#19LiquidityPositionReportMessageliquidityPositionReportMessage
Liquidity position report from Bank of Lithuania
- application/json
Message IDliquidityPositionReportMessage
object
messageType
required
string
Const:"LiquidityPositionReportMessage"
required
array<object>
non-empty
object
reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
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.
identificationCode
required
string
Indicates direction of the liquidity position (CREDIT or DEBIT).

Allowed values:
"CREDIT"
"DEBIT"
Additional properties are allowed.
Additional properties are allowed.
#20InstantPaymentTransactionsReportMessageinstantPaymentTransactionsReportMessage
Report of SEPA Instant transactions from Bank of Lithuania
- application/json
Message IDinstantPaymentTransactionsReportMessage
object
messageType
required
string
Const:"InstantPaymentTransactionsReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Message identifier

reportId
required
string
Identifier of the report

pageNumber
required
integer
The number of the page

last
required
boolean
Whether this is the last page

reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
accountIban
required
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
array<object>
object
transactionType
required
string
Transaction type (CREDIT or DEBIT)

Allowed values:
"CREDIT"
"DEBIT"
debtorBic
required
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"
creditorBic
required
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
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.
originalPaymentTxId
required
string
Transaction ID of the original payment

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#21InstantPaymentStatusRequestMessageinstantPaymentStatusRequestMessage
Notification about current state of the payment
- application/json
Message IDinstantPaymentStatusRequestMessage
object
messageType
required
string
Const:"InstantPaymentStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

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

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

statusRequestId
required
string
Identifier of status request

messageType
required
string
Type of the message for which the status was requested:

PAYMENT – Outgoing instant payment

CANCELLATION – Payment cancellation

UNKNOWN – Unknown type

Allowed values:
"PAYMENT"
"CANCELLATION"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
#22InstantPaymentRetainedMessageinstantPaymentRetainedMessage
Notification about denying to return funds on cancellation
- application/json
Message IDinstantPaymentRetainedMessage
object
messageType
required
string
Const:"InstantPaymentRetainedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

retentionId
required
string
ID of the retained payment

originalMsgId
required
string
Original message ID

originalTxId
required
string
Original transaction ID

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional information about the retention

Additional properties are allowed.
Additional properties are allowed.
#23ParticipantUnavailabilityReportMessageparticipantUnavailabilityReportMessage
Notification about temporary unavailability of a participant
- application/json
Message IDparticipantUnavailabilityReportMessage
object
messageType
required
string
Const:"ParticipantUnavailabilityReportMessage"
required
array<object>
non-empty
object
internalUid
required
string
<= 255 characters
Unique identifier of unavailability

participantBic
required
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"
unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability

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.
object
transactionType
required
string
Transaction type (CREDIT or DEBIT)

Allowed values:
"CREDIT"
"DEBIT"
debtorBic
required
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"
creditorBic
required
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
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.
originalPaymentTxId
required
string
Transaction ID of the original payment

Additional properties are allowed.
object
transactionType
required
string
Type of the transaction

Allowed values:
"CREDIT"
"DEBIT"
balanceType
required
string
Type of account balance message

Allowed values:
"START_OF_DAY"
"END_OF_DAY"
"TRANSACTION"
relatedParticipantIndicator
required
string
Indicator of related participant

required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
transactionDate
required
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.
cancellationReasonCode
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
retainInstantPaymentReasonCode
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
instantMessageType
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
instantPaymentRejectionReason
string
Reason for instant payment rejection

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

INCORRECT_IBAN (AC03) – Incorrect IBAN

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

TRANSACTION_FORBIDDEN (AG01) – Transaction forbidden

INVALID_BANK_OPERATION_CODE (AG02) – Invalid bank operation code

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

INSTRUCTING_AGENT_SUSPENDED (AG10) – Instructing agent suspended

CREDITOR_AGENT_SUSPENDED (AG11) – Creditor agent suspended

INSUFFICIENT_FUND (AM04) – Insufficient funds

WRONG_AMOUNT (AM09) – Wrong amount

AMOUNT_EXCEEDS_LIMIT (AM23) – Amount exceeds settlement limit

ALREADY_RETURNED_TRANSACTION (ARDT) – Already returned transaction

REQUESTED_BY_CUSTOMER (CUST) – Requested by customer

DUPLICATE_PAYMENT (DUPL) – Duplicate payment

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation request

FRAUDULENT_TRANSACTION (FRAD) – Fraudulent transaction

LEGAL_DECISION (LEGL) – Legal decision

CUSTOMER_NOT_SPECIFIED_REASON (MS02) – Not specified reason (customer)

AGENT_NOT_SPECIFIED_REASON (MS03) – Not specified reason (agent)

NO_ANSWER_FROM_CUSTOMER (NOAS) – No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED (NOOR) – Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION (RC01) – Bank identifier incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or identification

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (RR04) – Regulatory reason

TECHNICAL_ERROR (TECH) – Technical error

CUT_OFF_TIME (TM01) – Invalid cut-off time

INSUFFICIENT_LIQUIDITY (XT04) – Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME (XT06) – Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP (XT79) – Debtor agent not allowed to send IP

CREDIT_AGENT_NOT_ALLOWED_SEND_IP (XT80) – Creditor agent not allowed to receive IP

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED (XT83) – Product usage not allowed

UNKNOWN (UNKNOWN) – Unknown reason

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"UNKNOWN"
instantReturnReasonCode
string
Reason for returned instant payment.

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"FOLLOWING_CANCELLATION_REQUEST"
"UNKNOWN"
object
messageType
required
string
Const:"OutgoingInstantPaymentMessage"
required
array<object>
1 items
object
Allows to create a new outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

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

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
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
<= 140 characters
The purpose of the payment. If the text is longer, it will be trimmed automatically.

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
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
Allows to create a new outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

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

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
required
object
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
<= 140 characters
The purpose of the payment. If the text is longer, it will be trimmed automatically.

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
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

Allowed values:
"ANY_BIC"
"LEI"
"REGULAR"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"RejectInstantPaymentMessage"
required
array<object>
1 items
object
Rejects a previously received incoming instant payment.

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

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

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

reasonCode
required
string
Reason for rejection of the instant payment.

CLEARING_TIMEOUT (AB05) – Clearing timeout

CREDITOR_AGENT_NOT_AVAILABLE (AB08) – Creditor agent not available

ERROR_AT_CREDITOR_AGENT (AB09) – Error at creditor agent

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

FORBIDDEN_TRANSACTION (AG01) – Forbidden transaction

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

NOT_ALLOWED_AMOUNT (AM02) – Not allowed amount

DUPLICATE (AM05) – Duplicate

MISSING_CREDITOR_ADDRESS (BE04) – Missing creditor address

DECEASED_CUSTOMER (MD07) – Deceased customer

REASON_NOT_SPECIFIED_BY_CUSTOMER (MS02) – Not specified reason by customer

REASON_NOT_SPECIFIED_BY_AGENT (MS03) – Not specified reason by agent

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or ID

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (PR04) – Regulatory reason

Allowed values:
"CLEARING_TIMEOUT"
"CREDITOR_AGENT_NOT_AVAILABLE"
"ERROR_AT_CREDITOR_AGENT"
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"FORBIDDEN_TRANSACTION"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"NOT_ALLOWED_AMOUNT"
"DUPLICATE"
"MISSING_CREDITOR_ADDRESS"
"DECEASED_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_AGENT"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
originatorBic
string
Rejection originator BIC.

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

Additional properties are allowed.
Additional properties are allowed.
object
Rejects a previously received incoming instant payment.

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

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

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

reasonCode
required
string
Reason for rejection of the instant payment.

CLEARING_TIMEOUT (AB05) – Clearing timeout

CREDITOR_AGENT_NOT_AVAILABLE (AB08) – Creditor agent not available

ERROR_AT_CREDITOR_AGENT (AB09) – Error at creditor agent

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

FORBIDDEN_TRANSACTION (AG01) – Forbidden transaction

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

NOT_ALLOWED_AMOUNT (AM02) – Not allowed amount

DUPLICATE (AM05) – Duplicate

MISSING_CREDITOR_ADDRESS (BE04) – Missing creditor address

DECEASED_CUSTOMER (MD07) – Deceased customer

REASON_NOT_SPECIFIED_BY_CUSTOMER (MS02) – Not specified reason by customer

REASON_NOT_SPECIFIED_BY_AGENT (MS03) – Not specified reason by agent

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or ID

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (PR04) – Regulatory reason

Allowed values:
"CLEARING_TIMEOUT"
"CREDITOR_AGENT_NOT_AVAILABLE"
"ERROR_AT_CREDITOR_AGENT"
"INCORRECT_ACCOUNT_NUMBER"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"FORBIDDEN_TRANSACTION"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"NOT_ALLOWED_AMOUNT"
"DUPLICATE"
"MISSING_CREDITOR_ADDRESS"
"DECEASED_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_CUSTOMER"
"REASON_NOT_SPECIFIED_BY_AGENT"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
originatorBic
string
Rejection originator BIC.

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

Additional properties are allowed.
object
messageType
required
string
Const:"ConfirmInstantPaymentMessage"
required
array<object>
1 items
object
Confirms a previously received incoming instant payment.

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

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

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

Additional properties are allowed.
Additional properties are allowed.
object
Confirms a previously received incoming instant payment.

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

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

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

Additional properties are allowed.
object
Cancel a previously sent outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Will be trimmed if exceeds the limit.

Additional properties are allowed.
object
messageType
required
string
Const:"CancelInstantPaymentMessage"
required
array<object>
1 items
object
Cancel a previously sent outgoing instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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

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

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
additionalInfo
string
<= 105 characters
Additional information about cancellation. Will be trimmed if exceeds the limit.

Additional properties are allowed.
Additional properties are allowed.
object
Return a previously received instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment to be returned.

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

txId
string
must match: ^[0-9a-zA-Z\-?:().,'+ ]{1,35}$
Unique identification of the related 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.
Additional properties are allowed.
object
messageType
required
string
Const:"ReturnInstantPaymentMessage"
required
array<object>
1 items
object
Return a previously received instant payment.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment to be returned.

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

txId
string
must match: ^[0-9a-zA-Z\-?:().,'+ ]{1,35}$
Unique identification of the related 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.
Additional properties are allowed.
Additional properties are allowed.
object
Do not return funds for a previously received payment cancellation.

paymentUid
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 related original message

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

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional retention information (optional comment or justification).

Additional properties are allowed.
object
messageType
required
string
Const:"RetainInstantPaymentMessage"
required
array<object>
1 items
object
Do not return funds for a previously received payment cancellation.

paymentUid
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 related original message

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

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional retention information (optional comment or justification).

Additional properties are allowed.
Additional properties are allowed.
object
Request for liquidity transfer between internal accounts.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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"
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"
Additional properties are allowed.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"LiquidityTransferRequestMessage"
required
array<object>
1 items
object
Request for liquidity transfer between internal accounts.

paymentUid
required
string
<= 255 characters
Unique identifier of the payment.

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"
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"
Additional properties are allowed.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
Request for the status of an outgoing instant payment cancellation.

cancelledPaymentUid
required
string
<= 255 characters
Unique identifier of the payment being checked for cancellation status.

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

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

Additional properties are allowed.
object
messageType
required
string
Const:"RequestInstantCancellationStatusMessage"
required
array<object>
1 items
object
Request for the status of an outgoing instant payment cancellation.

cancelledPaymentUid
required
string
<= 255 characters
Unique identifier of the payment being checked for cancellation status.

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

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

Additional properties are allowed.
Additional properties are allowed.
object
System unavailability report details.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of unavailability.

unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability.

Additional properties are allowed.
object
messageType
required
string
Const:"SystemUnavailabilityReportMessage"
required
array<object>
1 items
object
System unavailability report details.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of unavailability.

unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability.

Additional properties are allowed.
Additional properties are allowed.
object
Payload for cancelling a previously sent system unavailability report.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of previously sent unavailability.

Additional properties are allowed.
object
messageType
required
string
Const:"CancelSystemUnavailabilityReportMessage"
required
array<object>
1 items
object
Payload for cancelling a previously sent system unavailability report.

unavailabilityUid
required
string
<= 255 characters
Unique identifier of previously sent unavailability.

Additional properties are allowed.
Additional properties are allowed.
object
Payload of accepted instant message

originalMessageUid
required
string
Unique internal identifier of the outgoing payment

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

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

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
Additional properties are allowed.
object
messageType
required
string
Const:"InstantMessageAccepted"
required
array<object>
non-empty
object
Payload of accepted instant message

originalMessageUid
required
string
Unique internal identifier of the outgoing payment

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

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

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
Additional properties are allowed.
Additional properties are allowed.
object
Payload of rejected instant message

originalMessageUid
required
string
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 related original transaction

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
rejectionReason
required
string
Reason for instant payment rejection

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

INCORRECT_IBAN (AC03) – Incorrect IBAN

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

TRANSACTION_FORBIDDEN (AG01) – Transaction forbidden

INVALID_BANK_OPERATION_CODE (AG02) – Invalid bank operation code

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

INSTRUCTING_AGENT_SUSPENDED (AG10) – Instructing agent suspended

CREDITOR_AGENT_SUSPENDED (AG11) – Creditor agent suspended

INSUFFICIENT_FUND (AM04) – Insufficient funds

WRONG_AMOUNT (AM09) – Wrong amount

AMOUNT_EXCEEDS_LIMIT (AM23) – Amount exceeds settlement limit

ALREADY_RETURNED_TRANSACTION (ARDT) – Already returned transaction

REQUESTED_BY_CUSTOMER (CUST) – Requested by customer

DUPLICATE_PAYMENT (DUPL) – Duplicate payment

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation request

FRAUDULENT_TRANSACTION (FRAD) – Fraudulent transaction

LEGAL_DECISION (LEGL) – Legal decision

CUSTOMER_NOT_SPECIFIED_REASON (MS02) – Not specified reason (customer)

AGENT_NOT_SPECIFIED_REASON (MS03) – Not specified reason (agent)

NO_ANSWER_FROM_CUSTOMER (NOAS) – No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED (NOOR) – Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION (RC01) – Bank identifier incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or identification

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (RR04) – Regulatory reason

TECHNICAL_ERROR (TECH) – Technical error

CUT_OFF_TIME (TM01) – Invalid cut-off time

INSUFFICIENT_LIQUIDITY (XT04) – Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME (XT06) – Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP (XT79) – Debtor agent not allowed to send IP

CREDIT_AGENT_NOT_ALLOWED_SEND_IP (XT80) – Creditor agent not allowed to receive IP

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED (XT83) – Product usage not allowed

UNKNOWN (UNKNOWN) – Unknown reason

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"UNKNOWN"
originatorBic
string
Rejection originator BIC

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

Additional properties are allowed.
object
messageType
required
string
Const:"InstantMessageRejected"
required
array<object>
non-empty
object
Payload of rejected instant message

originalMessageUid
required
string
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 related original transaction

messageType
required
string
Type of instant message

INCOMING_PAYMENT — IFCCTRNS-IN (Incoming payment)

OUTGOING_PAYMENT — IFCCTRNS-OUT (Outgoing payment)

STATUS_REPORT — IFPSRPRT-OUT (Status report)

STATUS_REQUEST — IFPSRPRQ-OUT (Status request)

CANCELLATION — IFPCRQST-OUT (Cancellation request)

PAYMENT_RETAINMENT — IROINVST-OUT (Retainment)

PAYMENT_RETURN — IPRTRN-OUT (Return)

LIQUIDITY_TRANSFER — ILTREQ-OUT (Liquidity transfer)

Allowed values:
"INCOMING_PAYMENT"
"OUTGOING_PAYMENT"
"STATUS_REPORT"
"STATUS_REQUEST"
"CANCELLATION"
"PAYMENT_RETAINMENT"
"PAYMENT_RETURN"
"LIQUIDITY_TRANSFER"
rejectionReason
required
string
Reason for instant payment rejection

INCORRECT_ACCOUNT_NUMBER (AC01) – Incorrect account number

INCORRECT_IBAN (AC03) – Incorrect IBAN

CLOSED_ACCOUNT (AC04) – Closed account

BLOCKED_ACCOUNT (AC06) – Blocked account

TRANSACTION_FORBIDDEN (AG01) – Transaction forbidden

INVALID_BANK_OPERATION_CODE (AG02) – Invalid bank operation code

ORIGINAL_PAYMENT_NOT_RECEIVED (AG09) – Original payment not received

INSTRUCTING_AGENT_SUSPENDED (AG10) – Instructing agent suspended

CREDITOR_AGENT_SUSPENDED (AG11) – Creditor agent suspended

INSUFFICIENT_FUND (AM04) – Insufficient funds

WRONG_AMOUNT (AM09) – Wrong amount

AMOUNT_EXCEEDS_LIMIT (AM23) – Amount exceeds settlement limit

ALREADY_RETURNED_TRANSACTION (ARDT) – Already returned transaction

REQUESTED_BY_CUSTOMER (CUST) – Requested by customer

DUPLICATE_PAYMENT (DUPL) – Duplicate payment

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation request

FRAUDULENT_TRANSACTION (FRAD) – Fraudulent transaction

LEGAL_DECISION (LEGL) – Legal decision

CUSTOMER_NOT_SPECIFIED_REASON (MS02) – Not specified reason (customer)

AGENT_NOT_SPECIFIED_REASON (MS03) – Not specified reason (agent)

NO_ANSWER_FROM_CUSTOMER (NOAS) – No answer from customer

ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED (NOOR) – Original credit transfer not received

MISSING_DEBTOR_ACCOUNT_IDENTIFICATION (RC01) – Bank identifier incorrect

MISSING_DEBTOR_ACCOUNT_OR_ID (RR01) – Missing debtor account or identification

MISSING_DEBTOR_NAME_OR_ADDRESS (RR02) – Missing debtor name or address

MISSSING_CREDITOR_NAME_OR_ADDRESS (RR03) – Missing creditor name or address

REGULATORY_REASON (RR04) – Regulatory reason

TECHNICAL_ERROR (TECH) – Technical error

CUT_OFF_TIME (TM01) – Invalid cut-off time

INSUFFICIENT_LIQUIDITY (XT04) – Insufficient liquidity

INVALID_ACCEPTANCE_DATE_TIME (XT06) – Invalid acceptance date/time

DEBTOR_AGENT_NOT_ALLOWED_SEND_IP (XT79) – Debtor agent not allowed to send IP

CREDIT_AGENT_NOT_ALLOWED_SEND_IP (XT80) – Creditor agent not allowed to receive IP

PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED (XT83) – Product usage not allowed

UNKNOWN (UNKNOWN) – Unknown reason

Allowed values:
"INCORRECT_ACCOUNT_NUMBER"
"INCORRECT_IBAN"
"CLOSED_ACCOUNT"
"BLOCKED_ACCOUNT"
"TRANSACTION_FORBIDDEN"
"INVALID_BANK_OPERATION_CODE"
"ORIGINAL_PAYMENT_NOT_RECEIVED"
"INSTRUCTING_AGENT_SUSPENDED"
"CREDITOR_AGENT_SUSPENDED"
"INSUFFICIENT_FUND"
"WRONG_AMOUNT"
"AMOUNT_EXCEEDS_LIMIT"
"ALREADY_RETURNED_TRANSACTION"
"REQUESTED_BY_CUSTOMER"
"DUPLICATE_PAYMENT"
"FOLLOWING_CANCELLATION_REQUEST"
"FRAUDULENT_TRANSACTION"
"LEGAL_DECISION"
"CUSTOMER_NOT_SPECIFIED_REASON"
"AGENT_NOT_SPECIFIED_REASON"
"NO_ANSWER_FROM_CUSTOMER"
"ORIGINAL_CREDIT_TRANSFER_NOT_RECEIVED"
"MISSING_DEBTOR_ACCOUNT_IDENTIFICATION"
"MISSING_DEBTOR_ACCOUNT_OR_ID"
"MISSING_DEBTOR_NAME_OR_ADDRESS"
"MISSSING_CREDITOR_NAME_OR_ADDRESS"
"REGULATORY_REASON"
"TECHNICAL_ERROR"
"CUT_OFF_TIME"
"INSUFFICIENT_LIQUIDITY"
"INVALID_ACCEPTANCE_DATE_TIME"
"DEBTOR_AGENT_NOT_ALLOWED_SEND_IP"
"CREDIT_AGENT_NOT_ALLOWED_SEND_IP"
"PARTICIPANT_PRODUCT_USAGE_NOT_ALLOWED"
"UNKNOWN"
originatorBic
string
Rejection originator BIC

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

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

additionalReasonInfo
string
<= 105 characters
Additional information provided with the cancellation.

originalMsgId
required
string
<= 35 characters
Original message ID.

cancellationId
string
<= 35 characters
Cancellation message ID.

originalTxId
string
<= 35 characters
Original transaction ID.

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Unique internal identifier of the outgoing payment.

additionalReasonInfo
string
<= 105 characters
Additional information provided with the cancellation.

originalMsgId
required
string
<= 35 characters
Original message ID.

cancellationId
string
<= 35 characters
Cancellation message ID.

originalTxId
string
<= 35 characters
Original transaction ID.

reasonCode
required
string
Cancellation reason code.

DUPLICATE -- Payment was duplicated

FRAUD -- Fraud

TECHNICAL_ISSUE -- Technical issue

DEBTOR_REQUESTED_ISSUE -- Issue requested by Debtor

WRONG_AMOUNT -- Wrong amount

WRONG_IBAN -- Wrong IBAN

UNKNOWN -- Unknown

Allowed values:
"DUPLICATE"
"FRAUD"
"TECHNICAL_ISSUE"
"DEBTOR_REQUESTED_ISSUE"
"WRONG_AMOUNT"
"WRONG_IBAN"
"UNKNOWN"
Additional properties are allowed.
object
messageType
required
string
Const:"LiquidityTransferReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Incoming message identifier.

transactionId
required
string
Liquidity transfer transaction ID.

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.
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.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
msgId
required
string
Incoming message identifier.

transactionId
required
string
Liquidity transfer transaction ID.

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.
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.
required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"AccountStatementReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Message identifier

pageNumber
required
integer
format: int64
The number of the page

last
required
boolean
Is this page last?

required
array<object>
The array of account balances

object
transactionType
required
string
Type of the transaction

Allowed values:
"CREDIT"
"DEBIT"
balanceType
required
string
Type of account balance message

Allowed values:
"START_OF_DAY"
"END_OF_DAY"
"TRANSACTION"
relatedParticipantIndicator
required
string
Indicator of related participant

required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
transactionDate
required
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.
Additional properties are allowed.
object
msgId
required
string
Message identifier

pageNumber
required
integer
format: int64
The number of the page

last
required
boolean
Is this page last?

required
array<object>
The array of account balances

object
transactionType
required
string
Type of the transaction

Allowed values:
"CREDIT"
"DEBIT"
balanceType
required
string
Type of account balance message

Allowed values:
"START_OF_DAY"
"END_OF_DAY"
"TRANSACTION"
relatedParticipantIndicator
required
string
Indicator of related participant

required
object
currency
required
string
Currency of the money

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

Additional properties are allowed.
transactionDate
required
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
Internal identifier of the payment.

paymentTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentTimestampTZ
string
format: date-time
Date and time with timezone at which payment message was received.

msgId
required
string
Message identifier.

txId
required
string
<= 35 characters
Unique payment identifier as assigned by first instructing agent.

purpose
string
Remittance information provided by the Creditor.

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
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
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
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
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:"InstantPaymentReceivedMessage"
required
array<object>
non-empty
object
paymentUid
required
string
Internal identifier of the payment.

paymentTimestamp
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
paymentTimestampTZ
string
format: date-time
Date and time with timezone at which payment message was received.

msgId
required
string
Message identifier.

txId
required
string
<= 35 characters
Unique payment identifier as assigned by first instructing agent.

purpose
string
Remittance information provided by the Creditor.

required
object
required
object
Information on party’s personal details

type
required
string
Type of the party:

ORG -- organization

PRIVATE -- private person

UNKNOWN -- unknown person type

NONE -- no person type

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

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

deprecated
allOf
Country code of the party.

Deprecation: Use structured address to specify this value

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

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

Deprecation: Use structured address instead

object
Structured address.

streetName
string
<= 70 characters
Street Name

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

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

floor
string
<= 70 characters
Floor

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

room
string
<= 70 characters
Room

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

townName
string
<= 35 characters
Town Name

townLocationName
string
<= 35 characters
Town Location Name

districtName
string
<= 35 characters
District Name

countrySubDivision
string
<= 35 characters
Country Sub Division

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

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

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

required
allOf
Number of the party’s account

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

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

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
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
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
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
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
Internal identifier of the original payment

returnId
required
string
Return transaction ID

originalMsgId
required
string
Message ID of original payment

originalTxId
required
string
Transaction ID of original payment

reasonCode
required
string
Reason for returned instant payment.

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"FOLLOWING_CANCELLATION_REQUEST"
"UNKNOWN"
additionalInfo
required
string
Additional information for return reason

required
object
currency
required
string
Currency of the money

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

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

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

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"InstantPaymentReturnedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

returnId
required
string
Return transaction ID

originalMsgId
required
string
Message ID of original payment

originalTxId
required
string
Transaction ID of original payment

reasonCode
required
string
Reason for returned instant payment.

FOLLOWING_CANCELLATION_REQUEST (FOCR) – Following cancellation

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"FOLLOWING_CANCELLATION_REQUEST"
"UNKNOWN"
additionalInfo
required
string
Additional information for return reason

required
object
currency
required
string
Currency of the money

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

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

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

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"InstantPaymentDebitedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment.

returnId
required
string
<= 255 characters
ID of the returned payment.

originalMsgId
required
string
<= 35 characters
Message ID of original payment.

originalTxId
required
string
<= 35 characters
Transaction ID of original payment.

Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment.

returnId
required
string
<= 255 characters
ID of the returned payment.

originalMsgId
required
string
<= 35 characters
Message ID of original payment.

originalTxId
required
string
<= 35 characters
Transaction ID of original payment.

Additional properties are allowed.
object
messageType
required
string
Const:"LiquidityPositionReportMessage"
required
array<object>
non-empty
object
reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
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.
identificationCode
required
string
Indicates direction of the liquidity position (CREDIT or DEBIT).

Allowed values:
"CREDIT"
"DEBIT"
Additional properties are allowed.
Additional properties are allowed.
object
reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
required
object
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.
identificationCode
required
string
Indicates direction of the liquidity position (CREDIT or DEBIT).

Allowed values:
"CREDIT"
"DEBIT"
Additional properties are allowed.
object
msgId
required
string
Message identifier

reportId
required
string
Identifier of the report

pageNumber
required
integer
The number of the page

last
required
boolean
Whether this is the last page

reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
accountIban
required
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
array<object>
object
transactionType
required
string
Transaction type (CREDIT or DEBIT)

Allowed values:
"CREDIT"
"DEBIT"
debtorBic
required
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"
creditorBic
required
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
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.
originalPaymentTxId
required
string
Transaction ID of the original payment

Additional properties are allowed.
Additional properties are allowed.
object
messageType
required
string
Const:"InstantPaymentTransactionsReportMessage"
required
array<object>
non-empty
object
msgId
required
string
Message identifier

reportId
required
string
Identifier of the report

pageNumber
required
integer
The number of the page

last
required
boolean
Whether this is the last page

reportDate
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
accountIban
required
string
must match: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
Examples values:
"LT121000011101001000"
required
array<object>
object
transactionType
required
string
Transaction type (CREDIT or DEBIT)

Allowed values:
"CREDIT"
"DEBIT"
debtorBic
required
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"
creditorBic
required
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
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.
originalPaymentTxId
required
string
Transaction ID of the original payment

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
instantStatusRequestMessageType
string
Type of the message for which the status was requested:

PAYMENT – Outgoing instant payment

CANCELLATION – Payment cancellation

UNKNOWN – Unknown type

Allowed values:
"PAYMENT"
"CANCELLATION"
"UNKNOWN"
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

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

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

statusRequestId
required
string
Identifier of status request

messageType
required
string
Type of the message for which the status was requested:

PAYMENT – Outgoing instant payment

CANCELLATION – Payment cancellation

UNKNOWN – Unknown type

Allowed values:
"PAYMENT"
"CANCELLATION"
"UNKNOWN"
Additional properties are allowed.
object
messageType
required
string
Const:"InstantPaymentStatusRequestMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

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

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

statusRequestId
required
string
Identifier of status request

messageType
required
string
Type of the message for which the status was requested:

PAYMENT – Outgoing instant payment

CANCELLATION – Payment cancellation

UNKNOWN – Unknown type

Allowed values:
"PAYMENT"
"CANCELLATION"
"UNKNOWN"
Additional properties are allowed.
Additional properties are allowed.
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

retentionId
required
string
ID of the retained payment

originalMsgId
required
string
Original message ID

originalTxId
required
string
Original transaction ID

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional information about the retention

Additional properties are allowed.
object
messageType
required
string
Const:"InstantPaymentRetainedMessage"
required
array<object>
non-empty
object
originalPaymentUid
required
string
<= 255 characters
Internal identifier of the original payment

retentionId
required
string
ID of the retained payment

originalMsgId
required
string
Original message ID

originalTxId
required
string
Original transaction ID

reasonCode
required
string
Reason code for retaining the incoming payment:

INSUFFICIENT_FUNDS (AM04) – There are insufficient funds on the account

CLOSED_ACCOUNT (AC04) – The account is closed

LEGAL_REASONS (LEGL) – For legal reasons, specifying the reason in clear text

REFUSAL (CUST) – Refusal by Creditor to return

NO_ANSWER_FROM_CREDITOR (NOAS) – No answer is received from the Creditor

NO_FUNDS_RECEIVED (NOOR) – The funds were not received

ALREADY_RETURNED (ARDT) – The funds have already been returned

UNKNOWN (UNKNOWN) – Unknown

Allowed values:
"INSUFFICIENT_FUNDS"
"CLOSED_ACCOUNT"
"LEGAL_REASONS"
"REFUSAL"
"NO_ANSWER_FROM_CREDITOR"
"NO_FUNDS_RECEIVED"
"ALREADY_RETURNED"
"UNKNOWN"
additionalInfo
required
string
<= 105 characters
Additional information about the retention

Additional properties are allowed.
Additional properties are allowed.
object
internalUid
required
string
<= 255 characters
Unique identifier of unavailability

participantBic
required
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"
unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability

Additional properties are allowed.
object
messageType
required
string
Const:"ParticipantUnavailabilityReportMessage"
required
array<object>
non-empty
object
internalUid
required
string
<= 255 characters
Unique identifier of unavailability

participantBic
required
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"
unavailabilityStart
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
unavailabilityEnd
required
string
must match: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}
Examples values:
"2019-11-21T16:32:59"
description
string
Description of the reason of unavailability

Additional properties are allowed.
Additional properties are allowed.

SEPA Instant Transfer Gateway API 1.7.1

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.

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.

Messages

Schemas