International Payments - v3.1.3

1. Overview
2. Endpoints
   1. POST /international-payments
      1. Status
   2. GET /international-payments/{InternationalPaymentId}
      1. Status
   3. GET /international-payments/{InternationalPaymentId}/payment-details
      1. Status
   4. State Model
      1. Payment Order
         1. Multiple Authorisation
3. Data Model
   1. Reused Classes
      1. OBInternational3
      2. OBExchangeRate2
   2. International Payment - Request
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   3. International Payment - Response
      1. UML Diagram
      2. Notes
      3. Data Dictionary
   4. International Payment Order - Payment Details - Response
      1. UML Diagram
      2. Data Dictionary

Overview

The International Payments resource is used by a PISP to initiate an International Payment.

This resource description should be read in conjunction with a compatible Payment Initiation API Profile.

Endpoints

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

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

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.

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

OBInternational3

The OBInternational3 class is defined in the international-payment-consents page.

OBExchangeRate2

The OBExchangeRate2 class is defined in the international-payment-consents page.

International Payment - Request

The OBWriteInternational3 object will be used for a call to:

• POST /international-payments

UML Diagram

Notes

The international-payment request object contains the:

• ConsentId.
• The full Initiation and Risk objects from the international-payment request.
• The Initiation and Risk sections of the international-payment request must match the Initiation and Risk sections of the corresponding international-payment-consent request.

Data Dictionary

International Payment - Response

The OBWriteInternationalResponse4 object will be used for a response to a call to:

• POST /international-payments
• GET /international-payments/{InternationalPaymentId}

UML Diagram

Notes

The international-payment response object contains the:

• InternationalPaymentId.
• ConsentId.
• CreationDateTime of the international-payment resource.
• Status and StatusUpdateDateTime of the international-payment resource.
• ExpectedExecutionDateTime for the international-payment resource.
• ExpectedSettlementDateTime for the international-payment resource.
• The Charges and ExchangeRateInformation in the international-payment-consent response from the ASPSP.
• The Initiation object from the international-payment-consent.
• The MultiAuthorisation object if the international-payment resource requires multiple authorisations.

Data Dictionary

International Payment Order - Payment Details - Response

The OBWritePaymentDetailsResponse1 object will be used for a response to a call to:

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

UML Diagram

Data Dictionary