Retrieve Subscription By Id
GET {{base_url}}/banking/v2/pay/subscriptions/:subscriptionId
This endpoint can be used to retrieve a particular subscription.
Path variables
| Field | Type | Description |
|---|
| subscriptionId | string | Unique identifier for the subscription. |
Attributes
| Field | Type | Description |
|---|
| subscriptionId | | Unique identifier for the subscription |
| subscriptionConsentId | string | Unique consent id |
| payerCompanyId | string | Unique id for the company |
| bankId | integer | Unique id for the bank |
| creationDate | datetime | Date when the subscription was authorised |
| subscriptionRequestId | string | Unique id for the subscription Request |
| subscriptionStatus | string | Status of the subscription {PENDING,ACTIVE,CANCELLED,OVERDUE,REJECTED,CANCELLATION_PENDING} |
| currency | string | Account currency |
| amount | integer | Payment amount |
| externalId | string | external identifier for subscription payment |
| paymentStartDate | string | payment start date for the standing order |
| products | string | comma-separated |
| updatedDate | string | Consent updated Date |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid subscriptionId | 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
{"subscriptionId":"0000AFbjpoZ4pUXXlaHPOr","subscriptionConsentId":"72aee07c-df69-41f5-a457-9d5b35285b7f","payerCompanyId":"687400cc-bae5-4e20-a052-7e73f8fb7018","partnerId":"6ae1c843-e97d-437c-81d8-6106e91c985f","subscriptionRequestId":"76e3c92c-3d99-48e8-8d1b-0e4da9843022","bankId":31,"externalId":"","creationDate":"2022-01-19T19:22:12.142Z","updatedDate":"","amount":"9.99","currency":"GBP","reference":"tps-g","subscriptionStatus":"ACTIVE","cancellationReason":"","isoStatus":""}