Endpoints url
discount sandbox
https://mtls-api-nonprod.discountbank.co.il/devapi/cert
discount prod
https://mtls-api.discountbank.co.il/prod/d
mercantile sandbox
https://mtls-api-nonprod.mercantile.co.il/devapi/cert
mercantile prod
https://mtls-api.mercantile.co.il/prod/d
Summary
A Request to Pay scheme (RTP scheme) defines rules, messages and data sets for the exchange of a Request to Pay message (RTP message) from an originator to a receiver. With the Request to Pay Services of the openFinance API Framework, a service provider can use its openFinance API to receive RTP messages and to inform the sender about the status of the corresponding RTP transaction as well as potentially the status of the related payment.
The Berlin Group - A European Standards Initiative
production
development
https://mtls-api.discountbank.co.il/prod/d
Paths
/v2.1/requests-for-payments/{payment-product}
post /v2.1/requests-for-payments/{payment-product}
Request to Pay (RTP) API
Submits a request to pay transaction.
Submits a request to pay transaction.
payment-product
Required in path
string
The addressed payment product, e.g. for SEPA Credit Transfers (SCT). The default list of products for RTP supported in this standard is: -- masav -- zahav -- fp -- swift The ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client. For definitions of basic non euro generic products see [XS2A-DP]. Further products might be published by the ASPSP within its openFinance API documentation.
{
"enum": [
"masav",
"zahav",
"fp",
"swift"
]
}Digest
Required in header
string
When API Client include a signature according to this signature profile, they also must include a \"Digest\" header as defined in [RFC3230]. The \"Digest\" Header contains a Hash of the message body. If the message does not contain a body, the \"Digest\" header must contain the hash of an empty byte list. The only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843].
{
"x-example": "SHA-256=hl1\/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A="
}X-Request-ID
Required in header
string / uuid
ID of the request, unique to the call, as determined by the initiating party.
{
"x-example": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
}x-jws-signature
Required in header
string
The attribute x-jws-signature contains the JSON Web Signature.
{
"x-example": "eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4"
}API-Contract-ID
Required in header
string
Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
{
"x-example": "Regulation"
}body
Required in body
object
Request body for a RTP request.
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
408
Request Timeout
409
Conflict
415
Unsupported Media Type
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
POST https://mtls-api.discountbank.co.il/prod/d/psd2/v2.1/requests-for-payments/{payment-product}
Try this operation
/v2.1/requests-for-payments/{payment-product}/{paymentId}/status
get /v2.1/requests-for-payments/{payment-product}/{paymentId}/status
Request to Pay (RTP) API
Get Transaction Status Request
Reads the status of an RTP initiation.
payment-product
Required in path
string
The addressed payment product, e.g. for SEPA Credit Transfers (SCT). The default list of products for RTP supported in this standard is: -- masav -- zahav -- fp -- swift The ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client. For definitions of basic non euro generic products see [XS2A-DP]. Further products might be published by the ASPSP within its openFinance API documentation.
{
"enum": [
"masav",
"zahav",
"fp",
"swift"
]
}paymentId
Required in path
string
Resource identification of the related payment.
{
"maxLength": 70,
"x-example": "fe7552ee-0728-4bd1-baf7-94942331e478"
}Digest
Required in header
string
When API Client include a signature according to this signature profile, they also must include a \"Digest\" header as defined in [RFC3230]. The \"Digest\" Header contains a Hash of the message body. If the message does not contain a body, the \"Digest\" header must contain the hash of an empty byte list. The only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843].
{
"x-example": "SHA-256=hl1\/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A="
}x-jws-signature
Required in header
string
The attribute x-jws-signature contains the JSON Web Signature.
{
"x-example": "eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4"
}X-Request-ID
Required in header
string / uuid
ID of the request, unique to the call, as determined by the initiating party.
{
"x-example": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
}Accept
Optional in header
string
application/json
200
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
408
Request Timeout
409
Conflict
415
Unsupported Media Type
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
GET https://mtls-api.discountbank.co.il/prod/d/psd2/v2.1/requests-for-payments/{payment-product}/{paymentId}/status
Try this operation
/v2.1/requests-for-payments/{payment-product}/{paymentId}
get /v2.1/requests-for-payments/{payment-product}/{paymentId}
Request to Pay (RTP) API
Get Request to Pay Request
Returns the content of a request to pay object.
payment-product
Required in path
string
The addressed payment product, e.g. for SEPA Credit Transfers (SCT). The default list of products for RTP supported in this standard is: -- masav -- zahav -- fp -- swift The ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client. For definitions of basic non euro generic products see [XS2A-DP]. Further products might be published by the ASPSP within its openFinance API documentation.
{
"enum": [
"masav",
"zahav",
"fp",
"swift"
]
}paymentId
Required in path
string
Resource identification of the related payment.
{
"maxLength": 70,
"x-example": "fe7552ee-0728-4bd1-baf7-94942331e478"
}Digest
Required in header
string
When API Client include a signature according to this signature profile, they also must include a \"Digest\" header as defined in [RFC3230]. The \"Digest\" Header contains a Hash of the message body. If the message does not contain a body, the \"Digest\" header must contain the hash of an empty byte list. The only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843].
{
"x-example": "SHA-256=hl1\/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A="
}x-jws-signature
Required in header
string
The attribute x-jws-signature contains the JSON Web Signature.
{
"x-example": "eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4"
}X-Request-ID
Required in header
string / uuid
ID of the request, unique to the call, as determined by the initiating party.
{
"x-example": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
}Accept
Optional in header
string
application/json
200
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
408
Request Timeout
409
Conflict
415
Unsupported Media Type
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
GET https://mtls-api.discountbank.co.il/prod/d/psd2/v2.1/requests-for-payments/{payment-product}/{paymentId}
Try this operation
delete /v2.1/requests-for-payments/{payment-product}/{paymentId}
Request to Pay (RTP) API
Request to Pay Cancellation Request
It initiates the cancellation of a request to pay.
payment-product
Required in path
string
The addressed payment product, e.g. for SEPA Credit Transfers (SCT). The default list of products for RTP supported in this standard is: -- masav -- zahav -- fp -- swift The ASPSP will publish which of the payment products/endpoints will be supported. The generic sepa credit transfer product reflects that no preference on SCT or SCT Inst is mandated by the API Client. For definitions of basic non euro generic products see [XS2A-DP]. Further products might be published by the ASPSP within its openFinance API documentation.
{
"enum": [
"masav",
"zahav",
"fp",
"swift"
]
}paymentId
Required in path
string
Resource identification of the related payment.
{
"maxLength": 70,
"x-example": "fe7552ee-0728-4bd1-baf7-94942331e478"
}Digest
Required in header
string
When API Client include a signature according to this signature profile, they also must include a \"Digest\" header as defined in [RFC3230]. The \"Digest\" Header contains a Hash of the message body. If the message does not contain a body, the \"Digest\" header must contain the hash of an empty byte list. The only hash algorithms that may be used to calculate the Digest within the context of this specification are SHA-256 and SHA-512 as defined in [RFC5843].
{
"x-example": "SHA-256=hl1\/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A="
}x-jws-signature
Required in header
string
The attribute x-jws-signature contains the JSON Web Signature.
{
"x-example": "eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4"
}X-Request-ID
Required in header
string / uuid
ID of the request, unique to the call, as determined by the initiating party.
{
"x-example": "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
}Accept
Optional in header
string
application/json
204
NO CONTENT
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
408
Request Timeout
409
Conflict
415
Unsupported Media Type
500
Internal Server Error
503
Service Unavailable
Example Request
Example Response
DELETE https://mtls-api.discountbank.co.il/prod/d/psd2/v2.1/requests-for-payments/{payment-product}/{paymentId}
Try this operation
Definitions
{
"type": "object",
"required": [
"paymentId",
"transactionStatus",
"requestStatus",
"_links"
],
"properties": {
"paymentId": {
"description": "resource identification of the generated payment initiation resource.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"transactionStatus": {
"description": "The status of the related payment.\n\"pending\" is used if the payment could not yet be checked or submitted.\n",
"allOf": [
{
"$ref": "#\/definitions\/TransactionStatus"
}
]
},
"requestStatus": {
"description": "The status of the related request to pay transaction.\n",
"allOf": [
{
"$ref": "#\/definitions\/RequestStatus"
}
]
},
"reasonCode": {
"description": "Additional information on the reason for e.g. rejecting the request \n",
"allOf": [
{
"$ref": "#\/definitions\/StatusReasonCode"
}
]
},
"reasonProprietary": {
"description": "Proprietary additional information on the reason for e.g. rejecting the request. \nRemark: If an ISO Code is available it should be used instead of Proprietary \nReasons. Further restrictions could be defined by API Access Schemes.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"transactionFees": {
"description": "Might be used by the ASPSP to transport the total transaction fee relevant in case of an\nunderlying payment initiation service. This field includes the entry of the \ncurrencyConversionFees if applicable. \n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"currencyConversionFees": {
"description": "Might be used by the ASPSP to transport specific currency conversion fees related to \nthe initiated credit transfer, in case of an underlying payment initiation service.\n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"estimatedTotalAmount": {
"description": "The amount which is estimated to be debted from the debtor account in case of an \nunderlying payment initiation service. \nNote: This amount includes fees.\n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"estimatedInterbankSettlementAmount": {
"description": "The estimated amount to be transferred to the payee. \n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"transactionFeeIndicator": {
"description": "If equals \\\"true\\\", the transaction will involve specific transaction cost as shown by the ASPSP in\ntheir public price list or as agreed between ASPSP and PSU.\nIf equals \\\"false\\\", the transaction will not involve additional specific transaction costs to the PSU unless the fee amount is given specifically in the data elements transactionFees and\/or currencyConversionFees.\nIf this data element is not used, there is no information about transaction fees unless the fee amount is given explicitly in the data element transactionFees and\/or currencyConversionFees.\n",
"type": "boolean"
},
"_links": {
"description": "A list of hyperlinks to be recognised by the API Client. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP \nwhen processing the request. The potential links for this response message are generically defined in [oFA SMPF] for all Transaction Initiation \nResponse messages. These links will also be contained in the related Open API files. \nRemark: All links can be relative or full links, to be decided by the ASPSP.\n",
"allOf": [
{
"$ref": "#\/definitions\/_links_200_RTP"
}
]
},
"psuMessage": {
"description": "Text to be displayed to the PSU.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max500Text"
}
]
},
"apiClientMessages": {
"description": "Messages to the API Client on operational issues.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation"
}
},
"paymentIdentification": {
"description": "Set of elements used to reference a payment instruction.\n",
"allOf": [
{
"$ref": "#\/definitions\/paymentIdentification"
}
]
},
"paymentMethod": {
"description": "Specifies the means of payment that will be used to move the amount of money.\nUsage: Only used for cross-border transactions.\nIf no paymentMethod is explicitly stated, paymentMethod will be interpreted as **TRF** (Credit Transfer).\n",
"allOf": [
{
"$ref": "#\/definitions\/CreditTransferPaymentMethodCode"
}
]
},
"categoryPurposeCode": {
"description": "Specifies the high level purpose of the instruction based on a set of pre-defined categories; provided as code.\n",
"allOf": [
{
"$ref": "#\/definitions\/CategoryPurposeCode"
}
]
},
"ultimateDebtor": {
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor. Restriction to the schema are applied depending on the product.\n",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription1"
}
]
},
"instructedAmount": {
"description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"creditorAccount": {
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.\n",
"allOf": [
{
"$ref": "#\/definitions\/accountReference1"
}
]
},
"creditorAgent": {
"description": "Financial institution servicing an account for the creditor.\n",
"allOf": [
{
"$ref": "#\/definitions\/agentDescription1"
}
]
},
"creditor": {
"description": "Party to which an amount of money is due.\n",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription"
}
]
},
"ultimateCreditor": {
"description": "Ultimate party to which an amount of money is due.\n",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription"
}
]
},
"purposeCode": {
"description": "Specifies the purpose of the instruction based the code set ExternalPurpose1Code from ISO 20022.\n",
"allOf": [
{
"$ref": "#\/definitions\/PurposeCode"
}
]
},
"purposeProprietary": {
"description": "Specifies the purpose of the instruction in proprietary encoding\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"remittanceInformationUnstructured": {
"description": "Information supplied to enable the matching\/reconciliation of an entry with the items that the payment is intended to settle, \nsuch as commercial invoices in an accounts' receivable system, in an unstructured form.\n",
"type": "array",
"minItems": 1,
"maxItems": 1,
"items": {
"$ref": "#\/definitions\/Max140Text"
},
"example": [
"{\"Ref Number Merchant\"}"
]
},
"additionalRequestInformation": {
"description": "Request related information which is not directly linked to the payment transaction.\nOnly applicable for request to pay services and extended payment services.\n",
"allOf": [
{
"$ref": "#\/definitions\/additionalRequestInformation"
}
]
},
"debtorAccount": {
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.\n",
"allOf": [
{
"$ref": "#\/definitions\/accountReference"
}
]
},
"debtor": {
"description": "Party that owes an amount of money to the (ultimate) creditor.\n",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription"
}
]
},
"requestedExecutionDate": {
"description": "Date at which the initiating party requests the clearing agent to process the payment.\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODate"
}
]
},
"requestedExecutionDateTime": {
"description": "Date and time at which the initiating party requests the clearing agent to process the payment.\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODateTime"
}
]
}
}
}
{
"type": "object",
"required": [
"transactionStatus"
],
"properties": {
"transactionStatus": {
"description": "The status of the related payment.\n\"pending\" is used if the payment could not yet be checked or submitted.\n",
"allOf": [
{
"$ref": "#\/definitions\/TransactionStatus"
}
]
},
"requestStatus": {
"description": "The status of the related request to pay transaction. To be delivered by the API Server if not agreed otherwise.\n",
"allOf": [
{
"$ref": "#\/definitions\/RequestStatus"
}
]
},
"reasonCode": {
"description": "Additional information on the reason for e.g. rejecting the request \n",
"allOf": [
{
"$ref": "#\/definitions\/StatusReasonCode"
}
]
},
"reasonProprietary": {
"description": "Proprietary additional information on the reason for e.g. rejecting the request. \nRemark: If an ISO Code is available it should be used instead of Proprietary \nReasons. Further restrictions could be defined by API Access Schemes.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"debtorDecisionDateTime": {
"description": "The date and time when the PSU has decided on accepting\/rejecting the related request.\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODateTime"
}
]
},
"acceptedAmount": {
"description": "Contained only if the accepted amount deviates from the instructed amount.\n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"acceptanceDateTime": {
"description": "Contained only if the agreed requested execution date deviates from the requested execution date in the request.\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODateTime"
}
]
},
"acceptedPaymentInstrument": {
"description": "masav or zahav or fp swift.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max105Text"
}
]
},
"statusIdentification": {
"description": "Reference added by the debtor\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"psuMessage": {
"description": "Text information for the PSU.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max500Text"
}
]
}
}
}
Body of the JSON response for a successful requests-for-payments request.
{
"properties": {
"paymentId": {
"description": "resource identification of the generated payment initiation resource.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"transactionStatus": {
"description": "The status of the related payment.\n\"pending\" is used if the payment could not yet be checked or submitted.\n",
"allOf": [
{
"$ref": "#\/definitions\/TransactionStatus"
}
]
},
"requestStatus": {
"description": "The status of the related request to pay transaction.\n",
"allOf": [
{
"$ref": "#\/definitions\/RequestStatus"
}
]
},
"reasonCode": {
"description": "Additional information on the reason for e.g. rejecting the request \n",
"allOf": [
{
"$ref": "#\/definitions\/StatusReasonCode"
}
]
},
"reasonProprietary": {
"description": "Proprietary additional information on the reason for e.g. rejecting the request. \nRemark: If an ISO Code is available it should be used instead of Proprietary \nReasons. Further restrictions could be defined by API Access Schemes.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"transactionFees": {
"description": "Might be used by the ASPSP to transport the total transaction fee relevant in case of an\nunderlying payment initiation service. This field includes the entry of the \ncurrencyConversionFees if applicable. \n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"currencyConversionFees": {
"description": "Might be used by the ASPSP to transport specific currency conversion fees related to \nthe initiated credit transfer, in case of an underlying payment initiation service.\n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"estimatedTotalAmount": {
"description": "The amount which is estimated to be debted from the debtor account in case of an \nunderlying payment initiation service. \nNote: This amount includes fees.\n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"estimatedInterbankSettlementAmount": {
"description": "The estimated amount to be transferred to the payee. \n",
"allOf": [
{
"$ref": "#\/definitions\/amount"
}
]
},
"transactionFeeIndicator": {
"description": "If equals \\\"true\\\", the transaction will involve specific transaction cost as shown by the ASPSP in\ntheir public price list or as agreed between ASPSP and PSU.\nIf equals \\\"false\\\", the transaction will not involve additional specific transaction costs to the PSU unless the fee amount is given specifically in the data elements transactionFees and\/or currencyConversionFees.\nIf this data element is not used, there is no information about transaction fees unless the fee amount is given explicitly in the data element transactionFees and\/or currencyConversionFees.\n",
"type": "boolean"
},
"_links": {
"description": "A list of hyperlinks to be recognised by the API Client. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP \nwhen processing the request. The potential links for this response message are generically defined in [oFA SMPF] for all Transaction Initiation \nResponse messages. These links will also be contained in the related Open API files. \nRemark: All links can be relative or full links, to be decided by the ASPSP.\n",
"allOf": [
{
"$ref": "#\/definitions\/_links_201_RTP"
}
]
},
"psuMessage": {
"description": "Text to be displayed to the PSU.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max500Text"
}
]
},
"apiClientMessages": {
"description": "Messages to the API Client on operational issues.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation"
}
}
},
"required": [
"paymentId",
"transactionStatus",
"requestStatus",
"_links"
],
"type": "object",
"additionalProperties": true
}
{
"type": "string",
"maxLength": 2048,
"example": "Text, maximum of 2048 characters."
}
{
"type": "string",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"BDID",
"BOID"
],
"example": "BOID"
}
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": {
"$ref": "#\/definitions\/MessageCode_ServiceUnspecific_401"
},
"path": {
"type": "string"
},
"text": {
"$ref": "#\/definitions\/Max500Text"
}
}
}
{
"type": "string",
"maxLength": 500,
"example": "Text, maximum of 500 characters."
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"pattern": "[A-Z]{3}",
"example": "EUR"
}
{
"type": "object",
"properties": {
"apiClientMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation_401_RTP"
}
},
"_links": {
"$ref": "#\/definitions\/links"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"href Type\" for more details.
{
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "",
"type": "string"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Remittance\" for more details.
{
"type": "object",
"properties": {
"referredDocumentInformation": {
"description": "Set of elements used to identify the documents referred to in the remittance information.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/referredDocumentInformation"
}
},
"creditorReferenceInformation": {
"description": "Reference information provided by the creditor to allow the identification of the underlying documents.\n",
"allOf": [
{
"$ref": "#\/definitions\/creditorReferenceInformation"
}
]
},
"additionalRemittanceInformation": {
"description": "Additional information to be displayed to the PSU e.g. within authorisation processes. This will not be used in related interbank payments.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/Max140Text"
}
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Push AIS Specific Error Codes\" for more details.
{
"type": "string",
"enum": [
"SUBSCRIPTION_INVALID",
"SECONDARY_URI_NOT_SUPPORTED",
"MIME_TYPE_NOT_SUPPORTED",
"LIMIT_FOR_BALANCE_NOT_SUPPORTED",
"ACCOUNT_CURRENCY_NOT_MATCHING",
"BALANCE_TYPE_NOT_SUPPORTED"
],
"example": "SUBSCRIPTION_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"Financial Institution Identification\" for more details.
{
"type": "object",
"properties": {
"bicfi": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/BICFI"
}
]
},
"clearingSystemMemberId": {
"description": "Information used to identify a member within a clearing system.\n",
"allOf": [
{
"$ref": "#\/definitions\/clearingSystemMemberIdentification"
}
]
},
"name": {
"description": "Name of the financial institution\n",
"allOf": [
{
"$ref": "#\/definitions\/Max140Text"
}
]
},
"postalAddress": {
"description": "Postal Address of the financial institution.\n",
"allOf": [
{
"$ref": "#\/definitions\/postalAddress"
}
]
},
"other": {
"description": "Unique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
"allOf": [
{
"$ref": "#\/definitions\/genericFinancialInstitutionIdentification"
}
]
}
}
}
{
"type": "string",
"maxLength": 35,
"example": "Text, maximum of 35 characters."
}
An alias to access a payment account via a registered mobile phone number.
{
"type": "string",
"pattern": "^[A-Za-z]{3}-\\d{3}-\\d{2,3}-\\d{7}$"
}
See document \"openFinance API Framework Data Dictionary\", section \"Account Reference\" for more details.
{
"type": "object",
"properties": {
"iban": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/IBAN"
}
]
},
"bban": {
"description": "BBAN of the account. This data elements is used for payment accounts which have no IBAN.\n",
"allOf": [
{
"$ref": "#\/definitions\/BBAN"
}
]
},
"maskedPan": {
"description": "Primary Account Number (PAN) of a card in a masked form.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"msisdn": {
"description": "An alias to access a payment account via a registered mobile phone number.\n",
"allOf": [
{
"$ref": "#\/definitions\/msisdn"
}
]
},
"other": {
"description": "An alias with a proprietary coding\n",
"allOf": [
{
"$ref": "#\/definitions\/genericAccountIdentification"
}
]
},
"typeCode": {
"description": "Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP.\n",
"allOf": [
{
"$ref": "#\/definitions\/CashAccountType"
}
]
},
"typeProprietary": {
"description": "Remark: Shall not be used in the consent model, since account category provides enough information for the ASPSP.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code\n",
"allOf": [
{
"$ref": "#\/definitions\/CurrencyCode"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
"example": "FR7612345987650123456789014"
}
{
"type": "object",
"properties": {
"apiClientMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation_405_RTP"
}
},
"_links": {
"$ref": "#\/definitions\/links"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Additional Request Information\" for more details.
{
"type": "object",
"required": [
"requestedExpiryDateTime"
],
"properties": {
"paymentConditions": {
"description": "Conditions for the execution of the payment.\n",
"allOf": [
{
"$ref": "#\/definitions\/paymentConditions"
}
]
},
"creationDateTime": {
"description": "creationDateTime of the originator\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODateTime"
}
]
},
"requestedExpiryDateTime": {
"description": "Date and Time at which this request expires.\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODateTime"
}
]
},
"originatorPspId": {
"description": "Originator payment service provider in case of indirect participation regarding a related API Access Scheme or bilateral contract\n",
"allOf": [
{
"$ref": "#\/definitions\/financialInstitutionIdentification"
}
]
},
"receiverPspId": {
"description": "Receiving payment service provider as defined by an API Access Scheme or bilateral contracts in case of not addressing the receiving institution directly. \nIt is mandatory in case where the technical API Provider is not the receiver as such.\n",
"allOf": [
{
"$ref": "#\/definitions\/financialInstitutionIdentification"
}
]
}
}
}
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": {
"$ref": "#\/definitions\/MessageCode_ServiceUnspecific_403"
},
"path": {
"type": "string"
},
"text": {
"$ref": "#\/definitions\/Max500Text"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"enum": [
"CACC"
],
"example": "CACC"
}
See document \"openFinance API Framework Data Dictionary\", section \"Generic Account Identification\" for more details.
{
"type": "object",
"required": [
"identification"
],
"properties": {
"identification": {
"description": "Unique and unambiguous identification of an account.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"schemeNameCode": {
"description": "An entry provided by an external ISO code list\n",
"allOf": [
{
"$ref": "#\/definitions\/AccountIdentificationCode"
}
]
},
"schemeNameProprietary": {
"description": "A scheme name defined in a proprietary way.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"issuer": {
"description": "Issuer of the identification\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
}
}
}
{
"type": "object",
"properties": {
"apiClientMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation_403_RTP"
}
},
"_links": {
"$ref": "#\/definitions\/links"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Generic Organisation Identification\" for more details.
{
"type": "object",
"required": [
"identification"
],
"properties": {
"identification": {
"description": "Unique and unambiguous identification of an organisation.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"schemeNameCode": {
"description": "An entry provided by an external ISO code list\n",
"allOf": [
{
"$ref": "#\/definitions\/OrganisationIdentificationCode"
}
]
},
"schemeNameProprietary": {
"description": "A scheme name defined in a proprietary way.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"issuer": {
"description": "Issuer of the identification\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Private Identification\" for more details.
{
"type": "object",
"properties": {
"others": {
"description": "Unique identification of a person, as assigned by an institution, using an identification scheme. \nShall be used if none of the above attributes is used.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/personIdentification"
}
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Geo Location\" for more details.
{
"type": "string",
"pattern": "GEO:-?[0-9]{1,2}\\.[0-9]{6};-?[0-9]{1,3}\\.[0-9]{6}",
"example": "GEO:52.506931;13.144558"
}
See document \"openFinance API Framework Data Dictionary\", section \"PIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"PAYMENT_FAILED",
"EXECUTION_DATE_INVALID"
],
"example": "PAYMENT_FAILED"
}
See document \"openFinance API Framework Data Dictionary\", section \"PIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"KID_MISSING"
],
"example": "KID_MISSING"
}
See document \"openFinance API Framework Data Dictionary\", section \"Party Description1\" for more details.
{
"type": "object",
"properties": {
"name": {
"description": "Name of the party.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max140Text"
}
]
}
}
}
{
"type": "string",
"maxLength": 256,
"example": "Text, maximum of 256 characters."
}
See document \"openFinance API Framework Data Dictionary\", section \"Organisation Identification\" for more details.
{
"type": "object",
"properties": {
"anyBIC": {
"description": "A code allocated to a business entity or to a financial institution by a Registration Authority under an international identification scheme.\n",
"allOf": [
{
"$ref": "#\/definitions\/BICFI"
}
]
},
"lei": {
"description": "Legal Entity Identifier.\n",
"allOf": [
{
"$ref": "#\/definitions\/LEI"
}
]
},
"others": {
"description": "Unique identification of an organisation, as assigned by an institution, using an identification scheme.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/genericOrganisationIdentification"
}
}
}
}
{
"title": "_links_201_RTP",
"type": "object",
"properties": {
"scaOAuth": {
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
],
"description": "See document \\\"openFinance API Framework Data Dictionary\\\", section \\\"href Type\\\" for more details."
},
"confirmation": {
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
],
"description": "See document \\\"openFinance API Framework Data Dictionary\\\", section \\\"href Type\\\" for more details."
},
"self": {
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
],
"description": "See document \\\"openFinance API Framework Data Dictionary\\\", section \\\"href Type\\\" for more details."
},
"status": {
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
],
"description": "See document \\\"openFinance API Framework Data Dictionary\\\", section \\\"href Type\\\" for more details."
},
"scaStatus": {
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
],
"description": "See document \\\"openFinance API Framework Data Dictionary\\\", section \\\"href Type\\\" for more details."
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Account Reference1\" for more details.
{
"type": "object",
"properties": {
"iban": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/IBAN"
}
]
},
"bban": {
"description": "BBAN of the account. This data elements is used for payment accounts which have no IBAN.\n",
"allOf": [
{
"$ref": "#\/definitions\/BBAN"
}
]
},
"maskedPan": {
"description": "Primary Account Number (PAN) of a card in a masked form.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code\n",
"allOf": [
{
"$ref": "#\/definitions\/CurrencyCode"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
"example": "ECBFDEFFFIM"
}
{
"type": "string",
"maxLength": 140,
"example": "Text, maximum of 140 characters."
}
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": {
"$ref": "#\/definitions\/MessageCode_ServiceUnspecific_404"
},
"path": {
"type": "string"
},
"text": {
"$ref": "#\/definitions\/Max500Text"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOSE",
"TELE",
"TXID",
"POID"
],
"example": "NIDN"
}
See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details.
{
"enum": [
"STATUS_INVALID"
],
"example": "STATUS_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string"
}
See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"SERVICE_INVALID"
],
"example": "SERVICE_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"format": "date",
"example": "2020-01-01"
}
See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"RESOURCE_UNKNOWN"
],
"example": "RESOURCE_UNKNOWN"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string"
}
See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"SERVICE_BLOCKED",
"CONSENT_UNKNOWN",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED"
],
"example": "SERVICE_BLOCKED"
}
See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"ROLE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKED",
"CERTIFICATE_MISSING",
"CLIENT_INVALID",
"CLIENT_INCONSISTENT",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"PSU_CREDENTIALS_INVALID",
"CORPORATE_ID_INVALID",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED"
],
"example": "CERTIFICATE_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"Service Unspecific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"FORMAT_ERROR",
"PARAMETER_NOT_CONSISTENT",
"PARAMETER_NOT_SUPPORTED",
"SERVICE_INVALID",
"CONSENT_UNKNOWN",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"RESOURCE_BLOCKED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"SCA_INVALID"
],
"example": "FORMAT_ERROR"
}
See document \"openFinance API Framework Data Dictionary\", section \"Referred Document Information\" for more details.
{
"type": "object",
"properties": {
"typeCode": {
"description": "Specifies the type of referred document, provided as code.\n",
"allOf": [
{
"$ref": "#\/definitions\/ReferredDocumentTypeCode"
}
]
},
"typeProprietary": {
"description": "Specifies the type of referred document, provided in proprietary encoding.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"typeIssuer": {
"description": "Issuer of the document type.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"number": {
"description": "Unique and unambiguous identification of the referred document.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"relatedDate": {
"description": "Date associated with the referred document.\n",
"allOf": [
{
"$ref": "#\/definitions\/ISODate"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Request Status\" for more details.
{
"type": "string",
"enum": [
"ACCP",
"ACWC",
"RCVD",
"PDNG",
"RJCT"
],
"example": "ACCP"
}
See document \"openFinance API Framework Data Dictionary\", section \"Signing Basket Specific Error Codes\" for more details.
{
"type": "string",
"enum": [
"REFERENCE_MIX_INVALID"
],
"example": "REFERENCE_MIX_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"PIIS Specific Error Codes\" for more details.
{
"type": "string",
"enum": [
"CARD_INVALID",
"NO_PIIS_ACTIVATION"
],
"example": "CARD_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"Transaction Status\" for more details.
{
"type": "string",
"enum": [
"ACCC",
"ACCP",
"ACSC",
"ACSP",
"ACTC",
"ACWC",
"ACWP",
"RCVD",
"PDNG",
"RJCT",
"CANC",
"ACFC",
"PATC",
"PART",
"PRES"
],
"example": "ACCC"
}
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": {
"$ref": "#\/definitions\/MessageCode_ServiceUnspecific_409"
},
"path": {
"type": "string"
},
"text": {
"$ref": "#\/definitions\/Max500Text"
}
}
}
{
"type": "string",
"maxLength": 70,
"example": "Text, maximum of 70 characters."
}
{
"title": "SinglePayment_RTP_SCT",
"type": "object",
"properties": {
"paymentIdentification": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/paymentIdentification"
},
{
"description": "Set of elements used to reference a payment instruction."
}
]
},
"paymentMethod": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/CreditTransferPaymentMethodCode"
},
{
"description": "Specifies the means of payment that will be used to move the amount of money.\nUsage: Only used for cross-border transactions.\nIf no paymentMethod is explicitly stated, paymentMethod will be interpreted as **TRF** (Credit Transfer)."
}
]
},
"ultimateDebtor": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription1"
},
{
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor. Restriction to the schema are applied depending on the product."
}
]
},
"instructedAmount": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/amount"
},
{
"description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party."
}
]
},
"creditorAccount": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/accountReference"
},
{
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction."
}
]
},
"creditorAgent": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/agentDescription1"
},
{
"description": "Financial institution servicing an account for the creditor."
}
]
},
"creditor": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription"
},
{
"description": "Party to which an amount of money is due."
}
]
},
"ultimateCreditor": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription"
},
{
"description": "Ultimate party to which an amount of money is due."
}
]
},
"purposeCode": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/PurposeCode"
},
{
"description": "Specifies the purpose of the instruction based the code set ExternalPurpose1Code from ISO 20022."
}
]
},
"purposeProprietary": {
"description": "Specifies the purpose of the instruction in proprietary encoding",
"type": "string",
"maxLength": 35
},
"remittanceInformationUnstructured": {
"description": "Information supplied to enable the matching\/reconciliation of an entry with the items that the payment is intended to settle, \nsuch as commercial invoices in an accounts' receivable system, in an unstructured form.",
"example": [
"{\"Ref Number Merchant\"}"
],
"type": "array",
"items": {
"type": "string",
"maxLength": 140
},
"maxLength": 140,
"minItems": 1,
"maxItems": 1
},
"additionalRequestInformation": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/additionalRequestInformation"
},
{
"description": "Request related information which is not directly linked to the payment transaction.\nOnly applicable for request to pay services and extended payment services."
}
]
},
"debtorAccount": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/accountReference"
},
{
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction."
}
]
},
"debtor": {
"type": "object",
"allOf": [
{
"$ref": "#\/definitions\/partyDescription"
},
{
"description": "Party that owes an amount of money to the (ultimate) creditor."
}
]
},
"requestedExecutionDate": {
"description": "Date at which the initiating party requests the clearing agent to process the payment.",
"type": "string",
"format": "date"
},
"requestedExecutionDateTime": {
"description": "Date and time at which the initiating party requests the clearing agent to process the payment.",
"type": "string",
"format": "date-time"
}
},
"required": [
"instructedAmount",
"creditorAccount",
"creditor",
"remittanceInformationUnstructured",
"additionalRequestInformation"
]
}
See document \"openFinance API Framework Data Dictionary\", section \"Signing Basket Specific Error Codes\" for more details.
{
"type": "string",
"enum": [
"REFERENCE_STATUS_INVALID"
],
"example": "REFERENCE_STATUS_INVALID"
}
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": {
"$ref": "#\/definitions\/MessageCode_ServiceUnspecific_400"
},
"path": {
"type": "string"
},
"text": {
"$ref": "#\/definitions\/Max500Text"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Links\" for more details.
{
"type": "object",
"properties": {
"scaOAuth": {
"description": "The link refers to a JSON document specifying the OAuth details of the ASPSP's authorisation server. JSON document follows the definition given in [RFC 8414].\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"confirmation": {
"description": "\\\"confirmation\\\": Might be added by the ASPSP if either the \\\"scaRedirect\\\" or \\\"scaOAuth\\\" hyperlink is returned in the same response message. \nThis hyperlink defines the URL to the resource which needs to be updated with \n* a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or\n* an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"self": {
"description": "The link to the payment initiation resource created by the request itself. \nThis link can be used later to retrieve the transaction status of the payment initiation.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"status": {
"description": "A link to retrieve the status of the transaction resource.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"transactionfees": {
"description": "The link is to the status resource. \nThis link is only added within the authorisation process in case fee information is available via the status resource.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"scaStatus": {
"description": "A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"account": {
"description": "A link to the resource providing the details of one account\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"savingsAccount": {
"description": "A link to the resource providing the details of a savings account.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"loanAccount": {
"description": "A link to the resource providing the details of a loan account.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"balances": {
"description": "A link to the resource providing the balance of a dedicated account.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"transactions": {
"description": "A link to the resource providing the transaction history of a dedicated account.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"cardAccount": {
"description": "A link to the resource providing the details of one card account.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"cardTransactions": {
"description": "A link to the resource providing the transaction history of a dedicated card account.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"transactionDetails": {
"description": "A link to the resource providing details of a dedicated transaction.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"ibanCheck": {
"description": "A link to the endpoint offering the addressed iban check result.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"paymentInitiation": {
"description": "A link to an initiation related to a payment resource.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"securitiesAccount": {
"description": "A link to the resource providing the details of one securitiesAccount.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"positions": {
"description": "A link to the resource providing the list of positions of one securitiesAccount.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"orders": {
"description": "A link to the resource providing the list of orders of one securitiesAccount.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"orderDetails": {
"description": "A link to the resource providing details of one specific order.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"relatedOrders": {
"description": "An array of links to request order details of related orders related to the order that is represented by the data structure containing this element \n(e.g. other orders that originated from the same order split as this order). \n",
"type": "array",
"items": {
"$ref": "#\/definitions\/hrefType"
}
},
"relatedTransactions": {
"description": "An array of links to request securities transaction details of transactions that resulted from this order.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/hrefType"
}
},
"subscription": {
"description": "A link to the resource providing the details of a subscription for Push AIS Services.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"entryStatusRevoked": {
"description": "Links to entry endpoints where the entry status is revoked.\n",
"type": "array",
"items": {
"$ref": "#\/definitions\/hrefType"
}
},
"first": {
"description": "Navigation link for paginated account reports.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"next": {
"description": "Navigation link for paginated account reports.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"previous": {
"description": "Navigation link for paginated account reports.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"last": {
"description": "Navigation link for paginated account reports.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"download": {
"description": "Download link for huge AIS data packages.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"confirmInitiation": {
"description": "link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"aspspParameters": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"aspspContacts": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"aspspDowntimes": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"onboardings": {
"description": "A link to commercially onboard to the related API, see openFinance, Admin Services for more details.\n",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"readConditions": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
},
"confirmConditions": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/hrefType"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Party Description\" for more details.
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "Name of the party.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max140Text"
}
]
},
"postaladdress": {
"description": "Postal Address of the party.\n",
"allOf": [
{
"$ref": "#\/definitions\/postalAddress"
}
]
},
"identification": {
"description": "Identification of the party.\n",
"allOf": [
{
"$ref": "#\/definitions\/partyIdentification"
}
]
},
"additionalPartyInformation": {
"description": "Only supported in extended services for creditor related parties, if at all.\n*NOTE:* This information will be neither put to the related interbank payment nor to account reports\/statements and \nmight only be used to display related information to the PSU during potential authorisation processes.\n",
"allOf": [
{
"$ref": "#\/definitions\/additionalPartyInformation"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"format": "uuid",
"example": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
}
See document \"openFinance API Framework Data Dictionary\", section \"Generic Financial Institution Identification\" for more details.
{
"type": "object",
"required": [
"identification"
],
"properties": {
"identification": {
"description": "Unique and unambiguous identification of a financial insitution.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"schemeNameCode": {
"description": "An entry provided by an external ISO code list\n",
"allOf": [
{
"$ref": "#\/definitions\/FinancialInstitutionIdentificationCode"
}
]
},
"schemeNameProprietary": {
"description": "A scheme name defined in a proprietary way.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"issuer": {
"description": "Issuer of the identification\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more detail
{
"type": "string",
"enum": [
"ATBLZ",
"AUBSB",
"CACPA",
"CHBCC",
"CHSIC",
"CNAPS",
"DEBLZ",
"ESNCC",
"GBDSC",
"GRBIC",
"HKNCC",
"IENCC",
"INFSC",
"ITNCC",
"JPZGN",
"NZNCC",
"PLKNR",
"PTNCC",
"RUCBC",
"SESBA",
"SGIBG",
"THCBC",
"TWNCC",
"USABA",
"USPID",
"ZANCC",
"NZRSA",
"MZBMO",
"CNCIP",
"KRBOK"
],
"example": "DEBLZ"
}
{
"type": "string",
"maxLength": 16,
"example": "16 Chars at most"
}
{
"type": "object",
"properties": {
"apiClientMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation_404_RTP"
}
},
"_links": {
"$ref": "#\/definitions\/links"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Postal Address\" for more details.
{
"type": "object",
"properties": {
"addressLines": {
"description": "At most seven entries are permitted. May only be used, if none of the structured address elements \\\"streetName\\\", \\\"buildingNumber\\\", \\\"postcode\\\" or \\\"townName\\\" is used.\n*Remark:* For SEPA transactions this is further restricted to a maximum of 1 entry.\n",
"type": "array",
"maxItems": 7,
"items": {
"$ref": "#\/definitions\/Max140Text"
}
},
"department": {
"description": "Identification of a division of a large organisation or building.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"subDepartment": {
"description": "Identification of a sub-division of a large organisation or building.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"streetName": {
"description": "Name of a street or thoroughfare.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"buildingNumber": {
"description": "Number that identifies the position of a building on a street.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max16Text"
}
]
},
"buildingName": {
"description": "Name of the building or house.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"floor": {
"description": "Floor or storey within a building.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"postBox": {
"description": "Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max16Text"
}
]
},
"room": {
"description": "Building room number.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"postCode": {
"description": "Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max16Text"
}
]
},
"townName": {
"description": "Name of a built-up area, with defined boundaries, and a local government. \n*Usage Rule:* If address lines are not used, this attribute is mandatrory.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"townLocationName": {
"description": "Specific location name within the town.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"districtName": {
"description": "Identifies a subdivision within a country sub-division.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"countrySubDivision": {
"description": "Identifies a subdivision of a country such as state, region, county.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"country": {
"description": "Nation with its own government.\n*Usage Rule:* If address lines are not used, this attribute is mandatrory.\n",
"allOf": [
{
"$ref": "#\/definitions\/CountryCode"
}
]
}
}
}
Psu Id number or passport number.
{
"type": "string",
"pattern": "^([0-9]{9}|[A-Za-z]{2}-([A-Za-z0-9]){1,16})$"
}
See document \"openFinance API Framework Data Dictionary\", section \"Person Identification\" for more details.
{
"type": "object",
"required": [
"identification"
],
"properties": {
"identification": {
"description": "Unique and unambiguous identification of a oersib.\n",
"allOf": [
{
"$ref": "#\/definitions\/psuId"
}
]
},
"schemeNameCode": {
"description": "An entry provided by an external ISO code list\n",
"allOf": [
{
"$ref": "#\/definitions\/PersonIdentificationCode"
}
]
},
"schemeNameProprietary": {
"description": "A scheme name defined in a proprietary way.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"issuer": {
"description": "Issuer of the identification\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"ACCESS_EXCEEDED"
],
"example": "ACCESS_EXCEEDED"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"enum": [
"AIIN",
"BBAN",
"CUID",
"UPIC"
],
"example": "AIIN"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"enum": [
"BONU",
"CASH",
"CBLK",
"CCRD",
"CORT",
"DCRD",
"DIVI",
"DVPM",
"EPAY",
"FCIN",
"FCOL",
"GP2P",
"GOVT",
"HEDG",
"ICCP",
"IDCP",
"INTC",
"INTE",
"LBOX",
"LOAN",
"MP2B",
"MP2P",
"OTHR",
"PENS",
"RPRE",
"RRCT",
"RVPM",
"SALA",
"SECU",
"SSBE",
"SUPP",
"TAXS",
"TRAD",
"TREA",
"VATX",
"WHLD",
"SWEP",
"TOPG",
"ZABA",
"VOST",
"FCDT",
"CIPC",
"CONC"
],
"example": "OTHR"
}
See document \"openFinance API Framework Data Dictionary\", section \"Clearing System Member Identification\" for more details.
{
"type": "object",
"properties": {
"memberId": {
"description": "Identification of a member of a clearing system.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"clearingSystemIdentificationCode": {
"description": "Identification of a clearing system, in a coded form as published in an external list.\n",
"allOf": [
{
"$ref": "#\/definitions\/ClearingSystemIdentificationCode"
}
]
},
"clearingSystemIdentificationProprietary": {
"description": "Identification code for a clearing system, that has not yet been identified in the list of clearing systems.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Additional Party Information\" for more details.
{
"type": "object",
"properties": {
"tradeName": {
"description": "Trade name of the related party. For display to the PSU only.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max70Text"
}
]
},
"merchantCategoryCode": {
"description": "Merchant Category Code as assigned by ISO:\n",
"allOf": [
{
"$ref": "#\/definitions\/MerchantCategoryCode"
}
]
},
"logoURL": {
"description": "A hyperlink to the logo of the party.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max2048Text"
}
]
},
"geoLocation": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/GeoLocation"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Agent Description1\" for more details.
{
"type": "object",
"required": [
"financialInstitutionId"
],
"properties": {
"financialInstitutionId": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/financialInstitutionIdentification"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"enum": [
"BKDF",
"BKFE",
"BKFM",
"BKIP",
"BKPP",
"CBLK",
"CDCB",
"CDCD",
"CDCS",
"CDDP",
"CDOC",
"CDQC",
"ETUP",
"FCOL",
"MTUP",
"ACCT",
"CASH",
"COLL",
"CSDB",
"DEPT",
"INTC",
"INTP",
"LIMA",
"NETT",
"BFWD",
"CCIR",
"CCPC",
"CCPM",
"CCSM",
"CRDS",
"CRPR",
"CRSP",
"CRTL",
"EQPT",
"EQUS",
"EXPT",
"EXTD",
"FIXI",
"FWBC",
"FWCC",
"FWSB",
"FWSC",
"MARG",
"MBSB",
"MBSC",
"MGCC",
"MGSC",
"OCCC",
"OPBC",
"OPCC",
"OPSB",
"OPSC",
"OPTN",
"OTCD",
"REPO",
"RPBC",
"RPCC",
"RPSB",
"RPSC",
"RVPO",
"SBSC",
"SCIE",
"SCIR",
"SCRP",
"SHBC",
"SHCC",
"SHSL",
"SLEB",
"SLOA",
"SWBC",
"SWCC",
"SWPT",
"SWSB",
"SWSC",
"TBAS",
"TBBC",
"TBCC",
"TRCP",
"AGRT",
"AREN",
"BEXP",
"BOCE",
"COMC",
"CPYR",
"GDDS",
"GDSV",
"GSCB",
"LICF",
"MP2B",
"POPE",
"ROYA",
"SCVE",
"SERV",
"SUBS",
"SUPP",
"TRAD",
"CHAR",
"COMT",
"MP2P",
"ECPG",
"ECPR",
"ECPU",
"EPAY",
"CLPR",
"COMP",
"DBTC",
"GOVI",
"HLRP",
"HLST",
"INPC",
"INPR",
"INSC",
"INSU",
"INTE",
"LBRI",
"LIFI",
"LOAN",
"LOAR",
"PENO",
"PPTI",
"RELG",
"RINP",
"TRFD",
"FORW",
"FXNT",
"ADMG",
"ADVA",
"BCDM",
"BCFG",
"BLDM",
"BNET",
"CBFF",
"CBFR",
"CCRD",
"CDBL",
"CFEE",
"CGDD",
"CORT",
"COST",
"CPKC",
"DCRD",
"DSMT",
"DVPM",
"EDUC",
"FACT",
"FAND",
"FCPM",
"FEES",
"GIFT",
"GOVT",
"ICCP",
"IDCP",
"IHRP",
"INSM",
"IVPT",
"MCDM",
"MCFG",
"MSVC",
"NOWS",
"OCDM",
"OCFG",
"OFEE",
"OTHR",
"PADD",
"PTSP",
"RCKE",
"RCPT",
"REBT",
"REFU",
"RENT",
"REOD",
"RIMB",
"RPNT",
"RRBN",
"RRCT",
"RRTP",
"RVPM",
"SLPI",
"SPLT",
"STDY",
"TBAN",
"TBIL",
"TCSC",
"TELI",
"TMPG",
"TPRI",
"TPRP",
"TRNC",
"TRVC",
"WEBI",
"IPAY",
"IPCA",
"IPDO",
"IPEA",
"IPEC",
"IPEW",
"IPPS",
"IPRT",
"IPU2",
"IPUW",
"ANNI",
"CAFI",
"CFDI",
"CMDT",
"DERI",
"DIVD",
"FREX",
"HEDG",
"INVS",
"PRME",
"SAVG",
"SECU",
"SEPI",
"TREA",
"UNIT",
"FNET",
"FUTR",
"ANTS",
"CVCF",
"DMEQ",
"DNTS",
"HLTC",
"HLTI",
"HSPC",
"ICRF",
"LTCF",
"MAFC",
"MARF",
"MDCS",
"VIEW",
"CDEP",
"SWFP",
"SWPP",
"SWRS",
"SWUF",
"ADCS",
"AEMP",
"ALLW",
"ALMY",
"BBSC",
"BECH",
"BENE",
"BONU",
"CCHD",
"COMM",
"CSLP",
"GFRP",
"GVEA",
"GVEB",
"GVEC",
"GVED",
"GWLT",
"HREC",
"PAYR",
"PEFC",
"PENS",
"PRCP",
"RHBS",
"SALA",
"SPSP",
"SSBE",
"LBIN",
"LCOL",
"LFEE",
"LMEQ",
"LMFI",
"LMRK",
"LREB",
"LREV",
"LSFL",
"ESTX",
"FWLV",
"GSTX",
"HSTX",
"INTX",
"NITX",
"PTXP",
"RDTX",
"TAXS",
"VATX",
"WHLD",
"TAXR",
"B112",
"BR12",
"TLRF",
"TLRR",
"AIRB",
"BUSB",
"FERB",
"RLWY",
"TRPT",
"CBTV",
"ELEC",
"ENRG",
"GASB",
"NWCH",
"NWCM",
"OTLC",
"PHON",
"UBIL",
"WTER",
"BOND",
"CABD",
"CAEQ",
"CBCR",
"DBCR",
"DICL",
"EQTS",
"FLCR",
"EFTC",
"EFTD",
"MOMA",
"RAPI",
"GAMB",
"LOTT",
"AMEX",
"SASW",
"AUCO",
"PCOM",
"PDEP",
"PLDS",
"PLRF",
"GAFA",
"GAHO",
"CPEN",
"DEPD",
"RETL",
"DEBT"
],
"example": "OTHR"
}
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": {
"$ref": "#\/definitions\/MessageCode_ServiceUnspecific_405"
},
"path": {
"type": "string"
},
"text": {
"$ref": "#\/definitions\/Max500Text"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Payment Identification\" for more details.
{
"type": "object",
"properties": {
"instructionId": {
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"endToEndId": {
"description": "",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"uetr": {
"description": "Universally unique identifier to provide an end-to-end reference of a payment transaction.\nIt is recommended to use time-based version (version 1) and variant 8,9,a or b of the UUID as defined in [RFC4122] for UUID fields such as uetr.\n",
"allOf": [
{
"$ref": "#\/definitions\/UUID"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Referred Document Type Code\" for more details.
{
"type": "string",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT",
"PUOR"
],
"example": "PUOR"
}
See document \"openFinance API Framework Data Dictionary\", section \"Creditor Reference Information\" for more details.
{
"type": "object",
"required": [
"reference"
],
"properties": {
"reference": {
"description": "The actual reference.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"referenceTypeCode": {
"description": "Type of the reference, provided as code.\n",
"allOf": [
{
"$ref": "#\/definitions\/CreditorReferenceTypeCode"
}
]
},
"referenceTypeProprietary": {
"description": "Type of the reference, provided in proprietary encoding.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
},
"referenceIssuer": {
"description": "Issuer of the reference.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max35Text"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"maxLength": 4,
"minLength": 4
}
See document \"openFinance API Framework Data Dictionary\", section \"Creditor Reference Type Code\" for more details.
{
"type": "string",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
],
"example": "PUOR"
}
{
"type": "object",
"additionalProperties": {
"$ref": "#\/definitions\/hrefType"
},
"properties": {
"scaOAuth": {
"$ref": "#\/definitions\/hrefType"
},
"confirmation": {
"$ref": "#\/definitions\/hrefType"
},
"self": {
"$ref": "#\/definitions\/hrefType"
},
"status": {
"$ref": "#\/definitions\/hrefType"
},
"scaStatus": {
"$ref": "#\/definitions\/hrefType"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"pattern": "[A-Z]{2}",
"example": "SE"
}
See document \"openFinance API Framework Data Dictionary\", section \"Client Message Information\" for more details.
{
"type": "object",
"required": [
"category",
"code"
],
"properties": {
"category": {
"description": "Only \\\"ERROR\\\" or \\\"WARNING\\\" permitted\n",
"type": "string"
},
"code": [],
"path": {
"description": "Path of the element of the request message which provoked the error message, if applicable\n",
"type": "string"
},
"text": {
"description": "Additional explaining text.\n",
"allOf": [
{
"$ref": "#\/definitions\/Max500Text"
}
]
}
}
}
{
"type": "string",
"maxLength": 105,
"example": "Text, maximum of 105 characters."
}
See document \"openFinance API Framework Data Dictionary\", section \"Amount\" for more details.
{
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"currency": {
"description": "ISO 4217 Alpha 3 currency code\n",
"allOf": [
{
"$ref": "#\/definitions\/CurrencyCode"
}
]
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\nExample: Valid representations for EUR with up to two decimals are:\n* 1056\n* 5768.2\n* -1.50\n* 5877.78\n",
"type": "string",
"pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?"
}
}
}
{
"type": "object",
"properties": {
"apiClientMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation_400_RTP"
}
},
"_links": {
"$ref": "#\/definitions\/links"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Payment Conditions\" for more details.
{
"type": "object",
"properties": {
"amountModificationAllowed": {
"description": "Indicates if the debtor is allowed to pay a different amount then the requested amount.\n",
"type": "boolean"
},
"earlyPaymentAllowed": {
"description": "Indicates if the debtor is allowed to pay before the requested execution date.\n",
"type": "boolean"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Status Reason Code\" for more details.
{
"type": "string",
"enum": [
"AM04",
"AM21",
"BEXX",
"CN01",
"DS0C",
"DS0D",
"DS0A",
"DS04",
"FOCR",
"SL11",
"TKSP",
"TKXP",
"AM02",
"DT05",
"AC05",
"AC06",
"DS0K",
"DT01",
"UPAY",
"EOL1"
],
"example": "AM04"
}
{
"type": "object",
"properties": {
"apiClientMessages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/clientMessageInformation_409_RTP"
}
},
"_links": {
"$ref": "#\/definitions\/links"
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"Credit Transfer Payment Method Code\" for more details.
{
"type": "string",
"enum": [
"TRF",
"CHK"
],
"example": "TRF"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"pattern": "[A-Z0-9]{18,18}[0-9]{2,2}",
"example": "549300DTUYXVMJXZNY75"
}
See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"pattern": "^(?!(CONSENT_INVALID|^(?!(CONSENT_INVALID))))"
}
See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"CONTENT_TEMPORARILY_NOT_AVAILABLE"
],
"example": "CONTENT_TEMPORARILY_NOT_AVAILABLE"
}
See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"REQUESTED_FORMATS_INVALID"
],
"example": "REQUESTED_FORMATS_INVALID"
}
See document \"openFinance API Framework Data Dictionary\", section \"Other ISO-related basic Types\" for more details.
{
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:00:00.999-01:00"
}
See document \"openFinance API Framework Data Dictionary\", section \"Party Identification\" for more details.
{
"type": "object",
"properties": {
"organisationId": {
"description": "An entry provided by an external ISO code list\n",
"allOf": [
{
"$ref": "#\/definitions\/organisationIdentification"
}
]
},
"privateId": {
"description": "A scheme name defined in a proprietary way.\n",
"allOf": [
{
"$ref": "#\/definitions\/privateIdentification"
}
]
}
}
}
See document \"openFinance API Framework Data Dictionary\", section \"AIS Specific HTTP Error Codes\" for more details.
{
"type": "string",
"enum": [
"CONSENT_TYPE_NOT_SUPPORTED",
"SESSIONS_NOT_SUPPORTED"
],
"example": "SESSIONS_NOT_SUPPORTED"
}