Solicitação de alteração de taxa do boleto hibrído

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

{
  "effectiveDate": "2025-08-29",
  "bankSlip": {
    "monetizationFee": 0.00,
    "splitMonetizationFee": 0.00
  },
  "dueDate": {
    "type": "PERCENTAGE",
    "fee": 0.00,
    "minValue": 0.0,
		"maxValue":0.0

  },
  "dueDateSplit": {
    "type": "PERCENTAGE",
    "fee": 0.00,
    "minValue": 0.0,
		"maxValue":0.0
  }
}

Exemplo de return

{
  "identifier": "d0a040fb-2b3f-4e8d-9569-5d6ae34fb265",
  "effectiveDate": "2025-09-18",
  "accountIdentifier": "b5af24f2-91fa-419f-baf8-e602505357ce",
  "type": "BANK_SLIP",
  "createdAt": "2025-09-18 13:55:35",
  "monetizationFee": 0.00,
  "splitMonetizationFee": 0.00,
  "cashinFeeValue": 0.00,
  "status": "COMPLETED",
  "errorMessage": "errorMessage_80842f134a0a",
  "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

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
staticPlanobjectObjeto que indica as características do plano pix estático
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
immediatePlanobjectObjeto que indica as características do plano pix imediato
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
dueDatePlanobjectObjeto que indica as características do plano pix com data de vencimento
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
immediateSplitPlanobjectObjeto que indica as características do plano split imediato
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
dueDateSplitPlanobjectObjeto que indica as características do plano split com data de vencimento
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
cashOutPlanobjectObjeto que indica as características do plano cash-out
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
remittancePlanobjectObjeto que indica as características do plano de remessa
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
dueDateSplitHybridBillobjectObjeto que indica as características do plano split de boleto hibrido com data de vencimento
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
dueDateHybridBillobjectObjeto que indica as características do plano de boleto hibrido com data de vencimento
└─typestringTipo de cobrança de multa
└─feeNumbervalor da multa
└─minValueNumberValor minimo do plano em questão
└─maxValueNumberValor máximo do plano em questão
monetizationFeeHybridBillNumberTaxa de monetização da modalidade Hybrid Bill
splitMonetizationFeeHybridBillNumberTaxa de monetização da modalidade split Hybrid Bill

Possíveis types

CampoDescrição
BANK_SLIPModalidade bank_slip ou boleto
PIXModalidade pix
HYBRID_BILLModalidade boleto híbrido

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!