International Payment Consents
- CBB Admin
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 28th Oct 2020 | Initial Release |
2. Overview
The International Payment Consent resource is used by a PISP to register an intent to initiate an International Payment.
This resource description should be read in conjunction with a compatible Payment Initiation API Profile.
3. Endpoints
Endpoints for the resource - and available methods.
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
3.1 | international-payment-consents | POST | POST /international-payment-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteInternationalConsent | OBWriteInternationalConsentResponse |
3.2 | international-payment-consents | GET | GET /international-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalConsentResponse |
3.3 | international-payment-consents | GET | GET /international-payment-consents/{ConsentId}/funds-confirmation | Mandatory (if resource POST implemented) | payments | Authorisation Code | Signed Response | No | NA | OBWriteFundsConfirmationResponse |
3.1 POST/international-payment-consents
The API endpoint allows the PISP to ask an ASPSP to create a new international-payment-consents resource.
The POST action indicates to the ASPSP that a payment consents has been staged. At this point, the user/customer 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 user/customer and PISP) to the ASPSP for the user/customer to authorise
The ASPSP creates the international-payment-consents resource and responds with a unique ConsentId to refer to the resource
3.1.1 Status
The default Status is "AwaitingAuthorisation" immediately after the international-payment-consents has been created.
Status |
AwaitingAuthorisation |
3.2 GET /international-payment-consents /{ConsentId}
A PISP can optionally retrieve a payment consents resource that they have created to check its status.
3.2.1 Status
The available Status codes for the international-payment-consents resource are:
Once the user/customer authorises the payment-consents resource, the Status of the payment-consents resource will be updated with "Authorised".
If the user/customer rejects the consent or the international-payment-consents has failed some other ASPSP validation, the Status will be set to "Rejected".
Once an international-payments has been successfully created using the international-payment-consents, the Status of the international-payment-consents will be set to "Consumed".
Status |
AwaitingAuthorisation |
Rejected |
Authorised |
Consumed |
3.3 GET /international-payment-consents/{ConsentId}/funds-confirmation
The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-payment-consents resource.
An ASPSP can only respond to a funds confirmation request if the international-payment-consents resource has an Authorised status. If the status is not Authorised, an ASPSP must respond with a 400 (Bad Request) and an BH.OBF.Resource.InvalidConsentStatus error code
Confirmation of funds requests do not affect the status of the international-payment-consents resource
3.3.1 State Model
3.3.1.1 Payment Order Consent
The state model for the international-payment-consents resource follows the generic consent state model.
4. Data Model
The Data Dictionary section gives the detail on the payload content for the International Payment API flows.
S.No. | Status | Status Definition |
1 | AwaitingAuthorisation | The consent resource is awaiting user/customer 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 |
4.1 Reused Classes
4.1.1 OBInternationalPaymentInitiation
This section describes the OBInternationalPaymentInitiation class which is reused as the Initiation object in the international-payment-consents resource.
4.1.1.1 UML Diagram
4.1.1.2 Notes
For the OBInternationalPaymentInitiation 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 user/customer
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-consents request immediately
If the ASPSP establishes a problem with the international-payment-consents after the API call, the ASPSP must set the Status of the international-payment-consents resource to Rejected
DebtorAccount is optional as the PISP may not know the account identification details for the user/customer
If the DebtorAccount is specified by the PISP and is invalid for the user/customer, then the international-payment-consents will be set to Rejected after user/customer 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 the "BH.OBF.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
Where the “BH.OBF.PAN” is specified as the SchemeName in the Account Identification Section (either DebtorAccount or CreditorAccount), the identification field must be populated with the full Primary Account Number - identifier scheme used to identify a card account
Where the “BH.OBF.BBAN” is specified as the SchemeName in the Account Identification Section (CreditorAccount), the identification field must be populated with the full basic bank account number (Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.)
Account/Servicer: This is the Data Type for Agent/SchemeName and used to identify the type of Identification used to identify an agent:
Where the "BH.OBF. BICFI" is specified as the SchemeName, the Identification field must be populated with the BIC (Valid BICs for financial institutions are registered by the ISO 9362 Registration Authority in the BIC directory, and consist of eight (8) or eleven (11) contiguous characters.)
Where the "BH.OBF. NCC" is specified as the SchemeName, the Identification field must be populated with the NCC (Valid NCC -National Clearing Code as an option for the accounts that don't have an IBAN, registered in the country identified by the 2 letter ISO-3166 Country code. For example, transfer to India may have Scheme Name as BH.OBF.NCC.IN and Identification can be the IFSC code of the bank/branch in India.)
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 user may wish to transfer 100USD from a BHD DebtorAccount (InstructedAmount will be 100USD), or 100BHD to an USD CreditorAccount (the InstructedAmount will be 100BHD.)
The CurrencyOfTransfer is used to specify the currency the funds will be transferred i.e., a user/customer may wish to transfer 100BHD from a BH 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 OBInternationalPaymentInitiation /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 user/customer 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 BHD and CurrencyOfTransfer is USD, then ExchangeRate will be 2.65 (USD to 1 BHD)
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
4.1.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBInternationalPaymentInitiation |
| OBInternationalPaymentInitiation | 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 International Payment | OBInternationalPaymentInitiation |
|
|
InstructionIdentification | 1..1 | OBInternationalPaymentInitiation/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 | String |
|
|
EndToEndIdentification | 0..1 | OBInternationalPaymentInitiation/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 | String |
|
|
LocalInstrument | 0..1 | OBInternationalPaymentInitiation/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 | String | Enum:
|
|
InstructionPriority | 0..1 | OBInternationalPaymentInitiation/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 | String | Enum:
|
|
Purpose | 0..1 | OBInternationalPaymentInitiation/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 | String |
|
|
ExtendedPurpose | 0..1 | OBInternationalPaymentInitiation/ExtendedPurpose | Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes | String |
|
|
ChargeBearer | 0..1 | OBInternationalPaymentInitiation/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction | String | Enum:
|
|
CurrencyOfTransfer | 1..1 | OBInternationalPaymentInitiation/CurrencyOfTransfer | Specifies the currency to be transferred amount, which is different from the currency of the debtor's account | String |
| ^[A-Z]{3,3}$ |
DestinationCountryCode | 0..1 | OBInternationalPaymentInitiation/DestinationCountryCode | Country in which Credit Account is domiciled. Nation with its own government | String |
| ^[A-Z]{2,2}$ |
InstructedAmount | 1..1 | OBInternationalPaymentInitiation/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 | OBInternationalPaymentInitiation/InstructedAmount |
|
|
Amount | 1..1 | OBInternationalPaymentInitiation/InstructedAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBInternationalPaymentInitiation/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" | String |
| ^[A-Z]{3,3}$ |
ExchangeRateInformation | 0..1 | OBInternationalPaymentInitiation/ExchangeRateInformation | Provides details on the currency exchange rate and contract | OBInternationalPaymentInitiation/ExchangeRateInformation |
|
|
UnitCurrency | 1..1 | OBInternationalPaymentInitiation/ExchangeRateInformation/UnitCurrency | Currency in which the rate of exchange is expressed in a currency exchange. In the example 1 CUR = xxxBHD, the unit currency is BHD | String |
| ^[A-Z]{3,3}$ |
ExchangeRate | 0..1 | OBInternationalPaymentInitiation/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 | Number |
|
|
RateType | 1..1 | OBInternationalPaymentInitiation/ExchangeRateInformation/RateType | Specifies the type used to complete the currency exchange | String | Enum:
|
|
ContractIdentification | 0..1 | OBInternationalPaymentInitiation/ExchangeRateInformation/ContractIdentification | Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent | String |
|
|
DebtorAccount | 0..1 | OBInternationalPaymentInitiation/DebtorAccount | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction | OBInternationalPaymentInitiation/DebtorAccount |
|
|
SchemeName | 1..1 | OBInternationalPaymentInitiation/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 1..1 | OBInternationalPaymentInitiation/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner | String |
|
|
Name | 0..1 | OBInternationalPaymentInitiation/DebtorAccount/Name | The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP’s online channels. Note, the account name is not the product name or the nickname of the account | String |
|
|
Creditor | 0..1 | OBInternationalPaymentInitiation/Creditor | Party to which an amount of money is due | OBInternationalPaymentInitiation/Creditor |
|
|
Name | 0..1 | OBInternationalPaymentInitiation/Creditor/Name | Name by which a party is known and which is usually used to identify that party | String |
|
|
PostalAddress | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services | OBInternationalPaymentInitiation/Creditor/PostalAddress |
|
|
AddressType | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/AddressType | Identifies the nature of the postal address | String | Enum:
|
|
Department | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/Department | Identification of a division of a large organisation or building | String |
|
|
SubDepartment | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building | String |
|
|
AddressLine | 0..7 | OBInternationalPaymentInitiation/CreditorPostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text | String |
|
|
StreetName | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/StreetName | Name of a street or thoroughfare | String |
|
|
BuildingNumber | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street | String |
|
|
PostCode | 0..1 | OBInternationalPaymentInitiation/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 | String |
|
|
TownName | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government | String |
|
|
CountrySubDivision | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, country | String |
|
|
Country | 0..1 | OBInternationalPaymentInitiation/Creditor/PostalAddress/Country | Nation with its own government | String |
| ^[A-Z]{2,2}$ |
CreditorAgent | 0..1 | OBInternationalPaymentInitiation/CreditorAgent | Financial institution servicing an account for the creditor | OBInternationalPaymentInitiation/CreditorAgent |
|
|
SchemeName | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/Identification | Unique and unambiguous identification of a financial institution or a branch of a financial institution | String |
|
|
Name | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/Name | Name by which an agent is known and which is usually used to identify that agent | String |
|
|
PostalAddress | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress |
|
|
AddressType | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/AddressType | Identifies the nature of the postal address | String | Enum:
|
|
Department | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building | String |
|
|
SubDepartment | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building | String |
|
|
AddressLine | 0..7 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text | String |
|
|
StreetName | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/StreetName | Name of a street or thoroughfare | String |
|
|
BuildingNumber | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street | String |
|
|
PostCode | 0..1 | OBInternationalPaymentInitiation/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 | String |
|
|
TownName | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government | String |
|
|
CountrySubDivision | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, country | String |
|
|
Country | 0..1 | OBInternationalPaymentInitiation/CreditorAgent/PostalAddress/Country | Nation with its own government | String |
| ^[A-Z]{2,2}$ |
CreditorAccount | 1..1 | OBInternationalPaymentInitiation/CreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction | OBInternationalPaymentInitiation/CreditorAccount |
|
|
SchemeName | 1..1 | OBInternationalPaymentInitiation/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 1..1 | OBInternationalPaymentInitiation/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner | String |
|
|
Name | 1..1 | OBInternationalPaymentInitiation/CreditorAccount/Name | The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account | String |
|
|
RemittanceInformation | 0..1 | OBInternationalPaymentInitiation/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 | OBInternationalPaymentInitiation/RemittanceInformation |
|
|
RemittanceDescription | 0..1 | OBInternationalPaymentInitiation/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 | String |
|
|
Reference | 0..1 | OBInternationalPaymentInitiation/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 | String |
|
|
SupplementaryData | 0..1 | OBInternationalPaymentInitiation/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block | OBSupplementaryData |
|
|
4.1.2 OBExchangeRateResponse (Reused Classes)
This section describes the OBExchangeRateResponse class, which is used in the response payloads in the international-payment-consents resource.
4.1.2.1 UML Diagram
4.1.2.2 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBExchangeRateResponse |
| OBExchangeRateResponse | Further detailed information on the exchange rate that has been used in the payment transaction | OBExchangeRateResponse |
|
|
UnitCurrency | 1..1 | OBExchangeRateResponse/UnitCurrency | Currency in which the rate of exchange is expressed in a currency exchange. In the example 1CUR = xxxBHD, the unit currency is BHD | String |
| ^[A-Z]{3,3}$ |
ExchangeRate | 1..1 | OBExchangeRateResponse/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 | Number |
|
|
RateType | 1..1 | OBExchangeRateResponse/RateType | Specifies the type used to complete the currency exchange | String | Enum:
|
|
ContractIdentification | 0..1 | OBExchangeRateResponse/ContractIdentification | Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent | String |
|
|
ExpirationDateTime | 0..1 | OBExchangeRateResponse/ExpirationDateTime | Specified date and time the exchange rate agreement will expire | DateTime |
|
|
4.2 International Payment Consent - Request
The OBWriteInternationalConsent object will be used for the call to:
POST /international-payment-consents
4.2.1 UML Diagram
4.2.2 Notes
The international-payment-consents request contains these objects:
Initiation
Authorisation
SCASupportData
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-consents request if the specified Initiation/ExchangeRateInformation cannot be fulfilled
4.3.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalConsent |
| OBWriteInternationalConsent |
| OBWriteInternationalConsent |
|
|
Data | 1..1 | OBWriteInternationalConsent/Data |
| OBWriteInternationalConsent/Data |
|
|
ReadRefundAccount | 0..1 | OBWriteInternationalConsent/Data/ReadRefundAccount | Specifies to share the refund account details with PISP | String | Enum
|
|
Initiation | 1..1 | OBWriteInternationalConsent/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 International Payment | OBInternationalPaymentInitiation |
|
|
Authorisation | 0..1 | OBWriteInternationalConsent/Data/Authorisation | The authorisation type request from the PISP | OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteInternationalConsent/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption. | OBSCASupportData |
|
|
Risk | 1..1 | OBWriteInternationalConsent/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 | OBRisk |
|
|
4.3 International Payment Consent - Response
The OBWriteInternationalConsentResponse object will be used for a response to a call to:
POST /international-payment-consents
GET /international-payment-consents/{ConsentId}
4.3.1 UML Diagram
4.3.2 Notes
The international-payment-consents response contains the full original payload from the international-payment-consents request with the additional elements below:
ConsentId
CreationDateTime the international-payment-consents resource was created
Status and StatusUpdateDateTime of the international-payment-consents resource
CutOffDateTime Behaviour is explained in Payment Initiation API Profile
ExpectedExecutionDateTime for the international-payments 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 user/customer authorisation)
ExpectedSettlementDateTime for the international-payments 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 user/customer authorisation)
Charges array which will be used by the ASPSP to indicate charges, and the ChargeBearer as relevant
Post successful user/customer Authentication, an ASPSP may provide Debtor/Name in the Payment Order Consent Response, even when the user/customer did not provide the Debtor Account via PISP
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-payments request if the PISP does not submit the international-payments 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 is the market rate on the date of execution (date on which the DebtorAccount is debited)
4.3.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteInternationalConsentResponse |
| OBWriteInternationalConsentResponse |
| OBWriteInternationalConsentResponse |
|
|
Data | 1..1 | OBWriteInternationalConsentResponse/Data |
| OBWriteInternationalConsentResponse/Data |
|
|
ConsentId | 1..1 | OBWriteInternationalConsentResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource | String |
|
|
CreationDateTime | 1..1 | OBWriteInternationalConsentResponse/Data/CreationDateTime | Date and time at which the resource was created | DateTime |
|
|
Status | 1..1 | OBWriteInternationalConsentResponse/Data/Status | Specifies the status of consent resource in code form | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteInternationalConsentResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated | DateTime |
|
|
ReadRefundAccount | 0..1 | OBWriteInternationalConsent/Data/ReadRefundAccount | Specifies to share the refund account details with PISP | String | Enum:
|
|
CutOffDateTime | 0..1 | OBWriteInternationalConsentResponse/Data/CutOffDateTime | Specified cut-off date and time for the payment consent | DateTime |
|
|
ExpectedExecutionDateTime | 0..1 | OBWriteInternationalConsentResponse/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource | DateTime |
|
|
ExpectedSettlementDateTime | 0..1 | OBWriteInternationalConsentResponse/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource | DateTime |
|
|
Charges | 0..n | OBWriteInternationalConsentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation | OBWriteInternationalConsentResponse/Data/Charges |
|
|
ChargeBearer | 1..1 | OBWriteInternationalConsentResponse/Data/Charges/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction | String | Enum:
|
|
Type | 1..1 | OBWriteInternationalConsentResponse/Data/Charges/ Type | Charge type, in a coded form | String |
|
|
Amount | 1..1 | OBWriteInternationalConsentResponse/Data/Charges/Amount | Amount of money associated with the charge type | OBWriteInternationalConsentResponse/Data/Charges/Amount |
|
|
Amount | 1..1 | OBWriteInternationalConsentResponse/Data/Charges/Amount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | String |
| ^\d{1,13}$\|^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBWriteInternationalConsentResponse/Data/Charges/Amount/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 | String |
| ^[A-Z]{3,3}$ |
ExchangeRateInformation | 0..1 | OBWriteInternationalConsentResponse/Data/ExchangeRateInformation | Further detailed information on the exchange rate that has been used in the payment transaction | OBExchangeRateResponse |
|
|
Initiation | 1..1 | OBWriteInternationalConsentResponse/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 International Payment | OBInternationalPaymentInitiation |
|
|
Authorisation | 0..1 | OBWriteInternationalConsentResponse/Data/Authorisation | The authorisation type request from the PISP | OBAuthorisation |
|
|
SCASupportData | 0..1 | OBWriteInternationalConsentResponse/Data/SCASupportData | Supporting Data provided by PISP, when requesting SCA Exemption | OBSCASupportData |
|
|
Debtor | 0..1 | OBWriteInternationalConsentResponse/Data/Debtor | Set of elements used to identify a person or an organisation | OBWriteInternationalConsentResponse/Data/Debtor |
|
|
Name | 1..1 | OBWriteInternationalConsentResponse/Data/Debtor/Name | The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP’s online channels | String |
|
|
Risk | 1..1 | OBWriteInternationalConsentResponse/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 | OBRisk |
|
|
4.4 International Payment Consent Confirmation of Funds - Response
The OBWriteFundsConfirmationResponse object will be used for a response to a call to:
GET /international-payment-consents/{ConsentId}/funds-confirmation
4.4.1 UML Diagram
4.4.2 Notes
The confirmation of funds response contains the result of a funds availability check, or SupplementaryData
4.4.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBWriteFundsConfirmationResponse |
| OBWriteFundsConfirmationResponse |
| OBWriteFundsConfirmationResponse |
|
|
Data | 1..1 | OBWriteFundsConfirmationResponse/Data |
| OBWriteFundsConfirmationResponse/Data |
|
|
FundsAvailableResult | 0..1 | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult | Result of a funds availability check | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult |
|
|
FundsAvailableDateTime | 1..1 | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult/FundsAvailableDateTime | Date and time at which the funds availability check was generated | DateTime |
|
|
FundsAvailable | 1..1 | OBWriteFundsConfirmationResponse/Data/FundsAvailableResult/FundsAvailable | Flag to indicate the availability of funds given the Amount in the consent request | Boolean |
|
|
SupplementaryData | 0..1 | OBWriteFundsConfirmationResponse/Data/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block | OBSupplementaryData |
|
|
5. Usage Examples
5.1 POST /international-payment-consents
5.1.1 Request
|
|
5.1.2 Response
|
|
5.2 GET / international-payment-consents/{ConsentId}/funds-confirmation
5.2.1 Request
|
4.2.2 Response
|
|
CENTRAL BANK OF BAHRAIN © 2020