| Termo | Significado |
|---|---|
| API key | Chave gp_live_... no header X-API-Key |
| Trilho PADRAO | Conta verificada; boleto, cartão, MED SPI, reembolso PIX |
| Trilho LIVRE | PIX simplificado com regras próprias de taxa |
| payment-pix | Receber pagamento via QR Code PIX dinâmico |
| transfer-pix | Enviar PIX para chave ou BR Code |
| payouts | Alias das rotas transfer-pix |
| billings | Cobrança avulsa (cartão, boleto, PIX em cobrança PJ) |
| subscriptions | Assinatura recorrente |
| transfer-internal | Transferência entre contas GoatPay por e-mail |
| coverFee | Define se amount é bruto, líquido ou valor ao destinatário |
| externalReference | ID do seu sistema associado à operação |
| referenceId | Identificador da operação no processador de pagamento (exposto em transações; substitui IDs técnicos internos) |
| infractionId | Identificador da infração MED no processador |
| requestId | Correlacionador de requisição para suporte |
| MED | Mecanismo Especial de Devolução (disputa PIX) |
| Subconta merchant | Carteira lógica sob a conta principal |
| whsec_ | Segredo para validar assinatura HMAC de webhook |
| Envelope | Formato { success, message, data, requestId } na API v1 |
Ajuda
Glossário
Termos da API e da plataforma GoatPay