Skip to main content
Transferência entre contas GoatPay no mesmo trilho da API key (PADRAO ou LIVRE). Não é PIX para banco externo: o destinatário é identificado pelo e-mail cadastrado na GoatPay. Permissões: transfer-internal/create, transfer-internal/get, transfer-internal/list.

​
Como funciona

ItemDetalhe
TaxaSem taxa GoatPay na transferência interna
DestinatáriorecipientEmail — e-mail da conta destino
TrilhoOrigem e destino no mesmo trilho (PADRAO ou LIVRE da chave)
LiquidaçãoImediata (COMPLETED) na criação
Webhooktransfer.internal.completed (envio) e transfer.internal.received (destino)
Cada operação gera duas transações no ledger: INTERNAL_TRANSFER_OUT (quem envia) e INTERNAL_TRANSFER_IN (quem recebe), ligadas por pairId na resposta.

​
Fluxo recomendado

1

1. Criar transferência

POST /transfer-internal/create com amount, recipientEmail e opcionalmente description e externalReference.Criar transferência interna
2

2. Guardar o id

Use o id retornado (transação de saída da sua conta) para consultas e reconciliação.
3

3. Acompanhar

Consultar ou Listar com filtros.Prefira webhooks em vez de polling.

​
Tipos na listagem

type na respostaSignificado
INTERNAL_TRANSFER_OUTVocê enviou
INTERNAL_TRANSFER_INVocê recebeu
Campos extras: transferKind: "internal", recipientEmail / recipientName (envio), counterpartyName (recebimento), pairId.

​
Filtros em GET /transfer-internal/list

Mesmos parâmetros das outras listagens:
ParâmetroDescrição
page / pageSizePaginação (máx. 100)
dateFrom / dateToPeríodo (createdAt, ISO 8601)
statusEx.: COMPLETED, PENDING
externalReferenceFiltro exato
searchid, descrição, referência, etc.
Resposta: items, page, pageSize, total, pages.

​
Endpoints

Criar

Enviar para e-mail GoatPay.

Consultar

Por id ou externalReference.

Listar

Histórico com filtros.
Não é possível transferir para a própria conta nem para e-mail inexistente na GoatPay. Valor mínimo R$ 1,00.