Sign in
Refunds

Get refund

Use to inspect a single refund: its destination, settled amount and failure reason.

get/refunds/{id}

Path parameters

idstring required

Refund ID

Response

OK

amountstring
attemptinteger
cancelled_atstring date-time
created_atstring date-time
created_bystring
credit_note_idstring
currencystring
environment_idstring
failed_atstring date-time
failure_reasonstring
gateway_idempotency_tokenstring
gateway_metadataobject
gateway_refund_idstring
gateway_tracking_idstring
idstring
idempotency_keystring
initiated_atstring date-time
invoice_idstring
metadataTypesMetadata
payment_gatewaystring
payment_idstring
refund_destination'GATEWAY' | 'WALLET' | 'OUT_OF_BAND'
refund_destination_idstring
refund_reason'DUPLICATE' | 'FRAUDULENT' | 'REQUESTED_BY_CUSTOMER' | 'ORDER_CHANGE' | 'SERVICE_ISSUE' | 'OTHER'
refund_status'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED'
settled_amountstring
status'published' | 'deleted' | 'archived'
succeeded_atstring date-time
tenant_idstring
updated_atstring date-time
updated_bystring

Changes

Changed in 1 of the 149 revisions of this API.1