Skip to main content
Guia completo: PIX automático. 
curl -X POST 'https://api.goatpay.com.br/v1/pix-automatic/authorizations/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "frequency": "MONTHLY", "contractId": "CONTRACT-123", "startDate": "2026-06-01", "customerId": "cus_cliente_psp", "value": 99.9, "description": "Assinatura mensal", "immediateQrCode": { "expirationSeconds": 3600, "originalValue": 10, "description": "Taxa de adesão" } }'

{
  "success": true,
  "message": "Autorização PIX Automático criada",
  "data": {
    "id": "a33047b1-fb19-4b68-9373-a7ba8a8162aa",
    "status": "CREATED",
    "frequency": "MONTHLY",
    "contractId": "CONTRACT-123",
    "value": 99.9,
    "startDate": "2026-06-01",
    "customerId": "clx_customer",
    "description": "Assinatura mensal",
    "dateCreated": "2026-05-31T10:00:00.000Z"
  },
  "requestId": "req_abc"
}

​
Corpo da requisição

​
frequency
string
required
WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY.
​
contractId
string
required
Código do contrato (máx. 35 caracteres).
​
startDate
string
required
Início da vigência YYYY-MM-DD.
​
customerId
string
required
ID do cliente (POST /customers/create).
​
immediateQrCode
object
required
Primeira cobrança que ativa a autorização.
​
immediateQrCode.originalValue
number
required
Valor da 1ª parcela.
​
immediateQrCode.expirationSeconds
number
required
Validade do QR em segundos.
​
value
number
Valor fixo das recorrências (obrigatório com paymentCreationMode SUBSCRIPTION).
​
finishDate
string
Fim da vigência YYYY-MM-DD.
​
paymentCreationMode
string
MANUAL (padrão) ou SUBSCRIPTION.
Produto deve estar habilitado na sua conta — solicite ao suporte GoatPay se receber erro de produto indisponível.