Receber
Criar cobrança PIX
Gera QR Code para o cliente pagar.
POST
Corpo da requisição
number
required
Valor em reais. Mínimo R$ 1,00.
string
required
Descrição da cobrança (3 a 180 caracteres).
boolean
Se true,
amount é o líquido desejado. Padrão false (valor bruto do QR).boolean
Se true, emite nota fiscal após pagamento (requer emissão fiscal automática ativa no dashboard).
integer
Tempo de expiração do QR Code PIX em segundos. Padrão
86400 (24 horas). Mínimo 60, máximo 604800 (7 dias).string
Nome do pagador.
string
CPF ou CNPJ do pagador.
string
Referência externa do seu sistema.
string
E-mail GoatPay do parceiro no split interno.
number
Percentual do líquido repassado ao splitUser (0,01 a 100).
Use webhooks (
payment.created, payment.paid) para confirmar pagamento sem polling.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Body
application/json
Valor em reais. Mínimo R$ 1,00 no trilho PADRAO.
Required range:
1 <= x <= 1000000Required string length:
3 - 180Maximum string length:
120Maximum string length:
14Maximum string length:
120Taxa fixa configurada no trilho PADRAO (ex. R$ 0,50 ou R$ 0,80).
Emite nota fiscal após pagamento confirmado (requer emissão fiscal automática ativa no dashboard).
Tempo de expiração do QR Code PIX em segundos. Padrão 86400 (24 horas).
Required range:
60 <= x <= 604800E-mail GoatPay do parceiro no split interno.
Required range:
0.01 <= x <= 100ID da subconta merchant. Líquido credita na subconta; disponível apenas no trilho PADRAO (requer merchantSubaccountsPixEnabled).

