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

FieldTypeRequiredDescription
limitintegernoPage size, 1–100 (default 20).
offsetintegernoNumber of records to skip (default 0).
statusstringnopending, succeeded, failed or refunded.
searchstringnoSearch merchant reference, customer name or email.
startDatestringnoInclusive UTC day, YYYY-MM-DD.
endDatestringnoInclusive 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

StatuserrorMeaning
403insufficient_scopeThis project key is not allowed to do that.
400invalid_payment_statusstatus must be one of the documented statuses.
400invalid_date_rangeDates must use YYYY-MM-DD.
503card_payments_not_availableMock payment access is disabled.

Related references

Browse the complete endpoint directory, the developer portal and the security and controls guide.