Payments
List Payments
Payments
List Payments
GET
/
api
/
v1
/
payments
curl --request GET \
--url https://app.flowglad.com/api/v1/payments \
--header 'Authorization: <api-key>'{
"data": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"invoiceId": "<string>",
"amount": 123,
"paymentMethod": "card",
"currency": "USD",
"status": "canceled",
"chargeDate": "2023-11-07T05:31:56Z",
"settlementDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"receiptNumber": "<string>",
"receiptURL": "<string>",
"customerId": "<string>",
"purchaseId": "<string>",
"paymentMethodId": "<string>",
"billingPeriodId": "<string>",
"stripeChargeId": "<string>",
"taxAmount": 123,
"subtotal": 123,
"taxType": "amusement_tax",
"taxCountry": "AF",
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": 123,
"refunded": true,
"refundedAmount": 123,
"refundedAt": "2023-11-07T05:31:56Z"
}
],
"currentCursor": "<string>",
"nextCursor": "<string>",
"hasMore": true,
"total": 123
}Authorizations
Response
200
application/json
Successful response
safeZodPositiveInteger
Available options:
card, us_bank_account, sepa_debit 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 safeZodDate
safeZodDate
Available options:
amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, rst, sales_tax, vat, none Available options:
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, ME, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW safeZodDate
curl --request GET \
--url https://app.flowglad.com/api/v1/payments \
--header 'Authorization: <api-key>'{
"data": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"invoiceId": "<string>",
"amount": 123,
"paymentMethod": "card",
"currency": "USD",
"status": "canceled",
"chargeDate": "2023-11-07T05:31:56Z",
"settlementDate": "2023-11-07T05:31:56Z",
"description": "<string>",
"receiptNumber": "<string>",
"receiptURL": "<string>",
"customerId": "<string>",
"purchaseId": "<string>",
"paymentMethodId": "<string>",
"billingPeriodId": "<string>",
"stripeChargeId": "<string>",
"taxAmount": 123,
"subtotal": 123,
"taxType": "amusement_tax",
"taxCountry": "AF",
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": 123,
"refunded": true,
"refundedAmount": 123,
"refundedAt": "2023-11-07T05:31:56Z"
}
],
"currentCursor": "<string>",
"nextCursor": "<string>",
"hasMore": true,
"total": 123
}