Version Control

Endpoints

POST /international-payment-consents 

The API endpoint allows the PISP to ask an ASPSP to create a new international-payment-consent resource.

• The POST action indicates to the ASPSP that a payment consent has been staged. At this point, the PSU may not have been identified by the ASPSP, and the request payload may not contain any information of the account that should be debited.

• The endpoint allows the PISP to send a copy of the consent (between PSU and PISP) to the ASPSP for the PSU to authorise.

• The ASPSP creates the international-payment-consent resource and responds with a unique ConsentId to refer to the resource.

Status

The default Status is "AwaitingAuthorisation" immediately after the international-payment-consent has been created.

GET /international-payment-consents/{ConsentId}

A PISP can optionally retrieve a payment consent resource that they have created to check its status. 

Status

Once the PSU authorises the payment-consent resource, the Status of the payment-consent resource will be updated with "Authorised".

If the PSU rejects the consent or the international-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".

Once an international-payment has been successfully created using the international-payment-consent, the Status of the international-payment-consent will be set to "Consumed".

The available Status codes for the international-payment-consent resource are:

GET /international-payment-consents/{ConsentId}/funds-confirmation

The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-payment-consent resource.

• An ASPSP can only respond to a funds confirmation request if the international-payment-consent resource has an Authorised status. If the status is not Authorised, an ASPSP must respond with a 400 (Bad Request) and a UK.OBIE.Resource.InvalidConsentStatus error code.

• Confirmation of funds requests do not affect the status of the international-payment-consent resource.

POST /international-payments

Once the international-payment-consent has been authorised by the PSU, the PISP can proceed to submit the international-payment for processing:

• This is done by making a POST request to the international-payments endpoint.

• This request is an instruction to the ASPSP to begin the international single immediate payment journey. The international payment must be submitted immediately, however, there are some scenarios where the international payment may not be executed immediately (e.g. busy periods at the ASPSP).

• The PISP must ensure that the Initiation and Risk sections of the international-payment match the corresponding Initiation and Risk sections of the international-payment-consent resource. If the two do not match, the ASPSP must not process the request and must respond with a 400 (Bad Request).

• Any operations on the international-payment resource will not result in a Status change for the international-payment resource.

Status

An international-payment can only be created if its corresponding international-payment-consent resource has the status of "Authorised". 

The international-payment resource that is created successfully must have one of the following PaymentStatusCode code-set enumerations:

GET /international-payments/{InternationalPaymentId}

A PISP can retrieve the international-payment to check its status.

Status

The international-payment resource must have one of the following PaymentStatusCode code-set enumerations:

GET /international-payments/{InternationalPaymentId}/payment-details

A PISP can retrieve the Details of the underlying payment transaction via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.

Status

The international-payments - payment-details must have one of the following PaymentStatusCode code-set enumerations:

State Model

Payment Order Consent

The state model for the international-payment-consent resource follows the generic consent state model. However, does not use the "Revoked" status, as the consent for an international-payment is not a long-lived consent.

Open

The definitions for the Status:

Payment Order

The state model for the international-payment resource follows the behaviour and definitions for the ISO 20022 PaymentStatusCode code-set.

Open

The definitions for the Status:

Multiple Authorisation

If the payment-order requires multiple authorisations, the Status of the multiple authorisations will be updated in the MultiAuthorisation object.

Open

The definitions for the Status:

Data Model

The data dictionary section gives the detail on the payload content for the International Payment API flows.

Reused Classes

OBInternational2

This section describes the OBInternational2 class which is reused as the Initiation object in the international-payment-consent and international-payment resources.

UML Diagram

Open

Notes

For the OBInternational2 Initiation object: 

• All elements in the Initiation payload that are specified by the PISP, must not be changed via the ASPSP as this is part of formal consent from the PSU.

• If the ASPSP is able to establish a problem with payload or any contextual error during the API call, the ASPSP must reject the international-payment-consent request immediately.

• If the ASPSP establishes a problem with the international-payment-consent after the API call, the ASPSP must set the Status of the international-payment-consent resource to Rejected.

• DebtorAccount is optional as the PISP may not know the account identification details for the PSU.

• If the DebtorAccount is specified by the PISP and is invalid for the PSU, then the international-payment-consent will be set to Rejected after PSU authentication.

• CreditorAgent must at least have either of the pairs provided: Scheme Name and Identification  or Name and Postal Address.

• Account Identification field usage:

  • Where "UK.OBIE.SortCodeAccountNumber" is specified as the SchemeName in the Account Identification Section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field).

  • Where the "UK.OBIE.IBAN" is specified as the SchemeName in the Account Identification Section (either DebtorAccount or CreditorAccount), the Identification field must be populated with the full IBAN.

• LocalInstrument is the requested payment scheme for execution. This is a free-text field.

• InstructionPrioirty may be used by the ASPSP to determine the payment scheme for execution.

• The InstructedAmount object must be populated with the desired Amount and Currency of transfer, regardless of the currency of the DebtorAccount or CreditorAccount. I.e., a PSU may wish to transfer 100EUR from a GBP DebtorAccount (InstructedAmount will be 100EUR), or 100GBP to an EUR CreditorAccount (the InstructedAmount will be 100GBP).

• The CurrencyOfTransfer is used to specify the currency the funds will be transferred. I.e., a PSU may wish to transfer 100USD from a GBP DebtorAccount to a Rupee INR CreditorAccount in India.

• The ChargeBearer field is used by the PISP to indicate the bearer of charges. An ASPSP must reject the request if the requested charge allocation cannot be fulfilled..

The OBInternational2/ExchangeRateInformation object must conform to these behaviours:

• A PISP must specify the DebtorAccount currency in the UnitCurrency field if the PISP is requesting a specific RateType so the ASPSP can respond with an exchange rate quote prior to PSU authorisation.

• A PISP may indicate an exchange rate request using the RateType with these enumerations:

  • Actual.

  • Agreed.

  • Indicative.

• A PISP must specify ExchangeRate and ContractIdentification when requesting an Agreed RateType. If an invalid ContractIdentification and ExchangeRate are requested together, an ASPSP must reject the request.

  • For an "Agreed" RateType a requested exchange rate is populated in the ExchangeRate field, against the UnitCurrency. I.e, if the UnitCurrency is GBP and CurrencyOfTransfer is USD, then ExchangeRate will be 1.34 (USD to 1 GBP).

  • For an "Agreed" RateType the exchange rate contract identifier is populated in the ContractIdentification field.

• A PISP must not specify ExchangeRate and/or ContractIdentification when requesting an Actual RateType.