Skip to main content
GET
Buscar um Checkout
Retorna um checkout pelo id, pelo externalId ou pelo customerId. Use para conferir o status quando o cliente volta ao seu site ou quando chega um webhook.
Requer a permissão CHECKOUT:READ.

Entenda o checkout

O que significa cada status, quando paidAmount é preenchido e o que muda com o upsell.
Exemplo:

Erros

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. Casa o checkout que oferece este método, mesmo que ofereça outros também.

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