v1

latestOpenAPI 3.1.02026-07-1342112262.5 KB

Refunds

Fetch a refund

Required scope: business/orders:read

get/v1/refunds/{refund_id}

Path parameters

refund_idstring required

The unique identifier of the refund.

Response

Successful Response

idstring required

The unique identifier of the refund.

client_transaction_idstring nullable required

The identifier provided when creating the transaction via the SDK.

display_namestring required

A human-friendly label for the refund.

receipt_numberstring required

The receipt number of the refund.

payment_idstring required

A reference to the original payment.

order_idstring nullable required

A reference to the refund order.

staff_idstring nullable

The unique identifier of the staff member who processed the refund. Matches the id returned by the Staff API. null when no staff member is associated with the refund.

original_order_idstring nullable required

A reference to the original order.

order_numberstring nullable required

A human-friendly identifier for the refund order.

original_order_numberstring nullable required

A human-friendly identifier for the original order.

created_atstring date-time required

The refund creation date and time in ISO 8601 format.

updated_atstring date-time nullable required

The date and time the refund was last modified in ISO 8601 format.

currencystring required

The currency code in ISO 4217 format.

notestring nullable required

An optional note attached to the refund.

status'approved' | 'failed' | 'pending' | 'rejected' required

processed_atstring date-time nullable required

The date and time the refund was processed in ISO 8601 format.

payment_method'card' | 'cash' | 'instant_eft' | 'gift_voucher' | 'other' required

refund_type'auth_reversal' | 'credit_return' | 'other' required

Example response

{
  "client_transaction_id": "rfd_765fde5ded7bxd",
  "created_at": "2024-11-19T15:27:02+00:00",
  "currency": "ZAR",
  "display_name": "Refund receipt #491352",
  "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3",
  "note": "This is a note on this refund.",
  "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
  "original_order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
  "original_order_number": "10542623",
  "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
  "payment_method": "card",
  "processed_at": "2024-11-20T16:27:23+00:00",
  "processing_fees": [
    {
      "amount": {
        "amount": 27800,
        "currency": "ZAR"
      },
      "type": "initial"
    }
  ],
  "receipt_number": "491352",
  "refund_type": "auth_reversal",
  "refunded_processing_fees": [
    {
      "amount": {
        "amount": 27800,
        "currency": "ZAR"
      },
      "type": "initial"
    }
  ],
  "staff_id": "1739522553-a7769044-ff8c-410d-b660-84e6727c70b9",
  "status": "approved",
  "total_amount": {
    "amount": 4500,
    "currency": "ZAR"
  },
  "updated_at": "2024-11-19T16:27:23+00:00"
}