CooperativePaymentSettings

​

Campos

​

Relacionamentos

• Relaciona-se com Organization.
• Relaciona-se com Cooperative (1:1).

​

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 usa a configuração ativa da Cooperative escolhida como contexto do provider e conta externa recebedora.
• externalApiKey é criptografado antes de ser persistido e é aceito somente em requests de escrita.
• Respostas da OPS API nunca retornam externalApiKey; elas expõem apenas hasExternalApiKey.
• A OPS API resolve organizationId e cooperativeId pelo contexto autenticado. Esses campos não são aceitos nos requests de escrita.
• externalWalletId é uma referência externa auxiliar; não representa regra de split.

​

Enums

​

CooperativePaymentSettingsStatus

​

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",
  "hasExternalApiKey": true,
  "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
}