Retrieve Subscriptions
GET {{base_url}}/banking/v2/pay/subscriptions
Subscriptions can be retrieved by providing the payer company.
The subscription response will include subscription 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 (PENDING,ACTIVE,CANCELLED,OVERDUE,REJECTED,CANCELLATION_PENDING) |
| pageId | string | Page offset of results |
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 CompanyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | |
| Invalid SubscrionRequestId | 403 Forbidden | |
Request Params
| Key | Datatype | Required | Description |
|---|
subscriptionRequestId | string | | |
bankId | number | | |
pageId | string | | |
status | string | | |
| 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":[{"subscriptionId":"3b6dc2ea-77da-456d-8bb5-92bfd477e5c8","subscriptionConsentId":"b64a7854-0ac7-4afe-8c1d-d999adcb4869","payerCompanyId":"687400cc-bae5-4e20-a052-7e73f8fb7018","partnerId":"6ae1c843-e97d-437c-81d8-6106e91c985f","subscriptionRequestId":"65e3c92c-4d99-58e8-9d1b-0e4da9843021","bankId":20,"externalId":"","creationDate":"2022-01-24T18:13:52.946Z","updatedDate":"","amount":"9.99","currency":"GBP","reference":"tps-6y","subscriptionStatus":"ACTIVE","cancellationReason":"","isoStatus":""}],"links":{}}