Create a payment
Create a payment
Authorizations
Authentication header of the form api key, where api key is your organization api key.
Headers
Specifies the version of the API to use
1.0.0 Body
Create payment
Customer information for the payment
Custom metadata associated with the payment A dictionary of key-value pairs.
Plan information for the payment
Optional custom price overriding the plan's configured price. Supported for one-off plans only.
Response
OK
Payment amount in the specified currency (e.g., cents)
15000
Payment amount converted to USD (e.g., cents)
15000
Avs check
The date and time at which the payment was created in UTC format.
"2025-05-25T14:30:00Z"
The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.
AED, AFN, ALL, AMD, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, 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, IMP, INR, IQD, IRR, ISK, JEP, 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, 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, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, BOV, COU, CHE, CHW, MXV, UGX, VES, VND, VUV, XAF, XCD, XCG, XOF, XPF, YER, USD CVC check
Unique identifier of the payment.
"pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789"
Custom metadata associated with the payment A dictionary of key-value pairs.
Transaction details related to payment
- Card API Schema
- PayPal API Schema
- Venmo API Schema
- CashApp API Schema
- Apple Pay API Schema
- Google Pay API Schema
Current status of the payment
PENDING, FAILED, AUTHORIZED, SETTLING, SETTLED, DECLINED, BLOCKED, CANCELLED Type of card token used, if applicable
CARD_PAN, NETWORK_TOKEN, PROCESSOR_TOKEN Indicates whether the transaction was merchant-initiated (MIT) or customer-initiated (CIT).
MIT, CIT Information about refund
Amount refunded from the original payment
0
Server-attested reason the payment was refunded; present only once a refund has executed, null otherwise
merchant_initiated, fraud_prevention "fraud_prevention"
Statement descriptor shown on the customer's bank statement
"MY COMPANY"
Reason of payment status
Tax info (provider, calculation/transaction ids, amounts, status)
Information about 3DS
The date and time of the last payment update in UTC format.
"2025-05-26T10:15:00Z"