Skip to main content
POST
Start a payment attempt

Authorizations

Authorization
string
header
required

Your secret key, e.g. sk_live_... or sk_sandbox_....

Headers

X-Idempotency-Key
string

Optional key, 8 to 128 characters, that makes this request safe to retry. The first response is stored for 24 hours; a repeat returns it unchanged with X-Idempotent-Replayed: true.

Required string length: 8 - 128

Path Parameters

paymentIntentId
string
required

The payment intent id.

Body

application/json
method_code
string
required

A code returned by the methods endpoint for this payment. Do not hard-code it.

Example:

"test"

country
string
required

ISO 3166-1 alpha-2 code the payer is paying from.

Required string length: 2
Example:

"US"

phone
object
required
currency
string

Charge in this currency instead of the intent's.

Required string length: 3

Response

Attempt started.

message
string
data
object