Authorizations

​
Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
payment_intent_id
string
required

The ID if the Payment Intent to confirm.

Body

application/json
​
payment_method_id
string
required

ID of the payment method to confirm the intent with.

Response

200 - application/json
​
id
string
required
​
amount
integer
required

Amount in cents

Required range: x > 0
​
currency
enum<string>
required
Available options:
usd
​
user_id
string
​
status
enum<string>
Available options:
initialized,
created,
requires_payment_method,
requires_confirmation,
requires_action,
processing,
succeeded,
requires_capture,
canceled,
failed
​
transfer_id
string
​
payment_method_id
string
​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
client_secret
string

Only availble on payment intent creation.

Retrieve a Payment IntentList all Transfer Batches