Payments
Find all Payments
Retrieve a paginated list of Payments
get/payments
Query parameters
pagenumber
Page number for offset pagination. Defaults to 1.
pageSizenumber
Number of items per page for offset pagination. Defaults to 10.
limitnumber
Opts into cursor pagination and sets the page size. When provided, "page"/"pageSize" are ignored and the response returns a "nextCursor" instead of a total count.
cursorstring
Opaque cursor from a previous cursor-paginated response. Used together with "limit" to fetch the next page.
sortDirection'ASC' | 'DESC' | 'asc' | 'desc'
Sort direction. Defaults to ASC.
sortBy'id' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'currency'
Field to sort by. Defaults to createdAt.
Response
OK
Example response
{
"pagination": {
"mode": "offset",
"pageSize": 10,
"hasPreviousPage": true,
"page": 2,
"itemCount": 11,
"pageCount": 2
},
"data": [
{
"createdAt": "2024-02-18T12:00:00Z",
"updatedAt": "2024-02-21T12:15:00Z",
"id": "pay_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"status": "succeeded",
"displayStatus": "succeeded",
"amount": 1500,
"note": "This is a note for the payment",
"currency": "usd",
"amountCaptured": 1500,
"isCaptured": true,
"isRecovered": true,
"isRetrying": true,
"chargebackRecordedAt": "2026-01-15T10:30:00.000Z",
"authorizedAt": "2026-01-15T10:30:00.000Z",
"capturedAt": "2026-01-15T10:35:00.000Z",
"reversedAt": "2026-01-20T14:00:00.000Z",
"initiator": "customer",
"offSessionType": "recurring",
"statementDescriptor": "Some product",
"latestMessage": "Payment was declined by the issuing bank.",
"latestDeclineType": "hard_decline",
"action": {
"redirectUrl": "https://example.com"
},
"checkoutKey": "ck_live_abc123def456",
"metadata": {},
"attribution": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "summer_sale",
"utm_term": "running+shoes",
"utm_content": "banner_a",
"utm_id": "utm_123",
"utm_contentid": "content_123",
"ref_id": "ref_abc",
"fbclid": "fbclid_abc",
"cmpid": "cmp_123"
},
"retry": {
"attempts": 2,
"nextAmount": 999
},
"customer": {
"createdAt": "2024-02-18T12:00:00Z",
"updatedAt": "2024-02-21T12:15:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"id": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"email": "user@gmail.com",
"name": "John Doe",
"phoneNumber": "+1234567890",
"dateOfBirth": "2020-01-01",
"gender": "male",
"restrictReason": "Customer restricted due to suspicious activity",
"isRestricted": true
},
"paymentMethod": {
"createdAt": "2024-02-18T12:00:00Z",
"updatedAt": "2024-02-21T12:15:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"id": "pm_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"type": "card",
"customer": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"card": {
"brand": "amex",
"lastFour": "1234",
"bin": "123456",
"expMonth": "12",
"expYear": "2025",
"cardholderName": "John Doe"
},
"applePay": {
"displayName": "MasterCard 1234"
}
},
"latestTransaction": {
"createdAt": "2024-02-18T12:00:00Z",
"updatedAt": "2024-02-21T12:15:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"status": "authorized",
"authentication": "not_requested",
"amount": 1500,
"initiator": "customer",
"statementDescriptor": "Hello World",
"amountCaptured": 1500,
"isCaptured": true,
"chargebackRecordedAt": "2026-01-15T10:30:00.000Z",
"captureMethod": "automatic",
"currency": "usd",
"processorId": "ch_1J8lZpJ9j1bSv2Jr6sVjXZ1N",
"gatewayProfile": {
"createdAt": "2024-02-18T12:00:00Z",
"updatedAt": "2024-02-21T12:15:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"active": true,
"title": "Profile #1",
"integration": "stripe",
"environment": "test"
},
"paymentMethod": {
"createdAt": "2024-02-18T12:00:00Z",
"updatedAt": "2024-02-21T12:15:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"id": "pm_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"type": "card",
"customer": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
"card": {
"brand": "amex",
"lastFour": "1234",
"bin": "123456",
"expMonth": "12",
"expYear": "2025",
"cardholderName": "John Doe"
},
"applePay": {
"displayName": "MasterCard 1234"
}
}
}
}
]
}Changes
Changed in 1 of the 2 revisions of this API.1
- ○
added the non-success response with the status
response-non-success-status-added
- ○