List refunds

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const refundListResponse of client.refunds.list({ payment_id: 'pay_xxxxxxxxxxxxxx' })) {
  console.log(refundListResponse.id);
}

{
  "data": [
    {
      "id": "rf_xxxxxxxxxxxxxxx",
      "amount": 6.9,
      "currency": "usd",
      "status": "pending",
      "created_at": "2023-12-01T05:00:00.401Z",
      "provider": "stripe",
      "provider_created_at": "2023-12-01T05:00:00.401Z",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "reference_value": "<string>",
      "payment": {
        "id": "pay_xxxxxxxxxxxxxx"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

GET

refunds

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const refundListResponse of client.refunds.list({ payment_id: 'pay_xxxxxxxxxxxxxx' })) {
  console.log(refundListResponse.id);
}

{
  "data": [
    {
      "id": "rf_xxxxxxxxxxxxxxx",
      "amount": 6.9,
      "currency": "usd",
      "status": "pending",
      "created_at": "2023-12-01T05:00:00.401Z",
      "provider": "stripe",
      "provider_created_at": "2023-12-01T05:00:00.401Z",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "reference_value": "<string>",
      "payment": {
        "id": "pay_xxxxxxxxxxxxxx"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization

string

header

required

The app API key from an app from the /dashboard/developer page

Query Parameters

after

string | null

Returns the elements in the list that come after the specified cursor.

before

string | null

Returns the elements in the list that come before the specified cursor.

first

integer | null

Returns the first n elements from the list.

Example:

42

last

integer | null

Returns the last n elements from the list.

Example:

42

payment_id

string

required

The ID of the payment to list refunds for

Example:

"pay_xxxxxxxxxxxxxx"

direction

enum<string> | null

The direction to sort the refunds by

Available options:

asc,

desc

created_before

string<date-time> | null

The maximum creation date to filter by

Example:

"2023-12-01T05:00:00.401Z"

created_after

string<date-time> | null

The minimum creation date to filter by

Example:

"2023-12-01T05:00:00.401Z"

Response

A successful response

The connection type for Refund.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The ID of the refund.

Example:

"rf_xxxxxxxxxxxxxxx"

data.amount

number

required

The amount of the refund.

Example:

6.9

data.currency

enum<string>

required

The currency of the refund.

Available options:

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

data.status

enum<string>

required

The status of the refund.

Available options:

pending,

requires_action,

succeeded,

failed,

canceled

data.created_at

string<date-time>

required

The time the refund was created.

Example:

"2023-12-01T05:00:00.401Z"

data.provider

enum<string>

required

The provider of the refund.

Available options:

stripe,

coinbase,

paypal,

apple,

sezzle,

splitit,

platform_balance,

multi_psp

data.provider_created_at

string<date-time> | null

required

The time the refund was created by the provider.

Example:

"2023-12-01T05:00:00.401Z"

data.reference_status

enum<string> | null

required

The status of the refund reference provided by the payment processor.

Available options:

available,

pending,

unavailable

data.reference_type

enum<string> | null

required

The type of the refund reference that was provided by the payment processor.

Available options:

acquirer_reference_number,

retrieval_reference_number,

system_trace_audit_number

data.reference_value

string | null

required

The value of the reference.

data.payment

object

required

The payment associated with the refund.

Show child attributes

data.payment.id

string

required

The payment ID

Example:

"pay_xxxxxxxxxxxxxx"

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Payment pending Retrieve refund

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response