POST
/
refunds
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const refund = await client.refunds.create({ payment_id: 'payment_id' });

  console.log(refund.business_id);
}

main();
{
  "amount": 123,
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "AED",
  "payment_id": "<string>",
  "reason": "<string>",
  "refund_id": "<string>",
  "status": "succeeded"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
payment_id
string
required

The unique identifier of the payment to be refunded.

​
reason
string | null

The reason for the refund, if any. Maximum length is 3000 characters. Optional.

Response

200 - application/json
Refund successfully initiated
​
business_id
string
required

The unique identifier of the business issuing the refund.

​
created_at
string
required

The timestamp of when the refund was created in UTC.

​
payment_id
string
required

The unique identifier of the payment associated with the refund.

​
refund_id
string
required

The unique identifier of the refund.

​
status
enum<string>
required
Available options:
succeeded,
failed,
pending,
review
​
amount
integer | null

The refunded amount.

​
currency
enum<string>
Available options:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
reason
string | null

The reason provided for the refund, if any. Optional.