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.

Dividir um recebimento

Envie splits para repartir o valor líquido da cobrança entre até 20 contas ZynPay. Cada accountId é o UUID de uma conta destinatária verificada e cada amountCents é um inteiro em centavos.
A tarifa é descontada primeiro. A soma dos splits deve ser menor ou igual a netAmountCents; o restante é creditado na conta que criou a cobrança. Quando o Pix é confirmado, toda a divisão é liquidada de forma idempotente. Cada destinatário vê Split recebido no extrato, recebe notificação no painel e push, e pode assinar o webhook split.received.
O split é imutável depois que a cobrança é criada. Reutilizar a mesma Idempotency-Key com destinatários ou valores diferentes retorna 409 IDEMPOTENCY_KEY_REUSED.

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
splits
object[]

Divisão do valor líquido. Cada destinatário deve ser uma conta ZynPay verificada e distinta da conta criadora. A soma não pode superar netAmountCents.

Maximum array length: 20
tracking
object

Identificadores opcionais de campanha e clique usados pelos plugins de conversão.

Response

Cobrança criada

charge
object