curl -X POST 'https://api.goatpay.com.br/v1/transfer-pix/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "amount": 50, "pixKey": "12345678909", "pixKeyType": "CPF", "description": "Saque PIX", "coverFee": true }'
{
"success": true,
"message": "Transferência PIX criada com sucesso",
"data": { "id": "clx_transacao", "status": "PENDING" },
"requestId": "req_abc"
}
Enviar
Enviar PIX
Envia PIX para chave PIX ou copia e cola (BR Code).
POST
/
transfer-pix
/
create
curl -X POST 'https://api.goatpay.com.br/v1/transfer-pix/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "amount": 50, "pixKey": "12345678909", "pixKeyType": "CPF", "description": "Saque PIX", "coverFee": true }'
{
"success": true,
"message": "Transferência PIX criada com sucesso",
"data": { "id": "clx_transacao", "status": "PENDING" },
"requestId": "req_abc"
}
curl -X POST 'https://api.goatpay.com.br/v1/transfer-pix/create' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "amount": 50, "pixKey": "12345678909", "pixKeyType": "CPF", "description": "Saque PIX", "coverFee": true }'
{
"success": true,
"message": "Transferência PIX criada com sucesso",
"data": { "id": "clx_transacao", "status": "PENDING" },
"requestId": "req_abc"
}
Corpo da requisição
number
required
Valor em reais. Mínimo R$ 1,00.
string
required
Descrição da transferência.
string
Chave PIX (obrigatório se não usar pixCopyPaste).
string
CPF, CNPJ, EMAIL, TELEFONE ou CHAVE_ALEATORIA.
string
CPF/CNPJ do titular (dígitos). Opcional/legado; transferências por chave PIX não exigem mais esse dado.
string
BR Code para pagar QR de terceiros.
boolean
Padrão true:
amount é o valor recebido pelo destinatário.pixCopyPaste (BR Code) exige trilho PADRÃO. /payouts/* é alias de /transfer-pix/*.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:
x >= 1Required string length:
3 - 180Available options:
CPF, CNPJ, EMAIL, TELEFONE, CHAVE_ALEATORIA CPF ou CNPJ do titular da chave (11 ou 14 dígitos, sem formatação).
Campo opcional/legado; transferências por chave PIX não exigem mais CPF/CNPJ do titular.
Em pagamentos por pixCopyPaste, o PSP pode inferir esse dado do BR Code quando disponível.
BR Code para pagar QR de terceiros.
Taxa de saída conforme configuração da conta (ex. R$ 0,80 no PADRAO).
ID da subconta merchant. Débito no saldo da subconta; disponível apenas no trilho PADRAO (requer merchantSubaccountsPixEnabled).