Retrieve Subscription Consent By Id
GET {{base_url}}/banking/v2/pay/subscription/subscriptionConsents/:SubscriptionConsentId
This endpoint can be used to retrieve a particular subscription consent.
The consent response will include subscription consent details (amount, currency, payment type), consent Id, payment start Date and status.
Path variables
| Field | Type | Description |
|---|
| subscriptionConsentId | string | Unique identifier for the subscription consent. |
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 subscriptionConsentId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
Request Params
| Key | Datatype | Required | Description |
|---|
externalId | 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
{"subscriptionConsentId":"72aee07c-df69-41f5-a457-9d5b35285b7f","payerCompanyId":"687400cc-bae5-4e20-a052-7e73f8fb7018","partnerId":"6ae1c843-e97d-437c-81d8-6106e91c985f","subscriptionRequestId":"76e3c92c-3d99-48e8-8d1b-0e4da9843022","amount":"9.99","currency":"GBP","bankId":31,"reference":"tps-g","idempotencyKey":"unique_key","authorisedDate":"2022-01-19T19:22:11.002Z","externalId":"external_id","tokenId":"0aa13835-df4c-45c3-bdad-aea8b3ccf15f","paymentStartDate":"2022-01-20T19:20:12.187Z","clientCallbackUrl":"","status":"AUTHORISED","creationDate":"2022-01-19T19:20:13.725Z","updatedDate":""}