The Payment Initiation API enables you to initiate a payment using one of the payment products made available by the Bank of the Payment Service User in his internet Banking.
With this API it is possible to integrate this type of of payments in an online store as well as to provide personal finance services to both private and corporate clients.
This API intends to provide an interface to access PSD2 Payments services.
The API is designed on a REST model using JSON structures.
Paths
/{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}
Periodic Payment Initiation Request
Creates a periodic payment initiation request at the ASPSP.
ID of the transaction as determined by the initiating party.
{
"default": ""
}User identification in ASPSP
{
"default": ""
}Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
{
"default": ""
}Corporate User identification in ASPSP
{
"default": ""
}Might be mandated in the ASPSPs documentation. Only used in a corporate context.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
{
"default": ""
}HTTP method used at the PSU – TPP interface, if available. \n Valid values are: \n - GET \n - POST \n - PUT \n - PATCH \n - DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "GET"
}The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
{
"default": ""
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
"default": "GEO:1.111111;-1.111111"
}URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Shall be contained at least if the tppRedirectPreferred parameter is set to true or is missing.
{
"default": ""
}If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This may be ignored by the ASPSP. See Section 4.10 for further requirements on this header. \n The same condition as for TPP-Redirect-URI on keeping the URI equal during a transaction lifecycle applies also to this header.
If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. \n If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Shall be contained at least if the tppRedirectPreferred parameter is set to true or is missing.
{
"default": ""
}If it equals "true", the TPP prefers a redirect over an embedded SCA approach. \n If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. \n If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
If it equals "true", the TPP requests a delegated SCA approach. If it equals "false", the TPP do not request a delegated SCA approach. If the parameter is not used, the TPP do not request a delegated SCA approach.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
{
"default": ""
}Only used for Delegated Authentication Approach. \n "NSCA" - "SCA Not performed"; \n "SUCC" - "SCA Performed with Success"; \n If this data element is not used, there is no information about transaction SCA authentication
{
"enum": [
"NSCA",
"SUCC"
]
}A signature of the request by the TPP on application level. This might be mandated by ASPSP.
{
"default": ""
}Hash of the message body. Should be present when Request body exists
{
"default": ""
}An identification provided by the ASPSP for the later identification of the authentication delegated.
{
"default": ""
}This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
{
"default": ""
}Request date
Identification of the aspsp
{
"default": ""
}Type of payment
{
"default": "sepa-credit-transfers",
"enum": [
"sepa-credit-transfers",
"cross-border-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments"
]
}Payment Initiation Request
{
"schema": {
"description": "Creates a payment initiation request at the ASPSP.",
"type": "object",
"required": [
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
],
"properties": {
"endToEndIdentification": {
"description": "Unique identification as assigned by the sending party to unambiguously identify this payment.",
"type": "string",
"maxLength": 35,
"default": ""
},
"debtorAccount": {
"$ref": "#\/definitions\/AccountReference",
"description": "Debtor account"
},
"instructedAmount": {
"$ref": "#\/definitions\/Amount",
"description": "Instructed amount (inc. Curr.)"
},
"creditorAccount": {
"$ref": "#\/definitions\/AccountReference",
"description": "Creditor account"
},
"creditorAgent": {
"description": "BICFI",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
},
"creditorName": {
"description": "Name of the creditor if a “Debited” transaction",
"type": "string",
"maxLength": 70,
"minLength": 1,
"default": "a"
},
"creditorAddress": {
"$ref": "#\/definitions\/Address",
"description": "Address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured Remittance Information",
"type": "string",
"maxLength": 140,
"default": ""
},
"startDate": {
"type": "string",
"format": "date",
"description": "StartDate"
},
"purposeCode": {
"type": "string",
"description": "Specifies the category purpose, as published in an external category purpose code list.",
"maxLength": 4
},
"chargeBearer": {
"$ref": "#\/definitions\/ChargeBearer",
"description": "Specifies which party\/parties will bear the charges associated with the processing of the payment transaction."
},
"endDate": {
"type": "string",
"format": "date",
"description": "EndDate"
},
"frequency": {
"$ref": "#\/definitions\/FrequencyCode",
"description": "Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual,"
},
"executionRule": {
"$ref": "#\/definitions\/ExecutionRule",
"description": "Following\/Preceeding"
},
"dayOfExecution": {
"type": "integer",
"format": "int32",
"description": "Month day to execute payment. The format is following the regular expression \\d{1,2}. Example: The first day is addressed by \"1\"."
},
"creditorClearingCode": {
"type": "string",
"maxLength": 35,
"description": "Clearing Code of the Creditor Finantial Institution"
},
"creditorAgentName": {
"description": "Name of the creditor's agent",
"type": "string",
"maxLength": 140,
"default": ""
},
"creditorAgentAddress": {
"$ref": "#\/definitions\/Address",
"description": "Address"
}
},
"additionalProperties": false
}
}Created
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
/{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}/{payment-id}
Get Payment Request
Requests properties of a payment initiation
ID of the transaction as determined by the initiating party.
{
"default": ""
}User identification in ASPSP
{
"default": ""
}Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility.
{
"default": ""
}Corporate User identification in ASPSP
{
"default": ""
}Might be mandated in the ASPSPs documentation. Only used in a corporate context.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
{
"default": ""
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
{
"default": ""
}The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
"default": "GEO:1.111111;-1.111111"
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}HTTP method used at the PSU – TPP interface, if available. \n Valid values are: \n - GET \n - POST \n - PUT \n - PATCH \n - DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "GET"
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}A signature of the request by the TPP on application level. This might be mandated by ASPSP.
{
"default": ""
}The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
{
"default": ""
}Request date
Identification of the aspsp
{
"default": ""
}Type of payment
{
"default": "sepa-credit-transfers",
"enum": [
"sepa-credit-transfers",
"cross-border-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments"
]
}Identification of the payment
{
"default": ""
}Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
Cancel Payment Request
Cancels a given periodic payment initiaton resource.
Identification of the aspsp
{
"default": ""
}Identification of the payment
{
"default": ""
}Type of payment
{
"default": "sepa-credit-transfers",
"enum": [
"sepa-credit-transfers",
"cross-border-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments"
]
}ID of the transaction as determined by the initiating party.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
{
"default": ""
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
{
"default": ""
}The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
"default": "GEO:1.111111;-1.111111"
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}HTTP method used at the PSU – TPP interface, if available. \n Valid values are: \n - GET \n - POST \n - PUT \n - PATCH \n - DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "GET"
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}If it equals "true", the TPP prefers a redirect over an embedded SCA approach. \n If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. \n If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
If it equals "true", the TPP prefers a decoupled SCA approach. \n If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. \n If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU. \n The parameter might be ignored by the ASPSP. \n If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used. \n RFU: TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.
URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Shall be contained at least if the tppRedirectPreferred parameter is set to true or is missing.
{
"default": ""
}If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This may be ignored by the ASPSP. See Section 4.10 for further requirements on this header. \n The same condition as for TPP-Redirect-URI on keeping the URI equal during a transaction lifecycle applies also to this header.
If it equals "true", the TPP prefers to start the authorisation process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality. \n If it equals "false" or if the parameter is not used, there is no preference of the TPP. This especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
{
"default": ""
}The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
{
"default": ""
}Request date
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
/{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}/{payment-id}/status
Get Status Request
Requests status of a payment initiation
ID of the transaction as determined by the initiating party.
{
"default": ""
}Corporate User identification in ASPSP
{
"default": ""
}Might be mandated in the ASPSPs documentation. Only used in a corporate context.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.
{
"default": ""
}The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
{
"default": ""
}The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
{
"default": ""
}The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
"default": "GEO:1.111111;-1.111111"
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
{
"default": ""
}HTTP method used at the PSU – TPP interface, if available. \n Valid values are: \n - GET \n - POST \n - PUT \n - PATCH \n - DELETE
{
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"default": "GET"
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}A signature of the request by the TPP on application level. This might be mandated by ASPSP.
{
"default": ""
}The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
{
"default": ""
}Request date
Identification of the aspsp
{
"default": ""
}Type of payment
{
"default": "sepa-credit-transfers",
"enum": [
"sepa-credit-transfers",
"cross-border-credit-transfers",
"instant-sepa-credit-transfers",
"target-2-payments"
]
}Identification of the payment
{
"default": ""
}Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
Definitions
Identifier of the addressed account.
{
"type": "object",
"properties": {
"iban": {
"description": "This data element is used in a mutually exclusive way with BBAN.",
"type": "string",
"pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$",
"default": "PT000"
},
"bban": {
"description": "This data element is used for payment accounts which have no IBAN.",
"type": "string",
"default": "1",
"pattern": "^[a-zA-Z0-9]{1,30}$"
},
"pan": {
"description": "Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.",
"type": "string",
"maxLength": 35,
"default": ""
},
"maskedPan": {
"description": "Primary Account Number (PAN) of a card in a masked form.",
"type": "string",
"maxLength": 35,
"default": ""
},
"msisdn": {
"description": "An alias to access a payment account via a registered mobile phone number",
"type": "string",
"maxLength": 35,
"default": ""
},
"currency": {
"description": "ISO 4217 Alpha 3 currency code.",
"type": "string",
"default": "EUR",
"pattern": "^[A-Z]{3,3}$"
}
},
"additionalProperties": false
}
Address
{
"type": "object",
"required": [
"country"
],
"properties": {
"street": {
"description": "Street",
"type": "string",
"maxLength": 70,
"default": ""
},
"buildingNumber": {
"description": "Building Number",
"type": "string",
"default": ""
},
"city": {
"description": "City",
"type": "string",
"default": ""
},
"postalCode": {
"description": "Postal Code",
"type": "string",
"default": ""
},
"country": {
"description": "Country",
"type": "string",
"default": ""
}
},
"additionalProperties": false
}
Amount
{
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"currency": {
"description": "ISO 4217 currency code\n",
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"default": "EUR"
},
"amount": {
"description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\n\nThe decimal separator is a dot.\n",
"type": "string",
"pattern": "^\\-{0,1}[0-9]{1,9}(\\.[0-9]{0,2}){0,1}$",
"default": "0"
}
},
"additionalProperties": false
}
Array of Authentication object
{
"type": "array",
"items": {
"$ref": "#/definitions/Authentication",
"description": "Authentication Data"
},
"additionalProperties": false
}
Authentication Data
{
"type": "object",
"required": [
"authenticationType",
"authenticationMethodId"
],
"properties": {
"authenticationType": {
"description": "Type of the authentication method.",
"$ref": "#/definitions/AuthenticationType"
},
"authenticationVersion": {
"description": "Depending on the authenticationType. This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP’s documentation.\n",
"type": "string",
"default": ""
},
"authenticationMethodId": {
"description": "An identification provided by the ASPSP for the later identification of the authentication method selection.\n",
"type": "string",
"maxLength": 35,
"default": ""
},
"name": {
"description": "This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like “SMS OTP on phone +49160 xxxxx 28”. This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.\n",
"type": "string",
"default": ""
},
"explanation": {
"description": "detailed information about the sca method for the PSU.\n",
"type": "string",
"default": ""
}
},
"additionalProperties": false
}
authentication types:
SMS_OTP - An SCA method, where an OTP linked to the transaction to be authorised is sent to the PSU through a SMS channel.
CHIP_OTP - An SCA method, where an OTP is generated by a chip card, e.g. an TOP derived from an EMV cryptogram. To contact the card, the PSU normally needs a (handheld) device. With this device, the PSU either reads the challenging data through a visual interface like flickering or the PSU types in the challenge through the device key pad. The device then derives an OTP from the challenge data and displays the OTP to the PSU.
PHOTO_OTP - An SCA method, where the challenge is a QR code or similar encoded visual data which can be read in by a consumer device or specific mobile app. The device resp. the specific app than derives an OTP from the visual challenge data and displays the OTP to the PSU.
PUSH_OTP - An OTP is pushed to a dedicated authentication APP and displayed to the PSU.
{
"type": "string",
"enum": [
"SMS_OTP",
"CHIP_OTP",
"PHOTO_OTP",
"PUSH_OTP"
],
"default": "SMS_OTP",
"additionalProperties": false
}
Requested Authentication Data
{
"type": "object",
"properties": {
"image": {
"description": "PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding , cp. [RFC 4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.\n",
"type": "string",
"format": "byte",
"default": ""
},
"data": {
"description": "String challenge data",
"type": "string",
"default": ""
},
"imageLink": {
"description": "A link where the ASPSP will provides the challenge image for the TPP.",
"type": "string",
"default": ""
},
"otpMaxLength": {
"description": "The maximal length for the OTP to be typed in by the PSU.",
"type": "number",
"default": 0
},
"otpFormat": {
"description": "The format type of the OTP to be typed in.",
"type": "string",
"enum": [
"characters",
"integer"
],
"default": "integer"
},
"additionalInformation": {
"description": "Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU.",
"type": "string",
"default": ""
}
},
"additionalProperties": false
}
TBD
{
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR",
"SLEV"
],
"default": "SHAR",
"additionalProperties": false
}
Error Information.
{
"type": "object",
"properties": {
"tppMessages": {
"$ref": "#/definitions/TppMessageArray",
"description": "Messages to the TPP on operational issues."
}
},
"additionalProperties": false
}
Error and status Information.
{
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#/definitions/TransactionStatusType",
"description": "The transaction status is filled with codes of the ISO 20022 corresponding element."
},
"tppMessages": {
"$ref": "#/definitions/TppMessageArray",
"description": "Messages to the TPP on operational issues."
}
},
"additionalProperties": false
}
following/preceeding
{
"type": "string",
"enum": [
"following",
"preceeding"
],
"additionalProperties": false
}
Daily Weekly EveryTwoWeeks Monthly EveryTwoMonths Quarterly SemiAnnual Annual
{
"type": "string",
"enum": [
"Daily",
"Weekly",
"EveryTwoWeeks",
"Monthly",
"EveryTwoMonths",
"Quarterly",
"SemiAnnual",
"Annual"
],
"default": "Monthly",
"additionalProperties": false
}
Message error codes.
{
"type": "string",
"enum": [
"SERVICE_BLOCKED",
"CORPORATE_ID_IVALID",
"CONSENT_UNKNOWN",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"RESOURCE_UNIKNOWN",
"RESOURCE_EXPIRED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKKNOWN",
"TRANSACTION_ID_INVALID",
"PRODUCT_INVALID",
"PRODUCT_UNKNOWN",
"PAYMENT_FAILED",
"REQUIRED_KID_MISSING",
"SESSIONS_NOT_SUPPORTED",
"ACCESS_EXCEEDED",
"REQUESTED_FORMATS_INVALID",
"CARD_INVALID",
"NO_PIIS_ACTIVATION"
],
"default": "CONSENT_INVALID",
"additionalProperties": false
}
Cancels a given periodic payment initiaton resource.
{
"type": "object",
"properties": {
"transactionStatus": {
"description": "The transaction status is filled with codes of the ISO 20022 data table.",
"$ref": "#/definitions/TransactionStatusType"
},
"_links": {
"$ref": "#/definitions/PaymentDeleteLink",
"description": "A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. Remark: All links can be relative or full links, to be decided by the ASPSP. Type of links admitted in this response, (further links might be added for ASPSP defined extensions): \"startAuthorisation\": \\n In case, where just the authorisation process of the cancellation needs to be started, but no additional data needs to be updated for time being (no authentication method to be selected, no PSU identification nor PSU authentication data to be uploaded). \\n \"startAuthorisationWithPsuIdentification\": \\n In case where a PSU Identification needs to be updated when starting the cancellation authorisation: The link to the cancellation-authorisations end-point, where the cancellation sub-resource has to be generated while uploading the PSU identification data. \\n \"startAuthorisationWithPsuAuthentication\": \\n In case of a yet to be created authorisation sub-resource: The link to the cancellation-authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data. \\n \"startAuthorisationWithEncryptedPsuAuthentication\": \\n Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading. \\n \"startAuthorisationWithAuthenticationMethodSelection\": \\n The link to the authorisation end-point, where the cancellation-authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element \"scaMethods\""
},
"psuMessage": {
"type": "string",
"description": "Text to be displayed to the PSU."
},
"tppMessages": {
"$ref": "#/definitions/TppMessageArray",
"description": "Messages to the TPP on operational issues."
},
"transactionFees": {
"description": "Can be used by the ASPSP to transport transaction fees relevant for the underlying payments.",
"$ref": "#/definitions/Amount"
},
"transactionFeeIndicator": {
"type": "boolean",
"description": "If equals “true”, the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals “false”, the transaction will not involve additional specific transaction costs to the PSU."
},
"scaMethods": {
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also an hyperlink of type “selectAuthenticationMethods” contained in the response body. These methods shall be presented towards the PSU for selection by the TPP.",
"$ref": "#/definitions/AuthenticationArray"
}
},
"additionalProperties": false
}
Returns the content of a payment initiation object.
{
"type": "object",
"required": [
"transactionStatus",
"paymentId"
],
"properties": {
"transactionStatus": {
"$ref": "#/definitions/TransactionStatusType",
"description": "Status"
},
"paymentId": {
"description": "Resource identification of the generated payment initiation resource.",
"type": "string",
"default": ""
},
"debtorName": {
"description": "For a corporate account, the corporate name is used for this attribute",
"type": "string",
"maxLength": 70
},
"debtorAccount": {
"$ref": "#/definitions/AccountReference",
"description": "Debtor account"
},
"instructedAmount": {
"$ref": "#/definitions/Amount",
"description": "Instructed amount (inc. Curr.)."
},
"creditorAccount": {
"$ref": "#/definitions/AccountReference",
"description": "Creditor account"
},
"creditorAgent": {
"description": "BICFI",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
},
"creditorName": {
"description": "Name of the creditor if a “Debited” transaction",
"type": "string",
"maxLength": 70,
"default": ""
},
"creditorAddress": {
"$ref": "#/definitions/Address",
"description": "Address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured Remittance Information",
"type": "string",
"maxLength": 140,
"default": ""
},
"transactionFees": {
"$ref": "#/definitions/Amount",
"description": "Can be used by the ASPSP to transport transaction fees relevant for the underlying payments."
},
"transactionFeeIndicator": {
"description": "If equals “true”, the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals “false”, the transaction will not involve additional specific transaction costs to the PSU.",
"type": "boolean",
"default": false
},
"startDate": {
"type": "string",
"format": "date",
"description": "StartDate"
},
"purposeCode": {
"type": "string",
"description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published.",
"maxLength": 4
},
"chargeBearer": {
"$ref": "#/definitions/ChargeBearer",
"description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction."
},
"endDate": {
"type": "string",
"format": "date",
"description": "EndDate"
},
"frequency": {
"$ref": "#/definitions/FrequencyCode",
"description": "YEAR - Annual ADHO - Adhoc MNTH - Monthly DAIL - Daily INDA - Intraday WEEK - Weekly . . ."
},
"executionRule": {
"$ref": "#/definitions/ExecutionRule",
"description": "Following/Preceeding"
},
"dayOfExecution": {
"type": "integer",
"format": "int32",
"description": "Month day to execute payment. The format is following the regular expression \\d{1,2}. Example: The first day is addressed by \"1\"."
},
"creditorClearingCode": {
"type": "string",
"maxLength": 35,
"description": "Clearing Code of the Creditor Finantial Institution."
},
"creditorAgentName": {
"description": "Name of the creditor's agent",
"type": "string",
"maxLength": 140,
"default": ""
},
"creditorAgentAddress": {
"$ref": "#/definitions/Address",
"description": "Address"
}
},
"additionalProperties": false
}
A list of hyperlinks to be recognized by the TPP.
{
"properties": {
"scaRedirect": {
"description": "A link to an ASPSP site where SCA is performed within the Redirect SCA approach",
"type": "string",
"default": ""
},
"startAuthorisation": {
"description": "A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start.",
"type": "string",
"default": ""
},
"startAuthorisationWithPsuIdentification": {
"description": "The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call.",
"type": "string",
"default": ""
},
"startAuthorisationWithPsuAuthentication": {
"description": "The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element \"scaMethods\"",
"type": "string",
"default": ""
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element \"scaMethods\"",
"type": "string",
"default": ""
},
"startAuthorisationWithTransactionAuthorisation": {
"description": "The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.",
"type": "string",
"default": ""
},
"self": {
"description": "The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.",
"type": "string",
"default": ""
},
"status": {
"description": "The link to retrieve the transaction status of the payment initiation.",
"type": "string",
"default": ""
},
"scaStatus": {
"description": "The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.",
"type": "string",
"default": ""
}
},
"additionalProperties": false
}
A list of hyperlinks to be recognized by the TPP.
{
"properties": {
"startAuthorisation": {
"description": "A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start.",
"type": "string",
"default": ""
},
"startAuthorisationWithPsuIdentification": {
"description": "The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call.",
"type": "string",
"default": ""
},
"startAuthorisationWithPsuAuthentication": {
"description": "",
"type": "string",
"default": ""
},
"startAuthorisationWithAuthenticationMethodSelection": {
"description": "",
"type": "string",
"default": ""
}
},
"additionalProperties": false
}
A list of hyperlinks to be recognized by the TPP.
{
"properties": {
"self": {
"description": "The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation.\n",
"type": "string",
"default": ""
}
},
"additionalProperties": false
}
Creates a payment initiation request at the ASPSP.
{
"type": "object",
"required": [
"instructedAmount",
"creditorAccount",
"creditorName",
"startDate",
"frequency"
],
"properties": {
"endToEndIdentification": {
"description": "Unique identification as assigned by the sending party to unambiguously identify this payment.",
"type": "string",
"maxLength": 35,
"default": ""
},
"debtorAccount": {
"$ref": "#/definitions/AccountReference",
"description": "Debtor account"
},
"instructedAmount": {
"$ref": "#/definitions/Amount",
"description": "Instructed amount (inc. Curr.)"
},
"creditorAccount": {
"$ref": "#/definitions/AccountReference",
"description": "Creditor account"
},
"creditorAgent": {
"description": "BICFI",
"type": "string",
"pattern": "^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$",
"default": "ABCDEFABC0A"
},
"creditorName": {
"description": "Name of the creditor if a “Debited” transaction",
"type": "string",
"maxLength": 70,
"minLength": 1,
"default": "a"
},
"creditorAddress": {
"$ref": "#/definitions/Address",
"description": "Address"
},
"remittanceInformationUnstructured": {
"description": "Unstructured Remittance Information",
"type": "string",
"maxLength": 140,
"default": ""
},
"startDate": {
"type": "string",
"format": "date",
"description": "StartDate"
},
"purposeCode": {
"type": "string",
"description": "Specifies the category purpose, as published in an external category purpose code list.",
"maxLength": 4
},
"chargeBearer": {
"$ref": "#/definitions/ChargeBearer",
"description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction."
},
"endDate": {
"type": "string",
"format": "date",
"description": "EndDate"
},
"frequency": {
"$ref": "#/definitions/FrequencyCode",
"description": "Daily, Weekly, EveryTwoWeeks, Monthly, EveryTwoMonths, Quarterly, SemiAnnual, Annual,"
},
"executionRule": {
"$ref": "#/definitions/ExecutionRule",
"description": "Following/Preceeding"
},
"dayOfExecution": {
"type": "integer",
"format": "int32",
"description": "Month day to execute payment. The format is following the regular expression \\d{1,2}. Example: The first day is addressed by \"1\"."
},
"creditorClearingCode": {
"type": "string",
"maxLength": 35,
"description": "Clearing Code of the Creditor Finantial Institution"
},
"creditorAgentName": {
"description": "Name of the creditor's agent",
"type": "string",
"maxLength": 140,
"default": ""
},
"creditorAgentAddress": {
"$ref": "#/definitions/Address",
"description": "Address"
}
},
"additionalProperties": false
}
Creates a payment initiation response to TPP.
{
"type": "object",
"required": [
"transactionStatus",
"paymentId",
"_links"
],
"properties": {
"transactionStatus": {
"$ref": "#/definitions/TransactionStatusType",
"description": "The transaction status is filled with codes of the ISO 20022 data table."
},
"paymentId": {
"description": "Resource identification of the generated payment initiation resource.\n",
"type": "string",
"default": ""
},
"transactionFees": {
"$ref": "#/definitions/Amount",
"description": "Can be used by the ASPSP to transport transaction fees relevant for the underlying payments."
},
"currencyConversionFees": {
"$ref": "#/definitions/Amount",
"description": "Can be used by the ASPSP to transport transaction fees relevant for the underlying payments."
},
"estimatedTotalAmount": {
"$ref": "#/definitions/Amount",
"description": "Can be used by the ASPSP to transport transaction fees relevant for the underlying payments."
},
"estimatedInterbankSettlementAmount": {
"$ref": "#/definitions/Amount",
"description": "Can be used by the ASPSP to transport transaction fees relevant for the underlying payments."
},
"transactionFeeIndicator": {
"description": "If equals \"true\" the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU.\n\nIf equals \"false\" the transaction will not involve additional specific transaction costs to the PSU.\n",
"type": "boolean",
"default": false
},
"scaMethods": {
"$ref": "#/definitions/AuthenticationArray",
"description": "This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also an hyperlink of type “selectAuthenticationMethods” contained in the response body.\nThese methods shall be presented towards the PSU for selection by the TPP.\n"
},
"chosenScaMethod": {
"$ref": "#/definitions/Authentication",
"description": "This data element is only contained in the response if the APSPS has chosen the Embedded SCA Approach, if the PSU is already identified e.g. with the first relevant factor or alternatively an access token, if SCA is required and if the authentication method is implicitly selected.\n"
},
"challengeData": {
"$ref": "#/definitions/Challenge",
"description": "It is contained in addition to the data element chosenScaMethod if challenge data is needed for SCA.\nIn rare cases this attribute is also used in the context of the psuAuthentication link.\n"
},
"_links": {
"allOf": [
{
"$ref": "#/definitions/PaymentLink"
},
{
"type": "object",
"properties": {
"status": {
"description": "The link to retrieve the transaction status of the payment initiation.",
"type": "string",
"default": ""
},
"scaStatus": {
"description": "The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.",
"type": "string",
"default": ""
}
}
}
]
},
"psuMessage": {
"description": "Text to be displayed to the PSU.",
"type": "string",
"default": ""
},
"tppMessages": {
"$ref": "#/definitions/TppMessageArray",
"description": "Messages to the TPP on operational issues."
},
"creditorClearingCode": {
"type": "string",
"maxLength": 35,
"description": "Clearing Code of the Creditor Finantial Institution."
}
},
"additionalProperties": false
}
Informs TPP about status of a payment initiation.
{
"type": "object",
"required": [
"transactionStatus"
],
"properties": {
"transactionStatus": {
"$ref": "#/definitions/TransactionStatusType"
},
"_links": {
"$ref": "#/definitions/PaymentStatusLink",
"description": "Should refer to next steps if the problem can be resolved via the interface e.g. for re-submission of credentials."
}
},
"additionalProperties": false
}
Transports additional error information.
{
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"default": "",
"description": "Category of the error. Only \"ERROR\" or \"WARNING\" permitted."
},
"code": {
"$ref": "#/definitions/MessageCode",
"description": "Message error code."
},
"path": {
"type": "string",
"default": "",
"description": "Path of the element of the request message which provoked this error message."
},
"text": {
"type": "string",
"maxLength": 512,
"default": "",
"description": "Additional explaining text."
}
},
"additionalProperties": false
}
Messages to the TPP on operational issues.
{
"type": "array",
"items": {
"$ref": "#/definitions/TppMessage",
"description": "Transports additional error information."
},
"additionalProperties": false
}
ISO20022: The transaction status is filled with value of the ISO20022 data table. RCVD : RECEIVED PDNG : PENDING PATC : PARTIALLY ACCEPTED TECHNICAL CORRECT ACTC : ACCEPTED TECHNICAL VALIDATION ACFC : ACCEPTED FUNDS CHECKED ACWC : ACCEPTED WITH CHANGE ACWP : ACCEPTED WITHOUT POSTING ACSP : ACCEPTED SETTLEMENT IN PROCESS ACSC : ACCEPTED SETTLEMENT COMPLETED ACCC : ACCEPTED SETTLEMENT COMPLETED CREDITOR CANC : CANCELED RJCT : REJECTED
{
"type": "string",
"enum": [
"RCVD",
"PDNG",
"PATC",
"ACTC",
"ACFC",
"ACWC",
"ACWP",
"ACSP",
"ACSC",
"ACCC",
"CANC",
"RJCT"
],
"default": "RJCT",
"additionalProperties": false
}