Retrieve Payment (by id)
GET {{base_url}}/banking/v2/pay/payments/:paymentId
The 'Retrieve payment' endpoint can be used to retrieve a particular payment using the bank id and payment id.
Path variables
| Field | Type | Description |
|---|
| paymentId | string | Unique identifier for the payment |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the payment |
| bankId | integer | Unique identifier for the bank |
| companyId | string | Unique identifier for the company |
| consentId | string | Unique identifier for the consent |
| creditor | JSON object | Creditor information |
| creditor -> schemeName | string | IBAN or Account and sort code |
| creditor -> identification | string | Creditor's account details |
| creditor -> name | string | Creditor name |
| amount | integer | Balance amount |
| currency | string | Account currency |
| reference | string | Transaction reference |
| type | string | Payment type {DOMESTICSCHEDULED,DOMESTIC-STANDINGORDER, DOMESTIC-PAYMENT,INTERNATIONAL-SCHEDULED, INTERNATIONAL-STANDINGORDER, INTERNATIONAL-PAYMENT} |
| creationDate | datetime | Date and time of the transaction |
| remittanceInfo | string | Partner Id is sent in order to reconcile payment with AIS transaction |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid paymentId | 404 Not Found | |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
RESPONSES
status: OK
{"id":"paymentId1234","consentId":"consentId3456","bankId":6,"companyId":"companyId1234","type":"DOMESTIC","status":"PENDING","amount":"25.00","currency":"GBP","reference":"reference","creditor":{"schemeName":"UK.OBIE.SortCodeAccountNumber","identification":"11223301234567","name":"Creditor name"},"creationDate":"2020-10-27T10:02:37Z","remittanceInfo":"partnerId1234"}