ZyloPaydocs
Refunds

Retrieve a refund

A refund by ID.

GET/v1/refunds/{id}scope refunds:read

Path parameters

idstringrequired

Refund ID (re_…).

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 the refund object.

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/refunds/re_4Fq9LwP2mZt8Xk3Vb7Ns1HdQ \
  -H "Authorization: Bearer $ZYLOPAY_SECRET_KEY"

Example response

{
  "id": "re_4Fq9LwP2mZt8Xk3Vb7Ns1HdQ",
  "object": "refund",
  "livemode": false,
  "amount": 1000000,
  "currency": "usdc",
  "payment": "pay_1042",
  "status": "succeeded",
  "reason": "Customer returned one item",
  "failure_code": null,
  "failure_message": null,
  "tx_hash": "0x9e1f0c8a36f2a7b6d1e4c3b2a1908f7e6d5c4b3a2918f7e6d5c4b3a2918f7e6d",
  "source": "api",
  "metadata": {
    "return_id": "R-2211"
  },
  "network": "testnet",
  "created": "2026-09-28T15:10:04.000Z",
  "updated": "2026-09-28T15:10:05.000Z"
}

On this page