Skip to main content
POST
Create a one-time payment

Authorizations

Authorization
string
header
required

Merchant API key bearer token.

Headers

Idempotency-Key
string
required

Client-supplied unique key for safe retries of this mutating request. Scoped per merchant or resource as documented on each endpoint.

Example:

"idem-01"

Body

application/json

Payment creation payload.

customerId
string
required
merchantId
string
required
paymentInstrumentId
string
required
captureMethod
enum<string>
default:automatic
Available options:
automatic,
manual
priceId
string
amount
integer
Required range: 0 < x <= 9007199254740991
currency
string

Supported currency code (USD, CAD)

Required string length: 3
description
string
Required string length: 1 - 1000
metadata
object

Response

paymentId
string
required
idempotencyKey
string
required
Minimum string length: 1
customerId
string
required
merchantId
string
required
paymentInstrumentId
string
required
priceId
string
required
captureMethod
enum<string>
required
Available options:
automatic,
manual
amount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
currency
string
required

Supported currency code (USD, CAD)

Required string length: 3
status
enum<string>
required
Available options:
pending,
authorized,
captured,
completed,
voided,
refunded,
declined,
returned
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
description
string
Required string length: 1 - 1000
metadata
object
authorizedAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
capturedAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
settledAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
voidedAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
declineCode
enum<string>
Available options:
insufficient_funds,
expired_card,
invalid_card,
invalid_cvv,
fraud_suspected,
do_not_honor,
limit_exceeded,
card_not_supported,
account_closed,
account_frozen,
invalid_account,
duplicate_transaction,
stop_payment,
transaction_not_permitted,
processing_error,
generic_decline,
unknown
declineMessage
string