Skip to main content
POST
/
v1
/
payment_intents
Create
curl --request POST \
  --url https://{defaultHost}/v1/payment_intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_intent": {
    "customer": "b41c736a-622d-497e-96fd-79368a8d93c5",
    "processor_type": "stripe"
  }
}
'
{
  "id": "2b216c2c-784c-4ab9-b2fc-b7544902ec99",
  "object": "payment_intent",
  "amount": 0,
  "currency": "usd",
  "external_intent_id": "seti_Q0kyFINiyyO9lFH",
  "live_mode": true,
  "off_session": false,
  "processor_data": {
    "stripe": {
      "account_id": "external_account_46",
      "publishable_key": "pk_test_51KeWoQFugiAKLuJycCZesY1aYEzfauqW2SHSZSUj5xCorx7h7oZd5i6Vz2whx7Y5fMZr6WQQTeOoQEtaEnpk4fkB00dinySlbK",
      "client_secret": "seti_1Pgag7B7WZ01zgkWSgwGdb8Z_secret_QXg2AQLdBxJwtY51IkwvUaBVsnCqPSp",
      "type": "setup",
      "payment_method_id": null
    }
  },
  "processor_type": "stripe",
  "reusable": true,
  "status": "pending",
  "checkout": null,
  "customer": "b41c736a-622d-497e-96fd-79368a8d93c5",
  "payment_method": null,
  "platform_fee": null,
  "service_fee": null,
  "created_at": 1767909729,
  "updated_at": 1767909729
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
payment_intent
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
amount
integer

The amount intended to be collected by this payment intent.

​
payment_method_type
string

The payment method type to use for this payment intent. This is only applicable for mollie processors.

​
return_url
string

The URL the customer will be redirected to after the payment process. This is only applicable for mollie processors.

​
live_mode
boolean

Set to true if this checkout is in live mode, and set to false if it is in test mode.

​
processor_type
string

The processor being used for this checkout. The only allowed processors right now are stripe and paypal.

​
checkout

Expandable – The associated checkout ID.

​
currency
string

Three-letter ISO currency code, in lowercase. This value will match the Account currency.

​
customer

Expandable – The associated customer ID.

​
external_intent_id
string

The external ID necessary to capture payment through this processor. For example, if processing through Stripe, the external_intent_id will be set to the Stripe::PaymentIntent ID.

​
off_session
boolean

Set to true to indicate that the customer is not in the checkout flow during the payment attempt. When off_session=true payment collection will be attempted immediately.

​
payment_method

Expandable – The associated payment method ID.

​
platform_fee

Expandable – The associated platform fee ID.

​
processor_data
object

All of the additional data necessary to capture payment with this processor.

​
reusable
boolean

Whether or not the payment method that is generated from this payment intent should be reusable or not.

​
service_fee

Expandable – The associated service fee ID.

​
status
string

The status of this payment intent, one of pending, canceled, failed, processing, requires_action, requires_capture, or succeeded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.