Skip to main content
POST
Refund a payment

Authorizations

Authorization
string
header
required

Secret, platform or publishable API key. Platform keys require Payments-Account.

Headers

payments-account
string
payments-version
enum<string>
Available options:
2026-11-01
idempotency-key
string
required
Required string length: 1 - 255

Body

application/json
payment
string
required
Pattern: ^pay_[a-f0-9]{12}$
amount
number
metadata
object
reason
enum<string>
default:requested
Available options:
requested,
duplicate,
fraudulent

Response

Refund.

amount
number
required
created_at
string<date-time>
required
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MXV,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
USN,
UYI,
UYU,
UYW,
UZS,
VED,
VES,
VND,
VUV,
WST,
XAD,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWG
id
string
required
Pattern: ^rfd_[0-9a-hjkmnp-tv-z]{26}$
last_outcome
object | null
required
metadata
object
required
object
enum<string>
required
Available options:
refund
origin
enum<string>
required
Available options:
api,
processor
payment
string
required
Pattern: ^pay_[a-f0-9]{12}$
processor_reference
string | null
required
reason
enum<string>
required
Available options:
requested,
duplicate,
fraudulent,
compensation
status
enum<string>
required
Available options:
in_flight,
pending,
succeeded,
failed,
unknown