Retrieve Refund

curl --request GET \
  --url https://api.whop.com/api/v1/refunds/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/refunds/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/refunds/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/refunds/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/refunds/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "failure_message": "The customer's card is expired or was canceled.",
  "failure_reason": "expired_or_canceled_card",
  "id": "rf_xxxxxxxxxxxxxx",
  "metadata": null,
  "original_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "payment_id": "pay_xxxxxxxxxxxxxx",
  "provider": "stripe",
  "provider_created_at": "2026-01-01T12:00:00.000Z",
  "reason": "duplicate",
  "reference_status": "available",
  "reference_type": "acquirer_reference_number",
  "reference_value": null,
  "status": "failed",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "visa_rdr": false
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

refunds

{id}

Retrieve Refund

curl --request GET \
  --url https://api.whop.com/api/v1/refunds/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/refunds/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/refunds/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/refunds/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/refunds/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "failure_message": "The customer's card is expired or was canceled.",
  "failure_reason": "expired_or_canceled_card",
  "id": "rf_xxxxxxxxxxxxxx",
  "metadata": null,
  "original_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "payment_id": "pay_xxxxxxxxxxxxxx",
  "provider": "stripe",
  "provider_created_at": "2026-01-01T12:00:00.000Z",
  "reason": "duplicate",
  "reference_status": "available",
  "reference_type": "acquirer_reference_number",
  "reference_value": null,
  "status": "failed",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "visa_rdr": false
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-10-29-8"

Path Parameters

string

required

The refund to retrieve, prefixed rf_.

Response

refund retrieved

account_id

string | null

required

The account that issued the refund, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

amount

object | null

required

The refunded amount as it settled, in the payment's settlement currency, so pages of refunds net against the payment's refunded_amount. Converted at the rate in force when the refund was issued, not the payment's original rate. Null only when no exchange rate is recorded for a legacy multi-currency payment.

Show child attributes

created_at

string

required

When the refund was requested, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

failure_message

string | null

required

A merchant-facing explanation of why the refund failed, in the request's language. Null unless the refund failed or was canceled.

Example:

"The customer's card is expired or was canceled."

failure_reason

enum<string> | null

required

Why the refund failed, normalized across providers. Null unless the refund failed or was canceled.

Available options:

bank_declined,

expired_or_canceled_card,

lost_or_stolen_card,

insufficient_funds,

charge_disputed,

not_refundable,

merchant_request,

unknown,

null

Example:

"expired_or_canceled_card"

string

required

Refund ID, prefixed rf_.

Example:

"rf_xxxxxxxxxxxxxx"

metadata

object | null

required

Your own key-value data attached when the refund was requested.

Example:

null

original_amount

object

required

The refunded amount in the currency the processor moved.

Show child attributes

payment_id

string

required

The payment this refund reverses, prefixed pay_.

Example:

"pay_xxxxxxxxxxxxxx"

provider

string

required

The payment provider that processed the refund, such as paypal or coinbase.

Example:

"stripe"

provider_created_at

string | null

required

When the provider created the refund, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

reason

enum<string> | null

required

Why the refund was issued, when recorded.

Available options:

duplicate,

fraudulent,

requested_by_customer,

expired_uncaptured_charge,

dispute_alert,

null

Example:

"duplicate"

reference_status

enum<string> | null

required

Whether a banking-network tracking reference is available for this refund.

Available options:

available,

pending,

unavailable,

null

Example:

"available"

reference_type

enum<string> | null

required

The kind of tracking reference, such as an acquirer reference number.

Available options:

acquirer_reference_number,

retrieval_reference_number,

system_trace_audit_number,

null

Example:

"acquirer_reference_number"

reference_value

string | null

required

The tracking reference the buyer's bank can trace the refund by.

Example:

null

status

enum<string>

required

Where the refund stands with the processor: pending, requires_action, succeeded, failed, or canceled.

Available options:

pending,

requires_action,

succeeded,

failed,

canceled

Example:

"failed"

updated_at

string

required

When the refund last changed, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

visa_rdr

boolean

required

True when the card network initiated the refund through Rapid Dispute Resolution.

Example:

false

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Retrieve Refund

Authorizations

Headers

Path Parameters

Response