Devolver à principal

Tira um valor do saldo atribuído à subconta. O dinheiro já estava no seu saldo; só deixa de ser do cliente.

POST /v1/subaccounts/{id}/return

cURL

curl -X POST https://bukio-backend-production.up.railway.app/v1/subaccounts/sacc_9f1c2d3e4a5b6c7d8e9f0a1b2c3d4e5f/return \
  -H "Authorization: Bearer bk_live_..." \
  -H "Idempotency-Key: acerto-2026-10-vendedor-42" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 5000, "description": "Acerto de comissão" }'

200

{
  "id": "SUB-4Z3F7K9Q2W8M",
  "kind": "return",
  "kindTitle": "Devolvido à principal",
  "direction": "debit",
  "amount": 5000,
  "gross": null,
  "fee": 0,
  "description": "Acerto de comissão",
  "createdAt": "2026-10-08T15:30:00.000Z",
  "subaccount": { "id": "sacc_9f1c2d3e4a5b6c7d8e9f0a1b2c3d4e5f", "externalId": "vendedor-42", "balance": 9200 }
}

Escopo subaccounts:write. Não há Pix nem tarifa: é só uma mudança de atribuição, registrada como um movimento SUB- do tipo return. Vale também com a subconta desativada.

id · string · required

sacc_ + 32 hex ou o seu externalId.

Idempotency-Key · string · required

8 a 128 caracteres, única por devolução. Repetir com os mesmos dados devolve o mesmo movimento, sem devolver de novo.

amount · integer · required

Valor em centavos. Acima do saldo da subconta: 422 INSUFFICIENT_SUBACCOUNT_BALANCE.

description · string

Até 140 caracteres.

​

Resposta

O movimento criado, no formato de Movimentos da subconta (kind: "return", direction: "debit"), mais subaccount com o saldo dela depois.

cURL

curl -X POST https://bukio-backend-production.up.railway.app/v1/subaccounts/sacc_9f1c2d3e4a5b6c7d8e9f0a1b2c3d4e5f/return \
  -H "Authorization: Bearer bk_live_..." \
  -H "Idempotency-Key: acerto-2026-10-vendedor-42" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 5000, "description": "Acerto de comissão" }'

200

{
  "id": "SUB-4Z3F7K9Q2W8M",
  "kind": "return",
  "kindTitle": "Devolvido à principal",
  "direction": "debit",
  "amount": 5000,
  "gross": null,
  "fee": 0,
  "description": "Acerto de comissão",
  "createdAt": "2026-10-08T15:30:00.000Z",
  "subaccount": { "id": "sacc_9f1c2d3e4a5b6c7d8e9f0a1b2c3d4e5f", "externalId": "vendedor-42", "balance": 9200 }
}