...
2.1
1. Version Control
...
Version
...
Date
...
Description of Changes
...
Bahrain OBF v1.0.0
...
25th Aug 2020
...
Initial Release
2. Overview
The International Payment Consent resource is used by a PISP to register an intent to initiate an International Future dated Payment.
This resource description should be read in conjunction with a compatible Payment Initiation API Profile.
3. Endpoints
Endpoints for the resources are defined below
...
S. No.
...
Resource
...
HTTP Operation
...
Endpoint
...
Mandatory
...
Scope
...
Grant Type
...
Message Signing
...
Idempotency Key
...
Request Object
...
Response Object
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 25th Aug 2020 | Initial Release |
2. Overview
The International Payment Consent resource is used by a PISP to register an intent to initiate an International Future dated Payment.
This resource description should be read in conjunction with a compatible Payment Initiation API Profile.
3. Endpoints
Endpoints for the resources are defined below
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
2.1 | international-future-dated-payment-consents | POST | POST /international-future-dated-payment-consents | Conditional | payments | Client Credentials | Signed Request Signed Response | Yes | OBWriteInternationalFutureDatedConsent | OBWriteInternationalFutureDatedConsentResponse |
2.2 | international-future-dated-payment-consents | GET | GET /international-future-dated-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationalFutureDatedConsentResponse |
2.3 | international-future-dated-payment-consents | GET | GET /international-future-dated-payment-consents/{ConsentId}/funds-confirmation | Optional | payments | Authorization Code | Signed Response | No | NA | OBWriteFundsConfirmationResponse |
3.1 POST/international-future-dated-payment-consents
The API endpoint allows the PISP to ask an ASPSP to create a new international-future-dated-payment-consent resource.
The POST action indicates to the ASPSP that a payment consent 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-future-dated-payment-consent 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-future-dated-payment-consent has been created.
Status |
AwaitingAuthorisation |
3.2 GET /international- future-dated-payment-consents /{ConsentId}
A PISP can optionally retrieve a payment consent resource that they have created to check its status.
3.2.1 Status
Once the user/customer authorises the payment-consent resource, the Status of the payment-consent resource will be updated with "Authorised".
If the user/customer rejects the consent or the international-future-dated-payment-consent has failed some other ASPSP validation, the Status will be set to "Rejected".
Once an international-future-dated-payment has been successfully created using the international-future-dated-payment-consent, the Status of the international-future-dated-payment-consent will be set to "Consumed".
The available Status codes for the international-future-dated-payment-
...
POST
...
consent resource are:
Status |
AwaitingAuthorisation |
Rejected |
Authorised |
Consumed |
3.3 GET /international-future-dated-payment-consents
...
Conditional
...
payments
...
Client Credentials
...
Signed Request Signed Response
...
Yes
...
OBWriteInternationalFutureDatedConsent
...
OBWriteInternationalFutureDatedConsentResponse
...
2.2
...
/{ConsentId}/funds-confirmation
The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-future-dated-payment-
...
GET
...
consent resource.
An ASPSP can only respond to a funds confirmation request if the international-future-dated-payment-
...
Mandatory (if resource POST implemented)
...
payments
...
Client Credentials
...
Signed Response
...
No
...
NA
...
OBWriteInternationalFutureDatedConsentResponse
...
2.3
...
consent resource has an Authorised status. If the status is not Authorised, an ASPSP must respond with a 400 (Bad Request) and a BH.OBF.Resource.InvalidConsentStatus error code.
Confirmation of funds requests do not affect the status of the international-future-dated-payment-
...
GET
...
GET /international-future-dated-payment-consents/{ConsentId}/funds-confirmation
...
Optional
...
payments
...
Authorization Code
...
Signed Response
...
No
...
NA
...
OBWriteFundsConfirmationResponse
3.1 POST/international-future-dated-payment-consents
...
consent resource.
3.4 State Model
3.4.1 Payment Order
The state model for the international-future-dated-payment-consent resource.
The POST action indicates to the ASPSP that a payment consent 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-future-dated-payment-consent resource and responds with a unique ConsentId to refer to the resource.
3.1.1 Status
The default Status is "AwaitingAuthorisation" immediately after resource follows the generic consent state model.
...
The definitions for the Status:
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. Data Model
The Data Dictionary section gives the detail on the payload content for the International Payment API flows.
Reused Classes
4.1 OBInternationalFutureDatedInititiation
This section describes the OBInternationalFutureDatedInitiation class which is reused as the Initiation object in the international-future-dated-payment-consent has been createdresource.
...
Status
...
AwaitingAuthorisation
3.2 GET /international- future-dated-payment-consents /{ConsentId}
A PISP can optionally retrieve a payment consent resource that they have created to check its status.
3.2.1 Status
Once the user/customer authorises the payment-consent resource, the Status of the payment-consent resource will be updated with "Authorised".
...
4.1.1 UML Diagram
...
4.1.2 Notes
For the OBInternationalFutureDatedInitiation 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-future-dated-payment-consent consent request immediately.
If the ASPSP establishes a problem with the international-future-dated-payment-consent
...
after the API call, the ASPSP must set the Status of the international-future-dated-payment-consent 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-future-dated-payment-consent will be set to
...
The available Status codes for the international-future-dated-payment-consent resource are:
...
Status
...
AwaitingAuthorisation
...
Rejected
...
Authorised
...
Consumed
3.3 GET /international-future-dated-payment-consents/{ConsentId}/funds-confirmation
The API endpoint allows the PISP to ask an ASPSP to confirm funds on an international-future-dated-payment-consent resource.
An ASPSP can only respond to a funds confirmation request if the international-future-dated-payment-consent resource has an Authorised status. If the status is not Authorised, an ASPSP must respond with a 400 (Bad Request) and a BH.OBF.Resource.InvalidConsentStatus error code.
Confirmation of funds requests do not affect the status of the international-future-dated-payment-consent resource.
3.4 State Model
3.4.1 Payment Order
The state model for the international-future-dated-payment-consent resource follows the generic consent state model.
...
The definitions for the Status:
...
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. Data Model
The Data Dictionary section gives the detail on the payload content for the International Payment API flows.
Reused Classes
4.1 OBInternationalFutureDatedInititiation
This section describes the OBInternationalFutureDatedInitiation class which is reused as the Initiation object in the international-future-dated-payment-consent resource.
4.1.1 UML Diagram
...
4.1.2 Notes
For the OBInternationalFutureDatedInitiation 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-future-dated-payment-consent consent request immediately.
If the ASPSP establishes a problem with the international-future-dated-payment-consent after the API call, the ASPSP must set the Status of the international-future-dated-payment-consent 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-future-dated-payment-consent will be set to Rejected after user/customer authentication.
CreditorAgent must at least have either of the pairs provided: SchemeName and Identification, or Name and PostalAddress.
Account Identification field usage:
o SchemeName is a free-text field which will be populated with identification schemes an ASPSP accepts.
o Identification is a field which is populated with the Identification of the account, using the valid identification scheme provided.
Valid Bahrain Account Identification SchemeName values include, but are not restricted to:
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 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 future dated 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 user/customer authorisation.
A PISP may indicate an exchange rate request using the RateType with these enumerations:
o Actual
o Agreed
o 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.
o 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).
o 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
...
OBInternationalFutureDatedInitiation
...
...
OBInternationalFutureDatedInitiation
...
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 future dated international payment.
...
OBInternationalFutureDatedInitiation
...
...
...
InstructionIdentification
...
1..1
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/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
...
1..1
...
OBInternationalFutureDatedInitiation/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:
· BH.OBF.SWIFT
· BH.OBF.GCCNET
...
...
InstructionPriority
...
0..1
...
OBInternationalFutureDatedInitiation/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:
· Normal
· Urgent
...
...
Purpose
...
0..1
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/ChargeBearer
...
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
...
String
...
Enum:
· BorneByCreditor
· BorneByDebtor
· FollowingServiceLevel
· Shared
...
...
RequestedExecutionDateTime
...
1..1
...
OBInternationalFutureDatedInitiation/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.
...
DateTime
...
...
...
CurrencyOfTransfer
...
1..1
...
OBInternationalFutureDatedInitiation/CurrencyOfTransfer
...
Specifies the currency of the, to be transferred amount, which is different from the currency of the debtor's account.
...
String
...
...
^[A-Z]{3,3}$
...
DestinationCountryCode
...
0..1
...
OBInternationalFutureDatedInitiation/DestinationCountryCode
...
Country in which Credit Account is domiciled. Nation with its own government.
...
String
...
...
^[A-Z]{2,2}$
...
InstructedAmount
...
1..1
...
OBInternationalFutureDatedInitiation/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.
...
OBInternationalFutureDatedInitiation/InstructedAmount
...
...
...
Amount
...
1..1
...
OBInternationalFutureDatedInitiation/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,5}$
...
Currency
...
1..1
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/ExchangeRateInformation
...
Provides details on the currency exchange rate and contract.
...
OBInternationalFutureDatedInitiation/ExchangeRateInformation
...
...
...
UnitCurrency
...
1..1
...
OBInternationalFutureDatedInitiation/ExchangeRateInformation/UnitCurrency
...
Currency in which the rate of exchange is expressed in a currency exchange. In the example 1BHD = xxxCUR, the unit currency is BHD.
...
String
...
...
^[A-Z]{3,3}$
...
ExchangeRate
...
0..1
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/ExchangeRateInformation/RateType
...
Specifies the type used to complete the currency exchange.
...
String
...
Enum:
· Actual
· Agreed
· Indicative
...
...
ContractIdentification
...
0..1
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/DebtorAccount
...
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
...
OBInternationalFutureDatedInitiation/DebtorAccount
...
...
...
SchemeName
...
1..1
...
OBInternationalFutureDatedInitiation/DebtorAccount/SchemeName
...
Name of the identification scheme, in a coded form as published in an external list.
...
String
...
Enum:
· BH.OBF.IBAN
· BH.OBF.PAN
...
...
Identification
...
1..1
...
OBInternationalFutureDatedInitiation/DebtorAccount/Identification
...
Identification assigned by an institution to identify an account. This identification is known by the account owner.
...
String
...
...
...
Name
...
0..1
...
OBInternationalFutureDatedInitiation/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
...
OBInternationalFutureDatedInitiation/Creditor
...
Party to which an amount of money is due.
...
OBInternationalFutureDatedInitiation/Creditor
...
...
...
Name
...
0..1
...
OBInternationalFutureDatedInitiation/Creditor/Name
...
Name by which a party is known and which is usually used to identify that party.
...
String
...
...
...
Rejected after user/customer authentication.
CreditorAgent must at least have either of the pairs provided: SchemeName and Identification, or Name and PostalAddress.
Account Identification field usage:
o SchemeName is a free-text field which will be populated with identification schemes an ASPSP accepts.
o Identification is a field which is populated with the Identification of the account, using the valid identification scheme provided.
Valid Bahrain Account Identification SchemeName values include, but are not restricted to:
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 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 future dated 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 user/customer authorisation.
A PISP may indicate an exchange rate request using the RateType with these enumerations:
o Actual
o Agreed
o 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.
o 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).
o 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 | |||||||||
OBInternationalFutureDatedInitiation |
| OBInternationalFutureDatedInitiation | 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 future dated international payment. | OBInternationalFutureDatedInitiation |
|
| |||||||||
InstructionIdentification | 1..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/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 | 1..1 | OBInternationalFutureDatedInitiation/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: · BH.OBF.SWIFT · BH.OBF.GCCNET |
| |||||||||
InstructionPriority | 0..1 | OBInternationalFutureDatedInitiation/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: · Normal · Urgent |
| |||||||||
Purpose | 0..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | String | Enum: · BorneByCreditor · BorneByDebtor · FollowingServiceLevel · Shared |
| |||||||||
RequestedExecutionDateTime | 1..1 | OBInternationalFutureDatedInitiation/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. | DateTime |
|
| |||||||||
CurrencyOfTransfer | 1..1 | OBInternationalFutureDatedInitiation/CurrencyOfTransfer | Specifies the currency of the, to be transferred amount, which is different from the currency of the debtor's account. | String |
| ^[A-Z]{3,3}$ | |||||||||
DestinationCountryCode | 0..1 | OBInternationalFutureDatedInitiation/DestinationCountryCode | Country in which Credit Account is domiciled. Nation with its own government. | String |
| ^[A-Z]{2,2}$ | |||||||||
InstructedAmount | 1..1 | OBInternationalFutureDatedInitiation/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. | OBInternationalFutureDatedInitiation/InstructedAmount |
|
| |||||||||
Amount | 1..1 | OBInternationalFutureDatedInitiation/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,5}$ | |||||||||
Currency | 1..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/ExchangeRateInformation | Provides details on the currency exchange rate and contract. | OBInternationalFutureDatedInitiation/ExchangeRateInformation |
|
| |||||||||
UnitCurrency | 1..1 | OBInternationalFutureDatedInitiation/ExchangeRateInformation/UnitCurrency | Currency in which the rate of exchange is expressed in a currency exchange. In the example 1BHD = xxxCUR, the unit currency is BHD. | String |
| ^[A-Z]{3,3}$ | |||||||||
ExchangeRate | 0..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/ExchangeRateInformation/RateType | Specifies the type used to complete the currency exchange. | String | Enum: · Actual · Agreed · Indicative |
| |||||||||
ContractIdentification | 0..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/DebtorAccount | Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. | OBInternationalFutureDatedInitiation/DebtorAccount |
|
| |||||||||
SchemeName | 1..1 | OBInternationalFutureDatedInitiation/DebtorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum: · BH.OBF.IBAN · BH.OBF.PAN |
| |||||||||
Identification | 1..1 | OBInternationalFutureDatedInitiation/DebtorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
| |||||||||
Name | 0..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/Creditor | Party to which an amount of money is due. | OBInternationalFutureDatedInitiation/Creditor |
|
| |||||||||
Name | 0..1 | OBInternationalFutureDatedInitiation/Creditor/Name | Name by which a party is known and which is usually used to identify that party. | String |
|
| |||||||||
PostalAddress | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBInternationalFutureDatedInitiation/Creditor/PostalAddress |
|
| |||||||||
AddressType | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/AddressType | Identifies the nature of the postal address. | String | Enum: · Business · Correspondence · DeliveryTo · MailTo · POBox · Postal · Residential · Statement |
| |||||||||
Department | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
| |||||||||
SubDepartment | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
| |||||||||
StreetName | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/StreetName | Name of a street or thoroughfare. | String |
|
| |||||||||
BuildingNumber | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | String |
|
| |||||||||
PostCode | 0..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
| |||||||
AddressTypeCountrySubDivision | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/AddressTypeCountrySubDivision | Identifies the nature of the postal addressa subdivision of a country such as state, region, and county. | String | Enum: · Business · Correspondence · DeliveryTo · MailTo · POBox · Postal · Residential · Statement |
| Department | 0..1 |
| ||||||
Country | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ | |||||||||
AddressLine | 0..7 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/DepartmentIdentification of a division of a large organisation or buildingAddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
| |||||||||
SubDepartmentCreditorAgent | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | StringCreditorAgent | Financial institution servicing an account for the creditor. | OBInternationalFutureDatedInitiation/CreditorAgent |
|
| |||||||
StreetNameSchemeName | 0..1 | OBInternationalFutureDatedInitiation/CreditorCreditorAgent/PostalAddress/StreetNameSchemeName | Name of a street or thoroughfare.Stringthe identification scheme, in a coded form as published in an external list. | OBInternationalFutureDatedInitiation/CreditorAgent/SchemeName | Enum: · BH.OBF.BICFI · BH.OBF.NCC
|
| |||||||||
BuildingNumberIdentification | 0..1 | OBInternationalFutureDatedInitiation/CreditorCreditorAgent/PostalAddress/BuildingNumberNumber that identifies the position of a building on a streetIdentification | Unique and unambiguous identification of a financial institution or a branch of a financial institution. | String |
|
| |||||||||
PostCodeName | 0..1 | OBInternationalFutureDatedInitiation/CreditorCreditorAgent/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mailName | Name by which an agent is known and which is usually used to identify that agent. | String |
|
| |||||||||
TownNamePostalAddress | 0..1 | OBInternationalFutureDatedInitiation/CreditorCreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String | Information that locates and identifies a specific address, as defined by postal services. | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress |
|
| |||||||
CountrySubDivisionAddressType | 0..1 | OBInternationalFutureDatedInitiation/CreditorCreditorAgent/PostalAddress/CountrySubDivisionAddressType | Identifies a subdivision of a country such as state, region, and countythe nature of the postal address. | String |
|
| |||||||||
Country | 0..1 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ | |||||||||
AddressLine | 0..7 | OBInternationalFutureDatedInitiation/Creditor/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text | Enum: · Business · Correspondence · DeliveryTo · MailTo · POBox · Postal · Residential · Statement |
| ||||||||||
Department | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building. | String |
|
| |||||||||
CreditorAgentSubDepartment | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent | Financial institution servicing an account for the creditor. | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | String |
|
| |||||||
SchemeNameStreetName | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/SchemeNamePostalAddress/StreetName | Name of the identification scheme, in a coded form as published in an external list. | OBInternationalFutureDatedInitiation/CreditorAgent/SchemeName | Enum: · BH.OBF.BICFI · BH.OBF.NCC a street or thoroughfare. | String |
|
| |||||||
IdentificationBuildingNumber | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/IdentificationUnique and unambiguous identification of a financial institution or a branch of a financial institutionBuildingNumber | Number that identifies the position of a building on a street. | String |
|
| |||||||||
NamePostCode | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/NameName by which an agent is known and which is usually used to identify that agentPostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. | String |
|
| |||||||||
PostalAddressTownName | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
| |||||||
AddressTypeCountrySubDivision | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/AddressTypeCountrySubDivision | Identifies the nature of the postal addressa subdivision of a country such as state, region, and county. | String | Enum: | · Business · Correspondence · DeliveryTo · MailTo · POBox · Postal · Residential · Statement |
| ||||||||
DepartmentCountry | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ | |||||||||
AddressLine | 0..17 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building. | StringAddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | Max7 String 0Text |
|
| |||||||
SubDepartmentCreditorAccount | 01..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | StringCreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. | OBInternationalFutureDatedInitiation/CreditorAccount |
|
| |||||||
StreetNameSchemeName | 01..1 | OBInternationalFutureDatedInitiation/CreditorAgentCreditorAccount/PostalAddress/StreetNameSchemeName | Name of a street or thoroughfarethe identification scheme, in a coded form as published in an external list. | String | Enum: · BH.OBF.IBAN · BH.OBF.BBAN |
| |||||||||
BuildingNumberIdentification | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street1..1 | OBInternationalFutureDatedInitiation/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
| |||||||
PostCodeName | 01..1 | OBInternationalFutureDatedInitiation/CreditorAgentCreditorAccount/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mailName | 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 |
|
| |||||||||
TownNameRemittanceInformation | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | String |
|
| CountrySubDivision | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, and county. | StringRemittanceInformation | 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. | OBInternationalFutureDatedInitiation/RemittanceInformation |
|
|
CountryRemittanceDescription | 0..1 | OBInternationalFutureDatedInitiation/CreditorAgent/PostalAddress/CountryNation with its own governmentRemittanceInformation/RemittanceDescription | 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 |
| ^[A-Z]{2,2}$ | AddressLine | ||||||||
Reference | 0..71 | OBInternationalFutureDatedInitiation/CreditorAgentRemittanceInformation/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | Max7 String 0Text |
|
| |||||||||
CreditorAccount | 1..1 | OBInternationalFutureDatedInitiation/CreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. | OBInternationalFutureDatedInitiation/CreditorAccount |
|
| |||||||||
SchemeName | 1Reference | 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 | OBInternationalFutureDatedInitiation/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum: · BH.OBF.IBAN · BH.OBF.BBAN |
| |||||||||
Identification | 1..1 | OBInternationalFutureDatedInitiation/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
| |||||||||
Name | 1..1 | OBInternationalFutureDatedInitiation/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 | OBInternationalFutureDatedInitiation/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. | OBInternationalFutureDatedInitiation/RemittanceInformation |
|
| |||||||||
RemittanceDescription | 0..1 | OBInternationalFutureDatedInitiation/RemittanceInformation/RemittanceDescription | 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 | OBInternationalFutureDatedInitiation/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 identificationSupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryData |
|
|
4.2 OBExchangeRateResponse
This section describes the OBExchangeRateResponse class, which is used in the response payloads in the international-future-dated-payment-consent resource.
4.2.1 UML Diagram
...
II. Data Dictionary
Name | Occurrence | XPath | 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 1BHD = xxxCUR, 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: · Actual · Agreed · Indicative |
| ||
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 |
|
| ||
SupplementaryDataExpirationDateTime | 0..1 | OBInternationalFutureDatedInitiationOBExchangeRateResponse/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block. | OBSupplementaryDataExpirationDateTime | Specified date and time the exchange rate agreement will expire. | DateTime |
|
|
C. International Future dated Payment Consent - Request
The OBWriteInternationalFutureDatedConsent object will be used for the call to:
POST /international-future-dated-payment-consents.
I. UML Diagram