ZAzahlo
Payments

Retrieve a refund

Retrieve a refund. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

get/api/v1/refunds/{id}

Request

  • Base URL
    https://merchant.zahlo.eu
  • Auth
    API key in header x-api-key

Path parameters

idstring required

The resource identifier returned by the merchant API.

Response

Successful response

idstring required
object'refund' required
livemodeboolean required
createdAtstring date-time required
paymentIdstring required

The payment's id, as GET /api/v1/payments/{id} takes it.

amountMinorinteger required
currencystring required
status'pending' | 'succeeded' | 'failed' required
reasonstring nullable required
metadataobject required

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.