Skip to main content
POST
Simular Pagamento
Simula o pagamento de um QR Code PIX no ambiente de desenvolvimento. Só funciona com chaves de API de sandbox.

Requer a permissão CHECKOUT:READ. Disponível apenas em devMode.
Use para testar o fluxo completo sem precisar realizar um PIX real: crie um QR Code, simule o pagamento e confirme que seu webhook ou polling recebe o status PAID.
Em produção este endpoint retorna erro. Ative o modo de desenvolvimento para usá-lo.

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
required

Identificador único do Checkout Transparente

Body

application/json
metadata
object

Metadados opcionais para a requisição

Response

Pagamento ralizado com sucesso

data
object
error
string | null
Example:

null

success
boolean

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

Example:

true