Refund created

Headers

webhook-signature

string

required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp

string

required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json

string

required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

api_version

string

required

The API version for this webhook

Allowed value: "v1"

Example:

"v1"

timestamp

string<date-time>

required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

type

string

required

The webhook event type

Allowed value: "refund.created"

Example:

"refund.created"

data

object

required

An object representing a refund made on a payment.

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"

data.payment.total

number | null

required

The total to show to the creator (excluding buyer fees).

Example:

6.9

data.payment.subtotal

number | null

required

The subtotal to show to the creator (excluding buyer fees).

Example:

6.9

data.payment.usd_total

number | null

required

The total in USD to show to the creator (excluding buyer fees).

Example:

6.9

data.payment.currency

enum<string> | null

required

The currency of the payment.

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.payment.created_at

string<date-time>

required

The datetime the payment was created

Example:

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

data.payment.paid_at

string<date-time> | null

required

The datetime the payment was paid

Example:

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

data.payment.dispute_alerted_at

string<date-time> | null

required

When an alert came in that this transaction will be disputed

Example:

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

data.payment.payment_method_type

enum<string> | null

required

Machine-readable identifier for the payment method used on the payment. Examples include card, cashapp ..., local methods such as ideal, sofort, ... BNPL options like klarna, affirm, ..., or crypto. Returns null when the processor does not supply a type.

Available options:

acss_debit,

affirm,

afterpay_clearpay,

alipay,

alma,

amazon_pay,

apple_pay,

au_becs_debit,

bacs_debit,

bancontact,

billie,

blik,

boleto,

card,

cashapp,

crypto,

eps,

fpx,

giropay,

google_pay,

grabpay,

ideal,

kakao_pay,

klarna,

konbini,

kr_card,

link,

mobilepay,

multibanco,

naver_pay,

nz_bank_account,

oxxo,

p24,

pay_by_bank,

payco,

paynow,

pix,

promptpay,

revolut_pay,

samsung_pay,

satispay,

sepa_debit,

sofort,

swish,

twint,

us_bank_account,

wechat_pay,

zip,

bizum,

capchase_pay,

kriya,

mondu,

ng_wallet,

paypay,

sequra,

scalapay,

vipps,

custom,

customer_balance,

gopay,

mb_way,

ng_bank,

ng_bank_transfer,

ng_card,

ng_market,

ng_ussd,

paypal,

payto,

qris,

rechnung,

south_korea_market,

kr_market,

shopeepay,

upi,

sunbit,

netbanking,

id_bank_transfer,

demo_pay,

shop_pay,

sezzle,

coinbase,

splitit,

platform_balance,

apple,

venmo,

unknown

data.payment.billing_reason

enum<string> | null

required

The reason for the charge.

Available options:

subscription_create,

subscription_cycle,

subscription_update,

one_time,

manual,

subscription

data.payment.card_brand

enum<string> | null

required

Card network reported by the processor (for example visa, mastercard, amex). Present only when the underlying payment method type is card.

Available options:

mastercard,

visa,

amex,

discover,

unionpay,

jcb,

diners,

link,

troy,

visadankort,

visabancontact,

china_union_pay,

rupay,

jcbrupay,

elo,

maestro,

unknown

data.payment.card_last4

string | null

required

The last 4 digits of the card used to make the payment.

data.payment.user

object

required

The user that made this payment.

Show child attributes

data.payment.user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.payment.user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.payment.user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

data.payment.user.email

string | null

required

The email of the user

Example:

"[email protected]"

data.payment.member

object

required

The member attached to this payment.

Show child attributes

data.payment.member.id

string

required

The ID of the member

data.payment.member.phone

string | null

required

The phone number for the member, if available.

data.payment.membership

object

required

The membership attached to this payment.

Show child attributes

data.payment.membership.id

string

required

The internal ID of the membership.

Example:

"mem_xxxxxxxxxxxxxx"

data.payment.membership.status

enum<string>

required

The state of the membership.

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved,

drafted

Response

200

Return a 200 status to indicate that the data was received successfully

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Headers

Body

Response