openFinance API Framework XS2A API as PSD2 Interface Implementation Guidelines - Extended Payment Initiation Service (2.1)

Download OpenAPI specification:Download

URL: https://api.bog.ge/docs/openbanking License: Creative Commons Attribution 4.0 International Public License

The specific function in the Extended Payment Initiation Services is to make the initiation phase more flexible, i.e.

separate authorisation and actual initiation processes as well as
unbundle risk management functionality from the actual payment initiation, but already apply e.g. limit and balance checks during the authorisation and hence
potentially secure the future payment initiation in addition.

openFinance API Framework XS2A API as PSD2 Interface Implementation Guidelines

Extended Payment Initiation Service (XPIS)

The component for Payment Initiation Service (PIS) offers the following services:

Initiation and update of a payment request
Status information of a payment The {extended-payment-services} is referring to the service types XFPIS, XDPIS, XDFPIS, XMDPIS, XMDFPIS, XRPIS, XRFPIS and XMRPIS as defined in [oFA-OR-EPIS] and the related eight endpoint instances
secured-payments for XFPIS,
deferred-payments for XDPIS,
secured-deferred-payments for XDFPIS,
multiple-deferred-payments for XMDPIS,
secured-multiple-deferred-payments for XMDFPIS,
recurring-payments for XRPIS,
multiple-recurring-payments for XMRPIS.

Payment Initiation Request for Single Payments

Creates an extended payment resource for secured payments at the ASPSP for the XFPIS service.

Authorizations:

NoneBearerAuthOAuth

path Parameters

payment-product

required

string

Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers"

Example: sepa-credit-transfers

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported:

For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.

header Parameters

PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
PSU-ID	string (Max140Text) <= 140 characters Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-ID-Type	string (Max35Text) <= 35 characters Example: PSU-ID-TYPE_C Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.
PSU-Corporate-ID	string (Max140Text) <= 140 characters Example: PSU-CORP-ID1234 Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string (Max35Text) <= 35 characters Example: PSU-CORP-ID-TYPE_A Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Client-SCA-Approach-Preference	string (Max35Text) <= 35 characters Example: decoupled, redirect, embedded A comma separated list of attributes, where the first entry will have a higher priority than the next or to every SCA Approach which is not indicated at all, e.g. "decoupled, redirect, embedded" or "decoupled" This attribute may be ignored by the ASPSP
Client-Redirect-URI	string <uri> Example: https://exampleclient.com/redirectUri?clientEvent=11111111 URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach. It is recommended to always use this header field.
Client-Nok-Redirect-URI	string <uri> Example: https://exampleclient.com/NokUri?clientEvent=11111111 If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the Client-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
Client-Explicit-Authorisation-Preferred	boolean Example: true If it equals "true", the API Client prefers to start the authorisation process separately, e.g. because of the usage of a signing basket or because of asynchronous authorisation. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality or if asynchronous authorisation is not supported. If it equals "false" or if the parameter is not used, there is no preference of the API Client. This especially indicates that the API Client assumes a direct authorisation of the transaction in the next step, without using a signing basket.
Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
Content-Type required	string Example: application/json
API-Contract-ID	string <uuid> Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555 Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
Consent-ID	string (Max70Text) <= 70 characters Example: 123cons456 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.

Request Body schema:
application/json

Any of

	object Set of elements used to reference a payment instruction.
paymentMethod	string Enum: "TRF" "CHK" Specifies the means of payment that will be used to move the amount of money. Usage: Only used for cross-border transactions. If no paymentMethod is explicitly stated, paymentMethod will be interpreted as TRF (Credit Transfer).
categoryPurposeCode	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" Specifies the high level purpose of the instruction based on a set of pre-defined categories; provided as code.
	object Ultimate party that owes an amount of money to the (ultimate) creditor. Restriction to the schema are applied depending on the product.
required	object 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.
required	object Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
	object Financial institution servicing an account for the creditor.
required	object Party to which an amount of money is due.
	object Ultimate party to which an amount of money is due.
purposeCode	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" Specifies the purpose of the instruction based the code set ExternalPurpose1Code from ISO 20022.
remittanceInformationUnstructured	Array of strings (Max140Text) = 1 items [ items <= 140 characters ] Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
	Array of objects (remittance) = 1 items Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.
	object Request related information which is not directly linked to the payment transaction. Only applicable for request to pay services and extended payment services.
required	object Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
	object Party that owes an amount of money to the (ultimate) creditor.
requestedExecutionDate	string <date> Date at which the initiating party requests the clearing agent to process the payment.
requestedExecutionDateTime	string <date-time> Date and time at which the initiating party requests the clearing agent to process the payment.

Responses

Request samples

Payload

Content type

application/json

Example

SinglePayment_EPIS_SCT

{"paymentIdentification": {"instructionId": "Text, maximum of 35 characters.",
"endToEndId": "Text, maximum of 35 characters.",
"uetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
},
"paymentMethod": "TRF",
"categoryPurposeCode": "OTHR",
"ultimateDebtor": {"name": "Text, maximum of 140 characters."
},
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"creditorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"currency": "EUR"
},
"creditorAgent": {"financialInstitutionId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"creditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"ultimateCreditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"purposeCode": "OTHR",
"remittanceInformationUnstructured": ["{\"Ref Number Merchant\"}"
],
"remittanceInformationStructured": [ ],
"additionalRequestInformation": {"paymentConditions": {"amountModificationAllowed": true,
"earlyPaymentAllowed": true
},
"creationDateTime": "2020-01-01T13:00:00.999-01:00",
"requestedExpiryDateTime": "2020-01-01T13:00:00.999-01:00",
"originatorPspId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
},
"receiverPspId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"debtorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"msisdn": "Text, maximum of 35 characters.",
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "AIIN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
},
"typeCode": "CACC",
"typeProprietary": "Text, maximum of 35 characters.",
"currency": "EUR",
"proxy": {"typeCode": "EMAL",
"typeProprietary": "Text, maximum of 35 characters.",
"identification": "Text, maximum of 2048 characters."
},
"name": "Text, maximum of 70 characters.",
"owner": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
}
},
"servicer": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"debtor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"requestedExecutionDate": "2020-01-01",
"requestedExecutionDateTime": "2020-01-01T13:00:00.999-01:00"
}

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"paymentId": "Text, maximum of 70 characters.",
"securedBy": "bankGuarantee",
"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFee": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"transactionFeeIndicator": true,
"scaMethods": [{"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
}
],
"chosenScaMethod": {"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
},
"challengeData": {"image": "string",
"data": ["string"
],
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "string",
"additionalInformation": "string"
},
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"psuMessage": "Text, maximum of 500 characters.",
"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
]
}

Deferred Payment Authorisation Request

Creates an extended payment resource for deferred payments at the ASPSP.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service1

required

string

Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments"

Example: deferred-payments

Extended Payment Initiation Service. The default list is:

deferred-payments for XDPIS
secured-deferred-payments for XDFPIS
multiple-deferred-payments for XMDPIS
secured-multiple-deferred-payments for XMDFPIS

payment-product

required

string

Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers"

Example: sepa-credit-transfers

For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.

header Parameters

PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
PSU-ID	string (Max140Text) <= 140 characters Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-ID-Type	string (Max35Text) <= 35 characters Example: PSU-ID-TYPE_C Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.
PSU-Corporate-ID	string (Max140Text) <= 140 characters Example: PSU-CORP-ID1234 Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string (Max35Text) <= 35 characters Example: PSU-CORP-ID-TYPE_A Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Client-SCA-Approach-Preference	string (Max35Text) <= 35 characters Example: decoupled, redirect, embedded A comma separated list of attributes, where the first entry will have a higher priority than the next or to every SCA Approach which is not indicated at all, e.g. "decoupled, redirect, embedded" or "decoupled" This attribute may be ignored by the ASPSP
Client-Redirect-URI	string <uri> Example: https://exampleclient.com/redirectUri?clientEvent=11111111 URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach. It is recommended to always use this header field.
Client-Nok-Redirect-URI	string <uri> Example: https://exampleclient.com/NokUri?clientEvent=11111111 If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the Client-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
Client-Explicit-Authorisation-Preferred	boolean Example: true If it equals "true", the API Client prefers to start the authorisation process separately, e.g. because of the usage of a signing basket or because of asynchronous authorisation. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality or if asynchronous authorisation is not supported. If it equals "false" or if the parameter is not used, there is no preference of the API Client. This especially indicates that the API Client assumes a direct authorisation of the transaction in the next step, without using a signing basket.
Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
Content-Type required	string Example: application/json
API-Contract-ID	string <uuid> Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555 Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
Consent-ID	string (Max70Text) <= 70 characters Example: 123cons456 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.

Request Body schema: application/json

Any of

	object Set of elements used to reference a payment instruction.
paymentMethod	string Enum: "TRF" "CHK" Specifies the means of payment that will be used to move the amount of money. Usage: Only used for cross-border transactions. If no paymentMethod is explicitly stated, paymentMethod will be interpreted as TRF (Credit Transfer).
categoryPurposeCode	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" Specifies the high level purpose of the instruction based on a set of pre-defined categories; provided as code.
	object Ultimate party that owes an amount of money to the (ultimate) creditor. Restriction to the schema are applied depending on the product.
required	object 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.
required	object Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
	object Financial institution servicing an account for the creditor.
required	object Party to which an amount of money is due.
	object Ultimate party to which an amount of money is due.
purposeCode	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" Specifies the purpose of the instruction based the code set ExternalPurpose1Code from ISO 20022.
remittanceInformationUnstructured	Array of strings (Max140Text) = 1 items [ items <= 140 characters ] Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
	Array of objects (remittance) = 1 items Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.
	object Request related information which is not directly linked to the payment transaction. Only applicable for request to pay services and extended payment services.
required	object Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
	object Party that owes an amount of money to the (ultimate) creditor.
requestedExecutionDate	string <date> Date at which the initiating party requests the clearing agent to process the payment.
requestedExecutionDateTime	string <date-time> Date and time at which the initiating party requests the clearing agent to process the payment.

Responses

Request samples

Payload

Content type

application/json

Example

SinglePayment_EPIS_SCT

{"paymentIdentification": {"instructionId": "Text, maximum of 35 characters.",
"endToEndId": "Text, maximum of 35 characters.",
"uetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
},
"paymentMethod": "TRF",
"categoryPurposeCode": "OTHR",
"ultimateDebtor": {"name": "Text, maximum of 140 characters."
},
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"creditorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"currency": "EUR"
},
"creditorAgent": {"financialInstitutionId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"creditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"ultimateCreditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"purposeCode": "OTHR",
"remittanceInformationUnstructured": ["{\"Ref Number Merchant\"}"
],
"remittanceInformationStructured": [ ],
"additionalRequestInformation": {"paymentConditions": {"amountModificationAllowed": true,
"earlyPaymentAllowed": true
},
"creationDateTime": "2020-01-01T13:00:00.999-01:00",
"requestedExpiryDateTime": "2020-01-01T13:00:00.999-01:00",
"originatorPspId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
},
"receiverPspId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"debtorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"msisdn": "Text, maximum of 35 characters.",
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "AIIN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
},
"typeCode": "CACC",
"typeProprietary": "Text, maximum of 35 characters.",
"currency": "EUR",
"proxy": {"typeCode": "EMAL",
"typeProprietary": "Text, maximum of 35 characters.",
"identification": "Text, maximum of 2048 characters."
},
"name": "Text, maximum of 70 characters.",
"owner": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
}
},
"servicer": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"debtor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"requestedExecutionDate": "2020-01-01",
"requestedExecutionDateTime": "2020-01-01T13:00:00.999-01:00"
}

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"paymentId": "Text, maximum of 70 characters.",
"securedBy": "bankGuarantee",
"maximumNumberOfInitiations": 0,
"expiryDateTime": "2020-01-01T13:00:00.999-01:00",
"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFee": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"transactionFeeIndicator": true,
"scaMethods": [{"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
}
],
"chosenScaMethod": {"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
},
"challengeData": {"image": "string",
"data": ["string"
],
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "string",
"additionalInformation": "string"
},
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"psuMessage": "Text, maximum of 500 characters.",
"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
]
}

Initiation for Deferred Payments

Creates an initiation for a (partial) deferred payment initiation for the related authorised payment resource at the ASPSP.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service1 required	string Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" Example: deferred-payments Extended Payment Initiation Service. The default list is: deferred-payments for XDPIS secured-deferred-payments for XDFPIS multiple-deferred-payments for XMDPIS secured-multiple-deferred-payments for XMDFPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
Content-Type required	string Example: application/json
API-Contract-ID	string <uuid> Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555 Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

Request Body schema: application/json

	object If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for payment identification.
	object Amount requested from the API client to be executed by the ASPSP. Mandatory for XDPIS, XDFPIS, XRPIS and XRFPIS. If not contained in a XMDPIS service, then this is a dedicated closing transaction. This amount shall be smaller or equal to the amount still being reserved in the XDPIS/XDFPIS/XMPIS/XMFPIS case (current reservedAmount)
remittanceInformationUnstructured	Array of strings (Max140Text) [ items <= 140 characters ] If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for remittance information.
	Array of objects (remittance) The supported sub structure will depend on the underlying payment product. If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for remittance information.
closingFlag required	boolean If true, then the TPP indicates that this is the last initiation on the related payment resource. As a consequence, the mechanism for securing the payment (e.g. reservation of funds) is closed in the ASPSP system.

Responses

Request samples

Payload

Content type

application/json

{"paymentIdentification": {"instructionId": "Text, maximum of 35 characters.",
"endToEndId": "Text, maximum of 35 characters.",
"uetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
},
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"remittanceInformationUnstructured": ["Text, maximum of 140 characters."
],
"remittanceInformationStructured": [{"referredDocumentInformation": {"typeCode": "PUOR",
"typeProprietary": "Text, maximum of 35 characters.",
"typeIssuer": "Text, maximum of 35 characters.",
"number": "Text, maximum of 35 characters.",
"relatedDate": "2020-01-01"
},
"creditorReferenceInformation": {"reference": "Text, maximum of 35 characters.",
"referenceTypeCode": "PUOR",
"referenceTypeProprietary": "Text, maximum of 35 characters.",
"referenceIssuer": "Text, maximum of 35 characters."
},
"additionalRemittanceInformation": ["Text, maximum of 140 characters."
]
}
],
"closingFlag": true
}

Response samples

Content type

application/json

{"initiationId": "Text, maximum of 70 characters.",
"remainingAuthorizedAmount": {"currency": "EUR",
"amount": "string"
},
"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFee": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"transactionFeeIndicator": true
}

Recurring Payments Authorisation Request

Creates an extended payment resource for recurring payments which allow one initiation per period (with flexible amount less equal to the authorised amount) or multiple initiations per period at the ASPSP.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service2

required

string

Enum: "multiple-recurring-payments" "recurring-payments" "secured-recurring-payments"

Example: recurring-payments

Extended Payment Initiation Service. The default list is:

multiple-recurring-payments for XMRPIS,
recurring-payments for XRPIS and
secured-recurring-payments for XRFPIS.

payment-product

required

string

Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers"

Example: sepa-credit-transfers

For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.

header Parameters

PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
PSU-ID	string (Max140Text) <= 140 characters Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-ID-Type	string (Max35Text) <= 35 characters Example: PSU-ID-TYPE_C Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.
PSU-Corporate-ID	string (Max140Text) <= 140 characters Example: PSU-CORP-ID1234 Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string (Max35Text) <= 35 characters Example: PSU-CORP-ID-TYPE_A Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Client-SCA-Approach-Preference	string (Max35Text) <= 35 characters Example: decoupled, redirect, embedded A comma separated list of attributes, where the first entry will have a higher priority than the next or to every SCA Approach which is not indicated at all, e.g. "decoupled, redirect, embedded" or "decoupled" This attribute may be ignored by the ASPSP
Client-Redirect-URI	string <uri> Example: https://exampleclient.com/redirectUri?clientEvent=11111111 URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach. It is recommended to always use this header field.
Client-Nok-Redirect-URI	string <uri> Example: https://exampleclient.com/NokUri?clientEvent=11111111 If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the Client-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
Client-Explicit-Authorisation-Preferred	boolean Example: true If it equals "true", the API Client prefers to start the authorisation process separately, e.g. because of the usage of a signing basket or because of asynchronous authorisation. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality or if asynchronous authorisation is not supported. If it equals "false" or if the parameter is not used, there is no preference of the API Client. This especially indicates that the API Client assumes a direct authorisation of the transaction in the next step, without using a signing basket.
Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
Content-Type required	string Example: application/json
API-Contract-ID	string <uuid> Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555 Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
Consent-ID	string (Max70Text) <= 70 characters Example: 123cons456 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.

Request Body schema: application/json

startDate required	string <date> The first applicable day of execution starting from this date is the first execution request date.
endDate	string <date> The last applicable day of execution If not given, it is an infinite recurring payment.
frequency required	string Enum: "YEAR" "MNTH" "QURT" "MIAN" "WEEK" "DAIL" "ADHO" "INDA" "FRTN" The frequency of the recurring payment.
dayOfExecution	string <= 2 characters The format is following the regular expression \d{1,2}. Example: The first day is addressed by "1". The date is referring to the time zone of the ASPSP.

Responses

Request samples

Payload

Content type

application/json

{"startDate": "2020-01-01",
"endDate": "2020-01-01",
"frequency": "YEAR",
"dayOfExecution": "2C"
}

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"paymentId": "Text, maximum of 70 characters.",
"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFee": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"transactionFeeIndicator": true,
"scaMethods": [{"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
}
],
"chosenScaMethod": {"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
},
"challengeData": {"image": "string",
"data": ["string"
],
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "string",
"additionalInformation": "string"
},
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"psuMessage": "Text, maximum of 500 characters.",
"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
]
}

Initiation for Recurring Payments

Creates an initiation for a recurring payment initiation for the related authorised payment resource at the ASPSP.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service3 required	string Enum: "recurring-payments" "secured-recurring-payments" Example: recurring-payments Extended Payment Initiation Service. The default list is: recurring-payments for XRPIS and secured-recurring-payments for XRFPIS.
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
Content-Type required	string Example: application/json
API-Contract-ID	string <uuid> Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555 Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.

Request Body schema: application/json

	object If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for payment identification.
required	object Amount requested from the API client to be executed by the ASPSP. Mandatory for XDPIS, XDFPIS, XRPIS and XRFPIS. If not contained in a XMDPIS service, then this is a dedicated closing transaction. This amount shall be smaller or equal to the amount still being reserved in the XDPIS/XDFPIS/XMPIS/XMFPIS case (current reservedAmount)
remittanceInformationUnstructured	Array of strings (Max140Text) [ items <= 140 characters ] If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for remittance information.
	Array of objects (remittance) The supported sub structure will depend on the underlying payment product. If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for remittance information.
requestedExecutionDate	string <date> Shall be consistent with the planned regular execution day as defined in the initial payment resource.
requestedExecutionDateTime	string <date-time> Shall be consistent with the planned regular execution day as defined in the initial payment resource. Only to be used with instant payment products for execution at that timestamp

Responses

Request samples

Payload

Content type

application/json

{"paymentIdentification": {"instructionId": "Text, maximum of 35 characters.",
"endToEndId": "Text, maximum of 35 characters.",
"uetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
},
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"remittanceInformationUnstructured": ["Text, maximum of 140 characters."
],
"remittanceInformationStructured": [{"referredDocumentInformation": {"typeCode": "PUOR",
"typeProprietary": "Text, maximum of 35 characters.",
"typeIssuer": "Text, maximum of 35 characters.",
"number": "Text, maximum of 35 characters.",
"relatedDate": "2020-01-01"
},
"creditorReferenceInformation": {"reference": "Text, maximum of 35 characters.",
"referenceTypeCode": "PUOR",
"referenceTypeProprietary": "Text, maximum of 35 characters.",
"referenceIssuer": "Text, maximum of 35 characters."
},
"additionalRemittanceInformation": ["Text, maximum of 140 characters."
]
}
],
"requestedExecutionDate": "2020-01-01",
"requestedExecutionDateTime": "2020-01-01T13:00:00.999-01:00"
}

Response samples

Content type

application/json

{"initiationId": "Text, maximum of 70 characters.",
"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"requestedExecutionDate": "2020-01-01",
"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFee": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"transactionFeeIndicator": true
}

Initiation for Multiple Recurring Payments

Creates an initiation resource for a partial payment initiation for the related authorised payment resource at the ASPSP. The initiation might be either then be booked afterwards by the ASPSP or need an explicit confirmation by the API Client.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service4 required	string Value: "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
Content-Type required	string Example: application/json
API-Contract-ID	string <uuid> Example: 99435d7f-ad87-4aec-a2ae-99ddcb1f6555 Might be mandated by the ASPSP, if a commercial agreement is needed for the usage of the service.
PSU-IP-Address required	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
Client-Explicit-Confirmation-Requested	boolean Example: true If it equals "true", and if an explicit confirmation is supported by the ASPSP, then the related initiation will only be executed after an additional confirmation request. If it equals "true", and if an explicit confirmation is not supported by the ASPSP, then the related request will be rejected. If it equals "false" or if an explicit confirmation is not supported by the ASPSP or if not used by the API Client, then the related initiation needs no further action on the API to be executed.

Request Body schema: application/json

	object If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for payment identification.
required	object Amount requested from the API client to be executed by the ASPSP. Mandatory for XDPIS, XDFPIS, XRPIS and XRFPIS. If not contained in a XMDPIS service, then this is a dedicated closing transaction. This amount shall be smaller or equal to the amount still being reserved in the XDPIS/XDFPIS/XMPIS/XMFPIS case (current reservedAmount)
remittanceInformationUnstructured	Array of strings (Max140Text) [ items <= 140 characters ] If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for remittance information.
	Array of objects (remittance) The supported sub structure will depend on the underlying payment product. If this attribute is provided, then it will be used by the ASPSP in the related credit transfer for remittance information.

Responses

Request samples

Payload

Content type

application/json

{"paymentIdentification": {"instructionId": "Text, maximum of 35 characters.",
"endToEndId": "Text, maximum of 35 characters.",
"uetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
},
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"remittanceInformationUnstructured": ["Text, maximum of 140 characters."
],
"remittanceInformationStructured": [{"referredDocumentInformation": {"typeCode": "PUOR",
"typeProprietary": "Text, maximum of 35 characters.",
"typeIssuer": "Text, maximum of 35 characters.",
"number": "Text, maximum of 35 characters.",
"relatedDate": "2020-01-01"
},
"creditorReferenceInformation": {"reference": "Text, maximum of 35 characters.",
"referenceTypeCode": "PUOR",
"referenceTypeProprietary": "Text, maximum of 35 characters.",
"referenceIssuer": "Text, maximum of 35 characters."
},
"additionalRemittanceInformation": ["Text, maximum of 140 characters."
]
}
]
}

Response samples

Content type

application/json

{"initiationId": "Text, maximum of 70 characters.",
"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"confirmationExpiryDateTime": "2020-01-01T13:00:00.999-01:00",
"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFee": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"transactionFeeIndicator": true,
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"confirmInitiation": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}

Confirmation for Initiations (for Multiple Recurring Payments)

The API Client confirms with this request the actual execution of the addressed initiation.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service4 required	string Value: "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.
initiationId required	string ID of the corresponding initiation object as returned by a Initiation for Multiple Recurring Payments Request.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information

Responses

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters."
}

Cancellation for Initiations (for Multiple Recurring Payments)

The API Client asks for the cancellation of the addressed initiation as long as it is not confirmed yet.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service4 required	string Value: "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.
initiationId required	string ID of the corresponding initiation object as returned by a Initiation for Multiple Recurring Payments Request.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information

Responses

Response samples

Content type

application/json

{"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
],
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"creditorNameConfirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"updatePsuIdentification": {"href": "string"
},
"startAuthorisationWithProprietaryData": {"href": "string"
},
"updateProprietaryData": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"updatePsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"updateEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"selectAuthenticationMethod": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"authoriseTransaction": {"href": "string"
},
"updateResourceByDebtorAccountResource": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"transactionfees": {"href": "string"
},
"scaStatus": {"href": "string"
},
"account": {"href": "string"
},
"savingsAccount": {"href": "string"
},
"loanAccount": {"href": "string"
},
"balances": {"href": "string"
},
"transactions": {"href": "string"
},
"cardAccount": {"href": "string"
},
"cardTransactions": {"href": "string"
},
"transactionDetails": {"href": "string"
},
"ibanCheck": {"href": "string"
},
"paymentInitiation": {"href": "string"
},
"securitiesAccount": {"href": "string"
},
"positions": {"href": "string"
},
"orders": {"href": "string"
},
"orderDetails": {"href": "string"
},
"relatedOrders": [{"href": "string"
}
],
"relatedTransactions": [{"href": "string"
}
],
"subscription": {"href": "string"
},
"entryStatusRevoked": [{"href": "string"
}
],
"first": {"href": "string"
},
"next": {"href": "string"
},
"previous": {"href": "string"
},
"last": {"href": "string"
},
"download": {"href": "string"
},
"confirmInitiation": {"href": "string"
},
"aspspParameters": {"href": "string"
},
"aspspContacts": {"href": "string"
},
"aspspDowntimes": {"href": "string"
},
"onboardings": {"href": "string"
},
"readConditions": {"href": "string"
},
"confirmConditions": {"href": "string"
}
}
}

Get Transaction Status Request

Can check the status of a payment authorisation for deferred or recurring payments, resp. payment initiation in the case of secured-payments.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service5 required	string Enum: "secured-payments" "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: secured-payments XFPIS, deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS secured-recurring-payments for XRFPIS and multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"remainingAuthorizedAmount": {"currency": "EUR",
"amount": "string"
},
"psuMessage": "Text, maximum of 500 characters.",
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
]
}

Get Initiation Status Request

Can check the status of a payment authorisation for deferred or recurring payments, resp. payment initiation in the case of secured-payments.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service6 required	string Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS secured-recurring-payments for XRFPIS and multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.
initiationId required	string ID of the corresponding initiation object as returned by a Initiation for Multiple Recurring Payments Request.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters.",
"remainingAuthorizedAmount": {"currency": "EUR",
"amount": "string"
},
"psuMessage": "Text, maximum of 500 characters.",
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
]
}

Get Payment Request

Returns the content of a payment object.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service5 required	string Enum: "secured-payments" "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: secured-payments XFPIS, deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS secured-recurring-payments for XRFPIS and multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"paymentIdentification": {"instructionId": "Text, maximum of 35 characters.",
"endToEndId": "Text, maximum of 35 characters.",
"uetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
},
"paymentMethod": "TRF",
"categoryPurposeCode": "OTHR",
"ultimateDebtor": {"name": "Text, maximum of 140 characters."
},
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"creditorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"currency": "EUR"
},
"creditorAgent": {"financialInstitutionId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"creditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"ultimateCreditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"purposeCode": "OTHR",
"remittanceInformationUnstructured": ["{\"Ref Number Merchant\"}"
],
"remittanceInformationStructured": [ ],
"additionalRequestInformation": {"paymentConditions": {"amountModificationAllowed": true,
"earlyPaymentAllowed": true
},
"creationDateTime": "2020-01-01T13:00:00.999-01:00",
"requestedExpiryDateTime": "2020-01-01T13:00:00.999-01:00",
"originatorPspId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
},
"receiverPspId": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"debtorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"msisdn": "Text, maximum of 35 characters.",
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "AIIN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
},
"typeCode": "CACC",
"typeProprietary": "Text, maximum of 35 characters.",
"currency": "EUR",
"proxy": {"typeCode": "EMAL",
"typeProprietary": "Text, maximum of 35 characters.",
"identification": "Text, maximum of 2048 characters."
},
"name": "Text, maximum of 70 characters.",
"owner": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
}
},
"servicer": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"debtor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"requestedExecutionDate": "2020-01-01",
"requestedExecutionDateTime": "2020-01-01T13:00:00.999-01:00"
}

Payment Cancellation Request

It initiates the cancellation of a payment. Depending on the payment-service, the payment-product and the ASPSP's implementation, this API Client call might be sufficient to cancel a payment. If an authorisation of the payment cancellation is mandated by the ASPSP, a corresponding hyperlink will be contained in the response message. These two cases will be separated also in using different 2xx HTTP response codes.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service6 required	string Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS secured-recurring-payments for XRFPIS and multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
PSU-ID	string (Max140Text) <= 140 characters Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-ID-Type	string (Max35Text) <= 35 characters Example: PSU-ID-TYPE_C Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.
PSU-Corporate-ID	string (Max140Text) <= 140 characters Example: PSU-CORP-ID1234 Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string (Max35Text) <= 35 characters Example: PSU-CORP-ID-TYPE_A Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Client-SCA-Approach-Preference	string (Max35Text) <= 35 characters Example: decoupled, redirect, embedded A comma separated list of attributes, where the first entry will have a higher priority than the next or to every SCA Approach which is not indicated at all, e.g. "decoupled, redirect, embedded" or "decoupled" This attribute may be ignored by the ASPSP
Client-Redirect-URI	string <uri> Example: https://exampleclient.com/redirectUri?clientEvent=11111111 URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach. It is recommended to always use this header field.
Client-Nok-Redirect-URI	string <uri> Example: https://exampleclient.com/NokUri?clientEvent=11111111 If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the Client-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
Client-Explicit-Authorisation-Preferred	boolean Example: true If it equals "true", the API Client prefers to start the authorisation process separately, e.g. because of the usage of a signing basket or because of asynchronous authorisation. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality or if asynchronous authorisation is not supported. If it equals "false" or if the parameter is not used, there is no preference of the API Client. This especially indicates that the API Client assumes a direct authorisation of the transaction in the next step, without using a signing basket.
Client-Notification-URI	string Example: https://exampleclient.com/NotificationUri?clientEvent=11111111 URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client.
Client-Notification-Content-Preferred	string Example: status=SCA The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client.
Client-Brand-Logging-Information	string (Max140Text) <= 140 characters Example: ClientBrandB This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"scaMethods": [{"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
}
],
"chosenScaMethod": {"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
},
"challengeData": {"image": "string",
"data": ["string"
],
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "string",
"additionalInformation": "string"
},
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"scaStatus": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}

Get Initiations Request

Returns of all available initiation objects related to a given payment resource.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service6 required	string Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS secured-recurring-payments for XRFPIS and multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

query Parameters

transactionStatus

string (TransactionStatus)

Enum: "ACCC" "ACCP" "ACSC" "ACSP" "ACTC" "ACWC" "ACWP" "RCVD" "PDNG" "RJCT" "CANC" "ACFC" "PATC" "PART" "PRES" "RVCM" "RVNC" "RCVC"

Example: transactionStatus=ACCC

Will provide all available initiation objects where the transactionStatus equals the requested value.

dateFrom

string <date> (ISODate)

Example: dateFrom=2020-01-01

Conditional: Starting date (inclusive the date dateFrom) of the transaction list, mandated if no delta access is required and if bookingStatus does not equal "information". For booked transactions, the relevant date is the booking date. For pending transactions, the relevant date is the entry date, which may not be transparent neither in this API nor other channels of the ASPSP.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"initiations": [{"initiationId": "Text, maximum of 35 characters.",
"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"transactionStatus": "ACCC",
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"creditorNameConfirmation": {"href": "string"
},
"startAuthorisation": {"href": "string"
},
"startAuthorisationWithPsuIdentification": {"href": "string"
},
"updatePsuIdentification": {"href": "string"
},
"startAuthorisationWithProprietaryData": {"href": "string"
},
"updateProprietaryData": {"href": "string"
},
"startAuthorisationWithPsuAuthentication": {"href": "string"
},
"updatePsuAuthentication": {"href": "string"
},
"startAuthorisationWithEncryptedPsuAuthentication": {"href": "string"
},
"updateEncryptedPsuAuthentication": {"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {"href": "string"
},
"selectAuthenticationMethod": {"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {"href": "string"
},
"authoriseTransaction": {"href": "string"
},
"updateResourceByDebtorAccountResource": {"href": "string"
},
"self": {"href": "string"
},
"status": {"href": "string"
},
"transactionfees": {"href": "string"
},
"scaStatus": {"href": "string"
},
"account": {"href": "string"
},
"savingsAccount": {"href": "string"
},
"loanAccount": {"href": "string"
},
"balances": {"href": "string"
},
"transactions": {"href": "string"
},
"cardAccount": {"href": "string"
},
"cardTransactions": {"href": "string"
},
"transactionDetails": {"href": "string"
},
"ibanCheck": {"href": "string"
},
"paymentInitiation": {"href": "string"
},
"securitiesAccount": {"href": "string"
},
"positions": {"href": "string"
},
"orders": {"href": "string"
},
"orderDetails": {"href": "string"
},
"relatedOrders": [{"href": "string"
}
],
"relatedTransactions": [{"href": "string"
}
],
"subscription": {"href": "string"
},
"entryStatusRevoked": [{"href": "string"
}
],
"first": {"href": "string"
},
"next": {"href": "string"
},
"previous": {"href": "string"
},
"last": {"href": "string"
},
"download": {"href": "string"
},
"confirmInitiation": {"href": "string"
},
"aspspParameters": {"href": "string"
},
"aspspContacts": {"href": "string"
},
"aspspDowntimes": {"href": "string"
},
"onboardings": {"href": "string"
},
"readConditions": {"href": "string"
},
"confirmConditions": {"href": "string"
}
}
}
]
}

Retrieve Initiation Request

Returns of all available initiation objects related to a given payment resource.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service6 required	string Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" "multiple-recurring-payments" Example: multiple-recurring-payments Extended Payment Initiation Service. The default list is: deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS secured-recurring-payments for XRFPIS and multiple-recurring-payments for XMRPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.
initiationId required	string ID of the corresponding initiation object as returned by a Initiation for Multiple Recurring Payments Request.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"transactionStatus": "ACCC",
"reasonCode": "AM04",
"reasonProprietary": "Text, maximum of 35 characters."
}

Get Cancellation Authorisation Sub-Resources Request

Will deliver an array of resource identifications to all generated cancellation authorisation sub-resources.

Authorizations:

NoneBearerAuthOAuth

path Parameters

extended-payment-service7 required	string Enum: "deferred-payments" "secured-deferred-payments" "multiple-deferred-payments" "secured-multiple-deferred-payments" "recurring-payments" "secured-recurring-payments" Example: recurring-payments Extended Payment Initiation Service. The default list is: deferred-payments for XDPIS, secured-deferred-payments for XDFPIS, multiple-deferred-payments for XMDPIS, secured-multiple-deferred-payments for XMDFPIS recurring-payments for XRPIS and secured-recurring-payments for XRFPIS
payment-product required	string Enum: "sepa-credit-transfers" "micro-sepa-credit-transfers" "instant-sepa-credit-transfers" "target-2-payments" "cross-border-credit-transfers" Example: sepa-credit-transfers The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported. The following payment products are supported: For request bodies with JSON encoding: -- sepa-credit-transfers -- micro-sepa-credit-transfers -- instant-sepa-credit-transfers -- target-2-payments -- cross-border-credit-transfers The ASPSP will publish which of the payment products/endpoints will be supported. For definitions of basic non euro generic products see [oFA PFDom]. Further products might be published by the ASPSP within its XS2A documentation. These new product types will end in further endpoints of the XS2A Interface.
paymentId required	string (Max70Text) <= 70 characters Example: fe7552ee-0728-4bd1-baf7-94942331e478 Resource identification of the related payment.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"authorisationIds": ["Text, maximum of 70 characters."
]
}

Authorisation

Start Authorisation Process

Creates an account information consent resource at the ASPSP regarding access to account information to account types and accounts specified in this request.

Authorizations:

NoneBearerAuthOAuth

path Parameters

resource-path required	string Example: consents/account-access This resource path can be a one-level parameter {service} or a two-level parameter {service}/{product-type}, where {service} stands for the service type of the related business transaction, e.g. /payments or /consents source. {product-type} stands for the product-type of the related business transaction where applicable, e.g. sepa-credit-transfers in the case of payments or account-access in case of consents.
resourceId required	string (Max70Text) <= 70 characters Example: 1234-resource-567 Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource.
authorisation-category required	string Enum: "authorisations" "cancellation-authorisations" Example: authorisations The following two categories are supported: authorisations: used in case of an authorisation of the related business transaction. cancellation-authorisations: used in case of the cancellation authorisation of the related business transaction. Used only if applicable to the addressed {service}

header Parameters

PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. Conditions will be defined within service specifications, If applicable.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
PSU-ID	string (Max140Text) <= 140 characters Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-ID-Type	string (Max35Text) <= 35 characters Example: PSU-ID-TYPE_C Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.
PSU-Corporate-ID	string (Max140Text) <= 140 characters Example: PSU-CORP-ID1234 Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string (Max35Text) <= 35 characters Example: PSU-CORP-ID-TYPE_A Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Client-SCA-Approach-Preference	string (Max35Text) <= 35 characters Example: decoupled, redirect, embedded A comma separated list of attributes, where the first entry will have a higher priority than the next or to every SCA Approach which is not indicated at all, e.g. "decoupled, redirect, embedded" or "decoupled" This attribute may be ignored by the ASPSP
Client-Redirect-URI	string <uri> Example: https://exampleclient.com/redirectUri?clientEvent=11111111 URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandated for the Redirect SCA Approach. It is recommended to always use this header field.
Client-Nok-Redirect-URI	string <uri> Example: https://exampleclient.com/NokUri?clientEvent=11111111 If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the Client-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.

Request Body schema: application/json

Any of

required

object

The password, orencryptedPassword, subfield is used, depending depending on encryption requirements of the ASPSP as indicated in the corresponding hyperlink contained in the preceding response message of the ASPSP. The related encryption requirements are defined in Document "Protocol Functions and Security Measures".

password	string Contains a password in plaintext.
encryptedPassword	string Is used when a password is encrypted on application level.

Responses

Request samples

Payload

Content type

application/json

{"authenticationMethodId": "string"
}

Response samples

Content type

application/json

{"transactionFees": {"currency": "EUR",
"amount": "string"
},
"currencyConversionFees": {"currency": "EUR",
"amount": "string"
},
"estimatedTotalAmount": {"currency": "EUR",
"amount": "string"
},
"estimatedInterbankSettlementAmount": {"currency": "EUR",
"amount": "string"
},
"scaStatus": "received",
"authorisationId": "string",
"originalTransactionInformationAndVopStatus": [{"originalInstructionId": "Text, maximum of 35 characters.",
"originalEndToEndId": "Text, maximum of 35 characters.",
"originalUetr": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555",
"transactionStatus": "ACCC",
"statusReasonInformationCode": "AM04",
"statusReasonInformationProprietary": "Text, maximum of 35 characters.",
"statusReasonAdditionalInformation": "Text, maximum of 105 characters.",
"originalTransactionReference": {"instructedAmount": {"currency": "EUR",
"amount": "string"
},
"equivalentAmount": {"amount": {"currency": "EUR",
"amount": "string"
},
"currencyOfTransfer": "EUR"
},
"creditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
},
"creditorAccount": {"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"pan": "Text, maximum of 35 characters.",
"maskedPan": "Text, maximum of 35 characters.",
"msisdn": "Text, maximum of 35 characters.",
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "AIIN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
},
"typeCode": "CACC",
"typeProprietary": "Text, maximum of 35 characters.",
"currency": "EUR",
"proxy": {"typeCode": "EMAL",
"typeProprietary": "Text, maximum of 35 characters.",
"identification": "Text, maximum of 2048 characters."
},
"name": "Text, maximum of 70 characters.",
"owner": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
}
},
"servicer": {"bicfi": "ECBFDEFFFIM",
"clearingSystemMemberId": {"memberId": "Text, maximum of 35 characters.",
"clearingSystemIdentificationCode": "DEBLZ",
"clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
},
"name": "Text, maximum of 140 characters.",
"postalAddress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"other": {"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "string",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
}
},
"ultimateCreditor": {"name": "Text, maximum of 140 characters.",
"postaladdress": {"addressLines": ["Text, maximum of 140 characters."
],
"department": "Text, maximum of 70 characters.",
"subDepartment": "Text, maximum of 70 characters.",
"streetName": "Text, maximum of 70 characters.",
"buildingNumber": "16 Chars at most",
"buildingName": "Text, maximum of 35 characters.",
"floor": "Text, maximum of 70 characters.",
"postBox": "16 Chars at most",
"room": "Text, maximum of 70 characters.",
"postCode": "16 Chars at most",
"townName": "Text, maximum of 35 characters.",
"townLocationName": "Text, maximum of 35 characters.",
"districtName": "Text, maximum of 35 characters.",
"countrySubDivision": "Text, maximum of 35 characters.",
"country": "SE"
},
"identification": {"organisationId": {"anyBIC": "ECBFDEFFFIM",
"lei": "549300DTUYXVMJXZNY75",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "BOID",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
},
"privateId": {"birthDate": "2020-01-01",
"provinceOfBirth": "Text, maximum of 35 characters.",
"cityOfBirth": "Text, maximum of 35 characters.",
"countryOfBirth": "SE",
"others": [{"identification": "Text, maximum of 35 characters.",
"schemeNameCode": "NIDN",
"schemeNameProprietary": "Text, maximum of 35 characters.",
"issuer": "Text, maximum of 35 characters."
}
]
}
},
"additionalPartyInformation": {"tradeName": "Text, maximum of 70 characters.",
"merchantCategoryCode": "stri",
"logoURL": "Text, maximum of 2048 characters.",
"geoLocation": "GEO:52.506931;13.144558"
}
}
},
"creditorNameMatch": "MBAM",
"creditorOrganisationIdMatch": "MTCH",
"matchedCreditorName": "Text, maximum of 140 characters."
}
],
"scaMethods": [{"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
}
],
"chosenScaMethod": {"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
},
"challengeData": {"image": "string",
"data": ["string"
],
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "string",
"additionalInformation": "string"
},
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"updatePsuAuthentication": {"href": "string"
},
"updateEncryptedPsuAuthentication": {"href": "string"
},
"selectAuthenticationMethod": {"href": "string"
},
"authoriseTransaction": {"href": "string"
},
"scaStatus": {"href": "string"
},
"transactionFees": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"psuMessage": "Text, maximum of 500 characters."
}

Get Authorisation Sub-Resources Request

Will deliver an array of resource identifications of all generated authorisation or cancellation authorisation sub-resources.

Authorizations:

NoneBearerAuthOAuth

path Parameters

resource-path required	string Example: consents/account-access This resource path can be a one-level parameter {service} or a two-level parameter {service}/{product-type}, where {service} stands for the service type of the related business transaction, e.g. /payments or /consents source. {product-type} stands for the product-type of the related business transaction where applicable, e.g. sepa-credit-transfers in the case of payments or account-access in case of consents.
resourceId required	string (Max70Text) <= 70 characters Example: 1234-resource-567 Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource.
authorisation-category required	string Enum: "authorisations" "cancellation-authorisations" Example: authorisations The following two categories are supported: authorisations: used in case of an authorisation of the related business transaction. cancellation-authorisations: used in case of the cancellation authorisation of the related business transaction. Used only if applicable to the addressed {service}

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"authorisationIds": ["string"
]
}

Get Authorisation Status Request

Checks the SCA status of an authorisation or cancellation authorisation sub-resource.

Authorizations:

NoneBearerAuthOAuth

path Parameters

resource-path required	string Example: consents/account-access This resource path can be a one-level parameter {service} or a two-level parameter {service}/{product-type}, where {service} stands for the service type of the related business transaction, e.g. /payments or /consents source. {product-type} stands for the product-type of the related business transaction where applicable, e.g. sepa-credit-transfers in the case of payments or account-access in case of consents.
resourceId required	string (Max70Text) <= 70 characters Example: 1234-resource-567 Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource.
authorisation-category required	string Enum: "authorisations" "cancellation-authorisations" Example: authorisations The following two categories are supported: authorisations: used in case of an authorisation of the related business transaction. cancellation-authorisations: used in case of the cancellation authorisation of the related business transaction. Used only if applicable to the addressed {service}
authorisationId required	string (Max70Text) <= 70 characters Example: 123auth456 Resource identification of the related SCA.

header Parameters

Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.

Responses

Response samples

Content type

application/json

{"scaStatus": "received",
"psuName": "Text, maximum of 140 characters.",
"_links": {"scaStatus": {"href": "string"
},
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"apiClientMessages": [{"category": "string",
"code": "FORMAT_ERROR",
"path": "string",
"text": "Text, maximum of 500 characters."
}
]
}

Update PSU Data

Updates the addressed authorisation sub-resource data on the server by PSU data if requested by the ASPSP.

Authorizations:

NoneBearerAuthOAuth

path Parameters

resource-path required	string Example: consents/account-access This resource path can be a one-level parameter {service} or a two-level parameter {service}/{product-type}, where {service} stands for the service type of the related business transaction, e.g. /payments or /consents source. {product-type} stands for the product-type of the related business transaction where applicable, e.g. sepa-credit-transfers in the case of payments or account-access in case of consents.
resourceId required	string (Max70Text) <= 70 characters Example: 1234-resource-567 Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource.
authorisation-category required	string Enum: "authorisations" "cancellation-authorisations" Example: authorisations The following two categories are supported: authorisations: used in case of an authorisation of the related business transaction. cancellation-authorisations: used in case of the cancellation authorisation of the related business transaction. Used only if applicable to the addressed {service}
authorisationId required	string (Max70Text) <= 70 characters Example: 123auth456 Resource identification of the related SCA.

header Parameters

PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. Conditions will be defined within service specifications, If applicable.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information
PSU-ID	string (Max140Text) <= 140 characters Example: PSU-1234 Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation.
PSU-ID-Type	string (Max35Text) <= 35 characters Example: PSU-ID-TYPE_C Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation.
PSU-Corporate-ID	string (Max140Text) <= 140 characters Example: PSU-CORP-ID1234 Might be mandated in the ASPSP's documentation. Only used in a corporate context.
PSU-Corporate-ID-Type	string (Max35Text) <= 35 characters Example: PSU-CORP-ID-TYPE_A Might be mandated in the ASPSP's documentation. Only used in a corporate context.

Request Body schema: application/json

Any of

required

object

The password, orencryptedPassword, subfield is used, depending depending on encryption requirements of the ASPSP as indicated in the corresponding hyperlink contained in the preceding response message of the ASPSP. The related encryption requirements are defined in document "Protocol Functions and Security Measures".

password	string Contains a password in plaintext.
encryptedPassword	string Is used when a password is encrypted on application level.

Responses

Request samples

Payload

Content type

application/json

{"confirmationCode": "string"
}

Response samples

Content type

application/json

{"scaStatus": "received",
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"updatePsuIdentification": {"href": "string"
},
"updatePsuAuthentication": {"href": "string"
},
"updateAdditionalPsuAuthentication": {"href": "string"
},
"updateEncryptedPsuAuthentication": {"href": "string"
},
"updateAdditionalEncryptedPsuAuthentication": {"href": "string"
},
"updateResourceByDebtorAccountResource": {"href": "string"
},
"selectAuthenticationMethod": {"href": "string"
},
"authoriseTransaction": {"href": "string"
},
"scaStatus": {"href": "string"
},
"transactionFees": {"href": "string"
},
"status": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"psuMessage": "Text, maximum of 500 characters."
}

Update Resource with Debtor Account

The following method is used to update a payment related resource by an account which is associated to a PSU, and which needs to be received from the ASPSP first in the response of the "Update PSU Data with Authentication Request". Remark: This procedure might be offered by the ASPSP in decoupled or embedded SCA channels to support "noManualIbanEntry" requirements from regulators for payment initiation.

Authorizations:

NoneBearerAuthOAuth

path Parameters

resource-path

required

string

Example: consents/account-access

This resource path can be a one-level parameter {service} or a two-level parameter {service}/{product-type}, where

{service} stands for the service type of the related business transaction, e.g. /payments or /consents source.
{product-type} stands for the product-type of the related business transaction where applicable, e.g. sepa-credit-transfers in the case of payments or account-access in case of consents.

resourceId

required

string (Max70Text) <= 70 characters

Example: 1234-resource-567

Resource identification of the related payment initiation, signing basket, consent, subscription or other related business transaction resource.

header Parameters

PSU-IP-Address	string <ipv4> Example: 192.168.8.78 The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. Conditions will be defined within service specifications, If applicable.
PSU-IP-Port	string Example: 1234 The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Accept	string Example: application/json The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Charset	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Encoding	string Example: * The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-Accept-Language	string Example: en-gb,en;0.8 The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
PSU-User-Agent	string Example: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0 The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
PSU-Http-Method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" Example: GET HTTP method used at the PSU ? TPP interface, if available. Valid values are: GET POST PUT PATCH DELETE
PSU-Device-ID	string <uuid> Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 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 needs to be unaltered until removal from device.
PSU-Geo-Location	stringGEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9... Example: GEO:52.506931;13.144558 The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
Digest	string Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A= 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-jws-signature	string Example: eyJiNjQiOmZhbHNlLCJ4NXQjUzI1NiI6ImR5dFBwU2tKWXpoVGRQWFNXUDdqaFhnRzRrQ09XSVdHaWVzZHprdk5MelkiLCJjcml0IjpbInNpZ1QiLCJzaWdEIiwiYjY0Il0sInNpZ1QiOiIyMDIwLTEwLTI2VDExOjI2OjU3WiIsInNpZ0QiOnsicGFycyI6WyJ4LXJlcXVlc3QtaWQiLCJkaWdlc3QiXSwibUlkIjoiaHR0cDovL3VyaS5ldHNpLm9yZy8xOTE4Mi9IdHRwSGVhZGVycyJ9LCJhbGciOiJSUzI1NiJ9..NuGglWBtHcXavob2ZmW-PoSpMmhJS9U6z8zPqHFoE97vHI3z8wtaVdbwsj5WzgPjtVWUUnk8cxP4JjLXdwzwhhHB2uJ5FI4ZZGdSQQw-9pXPUx3cCJSzHmrgkJ-di-A4 The attribute x-jws-signature contains the JSON Web Signature.
X-Request-ID required	string <uuid> Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721 ID of the request, unique to the call, as determined by the initiating party.
Body-Sig-Profile	string Enum: "JAdES_JS" "XAdES" "EMV_AC" Example: XAdES Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed.
Body-Enc-Profile	string Enum: "JWE_CS" "XML_ENC" Example: JWE_CS Indicates the encryption profile used for the encryption of (parts of) the body.
Body-Enc-List	string Example: BODY Contains a List of names of data elements/ attributes of the body which contain encrypted information

Request Body schema: application/json

Any of

required

object

The resourceId of the account as provided in the "Update PSU Data with Authentication Request" response shall be used as the technical account reference.

resourceId

string <uuid>

To be used in authorisation processes, when updating a resource by an account.

Responses

Request samples

Payload

Content type

application/json

{"debtorAccount": {"resourceId": "99435c7e-ad88-49ec-a2ad-99ddcb1f5555"
}
}

Response samples

Content type

application/json

{"chosenScaMethod": {"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
},
"challengeData": {"image": "string",
"data": ["string"
],
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "string",
"additionalInformation": "string"
},
"scaMethods": [{"authenticationType": "PUSH_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "Text, maximum of 35 characters.",
"name": "string",
"explanation": "string"
}
],
"_links": {"scaRedirect": {"href": "string"
},
"scaOAuth": {"href": "string"
},
"confirmation": {"href": "string"
},
"selectAuthenticationMethod": {"href": "string"
},
"authoriseTransaction": {"href": "string"
},
"scaStatus": {"href": "string"
},
"transactionFees": {"href": "string"
},
"status": {"href": "string"
},
"encryptionCertificates": [{"href": "string"
}
],
"property1": {"href": "string"
},
"property2": {"href": "string"
}
},
"psuMessage": "Text, maximum of 500 characters."
}

openFinance API Framework XS2A API as PSD2 Interface Implementation Guidelines - Extended Payment Initiation Service (2.1)

Extended Payment Initiation Service (XPIS)

Payment Initiation Request for Single Payments

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/json

Responses

Request samples

Response samples

Deferred Payment Authorisation Request

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Initiation for Deferred Payments

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Recurring Payments Authorisation Request

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Initiation for Recurring Payments

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Initiation for Multiple Recurring Payments

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirmation for Initiations (for Multiple Recurring Payments)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Cancellation for Initiations (for Multiple Recurring Payments)

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get Transaction Status Request

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get Initiation Status Request

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get Payment Request

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Request Body schema:
application/json