The refund object

Return all or part of a payment to the payer.

EndpointsCopy Anchor Link

• GET /v1/refunds: List refunds
• POST /v1/refunds: Create a refund
• GET /v1/refunds/{id}: Retrieve a refund

AttributesCopy Anchor Link

idstring

Unique identifier (re_…).

objectstring

livemodeboolean

amountinteger

Amount refunded (USDC atoms).

currencystring

paymentstring

The refunded payment (pay_…).

statusstring

One of: pending, succeeded, failed

pending: sent, confirmation not seen yet (resolves automatically; do not retry). succeeded: funds returned. failed: nothing moved (failure_code).

reasonstring | null

failure_codestring | null

One of: refund_failed, settlement_reverted

failure_messagestring | null

tx_hashstring | null

Refund transaction hash on Monad.

sourcestring

One of: api, dashboard, pos, admin

Where the refund was requested: your API key, your dashboard, a terminal, or ZyloPay support (admin, under dual control).

metadataobject

networkstring

One of: mainnet, testnet

createdstring (date-time)

Creation time.

updatedstring (date-time)

Last status change.

ExampleCopy Anchor Link

{
  "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"
}