Solicitação de alteração de taxa de boleto

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": "2b2dd326-8c8a-4726-abb0-171f5600932c",
  "effectiveDate": "2025-01-03",
  "accountIdentifier": "7bef10fb-4ddb-4826-8813-899d554bf42b",
  "type": "BANK_SLIP",
  "createdAt": "2025-01-03 08:43:10",
  "monetizationFee": 0.00,
  "splitMonetizationFee": 0.00,
  "cashinFeeValue": 0.00,
  "status": "COMPLETED",
  "errorMessage": "errorMessage_73f2894f495e"
}

Exemplo do corpo de return

CampoTipoDescrição
IdentifierStringIdentificador associado a requisição de alteração
effectiveDateLocalDateData efetiva da solicitação de alteração de taxa
accountIdentifierStringIdentificador da conta associada a solicitação de alteração de taxa
typeEnumModalidade da solicitação de alteração de taxa
createdAtLocalDateData da criação da solicitação de alteração de taxa
monetizationFeeNumberTaxa 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).
splitMonetizationFeeNumberTaxa 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).
cashinFeeValueNumberTaxa 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).
statusEnumStatus da solicitação de alteração de taxa
errorMessageStringQualquer possível erro no processo de alteração de taxa

Possíveis types

CampoDescrição
BANK_SLIPModalidade bank_slip ou boleto
PIXModalidade pix

Possíveis Status

CampoDescrição
COMPLETEDSolicitação completa
PENDINGSolicitação pendente
ERRORErro na solicitação
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!