International Scheduled Payments v3.1

Owned by Freddi Gyara (Unlicensed)
Last updated: Nov 30, 2018
19 min read

Version Control

VersionDateAuthorComments
3.0 OB R/W API TeamThis is the baseline version. No change from RC3.
3.1-draft1 OB R/W API Team

This is the initial draft version for 3.1.

Draft 1 Changes

  • International Scheduled Payment Initiation resource updated to include an optional object SupplementaryData, as per Decision 168
  • Type of field OBInternationalScheduled2/Purpose is changed to ExternalPurpose1Code to match to ISO 20022 type of 4 character purpose code

Errata

  • Grammatical Fixes
3.1-draft2 OB R/W API Team

Draft2 Changes:

  • Updated example URLs to version 3.1.
3.1-draft3 OB R/W API Team

Draft3 Changes:

  • Clarified Currency of Transfer definition.

  • Added Confirmation of Funds for PISP functionality.

  • Data Model updated with a typed field for Account/SchemeName, Agent/SchemeName, and LocalInstrument fields to reference in Namespaced Enumerations page.
3.1-draft4 OB R/W API Team

Draft4 Changes:

  • Changed Confirmation of Funds endpoint to 'Mandatory (if immediate debit supported)'.
3.1-rc1 OB R/W API Team

RC1 Changes:

  • Type of the field OBInternationalScheduled2/Purpose is changed to OBExternalPurpose1Code1 to match to ISO 20022 type, i.e. a 4 character purpose code, without the listing in the OBIE Standards
  • Wrong UML attachment. Replaced the UML diagram for International Scheduled Payment - Request
  • Updated enumerations to use full UK.OBIE namespace.
  • Confirmed the confirmation of funds response contains the result of a funds availability check, or SupplementaryData.
  • Wrong UML attachment. Replaced the UML diagram for International Scheduled Payment - Response 
  • References of OBCharge1 replaced with OBCharge2 class
3.1OB R/W API Team

Version 3.1 final release.

No changes from Version 3.1 RC1

Endpoints

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

Signed Request

Signed Response

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

Client Credentials

Signed ResponseNoNAOBWriteInternationalScheduledConsentResponse1
international-scheduled-payment-consentsGETGET /international-scheduled-payment-consents/{ConsentId}/funds-confirmationMandatory (if immediate debit supported)paymentsAuthorization CodeSigned ResponseNoNAOBWriteFundsConfirmationResponse1
international-scheduled-paymentsPOSTPOST /international-scheduled-paymentsConditionalpaymentsAuthorization Code

Signed Request

Signed Response

YesOBWriteInternationalScheduled1OBWriteInternationalScheduledResponse1
international-scheduled-paymentsGETGET /international-scheduled-payments/{InternationalScheduledPaymentId}Mandatory (if resource POST implemented)payments

Client Credentials

Signed ResponseNoNAOBWriteInternationalScheduledResponse1

POST /international-scheduled-payment-consents

POST /international-scheduled-payment-consents

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

  • The POST action indicates to the ASPSP that an international scheduled 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-scheduled-payment-consent resource and responds with a unique ConsentId to refer to the resource.

Status

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

Status
AwaitingAuthorisation

GET /international-scheduled-payment-consents/{ConsentId}

GET /international-scheduled-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-scheduled-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".

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

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

Status
AwaitingAuthorisation
Rejected
Authorised
Consumed

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

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

The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-scheduled-payment-consent resource, where the payment is for immediate debit.

  • An ASPSP can only respond to a funds confirmation request if the international-scheduled-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-scheduled-payment-consent resource.

POST /international-scheduled-payments

POST /international-scheduled-payments

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

  • This is done by making a POST request to the international-scheduled-payments endpoint.
  • This request is an instruction to the ASPSP to begin the international scheduled payment journey. The PISP must submit the international scheduled payment immediately, however, there are some scenarios where the ASPSP may not warehouse the international scheduled payment immediately (e.g. busy periods at the ASPSP).
  • The PISP must ensure that the Initiation and Risk sections of the international-scheduled-payment match the corresponding Initiation and Risk sections of the international-scheduled-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-scheduled-payment resource will not result in a Status change for the international-scheduled-payment resource.

Status

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

The international-scheduled-payment resource that is created successfully must have one of the following Status codes:

Status
InitiationPending
InitiationFailed
InitiationCompleted 

GET /international-scheduled-payments/{InternationalScheduledPaymentId}

GET /international-scheduled-payments/{InternationalScheduledPaymentId}

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

Status

The international-scheduled-payment resource must have one of the following Status codes:

Status
InitiationPending
InitiationFailed
InitiationCompleted 

State Model

Payment Order Consent

The state model for the international-scheduled-payment-consent resource follows the generic consent state model. However, does not use the "Revoked" status, as the consent for an international-scheduled-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-scheduled-payment resource describes the initiation status only. I.e., not the subsequent execution of the international-scheduled-payment.



The definitions for the Status:


StatusPayment Status Description
1InitiationPendingThe initiation of the payment order is pending.
2InitiationFailedThe initiation of the payment order has failed.
3InitiationCompleted The initiation of the payment order is complete.

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 Scheduled Payment API flows.

Reused Classes

OBInternationalScheduled2

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

UML Diagram

Notes

For the OBInternationalScheduled2 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-scheduled-payment-consent consent request immediately.

  • If the ASPSP establishes a problem with the international-scheduled-payment-consent after the API call, the ASPSP must set the Status of the international-scheduled-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-scheduled-payment-consent will be set to Rejected after PSU authentication.
  • CreditorAgent must at least have either of the pairs provided: SchemeName and Identification, or Name and PostalAddress.
  • Account Identification field usage:
    • SchemeName is a free-text field which will be populated with identification schemes an ASPSP accepts.
    • Identification is a field which is populated with the Identification of the account, using the valid identification scheme provided.
  • Valid UK Account Identification SchemeName values include, but are not restricted to:
    • "UK.OBIE.SortCodeAccountNumber" - Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field).
    • "UK.OBIE.IBAN" - The Identification field must be populated with the full IBAN.
    • "UK.OBIE.PAN" - The Identification field must be populated with the full PAN. A PAN may be an instrument (e.g., a debit card) linked to a payment account, and may not be the only PAN linked to the payment account.
    • "UK.OBIE.Paym" - The Identification field must be populated with the Paym proxy value.
  • 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. I.e., a PSU may wish to transfer 100EUR from a GBP DebtorAccount (the InstructedAmount will be 100EUR), or 100GBP in EUR (the InstructedAmount will be 100GBP).
  • The CurrencyOfTransfer must be 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 Initiation request if the requested charge allocation cannot be fulfilled.
  • Permission field is restricted to "Create" however, may be extended to "Update" and "Delete" in a future iteration of the specification.
  • RequestedExecutionDateTime allows a PISP to specify the date for an ASPSP to execute the international scheduled payment.

The 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

OBInternationalScheduled2


OBInternationalScheduled2

The 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 scheduled international payment.

OBInternationalScheduled2



InstructionIdentification

1..1

OBInternationalScheduled2/InstructionIdentification

Unique 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



EndToEndIdentification

0..1

OBInternationalScheduled2/EndToEndIdentification

Unique 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



LocalInstrument

0..1

OBInternationalScheduled2/LocalInstrument

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.

OBExternalLocalInstrument1Code



InstructionPriority

0..1

OBInternationalScheduled2/InstructionPriority

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

OBPriority2Code

Normal

Urgent


Purpose

0..1

OBInternationalScheduled2/Purpose

Specifies the external purpose code in the format of character string with a maximum length of 4 characters.

The list of valid codes is an external code list published separately.

External code sets can be downloaded from www.iso20022.org.

OBExternalPurpose1Code1



ChargeBearer

0..1

OBInternationalScheduled2/ChargeBearer

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

OBChargeBearerType1Code

BorneByCreditor

BorneByDebtor

FollowingServiceLevel

Shared


RequestedExecutionDateTime

1..1

OBInternationalScheduled2/RequestedExecutionDateTime

Date at which the initiating party requests the clearing agent to process the payment.

Usage: This is the date on which the debtor's account is to be debited.

ISODateTime



CurrencyOfTransfer

1..1

OBInternationalScheduled2/CurrencyOfTransfer

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

ActiveOrHistoricCurrencyCode


^[A-Z]{3,3}$

InstructedAmount

1..1

OBInternationalScheduled2/InstructedAmount

Amount 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



Amount

1..1

OBInternationalScheduled2/InstructedAmount/Amount

A 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}$

Currency

1..1

OBInternationalScheduled2/InstructedAmount/Currency

A 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}$

ExchangeRateInformation

0..1

OBInternationalScheduled2/ExchangeRateInformation

Provides details on the currency exchange rate and contract.

OBExchangeRate1



UnitCurrency

1..1

OBInternationalScheduled2/ExchangeRateInformation/UnitCurrency

Currency 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}$

ExchangeRate

0..1

OBInternationalScheduled2/ExchangeRateInformation/ExchangeRate

The 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



RateType

1..1

OBInternationalScheduled2/ExchangeRateInformation/RateType

Specifies the type used to complete the currency exchange.

OBExchangeRateType2Code

Actual

Agreed

Indicative


ContractIdentification

0..1

OBInternationalScheduled2/ExchangeRateInformation/ContractIdentification

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

Max256Text



DebtorAccount

0..1

OBInternationalScheduled2/DebtorAccount

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

OBCashAccountDebtor4



SchemeName

1..1

OBInternationalScheduled2/DebtorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBInternationalScheduled2/DebtorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

0..1

OBInternationalScheduled2/DebtorAccount/Name

Name 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



SecondaryIdentification

0..1

OBInternationalScheduled2/DebtorAccount/SecondaryIdentification

This 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



Creditor

0..1

OBInternationalScheduled2/Creditor

Party to which an amount of money is due.

OBPartyIdentification43



Name

0..1

OBInternationalScheduled2/Creditor/Name

Name by which a party is known and which is usually used to identify that party.

Max140Text



PostalAddress

0..1

OBInternationalScheduled2/Creditor/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternationalScheduled2/Creditor/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternationalScheduled2/Creditor/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternationalScheduled2/Creditor/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternationalScheduled2/Creditor/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternationalScheduled2/Creditor/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternationalScheduled2/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.

Max16Text



TownName

0..1

OBInternationalScheduled2/Creditor/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternationalScheduled2/Creditor/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBInternationalScheduled2/Creditor/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBInternationalScheduled2/Creditor/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAgent

0..1

OBInternationalScheduled2/CreditorAgent

Financial institution servicing an account for the creditor.

OBBranchAndFinancialInstitutionIdentification6



SchemeName

0..1

OBInternationalScheduled2/CreditorAgent/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalFinancialInstitutionIdentification4Code



Identification

0..1

OBInternationalScheduled2/CreditorAgent/Identification

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Max35Text



Name

0..1

OBInternationalScheduled2/CreditorAgent/Name

Name by which an agent is known and which is usually used to identify that agent.

Max140Text



PostalAddress

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress

Information that locates and identifies a specific address, as defined by postal services.

OBPostalAddress6



AddressType

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/AddressType

Identifies the nature of the postal address.

OBAddressTypeCode

Business

Correspondence

DeliveryTo

MailTo

POBox

Postal

Residential

Statement


Department

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/Department

Identification of a division of a large organisation or building.

Max70Text



SubDepartment

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/SubDepartment

Identification of a sub-division of a large organisation or building.

Max70Text



StreetName

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/StreetName

Name of a street or thoroughfare.

Max70Text



BuildingNumber

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/BuildingNumber

Number that identifies the position of a building on a street.

Max16Text



PostCode

0..1

OBInternationalScheduled2/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.

Max16Text



TownName

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/TownName

Name of a built-up area, with defined boundaries, and a local government.

Max35Text



CountrySubDivision

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/CountrySubDivision

Identifies a subdivision of a country such as state, region, county.

Max35Text



Country

0..1

OBInternationalScheduled2/CreditorAgent/PostalAddress/Country

Nation with its own government.

CountryCode


^[A-Z]{2,2}$

AddressLine

0..7

OBInternationalScheduled2/CreditorAgent/PostalAddress/AddressLine

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max70Text



CreditorAccount

1..1

OBInternationalScheduled2/CreditorAccount

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

OBCashAccountCreditor3



SchemeName

1..1

OBInternationalScheduled2/CreditorAccount/SchemeName

Name of the identification scheme, in a coded form as published in an external list.

OBExternalAccountIdentification4Code



Identification

1..1

OBInternationalScheduled2/CreditorAccount/Identification

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Max256Text



Name

1..1

OBInternationalScheduled2/CreditorAccount/Name

Name 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



SecondaryIdentification

0..1

OBInternationalScheduled2/CreditorAccount/SecondaryIdentification

This 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



RemittanceInformation

0..1

OBInternationalScheduled2/RemittanceInformation

Information 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



Unstructured

0..1

OBInternationalScheduled2/RemittanceInformation/Unstructured

Information 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



Reference

0..1

OBInternationalScheduled2/RemittanceInformation/Reference

Unique 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



SupplementaryData

0..1

OBInternationalScheduled2/SupplementaryData

Additional information that can not be captured in the structured fields and/or any other specific block.

OBSupplementaryData1



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 Scheduled Payment Consent - Request

The OBWriteInternationalScheduledConsent2 object will be used for the call to:

  • POST /international-scheduled-payment-consents

UML Diagram

Notes

The international-scheduled-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-scheduled-payment-consent request if the specified Initiation/ExchangeRateInformation cannot be fulfilled.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalScheduledConsent2
OBWriteInternationalScheduledConsent2
OBWriteInternationalScheduledConsent2

Data1..1OBWriteInternationalScheduledConsent2/Data
OBWriteDataInternationalScheduledConsent2

Permission1..1OBWriteInternationalScheduledConsent2/Data/PermissionSpecifies the Open Banking service request types. OBExternalPermissions2CodeCreate
Initiation1..1OBWriteInternationalScheduledConsent2/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 scheduled international payment.OBInternationalScheduled2

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

Risk1..1OBWriteInternationalScheduledConsent2/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 Scheduled Payment Consent - Response

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

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

UML Diagram

Notes

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

  • ConsentId.
  • CreationDateTime the international-scheduled-payment-consent resource was created.
  • Status and StatusUpdateDateTime of the international-scheduled-payment-consent resource.
  • Permission field in the original request.
  • CutOffDateTime Behaviour is explained in Payment Initiation API Specification, Section - Payment Restrictions -> CutOffDateTime API Behaviour.
  • ExpectedExecutionDateTime for the international-scheduled-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-scheduled-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 ExchangeRate quote in the Data/ExchangeRateInformation object.
    • 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
    • An ASPSP may choose to debit the DebtorAccount with the agreed exchange rate on the date the international-scheduled-payment is created and settle on the RequestedExecutionDateTime
  • 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 is the market rate on the date of execution (date on which the DebtorAccount is debited)

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalScheduledConsentResponse2
OBWriteInternationalScheduledConsentResponse2
OBWriteInternationalScheduledConsentResponse2

Data1..1OBWriteInternationalScheduledConsentResponse2/Data
OBWriteDataInternationalScheduledConsentResponse2

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

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

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

Permission1..1OBWriteInternationalScheduledConsentResponse2/Data/PermissionSpecifies the Open Banking service request types. OBExternalPermissions2CodeCreate
CutOffDateTime0..1OBWriteInternationalScheduledConsentResponse2/Data/CutOffDateTimeSpecified cut-off date and time for the payment consent.ISODateTime

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

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

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

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

Initiation1..1OBWriteInternationalScheduledConsentResponse2/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 scheduled international payment.OBInternationalScheduled2

Authorisation0..1OBWriteInternationalScheduledConsentResponse2/Data/AuthorisationThe multiple authorisation flow response from the ASPSP.OBAuthorisation1

Risk1..1OBWriteInternationalScheduledConsentResponse2/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 Scheduled Payment Consent Confirmation of Funds - Response

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

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

UML Diagram

Notes

The confirmation of funds response contains the result of a funds availability check, or SupplementaryData.

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteFundsConfirmationResponse1
OBWriteFundsConfirmationResponse1
OBWriteFundsConfirmationResponse1

Data1..1OBWriteFundsConfirmationResponse1/Data
OBWriteDataFundsConfirmationResponse1

FundsAvailableResult0..1OBWriteFundsConfirmationResponse1/Data/FundsAvailableResultResult of a funds availability check.OBFundsAvailableResult1

FundsAvailableDateTime1..1OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult/FundsAvailableDateTimeDate and time at which the funds availability check was generated.ISODateTime

FundsAvailable1..1OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult/FundsAvailableFlag to indicate the availability of funds given the Amount in the consent request.xs:boolean

SupplementaryData0..1OBWriteFundsConfirmationResponse1/Data/SupplementaryDataAdditional information that can not be captured in the structured fields and/or any other specific block.OBSupplementaryData1

International Scheduled Payment - Request

The OBWriteInternationalScheduled2 object will be used for a call to:

  • POST /international-scheduled-payments

UML Diagram

Notes

The international-scheduled-payment request object contains the: 

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

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalScheduled2OBWriteInternationalScheduled2
OBWriteInternationalScheduled1


Data1..1OBWriteInternationalScheduled2/Data
OBWriteDataInternationalScheduled2

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

Initiation1..1OBWriteInternationalScheduled2/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 scheduled international payment.OBInternationalScheduled2

Risk1..1OBWriteInternationalScheduled2/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 Scheduled Payment - Response

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

  • POST /international-scheduled-payments
  • GET /international-scheduled-payments/{InternationalScheduledPaymentId}

UML Diagram

Notes

The international-scheduled-payment response object contains the: 

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

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodesPattern
OBWriteInternationalScheduledResponse2
OBWriteInternationalScheduledResponse2
OBWriteInternationalScheduledResponse2

Data1..1OBWriteInternationalScheduledResponse2/Data
OBWriteDataInternationalScheduledResponse2

InternationalScheduledPaymentId1..1OBWriteInternationalScheduledResponse2/Data/InternationalScheduledPaymentIdOB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.Max40Text

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

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

Status1..1OBWriteInternationalScheduledResponse2/Data/StatusSpecifies the status of the payment order resource.OBExternalStatus1CodeInitiationCompleted
InitiationFailed
InitiationPending
StatusUpdateDateTime1..1OBWriteInternationalScheduledResponse2/Data/StatusUpdateDateTimeDate and time at which the resource status was updated.ISODateTime

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

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

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

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

Initiation1..1OBWriteInternationalScheduledResponse2/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 scheduled international payment.OBInternationalScheduled2

MultiAuthorisation0..1OBWriteInternationalScheduledResponse2/Data/MultiAuthorisation
OBMultiAuthorisation1

Usage Examples


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

The example below shows a Scheduled (future dated) payment with final credit amount specified and requesting an Actual rate to be applied.

Actual rate will be applied on the date of Payment Order setup, and transfer happens on the RequestedExecutionDateTime.

POST /international-scheduled-payment-consents request

Payment Order Consent Request Payload
POST /international-scheduled-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": {
    "Permission":"Create",
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "RequestedExecutionDate": "2018-08-06T00:00:00+00:00",
      "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-scheduled-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": {
		"Permission": "Create",
		"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",
            "RequestedExecutionDate": "2018-08-06T00:00:00+00:00",	     
			"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.1/pisp/international-scheduled-payment-consents/58923"
	},
	"Meta": {}
}

Credit amount specified; Future Dated Payment, ASPSP doesn't provide Indicative rate on payment order setup

The example below shows a Scheduled (future dated) payment with final credit amount specified and requesting an Indicative rate to be applied.

Indicative rate will be applied on RequestedExecutionDateTime, as per the prevailing Indicative rate. So No Exchange Rate information will be returned in the ASPSP response

POST /international-scheduled-payment-consents request

Payment Order Consent Request Payload
POST /international-scheduled-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": {
    "Permission":"Create",
    "Initiation": {
      "InstructionIdentification": "ACME412",
      "EndToEndIdentification": "FRESCO.21302.GFX.20",
      "RequestedExecutionDate": "2018-08-06T00:00:00+00:00",
      "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": "Indicative"
	  }
    }
  },
  "Risk": {
    "PaymentContextCode": "PartyToParty"
  }
}

POST /international-scheduled-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": {
		"Permission": "Create",
		"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",
            "RequestedExecutionDate": "2018-08-06T00:00:00+00:00",	     
			"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": "Indicative"
	  		}
		}
	},
	"Risk": {
		"PaymentContextCode": "PartyToParty"

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

Confirm Funds on International Payment Order Consent

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

Payment Order Consent Request Payload
GET /international-scheduled-payment-consents/58923/funds-confirmation HTTP/1.1
Authorization: Bearer Jhingapulaav
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
Accept: application/json

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

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

{
	"Data": {
		"FundsAvailableResult": {
			"FundsAvailableDateTime": "2017-06-05T15:15:23+00:00",
			"FundsAvailable": true
		}
	},
	"Links": {
		"Self": "https://api.alphabank.com/open-banking/v3.1/pisp/domestic-payment-consents/58923/funds-confirmation"
	},
	"Meta": {}
}

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