Transfer

Campos

Campo	Tipo	Descrição
`transferId`	`UUID`	Identificador único
`organizationId`	`UUID`	Referência à organização da cooperativa beneficiária
`cooperativeId`	`UUID`	Referência à cooperativa beneficiária
`externalProvider`	`String`	Nome do provedor externo
`externalProviderId`	`String`	ID da transferência no provedor externo
`amount`	`Int`	Valor da transferência em centavos
`status`	`TransferStatus`	Status da transferência
`transferredAt`	`DateTime?`	Data em que a transferência foi efetivada
`createdBy`	`UUID?`	Usuário que criou o registro, quando aplicável
`createdAt`	`DateTime`	Data de criação
`updatedBy`	`UUID?`	Usuário que fez a última atualização, quando aplicável
`updatedAt`	`DateTime`	Data da última atualização

Relacionamentos

Relaciona-se com Organization.
Relaciona-se com Cooperative.

Regras de Negócio

Representa um saque do saldo disponível da cooperativa, consultado e executado no provedor de billing.
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.

Valor	Descrição
`PENDING`	Transferência criada, aguardando processamento
`PROCESSING`	Em processamento no provedor
`PAID`	Transferência efetivada com sucesso
`FAILED`	Transferência falhou
`CANCELED`	Transferência cancelada

Example

{
  "transferId": "0197a818-6bdc-7d65-9096-1987a5382aa1",
  "organizationId": "0197a7f7-7291-7a43-96db-2c8580b80c5d",
  "cooperativeId": "0197a800-24e6-76a2-90ed-ff0f6fba7b0c",
  "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"
}

Data Modelling

Authorization

Benefits

Billing

Communication

Credit Grant

Export

Fleet

Identity

Observability

Operations

Sales

Support

Tenant

Webhooks

Campos

Relacionamentos

Regras de Negócio

Enums

TransferStatus

Example

​Campos

​Relacionamentos

​Regras de Negócio

​Enums

​TransferStatus

​Example

Campos

Relacionamentos

Regras de Negócio

Enums

TransferStatus

Example