v2

latestOpenAPI 3.1.0Proprietary2026-07-261022123.6 KB

Get a refund

Retrieves a refund by its unique identifier.

get/refunds/{id}

Path parameters

idstring required

The unique identifier of the refund to retrieve.

Response

Returns a refund object

idstring required

The unique identifier for this refund.

type'card' | 'in_person_card'

The type of refund.

chargestring required

The unique identifier of the charge being refunded.

amountnumber required

The refund amount in the currency's major unit (e.g., 30.0 for R30.00).

currency'ZAR' required

The refund currency in ISO 4217 format. Only "ZAR" is currently supported.

reason'fraud' | 'requested_by_customer' | 'duplicate_charge' required

The reason for the refund.

status'processing' | 'success' | 'paused' | 'failure' required

The current status of the refund. processing indicates the refund is being processed, success indicates the refund was processed successfully, paused indicates the refund is paused pending resolution, and failure indicates the refund did not complete successfully.

noncestring required

A unique identifier for this specific resource. Use the nonce to ensure idempotency. If you attempt to create a resource with a nonce that has already been used, an error will be returned.

metadataMetadata

A set of key-value pairs that you can attach to the resource. Use metadata to store additional, structured information relevant to your integration.

createdAtstring date-time required

The UTC timestamp indicating when the refund was created. Formatted as an ISO 8601 string (e.g., 2024-01-15T09:30:00Z).

updatedAtstring date-time required

The UTC timestamp indicating when the refund was last modified, such as when the status changes. Formatted as an ISO 8601 string (e.g., 2024-01-15T09:35:00Z).