post
https://sandbox.tbanks.com.br/tariffs/bank-slip
Endpoint para solicitação de alteração de taxa de boleto
Detalhe importante: A data de efetivação de alteração de taxa deve ser superior a data de solicitação. Por exemplo, se a solicitação for no dia "2024-03-10" a data mínima de efetivação deve ser no próximo dia "2024-03-11".
Detalhe importante: As novas taxas não podem ser menores que a taxa global da conta.
Exemplo de requisição
{
"monetizationFee": 0.00,
"effectiveDate": "2024-12-09",
"splitMonetizationFee": 0.00
}
Exemplo de return
{
"identifier": "ef57483e-2082-420e-a57e-ef15d49202c1",
"effectiveDate": "2025-09-18",
"accountIdentifier": "b1a7cea5-24c4-4e6c-9616-cd6a5547f2fb",
"type": "BANK_SLIP",
"createdAt": "2025-09-18 13:56:02",
"monetizationFee": 0.00,
"splitMonetizationFee": 0.00,
"cashinFeeValue": 0.00,
"status": "COMPLETED",
"errorMessage": "errorMessage_cbfbe445a02a",
"staticPlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"immediatePlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"dueDatePlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"immediateSplitPlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"dueDateSplitPlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"cashOutPlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"remittancePlan": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"dueDateSplitHybridBill": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"dueDateHybridBill": {
"type": "PERCENTAGE",
"fee": 0.00,
"minValue": 0.00,
"maxValue": 0.00
},
"monetizationFeeHybridBill": 0.00,
"splitMonetizationFeeHybridBill": 0.00
}
Exemplo do corpo de return
| Campo | Tipo | Descrição |
|---|---|---|
Identifier | String | Identificador associado a requisição de alteração |
effectiveDate | LocalDate | Data efetiva da solicitação de alteração de taxa |
accountIdentifier | String | Identificador da conta associada a solicitação de alteração de taxa |
type | Enum | Modalidade da solicitação de alteração de taxa |
createdAt | LocalDate | Data da criação da solicitação de alteração de taxa |
monetizationFee | Number | Taxa de monetização da modalidade BANK_SLIP (Só é possível o retorno da mesma caso a solicitação de alteração seja do tipo BANK_SLIP). |
splitMonetizationFee | Number | Taxa de divisão de monetização da modalidade BANK_SLIP (Só é possível o retorno da mesma caso a solicitação de alteração seja do tipo BANK_SLIP). |
cashinFeeValue | Number | Taxa referente ao valor cobrado por pix da modalidade PIX (Só é possível o retorno da mesma caso a solicitação de alteração seja do tipo PIX). |
status | Enum | Status da solicitação de alteração de taxa |
errorMessage | String | Qualquer possível erro no processo de alteração de taxa |
staticPlan | object | Objeto que indica as características do plano pix estático |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
immediatePlan | object | Objeto que indica as características do plano pix imediato |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
dueDatePlan | object | Objeto que indica as características do plano pix com data de vencimento |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
immediateSplitPlan | object | Objeto que indica as características do plano split imediato |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
dueDateSplitPlan | object | Objeto que indica as características do plano split com data de vencimento |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
cashOutPlan | object | Objeto que indica as características do plano cash-out |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
remittancePlan | object | Objeto que indica as características do plano de remessa |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
dueDateSplitHybridBill | object | Objeto que indica as características do plano split de boleto hibrido com data de vencimento |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
dueDateHybridBill | object | Objeto que indica as características do plano de boleto hibrido com data de vencimento |
└─type | string | Tipo de cobrança de multa |
└─fee | Number | valor da multa |
└─minValue | Number | Valor minimo do plano em questão |
└─maxValue | Number | Valor máximo do plano em questão |
monetizationFeeHybridBill | Number | Taxa de monetização da modalidade Hybrid Bill |
splitMonetizationFeeHybridBill | Number | Taxa de monetização da modalidade split Hybrid Bill |
Possíveis types
| Campo | Descrição |
|---|---|
BANK_SLIP | Modalidade bank_slip ou boleto |
PIX | Modalidade pix |
HYBRID_BILL | Modalidade de boleto hibrido |
Possíveis Status
| Campo | Descrição |
|---|---|
COMPLETED | Solicitação completa |
PENDING | Solicitação pendente |
ERROR | Erro na solicitação |