Create a refund
Creates a new refund for a charge.
Request body
The unique identifier of the charge to refund.
The unique identifier of the terminal session to refund.
The refund amount in the currency's major unit (e.g., 30.0 for R30.00).
The refund currency in ISO 4217 format. Only "ZAR" is currently supported.
The reason for the refund.
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.
Additional metadata to be associated with the refund.
Response
Returns a new refund object
The unique identifier for this refund.
The type of refund.
The unique identifier of the charge being refunded.
The refund amount in the currency's major unit (e.g., 30.0 for R30.00).
The refund currency in ISO 4217 format. Only "ZAR" is currently supported.
The reason for the refund.
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.
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.
A set of key-value pairs that you can attach to the resource. Use metadata to store additional, structured information relevant to your integration.
The UTC timestamp indicating when the refund was created. Formatted as an ISO 8601 string (e.g., 2024-01-15T09:30:00Z).
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).