Skip to main content
GET
Get payment session

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Path Parameters

id
string
required

Identifier of the payment session.

Response

object | null

Payment session details

Payment session details. Returns null if not found.

id
string
required

Unique identifier of the payment session.

Example:

"ps_1234567890abcdefghij"

createdAt
string<date-time>
required

When the session was created.

Example:

"2025-01-15T18:00:00.000Z"

updatedAt
string<date-time>
required

When the session was last updated.

Example:

"2025-01-15T18:00:00.000Z"

status
enum<string>
required

Current session status.

Available options:
PENDING,
FINALIZED,
CANCELED,
EXPIRED
Example:

"PENDING"

displayMode
enum<string>
required

How the payment UI is presented.

Available options:
CUSTOMER_PORTAL,
CUSTOM,
EMBEDDED
Example:

"CUSTOMER_PORTAL"

origin
enum<string>
required

How the session was created.

Available options:
API,
INVOICE,
LISTING
Example:

"API"

expiresAt
required

Optional expiration date of the session.

Example:

null

totalAmount
number
required

Total amount in minor currency units.

Example:

150000

currency
string
required

ISO 4217 currency code.

Example:

"MXN"

customerId
string | null
required

Identifier of the customer associated with the session, if any.

Example:

null

returnUrl
string | null
required

URL to redirect to after successful payment.

Example:

null

cancelUrl
string | null
required

URL to redirect to if the payer cancels.

Example:

null

organizationId
string
required

Identifier of the owning organization.

Example:

"org_1234567890abcdefghij"

items
object[]
required

Line items in the session.

customer
object
required

Customer associated with the session, if any.

metadata
object[] | null
required

Session-level metadata entries.