Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Refunds

Retrieve refund

Retrieves the details of an existing refund.

Required permissions:

  • payment:basic:read
  • plan:basic:read
  • access_pass:basic:read
  • member:email:read
  • member:basic:read
  • member:phone:read
get/refunds/{id}

Path parameters

idstring required
Example:rf_xxxxxxxxxxxxxxx

The unique identifier of the refund.

Response

A successful response

amountnumber required

The refunded amount as a decimal in the specified currency, such as 10.43 for $10.43 USD.

created_atstring date-time required

The datetime the refund was created.

currency'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'eth' | 'ape' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'btc' | 'cny' | 'usdt' | 'kzt' | 'awg' | 'whop_usd' | 'xau' required

The available currencies on the platform

idstring required

The unique identifier for the refund.

provider'stripe' | 'coinbase' | 'paypal' | 'apple' | 'sezzle' | 'splitit' | 'platform_balance' | 'multi_psp' | 'adyen' | 'claritypay' | 'checkout_dot_com' | 'airwallex' | 'coinflow' | 'sequra' | 'dlocal' | 'masspay' required

The different payment providers.

provider_created_atstring date-time nullable required

The timestamp when the refund was created in the payment provider's system. Null if not available from the provider.

reference_status'available' | 'pending' | 'unavailable' required

The status of the refund reference.

reference_type'acquirer_reference_number' | 'retrieval_reference_number' | 'system_trace_audit_number' required

The type of refund reference that was made available by the payment provider.

reference_valuestring nullable required

The tracking reference value from the payment processor, used to trace the refund through banking networks. Null if no reference was provided.

status'pending' | 'requires_action' | 'succeeded' | 'failed' | 'canceled' required

The different statuses for a Refund object

Example response

{
  "amount": 6.9,
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "rf_xxxxxxxxxxxxxxx",
  "payment": {
    "card_last4": "4242",
    "created_at": "2023-12-01T05:00:00.401Z",
    "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
    "id": "pay_xxxxxxxxxxxxxx",
    "membership": {
      "id": "mem_xxxxxxxxxxxxxx"
    },
    "paid_at": "2023-12-01T05:00:00.401Z",
    "plan": {
      "id": "plan_xxxxxxxxxxxxx"
    },
    "product": {
      "id": "prod_xxxxxxxxxxxxx"
    },
    "subtotal": 6.9,
    "tax_amount": 6.9,
    "tax_refunded_amount": 6.9,
    "total": 6.9,
    "usd_total": 6.9,
    "user": {
      "email": "john.doe@example.com",
      "id": "user_xxxxxxxxxxxxx",
      "name": "John Doe",
      "username": "johndoe42"
    }
  },
  "provider_created_at": "2023-12-01T05:00:00.401Z",
  "reference_value": "74850120752"
}