Skip to main content
GET
Buscar um Checkout
Retorna os dados completos de um checkout pelo seu id.
Requer a permissão CHECKOUT:READ.
Use este endpoint para verificar o status de uma cobrança após o cliente retornar ao seu site, ou ao receber um webhook de pagamento. Valores de status:

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

id
string

Identificador único do Checkout

Example:

"bill_abc123xyz"

externalId
string

Identificador do Checkout no seu sistema

Example:

"pedido-123"

customerId
string

Identificador do cliente associado

Example:

"cust_abc123xyz"

method
enum<string>

Método de pagamento

Available options:
PIX,
CARD,
BOLETO

Response

Cobrança encontrada com sucesso.

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true