Skip to main content
POST
Criar um Pacote de Cobrança

Cabeçalhos

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

O identificador único da Organização associada ao Ledger.

Corpo

application/json
createdAt
string
obrigatório
Exemplo:

"2026-01-01T00:00:00Z"

enable
boolean | null
obrigatório
Exemplo:

true

id
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

label
string
obrigatório
Exemplo:

"Monthly Volume Billing"

ledgerId
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

organizationId
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

type
string
obrigatório
Exemplo:

"volume"

updatedAt
string
obrigatório
Exemplo:

"2026-01-01T00:00:00Z"

accountTarget
object
assetCode
string
Exemplo:

"BRL"

countMode
string
Exemplo:

"perRoute"

creditAccountAlias
string
Exemplo:

"account_fees_credit"

debitAccountAlias
string
Exemplo:

"account_fees_debit"

deletedAt
string
Exemplo:

"2026-06-01T00:00:00Z"

description
string
Exemplo:

"Charges per completed transaction route"

discountTiers
object[] | null
eventFilter
object
feeAmount
string
Exemplo:

"50.00"

freeQuota
integer<int64>
Exemplo:

100

maintenanceCreditAccount
string
Exemplo:

"account_maintenance_credit"

pricingModel
string
Exemplo:

"tiered"

tiers
object[] | null

Resposta

OK

createdAt
string
obrigatório
Exemplo:

"2026-01-01T00:00:00Z"

enable
boolean | null
obrigatório
Exemplo:

true

id
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

label
string
obrigatório
Exemplo:

"Monthly Volume Billing"

ledgerId
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

organizationId
string
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

type
string
obrigatório
Exemplo:

"volume"

updatedAt
string
obrigatório
Exemplo:

"2026-01-01T00:00:00Z"

accountTarget
object
assetCode
string
Exemplo:

"BRL"

countMode
string
Exemplo:

"perRoute"

creditAccountAlias
string
Exemplo:

"account_fees_credit"

debitAccountAlias
string
Exemplo:

"account_fees_debit"

deletedAt
string
Exemplo:

"2026-06-01T00:00:00Z"

description
string
Exemplo:

"Charges per completed transaction route"

discountTiers
object[] | null
eventFilter
object
feeAmount
string
Exemplo:

"50.00"

freeQuota
integer<int64>
Exemplo:

100

maintenanceCreditAccount
string
Exemplo:

"account_maintenance_credit"

pricingModel
string
Exemplo:

"tiered"

tiers
object[] | null