Skip to main content
GET
Get a one-time payment

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
status
enum<string>
required
Available options:
PENDING,
CONFIRMED,
CANCELLED
amount
number
required
currency
string
required
externalId
string
required

Your own identifier, unique within your organization.

url
string<uri>

The checkout URL.

description
string
expiresAt
string<date-time>
expired
boolean

Derived at read time, so it is never stale.

redirectUrl
string | null
homepageUrl
string | null
allowedTerms
integer[] | null

The installment plans the checkout offers, as numbers of monthly installments (1 is a single payment). null offers every plan active on your account.

Example:
createdAt
string<date-time>
updatedAt
string<date-time>
customer
object | null