...
Register an intent to stage a payment-order consentconsents.
Optionally confirm available funds for a payment-order for Domestic and International payments.
Subsequently submit the payment-order for processing.
Optionally retrieve the status of a payment-order consentconsents or payment-order resource.
...
Security & Access Control: Specifies the means for PISPs and users/customers to authenticate themselves and provide consentconsents.
Data Model: Documents mappings and enumerations that apply to all the end-points.
Alternative Flows: Documents rules for alternative flows.
1.2 Resources
Each of the Payment Initiation API resources are documented in the Resources and Data Models / PISP area of the specification. Each resource is documented with:
...
The HTTP Status Code reflects the outcome of the API call (the HTTP operation on the resource).
The Status field for the payment-order consent consents reflects the status of the user/customer consent consents authorisation.
The Status field for the payment-order resource reflects the status of the payment-order initiation or execution.
...
The figure below provides a general outline of a payment flow for all payment-order types using the Payment APIs. The payment-order types covered in this profile include:
Single Domestic paymentsPayment.
Domestic future dated payments.
Domestic standing orders.
International payments.
International future dated payment
International standing orders
Single Future Dated Domestic Payment.
Single International payment.
Bulk/Batch Payment.
The payment-order consent consents and payment-order resource in the following flow generalises for the different payment-order types. E.g. for a domestic payment, the payment-order consent consents resource is domestic-payment-consents; and the payment-order resource is domestic-payments.
...
This flow begins with a user/customer consenting to a payment being made. The consent consents is between the user/customer and the PISP.
The debtor account details can optionally be specified at this stage.
Step 2: Setup Payment-Order ConsentConsents
The PISP connects to the ASPSP that services the user’s/customer’s payment account and creates a new payment-order consentconsents resource. This informs the ASPSP that one of its users/customers intends to make a payment-order. The ASPSP responds with an identifier for the payment-order consent consents resource (the ConsentId, which is the intent identifier).
This step is carried out by making a POST request to the payment-order consentconsents resource.
Step 3: Authorise ConsentConsents
The PISP requests the user/customer to authorise the consentconsents. The ASPSP may carry this out by using a redirection flow or a decoupled flow.
In a redirection flow, the PISP redirects the user/customer to the ASPSP .
The redirect includes the ConsentId generated in the previous step.
This allows the ASPSP to correlate the payment order consent consents that was setup.
The ASPSP authenticates the user/customer.
The user/customer selects the debtor account at this stage (if it has not been previously specified in Step 1).
The ASPSP updates the state of the payment order consent consents resource internally to indicate that the consent consents has been authorised.
Once the consent consents has been authorised, the user/customer is redirected back to the PISP.
In a decoupled flow, the ASPSP requests the user/customer to authorise consent consents on an authentication device that is separate from the consumption device on which the user/customer is interacting with the PISP.
The decoupled flow is initiated by the PISP calling a back-channel authorisation request.
The request contains a 'hint' that identifies the user/customer paired with the consent consents to be authorised.
The ASPSP authenticates the user/customer.
The user/customer selects the debtor account at this stage (if it has not been previously specified in Step 1).
The ASPSP updates the state of the payment order consent consents resource internally to indicate that the consent consents has been authorised.
Once the consent consents has been authorised, the ASPSP can make a callback to the PISP to provide an access token.
...
Once the user/customer is authenticated and authorised the payment-order-consentconsents, the PISP can check whether funds are available to make the payment.
This is carried out by making a GET request, calling the funds-confirmation operator on the payment-order-consentconsents resource.
Step 5: Create Payment-Order
The PISP creates a payment-order resource to indicate that the payment created in the steps above should be submitted for processing.
This is carried out by making a POST request to the appropriate payment-order resource.
The ASPSP returns the identifier for the payment-order resource to the PISP.
Step 6: Get ConsentConsents/Payment-Order/Payment-Details Status
The PISP can check the status of the payment-order consent consents (with the ConsentId) or payment-order resource (with the payment-order resource identifier) or payment-details (with the payment-order resource identifier).
This is carried out by making a GET request to the payment-order consentconsents or payment-order or payment-details resource resource.
2.1.2 Sequence Diagram
...
2.2 Payment Restrictions
...
An ASPSP must reject the payment-order consentconsents if the ASPSP is unable to handle the request.
...
An ASPSP may return the specific CutOffDateTime when responding to a payment-order consent consents request.
An ASPSP must document the behaviour for a payment receipt before and after the CutOffDateTime for a payment-order has elapsed.
...
Reject the payment-order (and steps associated with the creation of payment-order) if received after the applicable CutOffDateTime.
Accept the payment-order (and steps associated with the creation of payment-order) if received after the applicable CutOffDateTime.
2.2.1.1 Reject the Payment-Order
...
An ASPSP must reject the payment-order consentconsents if the CutOffDateTime for a specific payment-order type has elapsed.
An ASPSP must reject an authorisation request when the underlying intent object is associated with a CutoffDateTime that has elapsed. The ASPSP must not issue an access token in such a situation. The ASPSP must set the status of the payment-order consent consents resource to “Rejected”.
An ASPSP must reject the payment-order resource if the CutOffDateTime for a specific payment-order type, has been established and has elapsed.
A PISP must ensure that the user/customer consent consents authorisation is completed and the payment-order resource is created before the CutOffDateTime elapses.
For a payment-order consentconsents or a payment-order resource that has been rejected due to the elapsed CutoffDateTime, the PISP may decide to create a corresponding future dated payment endpoint to create a new payment-order consentconsents. The PISP may use the /domestic-future-dated-payment-consents endpoint to create a consent consents for the same payment for the next working day.
...
An ASPSP must accept the payment-order consentconsents if the CutOffDateTime for a specific payment-order type has elapsed.
An ASPSP must accept an authorisation request when the underlying intent object is associated with a CutoffDateTime that has elapsed.
An ASPSP must accept the payment-order resource if the CutOffDateTime for a specific payment-order type, has been established and has elapsed.
An ASPSP may update the payment-order consent consents or payment-order resource with the CutOffDateTime, ExpectedExecutionDateTime and ExpectedSettlementDateTime, to communicate expected execution behaviour if the CutOffDateTime has elapsed
...
This section overviews the release management and versioning strategy for the Payment Initiation API. It applies to all Payment Order Consent Consents and Payment Order resources, specified in the Endpoints section.
2.3.1 Payment-Order
...
Consents
2.3.1.1 POST
A PISP must not create a payment-order consent consents ConsentId on a newer version and use it to create a payment-order resource in a previous version.
E.g., A ConsentId created in v3, must not be used to create a v1 PaymentSubmissionId.
A PISP must not create a payment-order consent consents ConsentId on a previous version and use it to create a payment-order resource in a newer version.
E.g., A PaymentId created in v1, must not be used to create a v3 DomesticPaymentId.
2.3.1.2 GET
A PISP must not access a payment-order ConsentId created in a newer version, via a previous version endpoint.
E.g., A ConsentId created in v3 accessed via a v1 PaymentId.
An ASPSP may choose to make ConsentIds accessible across versions.
E.g., for a PaymentId created in v1, an ASPSP may or may not make it available via v3, as this is a short-lived consentconsents.
2.3.2 Payment-Order
...
Consents (Confirm Funds)
2.3.2.1 GET
A PISP must not confirm funds using a payment-order-consent consents ConsentId created in a different version.
E.g. A ConsentId created in v3, must not be used to confirm funds on a v1 endpoint.
...
A PISP must use a payment-order consent consents ConsentId within the same version to create the payment-order resource (in that version).
E.g., A v3 payment-order consentconsents can only be used to create a payment-order resource in v3.
An ASPSP must not allow a PISP to use a ConsentId from a previous version to create a Payment Order in a newer version, and vice versa.
2.3.3.2 GET
A PISP must refer to the ASPSP's online Developer Portal for guidelines on accessibility of a payment-order resource in a newer version.
A PISP must not access the payment-order resource types introduced in a newer version, on an older version endpoint:
E.g., an international-payment created in v3, which is accessed via the v1 payment-submissions endpoint.
A PISP must not access the payment-order resource created in a newer version on an older version endpoint:
E.g., for a domestic-payment resource created in v3, access via the v1 payment-submissions endpoint is not permitted.
An ASPSP must document the behaviour on the accessibility of a payment-order resource in a newer version on the ASPSP's online Developer Portal.
An ASPSP must allow access to the payment-order resource created in a previous version on a newer version endpoint (depending on an ASPSP's legal requirement for data retention):
E.g., a payment-submission created in v1, must be accessible as a v3 domestic-payment, with sensible defaults for additional fields introduced in v3 (e.g., if an ASPSP must make payment resources available for 7 years).
In the case where a payment-order type is the same, but the structure has changed in a newer version, sensible defaults may be used, with the ASPSP's Developer Portal clearly specifying the behaviour.
E.g., a new field StatusUpdateDateTime was introduced in v3, an ASPSP must populate this with the last status update time (as the StatusUpdateDateTime is a mandatory field).
...
PISPs must use a client credentials grant to obtain a token to make POST requests to the payment-order consentconsents endpoints. In the specification, this grant type is referred to as "Client Credentials".
PISPs must use an authorisation code grant using a redirect or decoupled flow to obtain a token to make POST requests to the payment-order resource endpoints. This token may also be used to confirm funds on a payment-order consentconsents resource. In the specification, this grant type is referred to as "Authorisation Code".
PISPs must use a client credentials grant to obtain a token to make GET requests (excluding confirming funds).
3.3
...
Consents Authorisation
OAuth 2.0 scopes are coarse-grained and the set of available scopes are defined at the point of client registration. There is no standard method for specifying and enforcing fine-grained scopes e.g., a scope to enforce payments of a specified amount on a specified date.
A consent consents authorisation is used to define the fine-grained scope that is granted by the user/customer to the PISP.
The PISP must begin a payment-order request by creating a payment-order consentconsents resource through a POST operation. These resources indicate the consentconsents that the PISP claims it has been given by the user/customer. At this stage, the consent consents is not yet authorised as the ASPSP has not yet verified this claim with the user/customer.
...
The ASPSP authenticates the user/customer.
The ASPSP plays back the consent consents (registered by the PISP) back to the user/customer to get consent consents authorisation. The user/customer may accept or reject the consent consents in its entirety (but not selectively).
If the consent consents did not indicate a debtor account the ASPSP presents the user/customer with a list of accounts from which the user/customer may select one.
Once these steps are complete, the consent consents is considered to have been authorised by the user/customer.
...
If the user/customer does not complete a successful consent consents authorisation (e.g., if the user/customer has not authenticated successfully), the authorisation code grant ends with a redirection to the PISP with an error response. The user/customer is redirected to the PISP with an error parameter indicating the error that occurred.
3.3.
...
2 Consents Revocation
A user/customer cannot revoke a payment-order consent consents once it has been authorised.
3.3.3 Changes to Selected Account
For a payment-order consentconsents, the selected debtor account cannot be changed once the consent consents has been authorised.
3.3.
...
4 Consents Re-Authentication
Payment consents are short-lived and cannot be re-authenticated by the user/customer.
...
This section describes the OBRisk class which is reused in the payment-order consent consents and payment-order resources.
...
Name | Occurrence | Xpath | Enhanced Definition | Class | Codes | Pattern |
OBRisk |
| OBRisk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk |
|
|
PaymentContextCode | 0..1 | OBRisk/PaymentContextCode | Specifies the payment context. | String | Enum:
|
|
MerchantCategoryCode | 0..1 | OBRisk/MerchantCategoryCode | Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. | String |
|
|
MerchantCustomerIdentification | 0..1 | OBRisk/MerchantCustomerIdentification | The unique customer identifier of the user/customer with the merchant. | String |
|
|
DeliveryAddress | 0..1 | OBRisk/DeliveryAddress | Information that locates and identifies a specific address, as defined by postal services or in free format text. | OBRisk/DeliveryAddress |
|
|
AddressLine | 0..7 | OBRisk/DeliveryAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
|
StreetName | 0..1 | OBRisk/DeliveryAddress/StreetName | Name of a street or thoroughfare. | String | ||
BuildingNumber | 0..1 | OBRisk/DeliveryAddress/BuildingNumber |
| String |
|
|
PostCode | 0..1 | OBRisk/DeliveryAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | String |
|
|
TownName | 0..1 | OBRisk/DeliveryAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
|
CountrySubDivision | 0..1 | OBRisk/DeliveryAddress/CountrySubDivision |
| String |
|
|
Country | 0..1 |
|
| String |
|
|
...
This section describes the OBCharge class - which is reused in the response payloads in the payment-order consent consents and payment-order resources.
...
This section describes the OBAuthorisation class which is used in the payment-order consent consents request and payment-order consent consents response payloads.
4.1.3.1 UML Diagram
...
This section describes the OBDomesticRefundAccount class which is used in the response payloads of Domestic Payment , and Domestic Future Dated Payment and Domestic Standing Order.
4.1.4.1 UML Diagram
...
4.1.4.2 Data Dictionary
...
This section describes the OBInternationalRefundAccount class which is used in the response payloads of International Payment, International Future Dated Payment and International Standing Order.
4.1.5.1 UML Diagram
...
4.1.5.2 Data Dictionary
Name | Occurrence | Xpath | Enhanced Definition | Class | Codes | Pattern |
OBInternationalRefundAccount |
| OBInternationalRefundAccount | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. | OBInternationalRefundAccount |
|
|
Creditor | 0..1 | OBInternationalRefundAccount/Creditor | Party to which an amount of money is due. | OBInternationalRefundAccount/Creditor |
|
|
Name | 0..1 | OBInternationalRefundAccount/Creditor/Name | Name by which a party is known and which is usually used to identify that party. | String |
|
|
PostalAddress | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress |
|
|
AddressType | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/AddressType | Identifies the nature of the postal address. | String | Enum:
|
|
Department | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
|
SubDepartment | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
|
AddressLine | 0..7 | OBInternationalRefundAccount/Creditor/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
|
StreetName | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/StreetName | Name of a street or thoroughfare. | String | ||
BuildingNumber | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | String |
|
|
PostCode | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | String |
|
|
TownName | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
|
CountrySubDivision | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, country. | String |
|
|
Country | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ |
Agent | 0..1 | OBInternationalRefundAccount/Agent | Financial institution servicing an account for the creditor. | OBInternationalRefundAccount/Agent |
|
|
SchemeName | 0..1 | OBInternationalRefundAccount/Agent/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 0..1 | OBInternationalRefundAccount/Agent/Identification | Unique and unambiguous identification of a financial institution or a branch of a financial institution. | String |
|
|
Name | 0..1 | OBInternationalRefundAccount/Agent/Name | Name by which an agent is known and which is usually used to identify that agent. | String |
|
|
PostalAddress | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress |
|
|
AddressType | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/AddressType | Identifies the nature of the postal address. | String | Enum:
|
|
Department | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
|
SubDepartment | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
|
AddressLine | 0..7 | OBInternationalRefundAccount/Agent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
|
StreetName | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/StreetName | Name of a street or thoroughfare. | String | ||
BuildingNumber | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | String |
|
|
PostCode | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | String |
|
|
TownName | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
|
CountrySubDivision | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, country. | String |
|
|
Country | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ |
Account | 1..1 | OBInternationalRefundAccount/Account | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. | OBInternationalRefundAccount/Account |
|
|
SchemeName | 1..1 | OBInternationalRefundAccount/Account/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
|
Identification | 1..1 | OBInternationalRefundAccount/Account/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
|
Name | 1..1 | OBInternationalRefundAccount/Account/Name | The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. | String |
|
|
...
Name | Occurrence | Xpath | Enhanced Definition | Class | Codes | Pattern |
OBWritePaymentDetails |
| OBWritePaymentDetails | Payment status details. | OBWritePaymentDetails |
|
|
PaymentTransactionId | 1..1 | OBWritePaymentDetails/PaymentTransactionId | Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. | String |
|
|
Status | 1..1 | OBWritePaymentDetails/Status | Status of a transfer, as assigned by the transaction administrator. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 |
| Date and time at which the status was assigned to the transfer. | DateTime |
|
|
StatusDetail | 0..1 | OBWritePaymentDetails/StatusDetail | Payment status details as per underlying Payment Rail. | OBWritePaymentDetails/StatusDetail |
|
|
LocalInstrument | 1..1 |
| User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. | String | Enum:
|
|
Status | 1..1 | OBWritePaymentDetails/StatusDetail/Status | Status of a transfer, as assigned by the transaction administrator. | String |
|
|
StatusReason | 0..1 | OBWritePaymentDetails/StatusDetail/StatusReason |
| String | Enum:
|
|
StatusReasonDescription | 0..1 | OBWritePaymentDetails/StatusDetail/StatusReasonDescription | Reason provided for the status of a transfer. | String |
|
|
...
This section describes the OBSCASupportData class, which is used across all payment order consent consents request resources, enabling PISPs to provide Supporting Data when requesting ASPSP for SCA Exemption.
...
Name | Occurrence | Xpath | Enhanced Definition | Class | Codes | Pattern |
OBSCASupportData |
| SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
RequestedSCAExemptionType | 0..1 | SCASupportData/RequestedSCAExemptionType | This field allows a PISP to request specific SCA Exemption for a Payment Initiation. | String | Enum:
|
|
AppliedAuthenticationApproach | 0..1 | SCASupportData/AppliedAuthenticationApproach | Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the user/customer was subject to SCA performed by the PISP. | String | Enum:
|
|
ReferencePaymentOrderId | 0..1 | SCASupportData/ReferencePaymentOrderId | Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring, then the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. | String |
|
|
...
Generated | Identifier | Business Description |
Merchant/PISP Sent in API Payload | EndToEndIdentification | The EndToEndIdentification reference is a reference that can be populated by the debtor (or merchant in the ecommerce space). This reference is important to the debtor (could be an internal reference Id against the transaction), it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary). |
Merchant/PISP Sent in API Payload | InstructionIdentification | The PISP generates the InstructionIdentification which is a unique transaction Id and passes it to the ASPSP (this is mandatory), but this does not have to go any further in the payment flow. The flow of this identifier needs to align with payment scheme rules. The expectation is that this is unique indefinitely across all time periods. The PISP can ensure this is indefinitely unique by including a date or date time element to the field, or by inserting a unique Id. |
Merchant/PISP Sent in API Payload | RemittanceInformation | The RemittanceInformation is the reference information that the creditor (or beneficiary) will need to reconcile (e.g. Invoice 123). |
ASPSP / API System | ConsentId | A unique identification as assigned by the ASPSP to uniquely identify the payment-order consent consents resource. |
ASPSP / API System | Payment Order Id | A unique identification as assigned by the ASPSP to uniquely identify the payment-order resource.
|
ASPSP / Payment Scheme | Scheme Payment ID | This is generated by the ASPSP to uniquely identify a payment through a processing scheme. |
...
Code Class | Name | Definition |
OBExternalPaymentContextCode | BillPayment | The context of the payment initiation is a bill payment. |
OBExternalPaymentContextCode | EcommerceGoods | The context of the payment initiation is for goods via an ecommerce channel. |
OBExternalPaymentContextCode | EcommerceServices | The context of the payment initiation is for services via an ecommerce channel. |
OBExternalPaymentContextCode | PartyToParty | The context of the payment initiation is a party to party payment. |
OBExternalPaymentContextCode | Other | The context of the payment initiation is of another type. |
OBTransactionIndividualStatusCode | AcceptedSettlementCompleted | Settlement on the debtor's account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed.
Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement. PISPs must not use this status as confirmation that settlement is complete on the creditor's account. |
OBTransactionIndividualStatusCode | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. |
OBTransactionIndividualStatusCode | Pending | Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed. |
OBTransactionIndividualStatusCode | Rejected | Payment initiation or individual transaction included in the payment initiation has been rejected. |
OBTransactionIndividualStatusCode | AcceptedWithoutPosting | Payment instruction included in the credit transfer is accepted without being posted to the creditor customer's account. |
OBTransactionIndividualStatusCode | AcceptedCreditSettlementCompleted | Settlement on the creditor's account has been completed. |
OBExternalConsentStatusCode | AwaitingAuthorisation | The consent consents resource is awaiting user/customer authorisation. |
OBExternalConsentStatusCode | Rejected | The consent consents resource has been rejected. |
OBExternalConsentStatusCode | Authorised | The consent consents resource has been successfully authorised. |
OBExternalConsentStatusCode | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action. |
OBChargeBearerTypeCode | BorneByCreditor | All transaction charges are to be borne by the creditor. |
OBChargeBearerTypeCode | BorneByDebtor | All transaction charges are to be borne by the debtor. |
OBChargeBearerTypeCode | FollowingServiceLevel | Charges are to be applied following the rules agreed in the service level and/or scheme. |
OBChargeBearerTypeCode | Shared | In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor. |
OBExternalAuthorisationCode | Single | Single authorisation type is requested. |
OBExternalStatusCode | InitiationCompleted | The payment-order initiation has been completed. |
OBExternalStatusCode | InitiationFailed | The payment-order initiation has failed. |
OBExternalStatusCode | InitiationPending | The payment-order initiation is pending. |
OBExternalStatusCode | InitiationCompleted | The payment-order initiation has been completed. |
OBExternalStatusCode | InitiationFailed | The payment-order initiation has failed. |
OBExternalStatusCode | InitiationPending | The payment-order initiation is pending. |
OBExternalStatusCode | Cancelled | Payment initiation has been successfully cancelled after having received a request for cancellation. |
OBExchangeRateTypeCode | Actual | Exchange rate is the actual rate. |
OBExchangeRateTypeCode | Agreed | Exchange rate is the agreed rate between the parties. |
OBExchangeRateTypeCode | Indicative | Exchange rate is the indicative rate. |
OBPriorityCode | Normal | Priority is normal. |
OBPriorityCode | Urgent | Priority is urgent. |
OBAddressTypeCode | Business | Address is the business address. |
OBAddressTypeCode | Correspondence | Address is the address where correspondence is sent. |
OBAddressTypeCode | DeliveryTo | Address is the address to which delivery is to take place. |
OBAddressTypeCode | MailTo | Address is the address to which mail is sent. |
OBAddressTypeCode | POBox | Address is a postal office (PO) box. |
OBAddressTypeCode | Postal | Address is the complete postal address. |
OBAddressTypeCode | Residential | Address is the home address. |
OBAddressTypeCode | Statement | Address is the address where statements are sent. |
OBTransactionIndividualExtendedISOStatusCode | Accepted | Request is accepted. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedCancellationRequest | Cancellation is accepted. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedCreditSettlementCompleted | Settlement on the creditor's account has been completed. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedCustomerProfile | Preceding check of technical validation was successful. Customer profile check was also successful. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedFundsChecked | Preceding check of technical validation and customer profile was successful and an automatic funds check was positive. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedSettlementCompleted | Settlement on the debtor's account has been completed.
Usage: this can be used by the first agent to report to the debtor that the transaction has been completed.
Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedTechnicalValidation | Authentication and syntactical and semantical validation are successful. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedWithChange | Instruction is accepted but a change will be made, such as date or remittance not sent. |
OBTransactionIndividualExtendedISOStatusCode | AcceptedWithoutPosting | Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account. |
OBTransactionIndividualExtendedISOStatusCode | Cancelled | Request is cancelled. |
OBTransactionIndividualExtendedISOStatusCode | NoCancellationProcess | No cancellation process. |
OBTransactionIndividualExtendedISOStatusCode | PartiallyAcceptedCancellationRequest | Cancellation is partially accepted. |
OBTransactionIndividualExtendedISOStatusCode | PartiallyAcceptedTechnicalCorrect | Authentication and syntactical and semantical validation are successful. |
OBTransactionIndividualExtendedISOStatusCode | PaymentCancelled | Transaction has been cancelled. |
OBTransactionIndividualExtendedISOStatusCode | Pending | Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed. |
OBTransactionIndividualExtendedISOStatusCode | PendingCancellationRequest | Cancellation request is pending. |
OBTransactionIndividualExtendedISOStatusCode | Received | Payment initiation has been received by the receiving agent. |
OBTransactionIndividualExtendedISOStatusCode | Rejected | Payment initiation or individual transaction included in the payment initiation has been rejected. |
OBTransactionIndividualExtendedISOStatusCode | RejectedCancellationRequest | Cancellation request is rejected. |
OBTransactionIndividualStatusReasonCode | Cancelled | Reason why the payment status is cancelled. |
OBTransactionIndividualStatusReasonCode | PendingFailingSettlement | Reason why the payment status is pending (failing settlement). |
OBTransactionIndividualStatusReasonCode | PendingSettlement | Reason why the payment status is pending (settlement). |
OBTransactionIndividualStatusReasonCode | Proprietary | Defines a free text proprietary reason. |
OBTransactionIndividualStatusReasonCode | ProprietaryRejection | Defines the reason that has been used by the Local Instrument system to reject the transaction. |
OBTransactionIndividualStatusReasonCode | Suspended | Reason why the payment status is suspended. |
OBTransactionIndividualStatusReasonCode | Unmatched | Reason why the payment status is unmatched. |
OBExternalSCAExemptionTypeCode | BillPayment | Bill Payment. |
OBExternalSCAExemptionTypeCode | ContactlessTravel | Contactless Travel. |
OBExternalSCAExemptionTypeCode | EcommerceGoods | Ecommerce Goods. |
OBExternalSCAExemptionTypeCode | EcommerceServices | Ecommerce Services. |
OBExternalSCAExemptionTypeCode | Kiosk | Kisok. |
OBExternalSCAExemptionTypeCode | Parking | Parking. |
OBExternalSCAExemptionTypeCode | PartyToParty | Party To Party. |
OBExternalAppliedAuthenticationApproachCode | CA | Single Factor Strong Customer Authentication. |
OBExternalAppliedAuthenticationApproachCode | SCA | Multi Factor Strong Customer Authentication. |
OBReadRefundAccountCode | Yes | Yes. |
OBReadRefundAccountCode | No | No. |
4.3.2 ISO Enumerations
These following ISO Enumerations are used in the Payment APIs.
...
5. Alternative and Error Flows
5.1 Idempotent Payment Order
...
Consents
Note: This flow has been generalised for all payment-order types.
...
Note: This flow has been generalised for all payment-order types.
...
5.3 Reject the Payment Order
...
Consents Creation after CutOffDateTime
This example illustrates a scenario where an ASPSP choses to Reject the Payment-Order consentconsents/resource request, after the CutoffTime. We have a payment-order consent consents created after the CutOffDateTime, and ASPSP rejects the ConsentConsents, and the PISP chooses to place a Future Dated Payment-Order consentconsents.
...
5.4 Reject the Payment Order Creation after CutOffDateTime
This example illustrates a scenario where an ASPSP choses to Reject the Payment-Order consentconsents/resource request, after the CutoffTime. We have a payment-order Consent Consents created and the Authorisation completed before the CutOffDateTime, but the Payment-Order submission happened after the CutOffDateTime, so the ASPSP has rejected it.
...