Skip to main content
POST
Create a payment

Authorizations

Authorization
string
header
required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version
enum<string>
default:1.0.0
required

Specifies the version of the API to use

Available options:
1.0.0

Body

application/json

Create payment

customer
object

Customer information for the payment

metadata
object

Custom metadata associated with the payment A dictionary of key-value pairs.

Example:
plan
object

Plan information for the payment

price
object

Optional custom price overriding the plan's configured price. Supported for one-off plans only.

Response

OK

amount
integer

Payment amount in the specified currency (e.g., cents)

Example:

15000

amount_usd
integer

Payment amount converted to USD (e.g., cents)

Example:

15000

avs_check
object

Avs check

created_at
string

The date and time at which the payment was created in UTC format.

Example:

"2025-05-25T14:30:00Z"

currency_code
enum<string>

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

Available options:
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
customer
object
cvc_check
object

CVC check

id
string

Unique identifier of the payment.

Example:

"pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789"

metadata
object

Custom metadata associated with the payment A dictionary of key-value pairs.

Example:
payment_details
object

Transaction details related to payment

payment_method
Card API Schema · object
payment_status
enum<string>

Current status of the payment

Available options:
PENDING,
FAILED,
AUTHORIZED,
SETTLING,
SETTLED,
DECLINED,
BLOCKED,
CANCELLED
payment_token_type
enum<string>

Type of card token used, if applicable

Available options:
CARD_PAN,
NETWORK_TOKEN,
PROCESSOR_TOKEN
payment_type
enum<string>

Indicates whether the transaction was merchant-initiated (MIT) or customer-initiated (CIT).

Available options:
MIT,
CIT
processor
object
refund
object

Information about refund

refunded_amount
integer

Amount refunded from the original payment

Example:

0

refund_reason
enum<string>

Server-attested reason the payment was refunded; present only once a refund has executed, null otherwise

Available options:
merchant_initiated,
fraud_prevention
Example:

"fraud_prevention"

statement_descriptor
string

Statement descriptor shown on the customer's bank statement

Example:

"MY COMPANY"

status_reason
object

Reason of payment status

subscription
object
tax
object

Tax info (provider, calculation/transaction ids, amounts, status)

three_d_secure
object

Information about 3DS

updated_at
string

The date and time of the last payment update in UTC format.

Example:

"2025-05-26T10:15:00Z"