Sign in
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"
}

Changes

Changed in 4 of the 27 revisions of this API.5814

  • e356f6586bf28See the full diff
    • ●

      added the new cancelled enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new failed enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pending enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new processing enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new requires_action enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new requires_confirmation enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new requires_payment_method enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new succeeded enum value to the status response property for the response status 200

      response-property-enum-value-added

  • a30b6aef464d114See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property accountId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property createdAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property customerRef to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property exchangeRate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property expiresAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property originalAmount to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property planRef to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property transactionId to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property amount to the response with the 200 status

      response-required-property-added

    • ○

      added the required property clientSecret to the response with the 200 status

      response-required-property-added

    • ○

      added the required property currency to the response with the 200 status

      response-required-property-added

    • ○

      added the required property processorPaymentId to the response with the 200 status

      response-required-property-added

    • ○

      added the required property publishableKey to the response with the 200 status

      response-required-property-added

    • ○

      added the required property status to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60c2cd1caf832See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 404

      response-body-type-changed

    This revision also has 192 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c6f97c4a54922See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 404

      response-body-type-changed