ZAzahlo
Payments

Sandbox only: settle a pending refund

Settles a pending refund as succeeded or failed; refund.succeeded or refund.failed follows. The provider never sees this outcome; the real handlers apply it, so the real events follow. 404 resource_not_available outside the sandbox; 409 state_conflict when the object is past this step.

post/api/v1/test-helpers/refunds/{id}/outcome

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.

Request body

outcome'succeeded' | 'failed' required

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.