Skip to main content
GET
Get debt info for payment page (public)

Path Parameters

debtId
string
required

Query Parameters

Response

sandbox
boolean
required

Test (sandbox) debt: the page shows only the sample PIX and the "Simular pagamento" button (POST /pix/debt/:debtId/simulate-payment); nothing is charged

debtorName
string
required
Example:

"João S."

creditorName
string
required
amountFormatted
string
required
Example:

"R$ 150,00"

amount
string
required
Example:

"150.00"

originalAmount
object
required
discountPercentage
number
required
hasCollectionOffer
boolean
required
maxCardInstallments
number
required
description
string
required
dueDate
string
required
methods
object[]
required

Methods actually available for this debt (GW-20) — the frontend builds its checkout tabs from this, not from a hardcoded provider.

boletoMissingPayerData
enum<string>[]
required

Payer fields the boleto needs that the client record lacks; the checkout asks the debtor for them and sends them to generate-for-debt. Empty when nothing is missing or boleto is not offered.

Available options:
document,
zipCode,
street,
streetNumber,
neighborhood,
city,
state
mpCheckoutEnabled
boolean
required
deprecated
custody
boolean
required

PIX is received by Payable on the creditor's behalf and paid out to them (no own PIX gateway)

collectionMode
enum<string>
required

Cobrança (billing) ou Recuperação (recovery); a página mostra "Não reconheço esta dívida" só na Recuperação

Available options:
billing,
recovery
disputeOpen
boolean
required

Contestação aberta pelo cliente (recoveryStatus = disputed), aguardando a empresa

disputeVoided
boolean
required

A empresa confirmou que a cobrança é indevida (recoveryStatus = voided); a página não oferece mais a contestação

mpPublicKey
object | null
deprecated