Skip to main content
GET
/
transfer-internal
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/transfer-internal/get/clx_interna' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Transferência interna encontrada",
  "data": {
    "id": "clx_interna",
    "type": "INTERNAL_TRANSFER_OUT",
    "status": "COMPLETED",
    "amount": 100,
    "feeAmount": 0,
    "netAmount": 100,
    "currency": "BRL",
    "description": "Pagamento parceiro",
    "externalReference": "repasse-001",
    "transferKind": "internal",
    "recipientEmail": "destinatario@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 GET 'https://api.goatpay.com.br/v1/transfer-internal/get/clx_interna' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Transferência interna encontrada",
  "data": {
    "id": "clx_interna",
    "type": "INTERNAL_TRANSFER_OUT",
    "status": "COMPLETED",
    "amount": 100,
    "feeAmount": 0,
    "netAmount": 100,
    "currency": "BRL",
    "description": "Pagamento parceiro",
    "externalReference": "repasse-001",
    "transferKind": "internal",
    "recipientEmail": "destinatario@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"
}

​
Parâmetros

​
id
string
required
ID da transação ou externalReference.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

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