Skip to main content
POST

Corpo da requisição

number
required
Valor em reais (mín. 1).
string
required
E-mail da conta destino GoatPay.
string
Descrição opcional (máx. 180 caracteres).
string
Referência externa (máx. 120). Idempotência se repetir o mesmo valor.

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
recipientEmail
string<email>
required
description
string
Maximum string length: 180
externalReference
string

Response

Transferência interna 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