Table of Contents |
---|
...
4.1.1.1 UML Diagram
...
4.1.1.2 Data Dictionary
Name | Occurrence | Xpath | Enhanced Definition | Class | Codes | Pattern | |||||||||||||
OBRisk |
| OBRisk | 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 |
|
| |||||||||||||
PaymentContextCode | 0..1 | OBRisk/PaymentContextCode | Specifies the payment context | Stirng | Enum:
|
| |||||||||||||
MerchantCategoryCode | 0..1 | OBRisk/MerchantCategoryCode | Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. | String |
|
| |||||||||||||
MerchantCustomerIdentification | 0..1 | OBRisk/MerchantCustomerIdentification | The unique customer identifier of the PSU with the merchant | String |
|
| |||||||||||||
DeliveryAddress | 0..1 | OBRisk/DeliveryAddress | Information that locates and identifies a specific address, as defined by postal services or in free format text. | OBRisk/DeliveryAddress |
|
| |||||||||||||
AddressLine | 0..27 | OBRisk/DeliveryAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, which is presented in free format text. | String |
|
| |||||||||||||
StreetNameBuildingNumber | 0..1 | OBRisk/DeliveryAddress/StreetNameName BuildingNumber | Number that identifies the position of a building on a street. | String |
|
| |||||||||||||
RoadNumber | 0..1 | OBRisk/DeliveryAddress/RoadNumber | Number of a road or thoroughfare. | String |
|
| |||||||||||||
BuildingNumberBlockNumber | 0..1 | OBRisk/DeliveryAddress/BuildingNumberBlockNumber | Number that identifies the position of a building on block in a streetcity. | String |
|
| |||||||||||||
PostCodeCity | 0..1 | OBRisk/DeliveryAddress/PostCodeCity | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.Name of the city | String |
|
| |||||||||||||
TownNameCountry | 10..1 |
| Name of a built-up area, with defined boundaries, and a local government. | String |
|
| CountrySubDivision | 0..2 | OBRisk/DeliveryAddress/CountrySubDivision | Identifies a subdivision of a country, for instance state, region, county.String |
|
| Country | 1..1 | OBRisk/DeliveryAddress/CountryNation Country |
| String |
|
|
...
Name | Occurrence | Xpath | Enhanced Definition | Class | Codes | Pattern |
OBCharge |
| OBCharge | Set of elements used to provide details of a charge for the payment initiation. | OBCharge |
|
|
ChargeBearer | 1..1 | OBCharge/ChargeBearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. | String | Enum:
|
|
Type | 1..1 | OBCharge/Type | Charge type, in a coded form. | String | Enum: · To be determined
|
|
Amount | 1..1 | OBCharge/Amount | Amount of money associated with the charge type. | OBActiveOrHistoricCurrencyAndAmount |
|
|
Amount | 1..1 | OBCharge/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,5}$ |
Currency | 1..1 | OBCharge/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}$ |
...
This section describes the OBInternationalRefundAccount class which is used in the response payloads of International Payment, International Future Dated Payment and International Standing Order.
4.1.5.1 UML Diagram
...
4.1.5.2 Data Dictionary
Name | Occurrence | Xpath | Enhanced Definition | 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 |
|
| |||||||||
StreetNameAddressLine | 0..17 | OBInternationalRefundAccount/Creditor/PostalAddress/StreetName | Name of a street or thoroughfare. | String | AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
| ||||||
BuildingNumber | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/BuildingNumber | Number that identifies the position of a building on a streetNumber that identifies the position of a building on a street. | String |
|
| |||||||||
PostCodeRoadNumber | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mailRoadNumber | Number of a road or thoroughfare. | String |
|
| |||||||||
TownNameBlockNumber | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/TownNameName of a built-up area, with defined boundaries, and a local governmentBlockNumber | Number that identifies the position of a block in a city. | String |
|
| |||||||||
CountrySubDivisionCity | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/CountrySubDivisionIdentifies a subdivision of a country such as state, region, county.City | Name of the city | String |
|
| |||||||||
Country | 0..1 | OBInternationalRefundAccount/Creditor/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ | |||||||||
AddressLineAgent | 0..71 | Agent | 0..1 | OBInternationalRefundAccount/Agent | Financial institution servicing an account for the creditor. | OBInternationalRefundAccount/Creditor/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
| 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 |
|
| |||||||||
StreetNameAddressLine | 0..17 | OBInternationalRefundAccount/Agent/PostalAddress/StreetNameName of a street or thoroughfareAddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | String |
|
| |||||||||
BuildingNumber | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a streetNumber that identifies the position of a building on a street. | String |
|
| |||||||||
PostCodeRoadNumber | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mailRoadNumber | Number of a road or thoroughfare. | String |
|
| |||||||||
TownNameBlockNumber | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/TownNameName of a built-up area, with defined boundaries, and a local governmentBlockNumber | Number that identifies the position of a block in a city. | String |
|
| |||||||||
CountrySubDivisionCity | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/CountrySubDivisionIdentifies a subdivision of a country such as state, region, county.City | Name of the city | String |
|
| |||||||||
Country | 0..1 | OBInternationalRefundAccount/Agent/PostalAddress/Country | Nation with its own government. | String |
| ^[A-Z]{2,2}$ | 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 |
|
| ||
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. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. | String |
|
| |||||||||
SecondaryIdentification | 0..1 | OBInternationalRefundAccount/Account/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | String |
|
|
...
The standard definitions for the elements in the API payloads are described in the Data Payload section. However, this table gives further detail on the business meaning, and how they are used.
Generated | Identifier | Business Description |
Merchant/PISP Sent in API Payload | EndToEndIdentification | The EndToEndIdentification reference is a reference that can be populated by the debtor (or merchant in the ecommerce space). This reference is important to the debtor (could be an internal reference Id against the transaction), it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary). |
Merchant/PISP Sent in API Payload | InstructionIdentification | The PISP generates the InstructionIdentification which is a unique transaction Id and passes it to the ASPSP (this is mandatory), but this does not have to go any further in the payment flow. The flow of this identifier needs to align with payment scheme rules. The expectation is that this is unique indefinitely across all time periods. The PISP can ensure this is indefinitely unique by including a date or date time element to the field, or by inserting a unique Id. |
Merchant/PISP Sent in API Payload | RemittanceInformation | The RemittanceInformation is the reference information that the creditor (or beneficiary) will need to reconcile (e.g. Invoice 123). |
ASPSP / API System | ConsentId | A unique identification as assigned by the ASPSP to uniquely identify the payment-order consent resource. |
ASPSP / API System | Payment Order Id | A unique identification as assigned by the ASPSP to uniquely identify the payment-order resource.
|
ASPSP / Payment Scheme | Scheme Payment ID | This is generated by the ASPSP to uniquely identify a payment through a processing scheme. |
4.3. Enumerations
4.3.1 Static Enumerations
...