Sign in
Refunds

Void refund

Void a refund by the refund ID.

See the refund non_voidable_reason_code for details on if the refund is eligible for a void.

post/v1/refunds/{refund_id}/void

Parameters

#/paths/~1v1~1payins/get/parameters/0 — unresolved $ref
#/paths/~1v1~1refunds~1%7Brefund_id%7D/get/parameters/1 — unresolved $ref

Request body

idempotency_keystring required

A unique identifier provided by the platform. This key will be used to detect subsequent retries of the same request. Subsequent requests with the same key will return the result of the first request, regardless if the first request succeeded or failed. This identifier should be generated by the platform and can be max 255 characters.

reason'CORRECTION' | 'DUPLICATE' | 'REQUESTED_BY_CUSTOMER' required

The reason to void this refund.

metadataSchema — unresolved $ref

Response

OK

statusStatus — unresolved $ref
dataData — unresolved $ref
errorsErrors — unresolved $ref

Changes