Skip to main content
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_pix_out",
    "type": "PIX_OUT",
    "status": "PROCESSING",
    "amount": 50,
    "feeAmount": 2,
    "netAmount": 52,
    "coverFee": true,
    "currency": "BRL",
    "description": "Saque PIX",
    "pixKey": "12345678909",
    "pixKeyType": "CPF",
    "referenceId": "ref_out_xyz",
    "createdAt": "2026-06-01T13:00:00.000Z"
  },
  "requestId": "req_abc123"
}

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_pix_out",
    "type": "PIX_OUT",
    "status": "PROCESSING",
    "amount": 50,
    "feeAmount": 2,
    "netAmount": 52,
    "coverFee": true,
    "currency": "BRL",
    "description": "Saque PIX",
    "pixKey": "12345678909",
    "pixKeyType": "CPF",
    "referenceId": "ref_out_xyz",
    "createdAt": "2026-06-01T13:00:00.000Z"
  },
  "requestId": "req_abc123"
}

​
Corpo da requisição

​
amount
number
required
Valor em reais. Mínimo R$ 1,00.
​
description
string
required
Descrição da transferência.
​
pixKey
string
Chave PIX (obrigatório se não usar pixCopyPaste).
​
pixKeyType
string
CPF, CNPJ, EMAIL, TELEFONE ou CHAVE_ALEATORIA.
​
pixKeyOwnerDocument
string
CPF ou CNPJ do titular da chave (somente dígitos). Campo opcional/legado; transferências por chave PIX não exigem mais CPF/CNPJ do titular. Em pixCopyPaste, pode vir do BR Code quando o PSP informar o documento do destinatário.
​
pixCopyPaste
string
BR Code para pagar QR de terceiros.
​
coverFee
boolean
Padrão true: amount é o valor recebido pelo destinatário.
​
subaccountId
string
ID da subconta merchant. O saque debita o saldo da subconta. Use a mesma rota transfer-pix/create — veja o guia de subcontas.
pixCopyPaste (BR Code) exige trilho PADRÃO. /payouts/* é alias de /transfer-pix/*.
Para agendar ou repetir envios, use POST /transfer-scheduled/create com triggerType, scheduledAt ou recurrenceRule — guia.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
​
amount
number
required
Required range: x >= 1
​
description
string
required
Required string length: 3 - 180
​
pixKey
string
​
pixKeyType
enum<string>
Available options:
CPF,
CNPJ,
EMAIL,
TELEFONE,
CHAVE_ALEATORIA
​
pixKeyOwnerDocument
string

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.

​
pixCopyPaste
string

BR Code para pagar QR de terceiros.

​
externalReference
string
​
coverFee
boolean
default:true
​
subaccountId
string

ID da subconta merchant. Débito no saldo da subconta (requer merchantSubaccountsPixEnabled).

Response

Transferência PIX criada ou consultada.

​
success
boolean
required
​
message
string
required
​
data
object
required

Transação exposta na API pública após sanitização. Não inclui provider, accountId, metadata, pixRail, direction, updatedAt nem providerStatus.

​
requestId
string