|
Version | Date | Author | Comments |
---|---|---|---|
3.0 | OB R/W API Team | This 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
Errata
| |
3.1-draft2 | OB R/W API Team | Draft2 Changes:
| |
3.1-draft3 | OB R/W API Team | Draft3 Changes:
| |
3.1-draft4 | OB R/W API Team | Draft4 Changes:
| |
3.1-rc1 | OB R/W API Team | RC1 Changes:
| |
3.1 | OB R/W API Team | Version 3.1 final release. No changes from Version 3.1 RC1 |
Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
---|---|---|---|---|---|---|---|---|---|
international-scheduled-payment-consents | POST | POST /international-scheduled-payment-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteInternationalScheduledConsent1 | OBWriteInternationalScheduledConsentResponse1 |
international-scheduled-payment-consents | GET | GET /international-scheduled-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalScheduledConsentResponse1 |
international-scheduled-payment-consents | GET | GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | Mandatory (if immediate debit supported) | payments | Authorization Code | Signed Response | No | NA | OBWriteFundsConfirmationResponse1 |
international-scheduled-payments | POST | POST /international-scheduled-payments | Conditional | payments | Authorization Code | Signed Request Signed Response | Yes | OBWriteInternationalScheduled1 | OBWriteInternationalScheduledResponse1 |
international-scheduled-payments | GET | GET /international-scheduled-payments/{InternationalScheduledPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalScheduledResponse1 |
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 default Status is "AwaitingAuthorisation" immediately after the international-scheduled-payment-consent has been created.
Status |
---|
AwaitingAuthorisation |
GET /international-scheduled-payment-consents/{ConsentId} |
A PISP can optionally retrieve a payment consent resource that they have created to check its 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 |
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.
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.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:
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} |
A PISP can retrieve the international-scheduled-payment to check its status.
The international-scheduled-payment resource must have one of the following Status codes:
Status |
---|
InitiationPending |
InitiationFailed |
InitiationCompleted |
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:
Status | Status Description | |
---|---|---|
1 | AwaitingAuthorisation | The consent resource is awaiting PSU authorisation. |
2 | Rejected | The consent resource has been rejected. |
3 | Authorised | The consent resource has been successfully authorised. |
4 | Consumed | The consented action has been successfully completed. This does not reflect the status of the consented action. |
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:
Status | Payment Status Description | |
---|---|---|
1 | InitiationPending | The initiation of the payment order is pending. |
2 | InitiationFailed | The initiation of the payment order has failed. |
3 | InitiationCompleted | The initiation of the payment order is complete. |
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:
Status | Status Description | |
---|---|---|
1 | AwaitingFurtherAuthorisation | The payment-order resource is awaiting further authorisation. |
2 | Rejected | The payment-order resource has been rejected by an authoriser. |
3 | Authorised | The payment-order resource has been successfully authorised by all required authorisers. |
The data dictionary section gives the detail on the payload content for the International Scheduled Payment API flows.
This section describes the OBInternationalScheduled2 class which is reused as the Initiation object in the international-scheduled-payment-consent and international-scheduled-payment resources.
For the OBInternationalScheduled2 Initiation object:
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.
The ExchangeRateInformation object must conform to these behaviours:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
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 |
This section describes the OBExchangeRate2 class which is reused in the response payloads in the international-payment-consent and international-payment resources.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBExchangeRate2 | OBExchangeRate2 | Further detailed information on the exchange rate that has been used in the payment transaction. | OBExchangeRate2 | |||
UnitCurrency | 1..1 | OBExchangeRate2/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 | 1..1 | OBExchangeRate2/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 | OBExchangeRate2/RateType | Specifies the type used to complete the currency exchange. | OBExchangeRateType2Code | Actual Agreed Indicative | |
ContractIdentification | 0..1 | OBExchangeRate2/ContractIdentification | Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. | Max256Text | ||
ExpirationDateTime | 0..1 | OBExchangeRate2/ExpirationDateTime | Specified date and time the exchange rate agreement will expire. | ISODateTime |
The OBWriteInternationalScheduledConsent2 object will be used for the call to:
The international-scheduled-payment-consent request contains these objects:
Exchange rate behaviour:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalScheduledConsent2 | OBWriteInternationalScheduledConsent2 | OBWriteInternationalScheduledConsent2 | ||||
Data | 1..1 | OBWriteInternationalScheduledConsent2/Data | OBWriteDataInternationalScheduledConsent2 | |||
Permission | 1..1 | OBWriteInternationalScheduledConsent2/Data/Permission | Specifies the Open Banking service request types. | OBExternalPermissions2Code | Create | |
Initiation | 1..1 | OBWriteInternationalScheduledConsent2/Data/Initiation | 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 | ||
Authorisation | 0..1 | OBWriteInternationalScheduledConsent2/Data/Authorisation | The authorisation type request from the TPP. | OBAuthorisation1 | ||
Risk | 1..1 | OBWriteInternationalScheduledConsent2/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk1 |
The OBWriteInternationalScheduledConsentResponse2 object will be used for a response to a call to:
The international-scheduled-payment-consent response contains the full original payload from the international-scheduled-payment-consent request with the additional elements below:
Exchange rate behaviour:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalScheduledConsentResponse2 | OBWriteInternationalScheduledConsentResponse2 | OBWriteInternationalScheduledConsentResponse2 | ||||
Data | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data | OBWriteDataInternationalScheduledConsentResponse2 | |||
ConsentId | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
CreationDateTime | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime | ||
Status | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data/Status | Specifies the status of consent resource in code form. | OBExternalConsentStatus1Code | Authorised AwaitingAuthorisation Consumed Rejected | |
StatusUpdateDateTime | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime | ||
Permission | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data/Permission | Specifies the Open Banking service request types. | OBExternalPermissions2Code | Create | |
CutOffDateTime | 0..1 | OBWriteInternationalScheduledConsentResponse2/Data/CutOffDateTime | Specified cut-off date and time for the payment consent. | ISODateTime | ||
ExpectedExecutionDateTime | 0..1 | OBWriteInternationalScheduledConsentResponse2/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource. | ISODateTime | ||
ExpectedSettlementDateTime | 0..1 | OBWriteInternationalScheduledConsentResponse2/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource. | ISODateTime | ||
Charges | 0..n | OBWriteInternationalScheduledConsentResponse2/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge2 | ||
ExchangeRateInformation | 0..1 | OBWriteInternationalScheduledConsentResponse2/Data/ExchangeRateInformation | Further detailed information on the exchange rate that has been used in the payment transaction. | OBExchangeRate2 | ||
Initiation | 1..1 | OBWriteInternationalScheduledConsentResponse2/Data/Initiation | 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 | ||
Authorisation | 0..1 | OBWriteInternationalScheduledConsentResponse2/Data/Authorisation | The multiple authorisation flow response from the ASPSP. | OBAuthorisation1 | ||
Risk | 1..1 | OBWriteInternationalScheduledConsentResponse2/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk1 |
The OBWriteFundsConfirmationResponse1 object will be used for a response to a call to:
The confirmation of funds response contains the result of a funds availability check, or SupplementaryData.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteFundsConfirmationResponse1 | OBWriteFundsConfirmationResponse1 | OBWriteFundsConfirmationResponse1 | ||||
Data | 1..1 | OBWriteFundsConfirmationResponse1/Data | OBWriteDataFundsConfirmationResponse1 | |||
FundsAvailableResult | 0..1 | OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult | Result of a funds availability check. | OBFundsAvailableResult1 | ||
FundsAvailableDateTime | 1..1 | OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult/FundsAvailableDateTime | Date and time at which the funds availability check was generated. | ISODateTime | ||
FundsAvailable | 1..1 | OBWriteFundsConfirmationResponse1/Data/FundsAvailableResult/FundsAvailable | Flag to indicate the availability of funds given the Amount in the consent request. | xs:boolean | ||
SupplementaryData | 0..1 | OBWriteFundsConfirmationResponse1/Data/SupplementaryData | Additional information that can not be captured in the structured fields and/or any other specific block. | OBSupplementaryData1 |
The OBWriteInternationalScheduled2 object will be used for a call to:
The international-scheduled-payment request object contains the:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalScheduled2 | OBWriteInternationalScheduled2 | OBWriteInternationalScheduled1 | ||||
Data | 1..1 | OBWriteInternationalScheduled2/Data | OBWriteDataInternationalScheduled2 | |||
ConsentId | 1..1 | OBWriteInternationalScheduled2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
Initiation | 1..1 | OBWriteInternationalScheduled2/Data/Initiation | 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 | ||
Risk | 1..1 | OBWriteInternationalScheduled2/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. | OBRisk1 |
The OBWriteInternationalScheduledResponse2 object will be used for a response to a call to:
The international-scheduled-payment response object contains the:
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
---|---|---|---|---|---|---|
OBWriteInternationalScheduledResponse2 | OBWriteInternationalScheduledResponse2 | OBWriteInternationalScheduledResponse2 | ||||
Data | 1..1 | OBWriteInternationalScheduledResponse2/Data | OBWriteDataInternationalScheduledResponse2 | |||
InternationalScheduledPaymentId | 1..1 | OBWriteInternationalScheduledResponse2/Data/InternationalScheduledPaymentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource. | Max40Text | ||
ConsentId | 1..1 | OBWriteInternationalScheduledResponse2/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | Max128Text | ||
CreationDateTime | 1..1 | OBWriteInternationalScheduledResponse2/Data/CreationDateTime | Date and time at which the message was created. | ISODateTime | ||
Status | 1..1 | OBWriteInternationalScheduledResponse2/Data/Status | Specifies the status of the payment order resource. | OBExternalStatus1Code | InitiationCompleted InitiationFailed InitiationPending | |
StatusUpdateDateTime | 1..1 | OBWriteInternationalScheduledResponse2/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime | ||
ExpectedExecutionDateTime | 0..1 | OBWriteInternationalScheduledResponse2/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource. | ISODateTime | ||
ExpectedSettlementDateTime | 0..1 | OBWriteInternationalScheduledResponse2/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource. | ISODateTime | ||
Charges | 0..n | OBWriteInternationalScheduledResponse2/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge2 | ||
ExchangeRateInformation | 0..1 | OBWriteInternationalScheduledResponse2/Data/ExchangeRateInformation | Further detailed information on the exchange rate that has been used in the payment transaction. | OBExchangeRate2 | ||
Initiation | 1..1 | OBWriteInternationalScheduledResponse2/Data/Initiation | 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 | ||
MultiAuthorisation | 0..1 | OBWriteInternationalScheduledResponse2/Data/MultiAuthorisation | OBMultiAuthorisation1 |
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
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
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": {} } |
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
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
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": {} } |
GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation Request
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
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": {} } |