Customers
Get customer payments
List all payments from a specific customer.
get/customers/{id}/payments
Path parameters
idstring required
Resource ID (UUID) or client key
Query parameters
by'id' | 'key'
Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.
pageSizeinteger
cursorstring
Response
Payments retrieved successfully
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "PMT-00001",
"customer": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CUSTOMER-ACME",
"name": "Acme Manufacturing Corp",
"friendlyId": "A123456",
"status": "ACTIVE",
"phoneNumber": "+1-555-123-4567",
"website": "https://acme-manufacturing.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"currency": "USD"
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}