ZyloPaydocs
Payments

List payments

Settled payments of your account in the key's mode, newest first.

GET/v1/paymentsscope payments:read

A payment appears once its settlement is indexed (about a second after the tap).

Query parameters

limitintegerdefault 20

Page size, 1-100.

cursorstring

The next_cursor of the previous page. Omit for the first (newest) page. Up to 1024 characters.

created_gtestring (date-time)

Only objects created at or after this time (ISO 8601).

created_ltstring (date-time)

Only objects created before this time (ISO 8601).

statusstring

One of: succeeded, partially_refunded, refunded

Filter by payment status.

terminalstring

Only payments taken on this terminal (tml_…).

order_idstring

Exact order ID.

payerstring

Payer wallet address (any case).

Headers

ZyloPay-Versionstring

Pin the request to an API version (2026-09-28). Defaults to the version the API key was created with.

Returns

HTTP 200 with a list object: data holds up to limit payment objects, newest first; has_more and next_cursor drive pagination.

Errors

StatusMeaning
400Invalid request (invalid_request_error / idempotency_error).
401Missing, invalid, expired or revoked API key (authentication_error).
403The key lacks the scope, the IP is not allowed, or the account is disabled (permission_error).
429Rate limit reached for this key (rate_limit_error); see Retry-After.
500Internal error (api_error). Retry with the same Idempotency-Key.

Branch on error.code. Every code is listed in error codes.

Example request

curl "https://zylopay-api.fly.dev/api/v1/payments?limit=50&status=succeeded" \
  -H "Authorization: Bearer $ZYLOPAY_SECRET_KEY"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "pay_1042",
      "object": "payment",
      "livemode": false,
      "amount": 2500000,
      "currency": "usdc",
      "amount_refunded": 0,
      "status": "succeeded",
      "fees": {
        "acquirer": 6250,
        "protocol": 6250,
        "cashback": 1250
      },
      "total_charged": 2512500,
      "net": 2500000,
      "cashback_status": "paid",
      "payer": "0x8ba1f109551bd432803012645ac136ddd64dba72",
      "order_id": "A7K2Q9XZ",
      "terminal": "tml_ZP-4821-K",
      "payment_intent": "pi_3f2c9e1a7b6d4c0e9f8a1b2c3d4e5f60",
      "payment_method": {
        "type": "wallet_pass",
        "credential": "nfc_id"
      },
      "split_group": null,
      "network": "testnet",
      "chain_id": 10143,
      "tx_hash": "0x5c504ed432cb51138bcf09aa5e8a410dd4a1e204ef84bfed1be16dfba1b22060",
      "block_number": 48213377,
      "log_index": 3,
      "settled_at": "2026-09-28T14:02:39.000Z",
      "created": "2026-09-28T14:02:40.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJpZCI6MTAzOH0"
}

On this page