post
https://sandbox.platform.credit.celcoin.com.br/escrow/api/v1/wallets//charges-1
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Cadastrar Cobrança
Cadastra uma nova cobrança vinculada a uma carteira (wallet), permitindo definição de vencimento, descontos, juros, multa e divisão de recebíveis.
Endpoint
POST /wallets/{walletId}/chargesAutenticação
Este endpoint requer autenticação via token.
Authorization: Bearer (access_token)
Headers
| Header | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Content-Type | string | Sim | application/json |
| Authorization | string | Sim | Bearer Token |
Path Parameters
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| walletId | string | Sim | Identificador da wallet |
Body Parameters
Objeto Raiz
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| due_date | datetime | Sim | Data de vencimento da cobrança |
| amount | float | Sim | Valor total da cobrança |
| fine | float | Não | Multa por atraso (mínimo 0) |
| interest | float | Não | Juros por atraso (mínimo 0) |
| discount_limit_date | datetime | Sim | Data limite para aplicação do desconto |
| days_to_expire_after_payment | integer | Não | Dias para expiração após pagamento |
| discount_modality | string | Sim | Modalidade do desconto |
| discount_value | float | Não | Valor do desconto (mínimo 0) |
| charge_debtor | object | Sim | Dados do pagador |
| charge_receivers | array | Sim | Lista de recebedores da cobrança |
discount_modality
Valores permitidos:
PERCENTFIXED
Objeto charge_debtor
charge_debtor| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| number | string | Sim | Número do endereço |
| neighborhood | string | Sim | Bairro (máx. 200 caracteres) |
| name | string | Sim | Nome do pagador |
| document | string | Sim | Documento válido (CPF ou CNPJ) |
| city | string | Sim | Cidade (máx. 100 caracteres) |
| public_area | string | Sim | Logradouro |
| state | string | Sim | Estado (UF – 2 caracteres) |
| postal_code | string | Sim | CEP válido |
| phone | object | Não | Telefone |
| string | Não | E-mail válido |
Objeto phone
phone| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| country_code | string | Não | Código do país |
| area_code | string | Não | DDD |
| number | string | Não | Número do telefone |
Objeto charge_receivers[]
charge_receivers[]| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| account_destination_id | string | Sim | Conta de destino |
| split_type | string | Sim | Tipo de divisão |
| split_percentage | float | Não | Percentual do split |
| split_amount | float | Não | Valor fixo do split |
split_type
Valores permitidos:
PERCENTAGEAMOUNT
Regra:
- Se
split_type = PERCENTAGE, informesplit_percentage - Se
split_type = AMOUNT, informesplit_amount
Exemplo de Requisição
{
"due_date": "2026-02-10T23:59:59Z",
"amount": 150.75,
"fine": 2.0,
"interest": 1.5,
"discount_limit_date": "2026-02-05T23:59:59Z",
"days_to_expire_after_payment": 5,
"discount_modality": "PERCENT",
"discount_value": 10,
"charge_debtor": {
"name": "João da Silva",
"document": "12345678909",
"public_area": "Rua das Flores",
"number": "100",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postal_code": "01001000",
"email": "[email protected]",
"phone": {
"country_code": "55",
"area_code": "11",
"number": "999999999"
}
},
"charge_receivers": [
{
"account_destination_id": "acc_123",
"split_type": "PERCENTAGE",
"split_percentage": 100
}
]
}Resposta de Sucesso
201 Created
{
"id": "ch_abc123456"
}