API Documentation
Purchases
Invoice Line Items
Invoices
Pricing Models
API Keys
Subscriptions
Payment Methods
Usage Events
Product Features
Refund a Payment
Copy
Ask AI
curl --request POST \
--url https://app.flowglad.com/api/v1/payments/{id}/refund \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"partialAmount": 123
}
'Copy
Ask AI
{
"payment": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"invoiceId": "<string>",
"amount": 4503599627370495,
"paymentMethod": "card",
"currency": "USD",
"status": "canceled",
"chargeDate": 0,
"description": "<string>",
"organizationId": "<string>",
"customerId": "<string>",
"purchaseId": "<string>",
"subscriptionId": "<string>",
"paymentMethodId": "<string>",
"billingPeriodId": "<string>",
"taxAmount": -1,
"subtotal": -1,
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": -1,
"refunded": true,
"refundedAmount": -1,
"failureMessage": "<string>",
"failureCode": "<string>",
"settlementDate": 0,
"receiptNumber": "<string>",
"receiptURL": "<string>",
"taxType": "amusement_tax",
"taxCountry": "AD",
"refundedAt": 0
}
}Payments
Refund a Payment
POST
/
api
/
v1
/
payments
/
{id}
/
refund
Refund a Payment
Copy
Ask AI
curl --request POST \
--url https://app.flowglad.com/api/v1/payments/{id}/refund \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"partialAmount": 123
}
'Copy
Ask AI
{
"payment": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"invoiceId": "<string>",
"amount": 4503599627370495,
"paymentMethod": "card",
"currency": "USD",
"status": "canceled",
"chargeDate": 0,
"description": "<string>",
"organizationId": "<string>",
"customerId": "<string>",
"purchaseId": "<string>",
"subscriptionId": "<string>",
"paymentMethodId": "<string>",
"billingPeriodId": "<string>",
"taxAmount": -1,
"subtotal": -1,
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": -1,
"refunded": true,
"refundedAmount": -1,
"failureMessage": "<string>",
"failureCode": "<string>",
"settlementDate": 0,
"receiptNumber": "<string>",
"receiptURL": "<string>",
"taxType": "amusement_tax",
"taxCountry": "AD",
"refundedAt": 0
}
}Authorizations
Path Parameters
Body
application/json
The amount to refund. If not provided, the entire amount will be refunded. Cannot exceed the amount of the associated payment.
Response
Successful response
Show child attributes
Show child attributes
Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991A positive integer
Required range:
0 < x <= 9007199254740991Available options:
card, link, us_bank_account, sepa_debit Currency code
Available options:
USD, AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KGS, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, STD, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Available options:
canceled, failed, refunded, processing, succeeded, requires_confirmation, requires_action Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, rst, sales_tax, vat, none ISO 3166-1 alpha-2 country code
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Epoch milliseconds.
Required range:
-9007199254740991 <= x <= 9007199254740991Was this page helpful?
⌘I