Skip to main content
GET
Retrieve a Payment Intent
Use this server-side endpoint to recover the latest payment state or receipt. Send the secret key in X-API-Key. The response intentionally excludes client_secret.

Authorizations

X-API-Key
string
header
required

Server-side secret key (sk_...) supplied in X-API-Key. Never expose this key in a browser or mobile app.

Path Parameters

id
string<uuid>
required

Payment Intent identifier returned by the create operation.

Response

Payment intent retrieved.

id
string<uuid>
required

Unique Payment Intent identifier (UUID v7).

amount
integer<int64>
required

Payment amount in the currency's smallest unit (for PHP, centavos).

currency
string
required

ISO 4217 currency code.

status
enum<string>
required

Authoritative intent or latest payment-attempt status.

Available options:
ACTIVE,
EXPIRED,
CONSUMED,
CANCELLED,
REQUIRES_ACTION,
PROCESSING,
SUCCEEDED,
DECLINED,
FAILED
updated_at
string<date-time>
required

UTC RFC 3339 timestamp when the returned state was last updated.

order_reference
string

Merchant-defined order reference supplied when the Payment Intent was created. Omitted when no order reference was supplied.

Maximum string length: 100
payment_attempt_id
string<uuid>

Identifier of the latest payment attempt. Omitted until an attempt exists.

user_message
string

Customer-safe message for the latest outcome. Omitted when no message is available.

failure_category
enum<string>

Normalized failure category for a failed attempt. PROCESSOR_UNAVAILABLE means the processor or issuer network returned an authoritative unavailable response and no authorization was created. CARD_NOT_ELIGIBLE means the card was rejected by a card-eligibility rule before reaching the processor. Omitted for non-failure states.

Available options:
VERIFICATION_REJECTED,
VERIFICATION_UNAVAILABLE,
PAYMENT_REJECTED,
PAYMENT_PROCESSING_ERROR,
PROCESSOR_UNAVAILABLE,
CARD_NOT_ELIGIBLE
receipt
object

Receipt details for a successful payment. Omitted when no successful payment exists.