...
The resource requires the ReadOffers permission. The resource response payload does not differ depending on the permissions granted.
4.1.5 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBReadOffer |
| OBReadOffer |
| OBReadOffer |
| |
Data | 1..1 | OBReadOffer/Data |
| OBReadOffer/Data |
| |
Offer | 0..n | OBReadOffer/Data/Offer |
| OBReadOffer/Data/Offer |
| |
AccountId | 1..1 | OBReadOffer/Data/Offer/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner | String |
| |
OfferId | 0..1 | OBReadOffer/Data/Offer/OfferId | A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner | String |
| |
OfferType | 0..1 | OBReadOffer/Data/Offer/OfferType | Offer type, in a coded form | String |
| |
Description | 0..1 | OBReadOffer/Data/Offer/Description | Further details of the offer | String |
| |
StartDateTime | 0..1 | OBReadOffer/Data/Offer/StartDateTime | Date and time at which the offer starts | DateTime |
| |
EndDateTime | 0..1 | OBReadOffer/Data/Offer/EndDateTime | Date and time at which the offer ends | DateTime |
|
|
Rate | 0..1 | OBReadOffer/Data/Offer/Rate | Rate associated with the offer type | String |
| ^(-?\d{1,3}){1}(.\d{1,4}){0,1}$ |
Value | 0..1 | OBReadOffer/Data/Offer/Value | Value associated with the offer type | Number |
|
|
Term | 0..1 | OBReadOffer/Data/Offer/Term | Further details of the term of the offer | String |
|
|
URL | 0..1 | OBReadOffer/Data/Offer/URL | URL (Uniform Resource Locator) where documentation on the offer can be found | String |
|
|
Amount | 0..1 | OBReadOffer/Data/Offer/Amount | Amount of money associated with the offer type | OBReadOffer/Data/Offer/Amount |
|
|
Amount | 1..1 | OBReadOffer/Data/Offer/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 | OBReadOffer/Data/Offer/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}$ |
Fee | 0..1 | OBReadOffer/Data/Offer/Fee | Fee associated with the offer type | OBReadOffer/Data/Offer/Fee |
|
|
Amount | 1..1 | OBReadOffer/Data/Offer/Fee/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 | OBReadOffer/Data/Offer/Fee/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}$ |
...