...
Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
international-payments | POST | POST /international-payments | Conditional | payments | Authorization Authorisation Code | Signed Request Signed Response | Yes | OBWriteInternational | OBWriteInternationalPaymentResponse |
international-payments | GET | GET /international-payments/{InternationalPaymentId} | Mandatory (if resource POST implemented) | payments | Client Credentials | Signed Response | No | NA | OBWriteInternationaPaymentlResponse |
payment-details | GET | GET /international-payments/{InternationalPaymentId}/payment-details | Optional | payments | Client Credentials | Signed Response | No | NA | OBWritePaymentDetailsResponse |
...
The OBExchangeRateResponse class is defined in the international-payment-consents page.
3.
...
The OBWriteInternational object will be used for a call to:
POST /international-payments
3.2.1 UML Diagram
...
3.2.2 Notes
1.3 OBInternationalRefundAccount
This section describes the OBInternationalRefundAccount class which is used in the response payloads of International Payment and International Future Dated Payment.
3.1.3.1 UML Diagram
...
3.1.3.1 Data Dictionary
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
OBInternationalRefundAccount | OBInternationalRefundAccount | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction | OBInternationalRefundAccount | |||
Creditor | 0..1 | OBInternationalRefundAccount/Creditor | Party to which an amount of money is due | OBInternationalRefundAccount/Creditor | ||
Name | 0..1 | OBInternationalRefundAccount/Creditor/Name | Name by which a party is known and which is usually used to identify that party | String | ||
PostalAddress | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress | Information that locates and identifies a specific address, as defined by postal services | OBPostalAddress | ||
AddressType | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/AddressType | Identifies the nature of the postal address | String | Enum:
| |
Department | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/Department | Identification of a division of a large organisation or building | String | ||
SubDepartment | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building | String | ||
AddressLine | 0..7 | OBInternationalRefundAccount/Creditor/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/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}$ | |
Agent | 0..1 | OBInternationalRefundAccount/Agent | Financial institution servicing an account for the creditor | OBInternationalRefundAccount/Agent | ||
SchemeName | 0..1 | OBInternationalRefundAccount/Agent/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
| |
Identification | 0..1 | OBInternationalRefundAccount/Agent/Identification | Unique and unambiguous identification of a financial institution or a branch of a financial institution | String | ||
Name | 0..1 | OBInternationalRefundAccount/Agent/Name | Name by which an agent is known and which is usually used to identify that agent | String | ||
PostalAddress | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services | OBPostalAddress | ||
AddressType | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/AddressType | Identifies the nature of the postal address | String | Enum:
| |
Department | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/Department | Identification of a division of a large organisation or building | String | ||
SubDepartment | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building | String | ||
AddressLine | 0..7 | OBInternationalRefundAccount/Agent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text | String | ||
StreetName | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/StreetName | Name of a street or thoroughfare | String | ||
BuildingNumber | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street | String | ||
PostCode | 0..1 | OBInternationalRefundAccount/Agent/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 | OBInternationalRefundAccount/Agent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government | String | ||
CountrySubDivision | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, country | String | ||
Country | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/Country | Nation with its own government | String | ^[A-Z]{2,2}$ | |
Account | 1..1 | OBInternationalRefundAccount/Account | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction | OBInternationalRefundAccount/Account | ||
SchemeName | 1..1 | OBInternationalRefundAccount/Account/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
| |
Identification | 1..1 | OBInternationalRefundAccount/Account/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner | String | ||
Name | 1..1 | OBInternationalRefundAccount/Account/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 |
3.2 International Payment - Request
The OBWriteInternational object will be used for a call to:
POST /international-payments
3.2.1 UML Diagram
...
3.2.2 Notes
The international-payment request object contains the:
...
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern | |
OBWriteInternational | OBWriteInternational |
| OBWriteInternational | OBWriteInternational |
|
| |
Data | 1..1 | OBWriteInternational/Data |
| OBWriteInternational/Data |
|
| |
ConsentId | 1..1 | OBWriteInternational/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
| |
Initiation | 1..1 | OBWriteInternational/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 |
|
| |
Risk | 1..1 | OBWriteInternational/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 |
|
|
...
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
OBWriteInternationalPaymentResponse |
| OBWriteInternationalPaymentResponse |
| OBWriteInternationalPaymentResponse |
|
|
Data | 1..1 | OBWriteInternationalPaymentResponse/Data |
| OBWriteInternationalPaymentResponse/Data |
|
|
InternationalPaymentId | 1..1 | OBWriteInternationalPaymentResponse/Data/InternationalPaymentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource. | String |
|
|
ConsentId | 1..1 | OBWriteInternationalPaymentResponse/Data/ConsentId | OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. | String |
|
|
CreationDateTime | 1..1 | OBWriteInternationalPaymentResponse/Data/CreationDateTime | Date and time at which the message was created. | DateTime |
|
|
Status | 1..1 | OBWriteInternationalPaymentResponse/Data/Status | Specifies the status of the payment information group. | String | Enum:
|
|
StatusUpdateDateTime | 1..1 | OBWriteInternationalPaymentResponse/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
|
ExpectedExecutionDateTime | 0..1 | OBWriteInternationalPaymentResponse/Data/ExpectedExecutionDateTime | Expected execution date and time for the payment resource. | DateTime |
|
|
ExpectedSettlementDateTime | 0..1 | OBWriteInternationalPaymentResponse/Data/ExpectedSettlementDateTime | Expected settlement date and time for the payment resource. | DateTime |
|
|
Refund | 0..1 | OBWriteInternationalPaymentResponse/Data/Refund | Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. | OBInternationalRefundAccount |
|
|
Charges | 0..n | OBWriteInternationalPaymentResponse/Data/Charges | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
ExchangeRateInformation | 0..1 | OBWriteInternationalPaymentResponse/Data/ExchangeRateInformation | Further detailed information on the exchange rate that has been used in the payment transaction. | OBExchangeRateResponse |
|
|
Initiation | 1..1 | OBWriteInternationalPaymentResponse/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 |
|
|
Debtor | 0..1 | OBWriteInternationalPaymentResponse/Data/Debtor | Set of elements used to identify a person or an organisation. | OBWriteInternationalPaymentResponse/Data/Debtor |
|
|
Name | 1..1 | OBWriteInternationalPaymentResponse/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. Note: The account name is not the product name or the nickname of the accountthe ASPSP's online channels. | String |
|
|
3.4 International Payment Order –Payment Details - Response
...
|
| TO_BE_DETERMINED
|
| ": {
|
| Building 152
|
| Bahrain
|
|
|
| Department
| TO_BE_CONFIRMED",
| Building 10952
|
| Bahrain
| "
|
|
| Building 152
|
| Bahrain
| }
|
|
4.1.2 Response
|
| 575Z
| 575Z
| 575Z
| 575Z
| ",
|
| Building 152
|
|
| Bahrain
|
|
|
| Building 10952
|
| Bahrain
| "
| 598Z
| TO_BE_DETERMINED
|
|
|
|
| Building 152
|
| Bahrain
|
| "Department
| TO_BE_CONFIRMED",
| Bahrain
| 596Z
| 596Z
|