Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Request-Id
string

Identificador opcional fornecido pelo cliente para correlação. A API aceita também X-Request-Id. O valor é ecoado de volta no header de resposta Request-Id. Se nenhum dos dois é enviado, a API gera req_<24 hex>.

Example:

"req_4a8b3c1d5e6f2a9b0c1d2e3f"

Path Parameters

checkoutId
string
required

Identificador técnico do checkout retornado na criação.

Example:

"chk_4a8b3c1d5e6f2a9b0c1d"

Response

Checkout encontrado.

Objeto principal da API de cobranças. Reúne os dados da cobrança Pix, do pagamento e da liquidação.

id
string
required

Identificador técnico do checkout. Formato chk_ + 20 caracteres hex.

Example:

"chk_4a8b3c1d5e6f2a9b0c1d"

livemode
boolean
required

true para chaves trq_live_; false para trq_test_.

Example:

false

status
enum<string>
required

Estado atual da cobrança.

Available options:
PENDING,
PAID,
REFUNDED,
EXPIRED,
CANCELLED
amount
integer
required

Valor da cobrança em centavos de BRL.

Example:

12990

currency
enum<string>
required

Moeda da cobrança. Hoje, sempre BRL.

Available options:
BRL
Example:

"BRL"

checkoutUrl
string<uri>
required

URL canônica do checkout hospedado pela TroqPay (/pay/{checkoutId}).

Example:

"https://pay.troqpay.com/pay/chk_4a8b3c1d5e6f2a9b0c1d"

createdAt
string<date-time>
required

Quando o checkout foi criado.

expiresAt
string<date-time>
required

Quando o checkout expira (se ainda não foi pago).

pix
object
required

Dados necessários para exibir o Pix ao comprador.

settlement
object
required

Dados da liquidação do checkout, em BRL.

metadata
object
required

Os pares chave-valor que você enviou. Pode ser {} se nenhum foi enviado.

description
string | null

O texto livre que você enviou na criação.

Example:

"Plano Pro"

externalId
string | null

O ID do pedido no seu sistema.

Example:

"order_1001"

paidAt
string<date-time> | null

Preenchido quando status muda para PAID.

customer
object | null

Dados do comprador. O campo phone aceito no envio não é retornado aqui.