Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Payment Intents

Get Payment Intent

Retrieves the details of a PaymentIntent that has previously been created.

get/v1/payment_intents/{id}

Path parameters

idstring required
Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Query parameters

expandstring

Comma-separated list of related objects to expand in the response.

Comma-separated list of related objects to expand in the response.

expand_customerboolean nullable

If true, expands the customer object in the response.

If true, expands the customer object in the response.

Response

An envelope wrapping a single payment intent object.

Example response

{
  "payment_intent": {
    "payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "amount": 2500,
    "amount_capturable": 2500,
    "amount_received": 2500,
    "transfer_data": {},
    "status": "canceled",
    "created_at": "2026-06-15T14:30:00Z",
    "capture_method": "automatic",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "test_mode": false,
    "transfer_group": "example_value",
    "payment_card_type": "primary",
    "last_payment_error": {}
  }
}