Public developer API
GET /v1/card-payments
Lists this business’s development-mode mock payment records. Supports pagination, status, date range and search filters.
Access
A project-specific API key (Authorization: Bearer dapi_live_...) and its Business ID (X-Business-Id). Rate limited per business (120 calls a minute by default).
AVAILABLE ON 25 DECEMBER 2026. Before that date this route returns mock records only outside production when CARD_PAYMENTS_MODE=mock is enabled.
The /api/v1/card-payments compatibility prefix is also available.
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Page size, 1–100 (default 20). |
offset | integer | no | Number of records to skip (default 0). |
status | string | no | pending, succeeded, failed or refunded. |
search | string | no | Search merchant reference, customer name or email. |
startDate | string | no | Inclusive UTC day, YYYY-MM-DD. |
endDate | string | no | Inclusive UTC day, YYYY-MM-DD. |
Example request
curl --request GET \
--url 'https://production.dutchapi.co/v1/card-payments' \
--header 'X-Business-Id: YOUR_BUSINESS_ID' \
--header 'Authorization: Bearer bsk_live_YOUR_BUSINESS_SECRET'
Response 200
{
"object": "list",
"total": 1,
"mode": "mock",
"liveProcessing": false,
"data": [
{
"id": "cp_mock_4c8f70a64b22458c8de92f3a",
"merchantReference": "order-1042",
"amount": 25.5,
"currency": "USD",
"status": "pending",
"mode": "mock",
"liveProcessing": false
}
]
}
Errors
| Status | error | Meaning |
|---|---|---|
| 403 | insufficient_scope | This project key is not allowed to do that. |
| 400 | invalid_payment_status | status must be one of the documented statuses. |
| 400 | invalid_date_range | Dates must use YYYY-MM-DD. |
| 503 | card_payments_not_available | Mock payment access is disabled. |