Skip to main content
POST
Criar cobrança Pix
Exige uma chave de API com o escopo pix:write. Veja como criar uma em Autenticação.
O cabeçalho Idempotency-Key é obrigatório. Reenviar a mesma chave com o mesmo corpo retorna a cobrança já criada, sem duplicar; reenviar com um corpo diferente retorna 409 IDEMPOTENCY_KEY_REUSED.
Em vez de ficar consultando o status manualmente, configure um webhook para ser avisado no instante em que a cobrança for paga.

Authorizations

Authorization
string
header
required

Chave de API criada em Integrações → Chaves de API no painel.

Headers

Idempotency-Key
string
required

Identificador único seu para essa cobrança. Reenviar a mesma chave com o mesmo corpo retorna a cobrança já criada; com um corpo diferente retorna 409.

Required string length: 1 - 255

Body

application/json
amountCents
integer
required

Valor da cobrança em centavos.

Required range: 80 <= x <= 9000000000000
Example:

5000

description
string

Texto exibido para o pagador na tela de checkout.

Required string length: 1 - 255
Example:

"Pedido #8421"

externalReference
string

Identificador do seu próprio sistema.

Required string length: 1 - 255
Example:

"8421"

expiresInSeconds
integer

Tempo até a cobrança expirar, em segundos. Se omitido, o provedor Pix define um prazo padrão.

Required range: 60 <= x <= 604800
Example:

1800

customer
object

Response

Cobrança criada

charge
object