Skip to main content
POST
/
transfer-internal
/
create
curl -X POST 'https://api.goatpay.com.br/v1/transfer-internal/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "amount": 100, "recipientEmail": "destino@empresa.com", "description": "Repasse parceiro" }'

{
  "success": true,
  "message": "Transferência interna criada com sucesso",
  "data": {
    "id": "clx_interna",
    "type": "INTERNAL_TRANSFER_OUT",
    "status": "COMPLETED",
    "amount": 100,
    "feeAmount": 0,
    "netAmount": 100,
    "currency": "BRL",
    "description": "Repasse parceiro",
    "externalReference": "repasse-001",
    "transferKind": "internal",
    "recipientEmail": "destino@empresa.com",
    "recipientName": "Empresa Destino",
    "pairId": "pair_abc",
    "completedAt": "2026-06-01T16:00:00.000Z",
    "createdAt": "2026-06-01T16:00:00.000Z"
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/transfer-internal/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "amount": 100, "recipientEmail": "destino@empresa.com", "description": "Repasse parceiro" }'

{
  "success": true,
  "message": "Transferência interna criada com sucesso",
  "data": {
    "id": "clx_interna",
    "type": "INTERNAL_TRANSFER_OUT",
    "status": "COMPLETED",
    "amount": 100,
    "feeAmount": 0,
    "netAmount": 100,
    "currency": "BRL",
    "description": "Repasse parceiro",
    "externalReference": "repasse-001",
    "transferKind": "internal",
    "recipientEmail": "destino@empresa.com",
    "recipientName": "Empresa Destino",
    "pairId": "pair_abc",
    "completedAt": "2026-06-01T16:00:00.000Z",
    "createdAt": "2026-06-01T16:00:00.000Z"
  },
  "requestId": "req_abc123"
}

​
Corpo da requisição

​
amount
number
required
Valor em reais (mín. 1).
​
recipientEmail
string
required
E-mail da conta destino GoatPay.
​
description
string
Descrição opcional (máx. 180 caracteres).
​
externalReference
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