Skip to main content

​
Campos

CampoTipoDescrição
cooperativePaymentSettingsIdUUIDIdentificador único
organizationIdUUIDReferência à organização da cooperativa
cooperativeIdUUIDReferência à cooperativa dona da configuração
externalProviderStringIdentificador lógico do provider usado pela interface de billing
externalAccountIdStringIdentificador da conta externa da cooperativa no provider
externalWalletIdString?Identificador auxiliar da carteira externa, quando existir
externalApiKeyStringAPI key externa armazenada de forma criptografada
statusCooperativePaymentSettingsStatusStatus da configuração de billing
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
deletedByUUID?Usuário que removeu o registro, quando aplicável
deletedAtDateTime?Data de remoção

​
Relacionamentos

​
Regras de Negócio

  • Cada cooperativa possui no máximo uma configuração de billing ativa.
  • A configuração pertence sempre a uma Cooperative, porque tickets e Orders são associados à cooperativa operacional.
  • externalAccountId identifica a conta externa usada pela cooperativa para cobranças, saldo, recebíveis e transferências.
  • Compra de créditos corporativos por Company não usa esta configuração como conta recebedora da Company; ela entra no fluxo master/MOB documentado em CompanyCreditPurchase.
  • externalApiKey é criptografado antes de ser persistido e nunca deve ser exibido em respostas públicas.
  • externalWalletId é uma referência externa auxiliar; não representa regra de split.

​
Enums

​
CooperativePaymentSettingsStatus

ValorDescrição
PENDINGConfiguração criada, aguardando habilitação
ACTIVEConfiguração ativa para operações financeiras
REJECTEDConfiguração recusada ou não aprovada
DISABLEDConfiguração desabilitada

​
Example

{
  "cooperativePaymentSettingsId": "0197a817-1cc7-7d9c-9d74-8149674d0ef2",
  "organizationId": "0197a7f7-7291-7a43-96db-2c8580b80c5d",
  "cooperativeId": "0197a800-24e6-76a2-90ed-ff0f6fba7b0c",
  "externalProvider": "billing_interface",
  "externalAccountId": "acct_2c9f81b0",
  "externalWalletId": "wallet_42d8a19f",
  "externalApiKey": "encrypted_external_api_key",
  "status": "ACTIVE",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T14:30:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T14:30:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}