Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-204887241.6 KB

d29ab7373802

Payment Intents

Get a specific payment intent

Retrieves detailed information about a specific payment intent including amount, currency, and client secret.

get/v1/sdk/payment-intents/{reference}

Path parameters

referencestring required

Payment intent reference or processor payment ID

Response

Payment intent retrieved successfully

accountIdstring

Connected Stripe account ID (only present on create)

amountnumber required

Amount in USD minor units (ledger/normalised). The charge-currency amount is originalAmount paired with currency.

clientSecretstring required

Client secret used to confirm the payment on the client

createdAtstring

Creation timestamp

currencystring required

ISO 4217 presentment (charge) currency code — pairs with originalAmount

customerRefstring

Customer reference

exchangeRatenumber

Exchange rate applied to convert to USD

expiresAtstring

Expiry timestamp of the payment intent

originalAmountnumber

Charge-currency amount in minor units (the currency the customer is billed in)

planRefstring

Plan reference

processorPaymentIdstring required

Payment processor payment intent ID

publishableKeystring required

Stripe publishable key for the environment

status'pending' | 'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'succeeded' | 'failed' | 'cancelled' required

Payment intent status

transactionIdstring

Ledger transaction ID

Example response

{
  "accountId": "acct_1A2B3C4D",
  "amount": 4999,
  "clientSecret": "pi_1a2b3c4d5e6f7g8h_secret_AbCdEf123456",
  "createdAt": "2025-10-18T10:30:00.000Z",
  "currency": "usd",
  "customerRef": "cus_3c4d5e6f7g8h",
  "exchangeRate": 1,
  "expiresAt": "2025-10-19T10:30:00.000Z",
  "originalAmount": 4999,
  "planRef": "pln_2b3c4d5e6f7g",
  "processorPaymentId": "pi_1a2b3c4d5e6f7g8h",
  "publishableKey": "pk_test_...",
  "status": "requires_payment_method",
  "transactionId": "507f1f77bcf86cd799439011"
}