...
This section describes the OBInternationalRefundAccount class which is used in the response payloads of International Payment.
4.3.1 UML Diagram
...
4.3.2 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 |
|
|
...
ConsentId
The full Initiation and Risk objects from the international-payments request
The Initiation and Risk sections of the international-payments request must match the Initiation and Risk sections of the corresponding international-payment-consents request
4.
...
4.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class | Codes | Pattern |
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 |
|
|
...