Skip to main content
POST
/
subaccount
/
transfer
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/transfer' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fromSubaccountId": "clx_sub_a",
    "toSubaccountId": "clx_sub_b",
    "amount": 30,
    "description": "Repasse interno"
  }'

{
  "success": true,
  "message": "Transferência entre subcontas",
  "data": {
    "outTransactionId": "clx_tx_from",
    "inTransactionId": "clx_tx_to",
    "amount": 30
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/subaccount/transfer' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fromSubaccountId": "clx_sub_a",
    "toSubaccountId": "clx_sub_b",
    "amount": 30,
    "description": "Repasse interno"
  }'

{
  "success": true,
  "message": "Transferência entre subcontas",
  "data": {
    "outTransactionId": "clx_tx_from",
    "inTransactionId": "clx_tx_to",
    "amount": 30
  },
  "requestId": "req_abc123"
}
​
fromSubaccountId
string
required
Subconta de origem.
​
toSubaccountId
string
required
Subconta de destino.
​
amount
number
required
Valor em reais.
​
description
string
Descrição opcional.
​
externalReference
string
Idempotência.

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
fromSubaccountId
string
required
​
toSubaccountId
string
required
​
amount
number
required
​
description
string
​
externalReference
string

Response

200 - application/json

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Pagamento PIX criado com sucesso"

​
data
object
required
​
requestId
string