Retrieve Payment Consents
GET {{base_url}}/banking/v2/pay/domestic/consents
Payment consents can be retrieved by providing a bankId.
The consent response will include payment details (amount, currency, payment type), consent Id, date and status.
Query parameters
| Field | Type | Description |
|---|
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique consent id returned by the bank |
| companyId | string | Unique id for the company |
| bankId | integer | Unique id for the bank |
| creationDate | datetime | Date when the consent was created |
| status | string | Status of consent {Authorised, AwaitingAuthorisation, Rejected} |
| currency | string | Account currency |
| amount | integer | Payment amount |
| type | string | Payment type {DOMESTIC} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid bankId | Empty response body | |
| Invalid pageId | 400 Bad Request | |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"id":"consentId1234","companyId":"companyId1234","amount":"20.00","currency":"GBP","type":"DOMESTIC","bankId":6,"creationDate":"2020-07-30T15:10:38.002Z","status":"AWAITINGAUTHORISATION"},{"id":"consentId1345","companyId":"companyId1234","amount":"10000.00","currency":"GBP","type":"DOMESTIC","bankId":6,"creationDate":"2020-10-20T09:11:14.164Z","status":"AUTHORISED"},{"id":"consentId345","companyId":"companyId1234","amount":"100.00","currency":"GBP","type":"DOMESTIC","bankId":6,"creationDate":"2020-07-28T22:05:15.102Z","status":"REJECTED"}],"links":{}}