Skip to main content
POST

​
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

​
X-API-Key
string
header
required

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

Body

application/json
​
amount
number
required

Valor em reais. Mínimo R$ 1,00 no trilho PADRAO.

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

Taxa de saída conforme configuração da conta (ex. R$ 0,80 no PADRAO).

​
subaccountId
string

ID da subconta merchant. Débito no saldo da subconta; disponível apenas no trilho PADRAO (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