International Payments - v3.1.2

  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. OBInternational2
      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

ResourceHTTP OperationEndpointMandatory ?ScopeGrant TypeMessage SigningIdempotency KeyRequest ObjectResponse Object
international-paymentsPOSTPOST /international-paymentsConditionalpaymentsAuthorization CodeSigned Request Signed ResponseYesOBWriteInternational2OBWriteInternationalResponse3
international-paymentsGETGET /international-payments/{InternationalPaymentId}Mandatory (if resource POST implemented)paymentsClient CredentialsSigned ResponseNoNAOBWriteInternationalResponse3
payment-detailsGETGET /international-payments/{InternationalPaymentId}/payment-detailsOptionalpaymentsClient CredentialsSigned ResponseNoNAOBWritePaymentDetailsResponse1

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:

Status
Pending
Rejected
AcceptedSettlementInProcess
AcceptedSettlementCompleted
AcceptedWithoutPosting
AcceptedCreditSettlementCompleted

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:

Status
Pending
Rejected
AcceptedSettlementInProcess
AcceptedSettlementCompleted
AcceptedWithoutPosting
AcceptedCreditSettlementCompleted

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:

Status
Accepted
AcceptedCancellationRequest
AcceptedTechnicalValidation
AcceptedCustomerProfile
AcceptedFundsChecked
AcceptedWithChange
Pending
Rejected
AcceptedSettlementInProcess
AcceptedSettlementCompleted
AcceptedWithoutPosting
AcceptedCreditSettlementCompleted
Cancelled
NoCancellationProcess
PartiallyAcceptedCancellationRequest
PartiallyAcceptedTechnicalCorrect
PaymentCancelled
PendingCancellationRequest
Received
RejectedCancellationRequest

State Model

Payment Order

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

Payment Order Status Lifecycle

The definitions for the Status:

 StatusPayment Status Description
1PendingPayment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
2RejectedPayment initiation or individual transaction included in the payment initiation has been rejected.
3AcceptedSettlementInProcessAll preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
4AcceptedSettlementCompletedSettlement on the debtor’s account has been completed.
5AcceptedWithoutPostingPayment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
6AcceptedCreditSettlementCompletedSettlement on the creditor’s account has been completed.
Multiple Authorisation

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

Multiple Authorisation Statss

The definitions for the Status:

 StatusStatus Description
1AwaitingFurtherAuthorisationThe payment-order resource is awaiting further authorisation.
2RejectedThe payment-order resource has been rejected by an authoriser.
3AuthorisedThe payment-order resource has been successfully authorised by all required authorisers.

Data Model

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

Reused Classes

OBInternational2

The OBInternational2 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 OBWriteInternational2 object will be used for a call to:

  • POST /international-payments

UML Diagram

International Payment - Request

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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternational2OBWriteInternational2 OBWriteInternational2   
Data1..1OBWriteInternational2/Data OBWriteDataInternational2  
ConsentId1..1OBWriteInternational2/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text  
Initiation1..1OBWriteInternational2/Data/InitiationThe Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.OBInternational2  
Risk1..1OBWriteInternational2/RiskThe Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.OBRisk1  

International Payment - Response

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

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

UML Diagram

International Payment - Response

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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalResponse3 OBWriteInternationalResponse3 OBWriteInternationalResponse3  
Data1..1OBWriteInternationalResponse3/Data OBWriteDataInternationalResponse3  
InternationalPaymentId1..1OBWriteInternationalResponse3/Data/InternationalPaymentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.Max40Text  
ConsentId1..1OBWriteInternationalResponse3/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text  
CreationDateTime1..1OBWriteInternationalResponse3/Data/CreationDateTimeDate and time at which the message was created.ISODateTime  
Status1..1OBWriteInternationalResponse3/Data/StatusSpecifies the status of the payment information group.OBTransactionIndividualStatus1CodeAcceptedCreditSettlementCompleted AcceptedWithoutPosting AcceptedSettlementCompleted AcceptedSettlementInProcess Pending Rejected 
StatusUpdateDateTime1..1OBWriteInternationalResponse3/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime  
ExpectedExecutionDateTime0..1OBWriteInternationalResponse3/Data/ExpectedExecutionDateTimeExpected execution date and time for the payment resource.ISODateTime  
ExpectedSettlementDateTime0..1OBWriteInternationalResponse3/Data/ExpectedSettlementDateTimeExpected settlement date and time for the payment resource.ISODateTime  
Charges0..nOBWriteInternationalResponse3/Data/ChargesSet of elements used to provide details of a charge for the payment initiation.OBCharge2  
ExchangeRateInformation0..1OBWriteInternationalResponse3/Data/ExchangeRateInformationFurther detailed information on the exchange rate that has been used in the payment transaction.OBExchangeRate2  
Initiation1..1OBWriteInternationalResponse3/Data/InitiationThe Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment.OBInternational2  
MultiAuthorisation0..1OBWriteInternationalResponse3/Data/MultiAuthorisationThe multiple authorisation flow response from the ASPSP.OBMultiAuthorisation1  

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

International Payment Order - Payment Details - Response

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWritePaymentDetailsResponse1 OBWritePaymentDetailsResponse1 OBWritePaymentDetailsResponse1  
Data1..1OBWritePaymentDetailsResponse1/Data OBWriteDataPaymentOrderStatusResponse1  
PaymentStatus0..unboundedOBWritePaymentDetailsResponse1/Data/PaymentStatusPayment status details.OBWritePaymentDetails1