Skip to main content
GET
/
v1
/
payment_intents
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/payment_intents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "acf38c5c-f33e-467b-91bc-34f00a06ef45",
  "object": "payment_intent",
  "amount": 500,
  "currency": "usd",
  "external_intent_id": "pi_3JhDzG2fs4LLhxzS06L7dgBR",
  "live_mode": true,
  "off_session": false,
  "processor_data": {
    "stripe": {
      "account_id": "external_account_47",
      "publishable_key": "pk_test_51KeWoQFugiAKLuJycCZesY1aYEzfauqW2SHSZSUj5xCorx7h7oZd5i6Vz2whx7Y5fMZr6WQQTeOoQEtaEnpk4fkB00dinySlbK",
      "client_secret": "pi_3K6NFo2fs4LLhxzS1leftxKh_secret_qoy2TA8XJEYKTp4bbF8hT3clV",
      "type": "payment",
      "payment_method_id": null
    }
  },
  "processor_type": "stripe",
  "reusable": false,
  "status": "pending",
  "checkout": null,
  "customer": "73a646e4-0881-4983-a73f-a651a2c258e4",
  "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.

Path Parameters

​
id
string
required

Query Parameters

​
refresh_status
boolean

If true, the server will check the associated payment processor to see if a status change has occured. (This should be used when retrieving a checkout or payment intent immediately after it has been paid through the processor. In this scenario, it's possible that you'll request the checkout before the server has received the webhook from the processor. Setting this pararmeter to true prevents this scenario.)

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.