List Payments
GET/paymentsDescription
Retrieve a list of all payments. The payments are returned in descending order by creation date, with the most recent payments appearing first.
Headers
| Header | Description | Required |
|---|---|---|
| Authorization | Bearer token with your API key | yes |
Query Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| limit | number | Maximum number of payments to return (default: 10, max: 100). | no |
| starting_after | string | Cursor for pagination. Returns payments created after this payment ID. | no |
| ending_before | string | Cursor for pagination. Returns payments created before this payment ID. | no |
| status | string | Filter by payment status. Repeatable: repeat the parameter to match multiple statuses (OR). Valid values: client_deposit_pending, client_deposit_detected, client_deposit_confirmed, client_deposit_expired, escrow_confirmed, settlement_pending, settled, failed, refunded, cancelled. | no |
| checkout_id | string | Filter payments by checkout ID. | no |
| payment_method | string | Filter by payment method: direct or two_step. | no |
| created_gte | string | Filter payments created on or after this ISO 8601 timestamp. | no |
| created_lte | string | Filter payments created on or before this ISO 8601 timestamp. | no |
Example Request
const response = await fetch('https://checkout-api.exodus-int.com/payments?limit=20&status=settled', {
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
},
});// Filter by multiple statuses (OR) by repeating the status parameter
const params = new URLSearchParams({ limit: '20' });
params.append('status', 'settled');
params.append('status', 'refunded');
const response = await fetch(`https://checkout-api.exodus-int.com/payments?${params}`, {
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
},
});Response
SUCCESSFUL RESPONSE
{
"object": "list",
"data": [
{
"id": "tz4a98xxat96iws9zmbrgj3a",
"object": "payment",
"status": "settled",
"payment_method": "two_step",
"detected_token": "USDC",
"detected_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"detected_chain": "eip155:1",
"token_amount": "5000000",
"token_amount_decimal": "5",
"deposit_address": "0x5fbdb2315678afecb367f032d93f642f64180aa3",
"payer_addresses": ["0x742d35Cc6634C0532925a3b844Bc9e7595f8fE21"],
"on_chain_id": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b",
"created_at": "2024-01-15T12:30:00Z",
"flagged": false
},
{
"id": "pfh0haxfpzowht3oi213cqos",
"object": "payment",
"status": "refunded",
"payment_method": "two_step",
"detected_token": "USDC",
"detected_token_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
"detected_chain": "eip155:8453",
"token_amount": "29990000",
"token_amount_decimal": "29.99",
"deposit_address": "0x3a1f7c2b9e0d4856af13d62b5e8c90147ab2cd5e",
"payer_addresses": ["0x9f8e7d6c5b4a3928170615243a5b6c7d8e9f0a1b"],
"on_chain_id": "0x2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c",
"created_at": "2024-01-14T10:00:00Z",
"flagged": false
}
],
"has_more": true
}Pagination
Use cursor-based pagination to navigate through large result sets:
// Get the next page of results
const nextPage = await fetch(
'https://checkout-api.exodus-int.com/payments?limit=20&starting_after=pfh0haxfpzowht3oi213cqos',
{
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
},
}
);