Retrieve Subscription Consents
GET {{base_url}}/banking/v2/pay/subscription/subscriptionConsents?subscriptionRequestId={{subscriptionRequestId}}&status
Subscription consents can be retrieved by providing the payer company.
The consent response will include subscription consent details (amount, currency, payment type), consent Id, payment start Date and status.
Query parameters
| Field | Type | Description |
|---|
| subscription RequestId | string | Unique id for the subscription Request |
| status | string | status of the subscription consent(AUTHORISED/AWAITINGAUTHORISATION/CONSUMED/REJECTED) |
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|
| subscriptionConsentId | string | Unique consent id |
| payerCompanyId | string | Unique id for the company |
| bankId | integer | Unique id for the bank |
| creationDate | datetime | Date when the consent was created |
| subscriptionRequestId | string | Unique id for the subscription Request |
| status | string | Status of consent {Authorised, AwaitingAuthorisation, Rejected} |
| currency | string | Account currency |
| amount | integer | Payment amount |
| idempotencyKey | string | unique identifier for consent from the bank |
| authorisedDate | string | Date when the consent was authorised |
| externalId | string | external identifier for consent |
| paymentStartDate | string | payment start date for the standing order |
| creationDate | string | Consent Creation Date |
| type | string | Payment type {DOMESTIC} |
| updatedDate | string | Consent updated Date |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid CompanyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | |
| Invalid SubscrionRequestId | 403 Forbidden | |
Request Params
| Key | Datatype | Required | Description |
|---|
bankId | number | | |
pageId | string | | |
subscriptionRequestId | string | | |
status | null | | |
| Key | Datatype | Required | Description |
|---|
Accept | string | | |
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"subscriptionConsentId":"cd5069f1-74a8-43d0-859d-e0b05eb43dbb","payerCompanyId":"687400cc-bae5-4e20-a052-7e73f8fb7018","partnerId":"6ae1c843-e97d-437c-81d8-6106e91c985f","subscriptionRequestId":"65e3c92c-4d99-58e8-9d1b-0e4da9843021","amount":"9.99","currency":"GBP","bankId":31,"reference":"tps-m","idempotencyKey":"unique_key","authorisedDate":"","externalId":"external_id","tokenId":"","paymentStartDate":"2022-01-22T20:52:53.288Z","clientCallbackUrl":"","status":"AWAITINGAUTHORISATION","creationDate":"2022-01-20T20:52:54.664Z","updatedDate":""},{"subscriptionConsentId":"38b42296-a17f-4de2-a8eb-76e44a25d25d","payerCompanyId":"687400cc-bae5-4e20-a052-7e73f8fb7018","partnerId":"6ae1c843-e97d-437c-81d8-6106e91c985f","subscriptionRequestId":"65e3c92c-4d99-58e8-9d1b-0e4da9843021","amount":"9.99","currency":"GBP","bankId":31,"reference":"tps-3f","idempotencyKey":"38b42296a17f4de2a","authorisedDate":"","externalId":"external_id2","tokenId":"","paymentStartDate":"2022-01-26T10:17:38.405Z","clientCallbackUrl":"","status":"AWAITINGAUTHORISATION","creationDate":"2022-01-24T10:17:39.567Z","updatedDate":""}],"links":{}}