Retrieve Payment Requests
GET {{base_url}}/banking/v2/pay/payment-request?status&purpose
The 'Retrieve payment requests' endpoint can be used to retrieve particular set of payment request using status and purpose.
Attributes
| Field | Type | Description |
|---|---|---|
| creditor | JSON object | Creditor information |
| creditor -> accountId | string | Unique identifier for the bank account (this is provided by Retrieve Bank Accounts endpoint) |
| creditor -> bankId | string | |
| creditor -> name | string | Name on the bank account |
| creditor -> schemeName | string | IBAN or Account and sort code |
| creditor -> identification | string | Unique id per bank account |
| creditor -> accountType | string | Type of bank account e.g. BUSINESS, PERSONAL |
| currency | string | Account currency |
| amount | integer | Payment amount |
| reference | string | Transaction reference |
| paymentType | string | Payment type {DOMESTIC} |
| usage | string | {SINGLE/MULTI} Configure the request to take either single or multiple payments |
| isProtected | boolean | If set to true, retrieve endpoints will mask bank account details. |
| purpose | string | {INVOICE, INSTANT_PAYMENTS, ECOMM, OTHERS} Purpose for which the payment is being taken |
| status | string | {ACTIVE, IN_ACTIVE} |
| creationDate | string | Date and Time when the request was created |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
status | null | {ACTIVE, IN_ACTIVE} | |
purpose | null | {INVOICE, INSTANT_PAYMENTS, ECOMM, OTHERS} |
HEADERS
| 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":"4b5b0eef-f17f-4760-afc9-1371f5b951c6","partnerId":"6ae1c843-e97d-437c-81d8-6106e91c985f","companyId":"2667fd3b-49e9-4a84-b77a-b013deada508","paymentType":"DOMESTIC","creditor":{"accountId":"6f440597-5af7-45f9-bf0d-0abbea113abd","bankId":50,"name":"Julia Research Ltd","schemeName":"UK.OBIE.SortCodeAccountNumber","identification":"60837109152388","accountType":"BUSINESS"},"amount":"0.01","currency":"GBP","reference":"test reference","creationDate":"2022-01-20T15:49:28.789Z","updatedDate":"","dynamicAmountUrl":"dynamicAmountUrl","usage":"SINGLE","status":"ACTIVE","isProtected":false,"purpose":"OTHERS","paymentLink":"https://pay.tomatopay.co.uk/request?l=eyJsaW5rSWQiOiJmMjJlZDMzYS1iNWUzLTRiZTUtYTgyYS1iNDMwYWY2OTliYzUiLCJwYXJ0bmVySWQiOiI2YWUxYzg0My1lOTdkLTQzN2MtODFkOC02MTA2ZTkxYzk4NWYifQ=="}],"links":{}}