List Payments
Overview
This endpoint retrieves a paginated list of Payments associated with an entity’s Customer. It provides details such as status, direction, recipient, amount, and references for reconciliation and monitoring.
Endpoint Details
| Definition | Description |
|---|---|
| Endpoint | https://api.paas-sandbox.co.passportfintech.com/v1/payments |
| Method | GET |
| Headers | Content-Type: application/json, Authorization |
| Authentication | Access Token (Bearer Token) |
Request Body
This endpoint does not require a request body.
Example Request
2
2
curl --location 'https://api.paas-sandbox.co.passportfintech.com/v1/payments' \--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \Response
- HTTP Status Code: 200 OK.
Example of Response
114
114
{ "pagination_info": {}, "payments": []}Common Errors and Handling
| HTTP Status Code | Meaning | Description |
|---|---|---|
| 400 | Bad Request | Invalid parameters or malformed request |
| 401 | Unauthorized | Missing/expired bearer token, or token lacks paas.core.breb_payments.list.get scope |
| 403 | Forbidden | Caller does not have permission to list payments |
| 404 | Not Found | No payments exist for the entity |
| 500 | Server Error | Unexpected error; retry or contact support |
Best Practices
- Use the
pagination_infoobject to iterate through large payment histories. - Filter by status to track operational flows.
- Leverage direction (OUTGOING, INCOMING) for settlement and reconciliation.
- Store and log id, reference, and updated_at for auditing purposes.
- Combine with Retrieve Payment (
GET /payments/{id}) to get detailed transaction information when needed.