...
The offers resource is used by an AISP to retrieve the offers available for a specific AccountId or to retrieve the offers detail in bulk for all accounts that the PSU customer has consented to.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
...
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object |
2.1 | offers | GET | GET/accounts/{accountsIdAccountId}/offers | Conditional | accounts | Authorization Authorisation Code | No | | | OBReadOffer |
2.2 | offers | GET | GET/offers | optional | accounts | Authorization Authorisation Code | No | Pagination | | OBReadOffer |
2.1 GET/accounts/{
...
AccountId}/offers
An AISP may retrieve the offers resource for a specific AccountId (which is retrieved in the call to GET /accounts).
...
If an ASPSP has implemented the bulk retrieval endpoints, an AISP AISP may optionally optionally retrieve the offers in bulk. This will retrieve the resources for all authorised accounts linked to the account-request.
3. Data Models
3.1. OBReadOffer
...
Generic features (and pricing) for the account product will be not be available via the offers resources. These generic features will be available via the product resource.
The outcome of any offer (or product feature) uptake will not be reported via the offers resource. The benefits, interest, cash-back for any account will be available via the statements resource (if this is available to PSUs customers in the existing ASPSP online channel).
...
4.1.1 Get Offers Request
GET /offers
AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/json
|
...
{
"Data": {
"Offer": [
{
"AccountId": "00345897",
"OfferId": "2267",
"OfferType": "BalanceTransfer",
"Description": "Balance Transfer offer up to BHD 2000",
"StartDateTime": "2020-03-26T11:30:21.278Z"278+03:00”,
"EndDateTime": "2020-04-26T11:30:21.278Z"278+03:00”,
"Rate": " ",
"Value": 0,
"Term": " ",
"URL": "www.xyz.com",
"Amount": {
"Amount": "2000",
"Currency": "BHD"
},
"Fee": {
"Amount": "20",
"Currency": "BHD" }
},
{
"AccountId": "00156784",
"OfferId": "2268",
"OfferType": "LimitIncrease",
"Description": "Credit limit increase for the account up to BHD 5000",
"StartDateTime": "2020-03-26T11:30:21.278Z"278+03:00”,
"EndDateTime": "2020-04-26T11:30:21.278Z"278+03:00”,
"Rate": " ",
"Value": 0,
"Term": " ",
"URL": "www.xyz.com",
"Amount": {
"Amount": "5000",
"Currency": "BHD" },
"Fee": {
"Amount": "50",
"Currency": "BHD" }
}
]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": 01,
"FirstAvailableDateTime": "2020-03-26T09:10:17.596Z"596+03:00”,
}
}
|
4.2. Specific Account
...
GET /accounts/00345897/offers
AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/json
|
...
{
"Data": {
"Offer": [
{
"AccountId": "00345897",
"OfferId": "2267",
"OfferType": "BalanceTransfer",
"Description": "Balance Transfer offer up to BHD 2000",
"StartDateTime": "2020-03-26T11:30:21.278Z"278+03:00”,
"EndDateTime": "2020-04-26T11:30:21.278Z"278+03:00”,
"Rate": " ",
"Value": 0,
"Term": " ",
"URL": "www.xyz.com",
"Amount": {
"Amount": "2000",
"Currency": "BHD"
},
"Fee": {
"Amount": "20",
"Currency": "BHD"
}
}
]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": 01,
"FirstAvailableDateTime": "2020-03-26T09:10:17.596Z"596+03:00”,
}
}
|