Skip to main content
GET
Get payment details for checkout page (public)

Path Parameters

paymentId
string
required

Query Parameters

Response

id
string<uuid>
required
amount
object
required
status
enum<string>
required
Available options:
PENDING,
PAID,
EXPIRED,
CANCELLED,
REFUNDED,
FAILED,
CHARGEBACK
paymentMethod
string
required
Example:

"pix"

custody
boolean
required

Charged on Payable's account on the creditor's behalf (Recebimentos)

sandbox
boolean
required

Sample PIX of a test (sandbox) debt: nothing is charged; pay it with "Simular pagamento"

qrCode
object | null
ticketUrl
object | null
expiresAt
object | null
creditorName
string | null

Set when custody