Skip to main content
POST
Create a payment

Authorizations

Authorization
string
header
required

Secret, platform or publishable API key. Platform keys require Payments-Account.

Headers

payments-account
string

Required for platform keys; refused for secret/publishable keys.

payments-version
enum<string>
Available options:
2026-11-01
idempotency-key
string
required
Required string length: 1 - 255

Body

application/json
amount
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
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,
INR,
IQD,
IRR,
ISK,
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,
MXV,
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,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
USN,
UYI,
UYU,
UYW,
UZS,
VED,
VES,
VND,
VUV,
WST,
XAD,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWG
capture_method
enum<string>
Available options:
automatic,
manual
checkout
string
checkout_session
string

Immutable cart reference; platform key only. Copied on retry.

Minimum string length: 1
confirm
boolean
customer
string
Pattern: ^cus_[a-f0-9]{12}$
description
string
descriptor_product
string
future_usage
enum<string>
Available options:
none,
on_session,
off_session
initiator
enum<string>
Available options:
customer,
merchant
ip_country
string
Pattern: ^[A-Z]{2}$
line_items
object[]
merchant_reference
string
metadata
object
parent_payment
string | null
Pattern: ^pay_[a-f0-9]{12}$
payment_method
Pattern: ^inst_[a-f0-9]{12}$
payment_method_data
object
purpose
enum<string>
Available options:
sale,
signup,
upsell,
renewal,
verification
return_url
string<uri>
routing_tags
string[]
Pattern: ^[^=]+=.+$
save_payment_method
boolean
shipping
object
shopper
object
store
string
Pattern: ^store_[a-f0-9]{12}$
test_clock
string
Pattern: ^clk_[0-9a-hjkmnp-tv-z]{26}$

Response

Payment. A decline is a result, not an API error.

amount
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
amount_capturable
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
amount_captured
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
amount_disputed
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
amount_refund_pending
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
amount_refunded
integer
required

Integer amount in the currency minor unit.

Required range: 0 <= x <= 2147483647
capture_method
enum<string> | null
required
Available options:
automatic,
manual,
null
checkout
string | null
required
checkout_session
string | null
required
client_secret
string | null
required
concluded_at
string<date-time> | null
required
created_at
string<date-time>
required
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BHD,
BIF,
BMD,
BND,
BOB,
BOV,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
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,
INR,
IQD,
IRR,
ISK,
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,
MXV,
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,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
USN,
UYI,
UYU,
UYW,
UZS,
VED,
VES,
VND,
VUV,
WST,
XAD,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWG
customer
string | null
required
Pattern: ^cus_[a-f0-9]{12}$
description
string | null
required
descriptor_product
string | null
required
expires_at
string<date-time> | null
required
future_usage
enum<string>
required
Available options:
none,
on_session,
off_session
id
string
required
Pattern: ^pay_[a-f0-9]{12}$
initiator
enum<string>
required
Available options:
customer,
merchant
ip_country
string | null
required
last_outcome
object | null
required
merchant_reference
string | null
required
metadata
object
required
mode
enum<string>
required
Available options:
live,
test
next_action
object
required
object
enum<string>
required
Available options:
payment
parent_payment
string | null
required
Pattern: ^pay_[a-f0-9]{12}$
payment_method
string | null
required
Pattern: ^inst_[a-f0-9]{12}$
payment_method_type
enum<string> | null
required
Available options:
card,
apple_pay,
google_pay,
link,
paypal,
klarna,
afterpay,
ideal,
null
policy_version
string
required
Pattern: ^polv_[0-9a-hjkmnp-tv-z]{26}$
purpose
enum<string>
required
Available options:
sale,
signup,
upsell,
renewal,
verification
renewal_cycle
string | null
required
retry_of
string | null
required
Pattern: ^pay_[a-f0-9]{12}$
return_url
string<uri> | null
required
routing_tags
string[]
required
saved_payment_method
object | null
required
statement_descriptor
string | null
required
status
enum<string>
required
Available options:
requires_payment_method,
requires_confirmation,
processing,
requires_action,
requires_capture,
succeeded,
failed,
canceled
store
string
required
Pattern: ^store_[a-f0-9]{12}$