Skip to main content

​
Campos

CampoTipoDescrição
transferIdUUIDIdentificador único
organizationIdUUIDReferência à organização da empresa beneficiária
companyIdUUIDReferência à empresa beneficiária
bankAccountIdUUIDReferência à conta bancária
externalProviderStringNome do provedor externo
externalProviderIdStringID da transferência no provedor externo
amountIntValor da transferência em centavos
statusTransferStatusStatus da transferência
transferredAtDateTime?Data em que a transferência foi efetivada
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização

​
Relacionamentos

​
Regras de Negócio

  • Representa um saque do saldo disponível da empresa (consultado no provedor) para sua conta bancária.
  • O valor (amount) é armazenado em centavos.
  • O par externalProvider + externalProviderId garante idempotência.
  • transferredAt é preenchido quando a transferência é efetivada (status PAID).
  • A transferência não vincula recebíveis; ela movimenta o saldo já liquidado no provedor.

​
Enums

​
TransferStatus

O status acompanha o processamento no provedor. Default PENDING; PAID indica transferência efetivada.
ValorDescrição
PENDINGTransferência criada, aguardando processamento
PROCESSINGEm processamento no provedor
PAIDTransferência efetivada com sucesso
FAILEDTransferência falhou
CANCELEDTransferência cancelada

​
Example

{
  "transferId": "0197a818-6bdc-7d65-9096-1987a5382aa1",
  "organizationId": "0197a801-1690-7590-b3cf-19599b9be3e4",
  "companyId": "0197a801-6a42-79aa-9e56-d3c85148c0fa",
  "bankAccountId": "0197a817-f0e7-7c45-bcf2-5b6e967c2b2a",
  "externalProvider": "billing_interface",
  "externalProviderId": "trf_3c35a871",
  "amount": 500000,
  "status": "PROCESSING",
  "transferredAt": null,
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-05T10:00:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-05T10:00:00.000Z"
}