International Payments v3.0

Owned by Chris Michael (Unlicensed)
Last updated: Sept 07, 2018 by Freddi Gyara (Unlicensed)
23 min read

Version Control

VersionDateAuthorComments
3.0-draft118-Apr-2018OB R/W API Team

First draft of v3

3.0-draft2 OB R/W API Team

Changes to the Data Model section.

Reused classes for the payment setup request and response objects are documented once:

  • OBInitiation2
  • OBRisk1

Payloads for the payment setup request and response have been updated to reflect requirements for P5a and P10. 

Changes to the request payload for the payment setup object:

  • Permission requested (operation for v3.0 will be limited to "Create")
  • InstructedAmount changes from 1..1 to 0..1 (optional) - as a PISP may stage an EquivalentAmount (to setup an international payment)
  • RequestedExecutionDate - which is a 0..1 (optional) field - which indicates to the ASPSP the payment setup is for a future date
  • ExchangeRateInformation object - where a PISP may indicate requested exchange type and rates, which may have been pre-negotiated with the ASPSP. The ASPSP will reject the request if the requested rate cannot be fulfilled.
  • EquivalentAmount to indicate payment amount in a currency other than the currency of the DebtorAccount
  • CreditorAccount object modified to allow for international beneficiaries (aligned to the beneficiaries endpoint for v2.0)

Changes to the response payload for the payment setup object:

  • The same changes as the request payload
  • StatusUpdateDateTime (to align with v2.0)
  • ExpirationDateTime to indicate the cut-off times and validity of the payment setup (for the ASPSP)
  • Charge array which will be used by the ASPSP to indicate charges, and the ChargeBearer as relevant
  • ExchangeRateInformation (the ASPSP response) - this object will be used to communicate exchange rate information back to the PISP. It must be consistent with what is requested in the Initiation object from the PISP.

For internation payments - have removed reference to:

  • "and the Servicer identification section (either DebtorAgent or CreditorAgent) should be populated with the "BICFI" as the SchemeName" in the case of an IBAN.
3.0-draft3 OB R/W API Team

Draft3 changes:

  • Separated international and domestic payments - created /international-payment-consents endpoint
  • Separated international and domestic payments - created /international-payments endpoint
  • Updates to specification text to refer to new resource names
  • Updates Status flow to clarify flow, and allowable values
  • Removed DebtorAgent as it is identifiable by the ASPSP after the PSU authenticates, so is not required
  • Renamed OBInitiation2 to OBInternational1 for International Payments
  • Added State Model section, and updated domestic-payment-consent resource with consistent authorisation state flow
  • Added new consent Status of Consumed to indicate action from requested authorisation is complete.
  • Initiation payload changes:
    • Added DebtorAccountCurrency and CurrencyOfTransfer fields into identify currency exchange
    • Specified InstructionAmount as mandatory - in the desired currency of transfer
    • PurposeCode - as requested for international payments
    • ChargesAccount - as requested
    • Creditor/Name and Creditor/PostalAddress - as requested
  • Renamed ExpirationDateTime to CutOffDateTime for clarity
  • The Initiation object from the international-payment-consent is now replayed in the response object for the international-payment
  • Aligned Mandatory? flag with page properties and general optionality principle.
  • Aligned GET operations Mandatory? flag with the equivalent resource POST.
3.0-draft4 OB R/W API Team

Draft4 changes:

OBInternational1 object:

  • Simplified exchange rate requirements to these objects:
    • CurrencyOfTransfer
    • InstructedAmount
    • ExchangeRateInformation
      • UnitCurrency changed to mandatory - and is used to reflect the Debtor Account's currency - in the case that a PISP is requesting an exchange rate quote
      • RateType (mandatory) options have been modified to include: Indicative, Actual and Agreed - to reflect better the communications between the PISP and ASPSP
  • DebtorAccountCurrency removed - as this is duplicated in the ExchangeRateInformation/UnitCurrency field
  • Purpose renamed from PurposeCode to better reflect ISO 20022 - this has been changed to the generic ISO 20022 ExternalPurposeCode object rather than the specific 4 letter codes, as requested in feedback.
  • Removed the Charge array, and replaced with a ChargeBearer field - as the PISP is unlikely to know the applicable Charge/Amount and Charge/Type options for all ASPSPs
  • Removed ChargesAccount - as it was deemed sufficiently edge-case
  • Added optional LocalInstrument to identify the requested payment scheme
  • Restricted InstructionPriority enumerations to Urgent and Normal - as per proposition requirements

Added re-used class description for:

  • OBCharge1
  • OBExchangeRate2

For the international-payment-consents response:

  • Renamed Charge object to Charges to reflect it is an array

For the international-payments request:

  • Removed Charge array and ExchangeRateInformation objects at the Data object level - as these are not required for the original non-repudiation requirement

For the international-payments response:

  • Renamed Charge object to Charges to reflect it is an array

Clarified use of Idempotency Key in endpoint table.

3.0-draft5 OB R/W API Team

Draft5 changes:

  • CurrencyOfTransfer set to mandatory in the Initiation payload
  • Usage examples
  • RateType guidance
  • SchemeName fields to be Max40Text - so Agent SchemeName values and Account SchemeName values will not be enforced via codelist.
  • DebtorAccount/Identification field extended to Max256Text to allow for email and other identification schemes
  • CreditorAccount/Identification field extended to Max256Text to allow for email and other identification schemes
  • Clarified that "All elements in the Initiation payload that are specified by the PISP must not be changed via the ASPSP."
  • Reworded section for clarity in POST /domestic-payments from "will" to "must", and "happen" to "be executed": "The domestic payment must be submitted immediately, however, there are some scenarios where the international payment may not be executed immediately"
  • Usage Examples and Alternate flows are moved back to the individual specification pages
  • Errata: removed reference of "International" from International Payment Initiation, in relation to OBCharge1 definition 
3.0-draft6/rc1 OB R/W API Team

Draft6 changes:

  • Guidance for exchange rate behaviour in OBInternationalStandingOrder1 has been split into specific guidance for:
    • OBInternationalStandingOrder1 section - for what the PISP may specify for the Initiation
    • International Standing Order Consent - Request section - for what the ASPSP must accept
    • International Standing Order Consent - Response - for how the ASPSP must respond
  • Clarified that an ExpirationDateTime on an "Agreed" RateType must not be populated
  • Updated the OBInternational1 object guidance from "the ASPSP must Reject the Initiation request" to "the ASPSP must reject the international-payment-consent"

  • Clarified the behavioural difference in when ASPSP rejects the payment-order consent request and when ASPSP sets the status of payment-order consent to Rejected

  • Added section for State Model / Payment Order / Multiple Authorisation
  • Updated definition of Name field in the CreditorAccount and DebtorAccount objects for clarity. Have specified usage that it is "The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account."
  • Added reused classes for:
    • OBAuthorisation1
    • OBMultiAuthorisation1
  • Updated Data Model section to reflect:
    • Authorisation object in the payment-order consent request and response
    • MultiAuthorisation object in the payment-order resource response
    • ExpectedExecutionDateTime and ExpectedSettlementDateTime in the payment-order consent response and payment-order resource response
  • Added Notes section to describe the content of the POST /international-payment-consent
  • Updated "PersonToPerson" to "PartyToParty" in Usage Examples
  • Linked GET Mandatory? status to resource POST implementation
3.0-draft7 OB R/W API Team

Draft7 changes:

  • Removed guidance that "The InstructionPriority must not be specified when the LocalInstrument is specified." as some ASPSPs require both to be specified.
  • Changed the Grant Type for GET Requests to be Client Credentials Only.
  • Moved definitions of reused classes - OBCharge1, OBAuthorisation1 and OBMultiAuthorisation1 to Payment Initiation API Specification page
  • Corrected Request/Response Object names in Endpoints table
  • Added namespace-prefixed enumerations to examples
  • Additional guidance on the ExpectedExecutionDateTime and ExpectedSettlementDateTime
3.0-RC2 OB R/W API Team

RC2 Changes:

  • Updated notes on CutOffDateTime to refer to Payment Initiation API Specification, Section - Payment Restrictions -> CutOffDateTime API Behaviour
3.0-RC3 OB R/W API Team

RC3 Changes:

  • ContractIdentification field extended to Max256Text to accommodate multiple contract identifiers if needed.
3.0 OB R/W API TeamThis is the baseline version. No change from RC3.

Endpoints

ResourceHTTP OperationEndpointMandatory ?ScopeGrant TypeMessage SigningIdempotency KeyRequest ObjectResponse Object
international-payment-consentsPOSTPOST /international-payment-consentsConditionalpaymentsClient Credentials

Signed Request

Signed Response

YesOBWriteInternationalConsent1OBWriteInternationalConsentResponse1
international-payment-consentsGETGET /international-payment-consents/{ConsentId}Mandatory (if resource POST implemented)payments

Client Credentials

Signed ResponseNoNAOBWriteInternationalConsentResponse1
international-paymentsPOSTPOST /international-paymentsConditionalpayments

Authorization Code

Signed Request

Signed Response

YesOBWriteInternational1OBWriteInternationalResponse1
international-paymentsGETGET /international-payments/{InternationalPaymentId}Mandatory (if resource POST implemented)payments

Client Credentials

Signed ResponseNoNAOBWriteInternationalResponse1

POST /international-payment-consents 

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.

Status
AwaitingAuthorisation

GET /international-payment-consents/{ConsentId}

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:

Status
AwaitingAuthorisation
Rejected
Authorised
Consumed

POST /international-payments

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 

GET /international-payments/{InternationalPaymentId}

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

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.



The definitions for the Status:


StatusStatus Description
1AwaitingAuthorisationThe consent resource is awaiting PSU authorisation.
2RejectedThe consent resource has been rejected.
3Authorised The consent resource has been successfully authorised.
4ConsumedThe consented action has been successfully completed. This does not reflect the status of the consented action.

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:


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.
3AcceptedSettlementInProcess All 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. 

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:


StatusStatus Description
1AwaitingFurtherAuthorisationThe payment-order resource is awaiting further authorisation.
2RejectedThe payment-order resource has been rejected by an authoriser.
3Authorised The 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

OBInternational1

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

UML Diagram

Notes

For the OBInternational1 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 "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 "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 into. 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 OBInternational1/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.
  • A PISP must not specify ExchangeRate and/or ContractIdentification when requesting an Indicative RateType.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBInternational1
OBInternational1The 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.OBInternational1

InstructionIdentification1..1OBInternational1/InstructionIdentificationUnique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.

Usage: the  instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.		Max35Text

EndToEndIdentification1..1OBInternational1/EndToEndIdentificationUnique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.
OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.		Max35Text

LocalInstrument0..1OBInternational1/LocalInstrumentUser 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.		Max35Text

InstructionPriority0..1OBInternational1/InstructionPriorityIndicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.OBPriority2CodeNormal
Urgent
Purpose0..1OBInternational1/PurposeSpecifies the external purpose code in the format of character string with a maximum length of 35 characters.
The list of valid codes is an external code list published separately.
External code sets can be downloaded from www.iso20022.org.		ExternalPurposeCode

ChargeBearer0..1OBInternational1/ChargeBearerSpecifies which party/parties will bear the charges associated with the processing of the payment transaction.OBChargeBearerType1CodeBorneByCreditor
BorneByDebtor
FollowingServiceLevel
Shared
CurrencyOfTransfer1..1OBInternational1/CurrencyOfTransferSpecifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.ActiveOrHistoricCurrencyCode^[A-Z]{3,3}$
InstructedAmount1..1OBInternational1/InstructedAmountAmount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

Usage: This amount has to be transported unchanged through the transaction chain.		OBActiveOrHistoricCurrencyAndAmount

Amount1..1OBInternational1/InstructedAmount/AmountA number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.OBActiveCurrencyAndAmount_SimpleType^\d{1,13}\.\d{1,5}$
Currency1..1OBInternational1/InstructedAmount/CurrencyA code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".ActiveOrHistoricCurrencyCode^[A-Z]{3,3}$
ExchangeRateInformation0..1OBInternational1/ExchangeRateInformationProvides details on the currency exchange rate and contract.OBExchangeRate1

UnitCurrency1..1OBInternational1/ExchangeRateInformation/UnitCurrencyCurrency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.ActiveOrHistoricCurrencyCode^[A-Z]{3,3}$
ExchangeRate0..1OBInternational1/ExchangeRateInformation/ExchangeRateThe factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.BaseOneRate

RateType1..1OBInternational1/ExchangeRateInformation/RateTypeSpecifies the type used to complete the currency exchange.OBExchangeRateType2CodeActual
Agreed
Indicative
ContractIdentification0..1OBInternational1/ExchangeRateInformation/ContractIdentificationUnique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.Max256Text

DebtorAccount0..1OBInternational1/DebtorAccountUnambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.OBCashAccountDebtor3

SchemeName1..1OBInternational1/DebtorAccount/SchemeNameName of the identification scheme, in a coded form as published in an external list.Max40Text

Identification1..1OBInternational1/DebtorAccount/IdentificationIdentification assigned by an institution to identify an account. This identification is known by the account owner.Max256Text

Name0..1OBInternational1/DebtorAccount/NameName of the account, as assigned by the account servicing institution.

Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.		Max70Text

SecondaryIdentification0..1OBInternational1/DebtorAccount/SecondaryIdentificationThis is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).		Max34Text

Creditor0..1OBInternational1/CreditorParty to which an amount of money is due.OBPartyIdentification43

Name0..1OBInternational1/Creditor/NameName by which a party is known and which is usually used to identify that party.Max140Text

PostalAddress0..1OBInternational1/Creditor/PostalAddressInformation that locates and identifies a specific address, as defined by postal services.OBPostalAddress6

AddressType0..1OBInternational1/Creditor/PostalAddress/AddressTypeIdentifies the nature of the postal address.OBAddressTypeCodeBusiness
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
Department0..1OBInternational1/Creditor/PostalAddress/DepartmentIdentification of a division of a large organisation or building.Max70Text

SubDepartment0..1OBInternational1/Creditor/PostalAddress/SubDepartmentIdentification of a sub-division of a large organisation or building.Max70Text

StreetName0..1OBInternational1/Creditor/PostalAddress/StreetNameName of a street or thoroughfare.Max70Text

BuildingNumber0..1OBInternational1/Creditor/PostalAddress/BuildingNumberNumber that identifies the position of a building on a street.Max16Text

PostCode0..1OBInternational1/Creditor/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.Max16Text

TownName0..1OBInternational1/Creditor/PostalAddress/TownNameName of a built-up area, with defined boundaries, and a local government.Max35Text

CountrySubDivision0..1OBInternational1/Creditor/PostalAddress/CountrySubDivisionIdentifies a subdivision of a country such as state, region, county.Max35Text

Country0..1OBInternational1/Creditor/PostalAddress/CountryNation with its own government.CountryCode^[A-Z]{2,2}$
AddressLine0..7OBInternational1/Creditor/PostalAddress/AddressLineInformation that locates and identifies a specific address, as defined by postal services, presented in free format text.Max70Text

CreditorAgent0..1OBInternational1/CreditorAgentFinancial institution servicing an account for the creditor.OBBranchAndFinancialInstitutionIdentification3

SchemeName0..1OBInternational1/CreditorAgent/SchemeNameName of the identification scheme, in a coded form as published in an external list.Max40Text

Identification0..1OBInternational1/CreditorAgent/IdentificationUnique and unambiguous identification of a financial institution or a branch of a financial institution.Max35Text

Name0..1OBInternational1/CreditorAgent/NameName by which an agent is known and which is usually used to identify that agent.Max140Text

PostalAddress0..1OBInternational1/CreditorAgent/PostalAddressInformation that locates and identifies a specific address, as defined by postal services.OBPostalAddress6

AddressType0..1OBInternational1/CreditorAgent/PostalAddress/AddressTypeIdentifies the nature of the postal address.OBAddressTypeCodeBusiness
Correspondence
DeliveryTo
MailTo
POBox
Postal
Residential
Statement
Department0..1OBInternational1/CreditorAgent/PostalAddress/DepartmentIdentification of a division of a large organisation or building.Max70Text

SubDepartment0..1OBInternational1/CreditorAgent/PostalAddress/SubDepartmentIdentification of a sub-division of a large organisation or building.Max70Text

StreetName0..1OBInternational1/CreditorAgent/PostalAddress/StreetNameName of a street or thoroughfare.Max70Text

BuildingNumber0..1OBInternational1/CreditorAgent/PostalAddress/BuildingNumberNumber that identifies the position of a building on a street.Max16Text

PostCode0..1OBInternational1/CreditorAgent/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.Max16Text

TownName0..1OBInternational1/CreditorAgent/PostalAddress/TownNameName of a built-up area, with defined boundaries, and a local government.Max35Text

CountrySubDivision0..1OBInternational1/CreditorAgent/PostalAddress/CountrySubDivisionIdentifies a subdivision of a country such as state, region, county.Max35Text

Country0..1OBInternational1/CreditorAgent/PostalAddress/CountryNation with its own government.CountryCode^[A-Z]{2,2}$
AddressLine0..7OBInternational1/CreditorAgent/PostalAddress/AddressLineInformation that locates and identifies a specific address, as defined by postal services, presented in free format text.Max70Text

CreditorAccount1..1OBInternational1/CreditorAccountUnambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.OBCashAccountCreditor2

SchemeName1..1OBInternational1/CreditorAccount/SchemeNameName of the identification scheme, in a coded form as published in an external list.Max40Text

Identification1..1OBInternational1/CreditorAccount/IdentificationIdentification assigned by an institution to identify an account. This identification is known by the account owner.Max256Text

Name1..1OBInternational1/CreditorAccount/NameName of the account, as assigned by the account servicing institution.

Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.
OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.		Max70Text

SecondaryIdentification0..1OBInternational1/CreditorAccount/SecondaryIdentificationThis is secondary identification of the account, as assigned by the account servicing institution.
This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).		Max34Text

RemittanceInformation0..1OBInternational1/RemittanceInformationInformation supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.OBRemittanceInformation1

Unstructured0..1OBInternational1/RemittanceInformation/UnstructuredInformation 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.Max140Text

Reference0..1OBInternational1/RemittanceInformation/ReferenceUnique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.

If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.		Max35Text

OBExchangeRate2

This section describes the OBExchangeRate2 class - which is reused in the response payloads in the international-payment-consent and international-payment resources.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBExchangeRate2
OBExchangeRate2Further detailed information on the exchange rate that has been used in the payment transaction.OBExchangeRate2

UnitCurrency1..1OBExchangeRate2/UnitCurrencyCurrency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.ActiveOrHistoricCurrencyCode^[A-Z]{3,3}$
ExchangeRate1..1OBExchangeRate2/ExchangeRateThe factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.BaseOneRate

RateType1..1OBExchangeRate2/RateTypeSpecifies the type used to complete the currency exchange.OBExchangeRateType2CodeActual
Agreed
Indicative
ContractIdentification0..1OBExchangeRate2/ContractIdentificationUnique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.Max256Text

ExpirationDateTime0..1OBExchangeRate2/ExpirationDateTimeSpecified date and time the exchange rate agreement will expire.ISODateTime

International Payment Consent - Request

The OBWriteInternationalConsent1 object will be used for the call to:

  • POST /international-payment-consents

UML Diagram

Notes

The international-payment-consent request contains these objects:

  • Initiation
  • Authorisation
  • Risk

Exchange rate behaviour:

  • An ASPSP must respond to an Agreed RateType request.
  • An ASPSP may respond to an Actual RateType request or may reject the request. 
  • An ASPSP may respond to an Indicative RateType request or may reject the request. 
  • An ASPSP must reject the international-payment-consent request if the specified Initiation/ExchangeRateInformation cannot be fulfilled.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalConsent1
OBWriteInternationalConsent1
OBWriteInternationalConsent1

Data1..1OBWriteInternationalConsent1/Data
OBWriteDataInternationalConsent1

Initiation1..1OBWriteInternationalConsent1/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.OBInternational1

Authorisation0..1OBWriteInternationalConsent1/Data/AuthorisationThe authorisation type request from the TPP.OBAuthorisation1

Risk1..1OBWriteInternationalConsent1/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 Consent - Response

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

  • POST /international-payment-consents
  • GET /international-payment-consents/{ConsentId}

UML Diagram

Notes

The international-payment-consent response contains the full original payload from the international-payment-consent request - with these additional elements:

  • ConsentId
  • CreationDateTime the international-payment-consent resource was created
  • Status and StatusUpdateDateTime of the international-payment-consent resource
  • CutOffDateTime Behaviour is explained in Payment Initiation API Specification, Section - Payment Restrictions -> CutOffDateTime API Behaviour
  • ExpectedExecutionDateTime for the international-payment resource if created before CutOffDateTIme - the expected DateTime the payment is executed against the Debtor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU authorisation).
  • ExpectedSettlementDateTime for the international-payment resource if created before CutOffDateTIme - the expected DateTime the payment will be received at the Creditor Account. If populated, the ASPSP must update the value with any changes (e.g., after PSU authorisation).
  • Charges array which will be used by the ASPSP to indicate charges, and the ChargeBearer as relevant
  • ExchangeRateInformation (the ASPSP response) - this object will be used to communicate exchange rate information back to the PISP. It must be consistent with what is requested in the Initiation object from the PISP.

Exchange rate behaviour:

  • For an Agreed RateType - if an ASPSP chooses to respond with Data/ExchangeRateInformation object:
    • An ASPSP may respond with the same requested exchange rate in the Data/ExchangeRateInformation object.
    • An ASPSP must not populate Data/ExchangeRateInformation/ExpirationDateTime.
  • For an Actual RateType - if an ASPSP chooses to respond with Data/ExchangeRateInformation object:
    • An ASPSP must respond with an actual quote in the Data/ExchangeRateInformation object.
    • An ASPSP must respond with an actual ExchangeRate quote
    • An ASPSP must respond with an ExpirationDateTime
    • An ASPSP must reject the international-payment request if the PISP does not submit the international-payment within the ExchangeRateInformation/ExpirationDateTime
  • For an Indicative RateType - if an ASPSP chooses to respond with Data/ExchangeRateInformation object:
    • An ASPSP must respond with an indicative quote in the Data/ExchangeRateInformation object.
    • An ASPSP must respond with an indicative ExchangeRate quote
    • An ASPSP must not populate Data/ExchangeRateInformation/ExpirationDateTime for the exchange rate, as it's the market rate on the date of execution (date on which the DebtorAccount is debited)

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalConsentResponse1
OBWriteInternationalConsentResponse1
OBWriteInternationalConsentResponse1

Data1..1OBWriteInternationalConsentResponse1/Data
OBWriteDataInternationalConsentResponse1

ConsentId1..1OBWriteInternationalConsentResponse1/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text

CreationDateTime1..1OBWriteInternationalConsentResponse1/Data/CreationDateTimeDate and time at which the resource was created.ISODateTime

Status1..1OBWriteInternationalConsentResponse1/Data/StatusSpecifies the status of consent resource in code form.OBExternalConsentStatus1CodeAuthorised
AwaitingAuthorisation
Consumed
Rejected
StatusUpdateDateTime1..1OBWriteInternationalConsentResponse1/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime

CutOffDateTime0..1OBWriteInternationalConsentResponse1/Data/CutOffDateTimeSpecified cut-off date and time for the payment consent.ISODateTime

ExpectedExecutionDateTime0..1OBWriteInternationalConsentResponse1/Data/ExpectedExecutionDateTimeExpected execution date and time for the payment resource.ISODateTime

ExpectedSettlementDateTime0..1OBWriteInternationalConsentResponse1/Data/ExpectedSettlementDateTimeExpected settlement date and time for the payment resource.ISODateTime

Charges0..nOBWriteInternationalConsentResponse1/Data/ChargesSet of elements used to provide details of a charge for the payment initiation.OBCharge1

ExchangeRateInformation0..1OBWriteInternationalConsentResponse1/Data/ExchangeRateInformationFurther detailed information on the exchange rate that has been used in the payment transaction.OBExchangeRate2

Initiation1..1OBWriteInternationalConsentResponse1/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.OBInternational1

Authorisation0..1OBWriteInternationalConsentResponse1/Data/AuthorisationThe authorisation type request from the TPP.OBAuthorisation1

Risk1..1OBWriteInternationalConsentResponse1/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 - Request

The OBWriteInternational1 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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternational1OBWriteInternational1
OBWriteInternational1


Data1..1OBWriteInternational1/Data
OBWriteDataInternational1

ConsentId1..1OBWriteInternational1/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text

Initiation1..1OBWriteInternational1/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.OBInternational1

Risk1..1OBWriteInternational1/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 OBWriteInternationalResponse1 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

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalResponse1
OBWriteInternationalResponse1
OBWriteInternationalResponse1

Data1..1OBWriteInternationalResponse1/Data
OBWriteDataInternationalResponse1

InternationalPaymentId1..1OBWriteInternationalResponse1/Data/InternationalPaymentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.Max40Text

ConsentId1..1OBWriteInternationalResponse1/Data/ConsentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.Max128Text

CreationDateTime1..1OBWriteInternationalResponse1/Data/CreationDateTimeDate and time at which the message was created.ISODateTime

Status1..1OBWriteInternationalResponse1/Data/StatusSpecifies the status of the payment information group.OBTransactionIndividualStatus1CodeAcceptedSettlementCompleted
AcceptedSettlementInProcess
Pending
Rejected
StatusUpdateDateTime1..1OBWriteInternationalResponse1/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime

ExpectedExecutionDateTime0..1OBWriteInternationalResponse1/Data/ExpectedExecutionDateTimeExpected execution date and time for the payment resource.ISODateTime

ExpectedSettlementDateTime0..1OBWriteInternationalResponse1/Data/ExpectedSettlementDateTimeExpected settlement date and time for the payment resource.ISODateTime

Charges0..nOBWriteInternationalResponse1/Data/ChargesSet of elements used to provide details of a charge for the payment initiation.OBCharge1

ExchangeRateInformation0..1OBWriteInternationalResponse1/Data/ExchangeRateInformationFurther detailed information on the exchange rate that has been used in the payment transaction.OBExchangeRate2

Initiation1..1OBWriteInternationalResponse1/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.OBInternational1

MultiAuthorisation0..1OBWriteInternationalResponse1/Data/MultiAuthorisationThe multiple authorisation flow response from the ASPSP.OBMultiAuthorisation1

Usage Examples

Debit amount specified; ASPSP provides actual (guaranteed) FX rate, for limited time

The payee specifies the amount to be debited from the payment account and requests a payment to be credited in USD at a fixed rate.

POST /international-payment-consents request

Payment Order Consent Request Payload
POST /international-payment-consents HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
	  "InstructionPriority": "Normal",
      "CurrencyOfTransfer":"USD",
      "InstructedAmount": {
        "Amount": {
           "Amount": "165.88",
           "Currency": "GBP"
         }
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "ACME Inc",
        "SecondaryIdentification": "0002"
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      },
	  "ExchangeRateInformation": {
		"UnitCurrency": "GBP",
	  	"RateType": "Actual"
	  }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /international-payment-consents response

Payment Order Consent Response Payload
HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
	"Data": {
		"ConsentId": "58923",
		"Status": "AwaitingAuthorisation",
		"ExpirationDateTime": "2017-06-05T16:00:13+00:00",
		"CreationDateTime": "2017-06-05T15:15:13+00:00",
		"StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
		"Initiation": {
			"InstructionIdentification": "ACME412",
			"EndToEndIdentification": "FRESCO.21302.GFX.20",
	        "InstructionPriority": "Normal",
            "CurrencyOfTransfer":"USD",
			"InstructedAmount": {
				"Amount": "165.88",
				"Currency": "GBP"
			},			
			"CreditorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "08080021325698",
				"Name": "ACME Inc",
				"SecondaryIdentification": "0002"
			},
			"RemittanceInformation": {
				"Reference": "FRESCO-101",
				"Unstructured": "Internal ops code 5120101"
			},
		  	"ExchangeRateInformation": {
				"UnitCurrency": "USD"
	  			"RateType": "Actual"
	  		}
		},
		"ExchangeRateInformation": {
			"UnitCurrency": "GBP",
			"ExchangeRate": "1.10",
			"RateType": "Actual",
			"ExpirationDateTime": "2017-06-05T15:45:13+00:00"
		}
	},
	"Risk": {
		"PaymentContextCode": "PartyToParty"

	},
	"Links": {
		"Self": "https://api.alphabank.com/open-banking/v3.0/international-payment-consents/58923"
	},
	"Meta": {}
}

Debit amount specified; ASPSP provides indicative FX rate

The payee specifies the amount to be debited from the payment account and requests a payment to be credited in USD at an indicative rate.

POST /international-payment-consents request

Payment Order Consent Request Payload
POST /international-payment-consents HTTP/1.1
...

{
  "Data": {
    "Initiation": {
      ...
      "CurrencyOfTransfer":"USD",
	  "InstructedAmount": {
        "Amount": {
           "Amount": "165.88",
           "Currency": "GBP"
         }
      },
	  "ExchangeRateInformation": {
		"UnitCurrency": "GBP",
	  	"RateType": "Indicative"
	  }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /international-payment-consents response

Payment Order Consent Response Payload
HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
	"Data": {
		"ConsentId": "58923",
		"Status": "AwaitingAuthorisation",
		"ExpirationDateTime": "2017-06-05T16:00:13+00:00",
		"CreationDateTime": "2017-06-05T15:15:13+00:00",
		"StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
		"Initiation": {
			...
		},
		"ExchangeRateInformation": {
			"UnitCurrency": "GBP",
			"ExchangeRate": "1.10",
			"RateType": "Indicative"
		},
	},
	"Risk": {
		"PaymentContextCode": "PartyToParty"

	},
	"Links": {
		"Self": "https://api.alphabank.com/open-banking/v3.0/international-payment-consents/58923"
	},
	"Meta": {}
}

Debit amount specified; ASPSP provides a pre-booked FX rate

The payee specifies the amount to be debited from the payment account and requests a payment to be credited in USD. The payee specifies a contract reference number that has been pre-negotiated and pre-booked with the ASPSP.

POST /international-payment-consents request

Payment Order Consent Request Payload
POST /payments HTTP/1.1
...

{
  "Data": {
    "Initiation": {
      ...
	  "ExchangeRateInformation": {
		"UnitCurrency": "GBP",
	  	"RateType": "Agreed",
		"ExchangeRate": "1.09",
		"ContractIdentification": "/tbill/2018/T102993"
	  }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /international-payment-consents response

Payment Order Consent Response Payload
HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
	"Data": {
		"ConsentId": "58923",
		"Status": "AwaitingAuthorisation",
		"ExpirationDateTime": "2017-06-05T16:00:13+00:00",
		"CreationDateTime": "2017-06-05T15:15:13+00:00",
		"StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
		"Initiation": {
			...
			"ExchangeRateInformation": {
				"UnitCurrency": "GBP",
		  		"RateType": "Agreed",
				"ExchangeRate": "1.09",
				"ContractIdentification": "/tbill/2018/T102993"
		  	}
		},
		"ExchangeRateInformation": {
			"UnitCurrency": "GBP",
	  		"RateType": "Agreed",	
			"ExchangeRate": "1.09",
			"ContractIdentification": "/tbill/2018/T102993"
	  	}
	},
	"Risk": {
		"PaymentContextCode": "PartyToParty"

	},
	"Links": {
		"Self": "https://api.alphabank.com/open-banking/v3.0/international-payment-consents/58923"
	},
	"Meta": {}
}

Credit amount specified; ASPSP provides actual (guaranteed) FX rate , for limited time

In this situation, the PSU specifies the amount that must be credited to the payee. The ASPSP will debit the appropriate amount in GBP depending on the exchange rate.

As in the situation where the PSU specifies the amount to be debited the exchange rate could be guaranteed, indicative or pre-booked. CurrencyOfTransfer specified.

POST /international-payment-consents request

Payment Order Consent Request Payload
POST /international-payment-consents HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "InstructedAmount": {
        "Amount": {
           "Amount": "165.88",
           "Currency": "USD"
         }
      },
      "CurrencyOfTransfer":"USD",
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "08080021325698",
        "Name": "ACME Inc",
        "SecondaryIdentification": "0002"
      },
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      },
	  "ExchangeRateInformation": {
		"UnitCurrency": "GBP",
	  	"RateType": "Actual"
	  }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /international-payment-consents response

Payment Order Consent Response Payload
HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
	"Data": {
		"ConsentId": "58923",
		"Status": "AwaitingAuthorisation",
		"ExpirationDateTime": "2017-06-05T16:00:13+00:00",
		"CreationDateTime": "2017-06-05T15:15:13+00:00",
		"StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
		"Initiation": {
			"InstructionIdentification": "ACME412",
			"EndToEndIdentification": "FRESCO.21302.GFX.20",
	        "InstructedAmount": {
            	"Amount": {
           			"Amount": "165.88",
		            "Currency": "USD"
         		}
      		},
            "CurrencyOfTransfer":"USD",
			"CreditorAccount": {
				"SchemeName": "UK.OBIE.SortCodeAccountNumber",
				"Identification": "08080021325698",
				"Name": "ACME Inc",
				"SecondaryIdentification": "0002"
			},
			"RemittanceInformation": {
				"Reference": "FRESCO-101",
				"Unstructured": "Internal ops code 5120101"
			},
		  	"ExchangeRateInformation": {
				"UnitCurrency": "GBP"
	  			"RateType": "Actual"
	  		}
		},
		"ExchangeRateInformation": {
			"UnitCurrency": "GBP",
			"ExchangeRate": "1.10",
			"RateType": "Actual",
			"ExpirationDateTime": "2017-06-05T15:45:13+00:00"
		}
	},
	"Risk": {
		"PaymentContextCode": "PartyToParty"

	},
	"Links": {
		"Self": "https://api.alphabank.com/open-banking/v3.0/international-payment-consents/58923"
	},
	"Meta": {}
}

International payment with all charges paid by payer

Charge types are indicative only

POST /international-payment-consents request

Payment Order Consent Request Payload
POST /international-payment-consents HTTP/1.1
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-idempotency-key: FRESCO.21302.GFX.20
x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
    .......
      "Charges": [{
          "ChargeBearer": "BorneByDebtor",
          "Type":"UK.OBIE.TransSWIFTOutNonEEASterling"	 
       }],
      "RemittanceInformation": {
        "Reference": "FRESCO-101",
        "Unstructured": "Internal ops code 5120101"
      },
	  "ExchangeRateInformation": {
		"UnitCurrency": "USD",
	  	"RateType": "Indicative"
	  }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /international-payment-consents response

Payment Order Consent Response Payload
HTTP/1.1 201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
	"Data": {
		"ConsentId": "58923",
		"Status": "AwaitingAuthorisation",
		"ExpirationDateTime": "2017-06-05T16:00:13+00:00",
		"CreationDateTime": "2017-06-05T15:15:13+00:00",
		"StatusUpdateDateTime": "2017-06-05T15:15:13+00:00",
		"Initiation": {
			"InstructionIdentification": "ACME412",
			"EndToEndIdentification": "FRESCO.21302.GFX.20",
      		.......
            "Charges":[{
                "ChargeBearer": "BorneByDebtor",
                 "Type":"UK.OBIE.TransSWIFTOutNonEEASterling"
            }],
			"RemittanceInformation": {
				"Reference": "FRESCO-101",
				"Unstructured": "Internal ops code 5120101"
			},
		  	"ExchangeRateInformation": {
				"UnitCurrency": "USD"
	  			"RateType": "Indicative"
	  		}
		},
        "ExchangeRateInformation": {
			"UnitCurrency": "USD",
			"ExchangeRate": "0.9090",
			"RateType": "Indicative"
		}
	},
	"Risk": {
		"PaymentContextCode": "PartyToParty"

	},
	"Links": {
		"Self": "https://api.alphabank.com/open-banking/v3.0/international-payment-consents/58923"
	},
	"Meta": {}
}

© Open Banking Limited 2019 | https://www.openbanking.org.uk/open-licence | https://www.openbanking.org.uk