Sumário
Descrição #
Este passo tem a finalidade demonstrar como atualiza um PIX agendado .
Endpoints #
- Produção: https://api2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-due-dates
- Homologação: https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-due-dates
Requisição (PUT) #
Segue exemplo da requisição:
curl "https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-due-dates" \
--request PUT \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <APP_TOKEN>" \
--header "client-cert: <CERTIFICADO_CLIENTE>"\
--header "client_id: <CLIENT_ID>" \
--header "access_token: <ACCESS_TOKEN>" \
--data '
{
"calendario": {
"dataDeVencimento": "2024-05-25",
"validadeAposVencimento": 10
},
"devedor": {
"nome": "Joao Silva",
"cpf": "68138423072"
},
"valor": {
"original": "02.00",
"modalidadeAlteracao": 1,
"juros": {
"modalidade": 1,
"valorPerc": "1.01"
},
"multa": {
"modalidade": 1,
"valorPerc": "1.00"
},
"desconto": {
"valorPerc": "01.01",
"modalidade": 1,
"descontoDataFixa": [
{
"modalidade": 1,
"data": "2024-05-20",
"valorPerc": "01.01"
},
{
"modalidade": 1,
"data": "2024-05-23",
"valorPerc": "11.01"
}
]
}
},
"chave": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"infoAdicionais": [
{
"nome": "Geladeira",
"valor": "Geladeira cor branca duas portas"
}
],
"correlationId": "c3f0d69e-9f8f-4ded-95e9-436074c24db9"
}'
Parâmetros de Requisição #
Cabeçalho #
- Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON
- Authorization: Bearer token usado para autenticação de usuário (Recebido no passo “oAuth Aplicação“)
- client-cert: Certificado usado para autenticar o usuário junto à aplicação
- client_id: ID de cliente usado para encaminhar a requisição ao gateway de APIs
- access_token: Token recebido após executar o método oAuth (access token)
Corpo (JSON) #
Resposta #
Propriedade | Descrição | Tipo | Obrigatoriedade |
---|---|---|---|
calendario.dataVencimento | Data de vencimento do pix | DateTime | Obrigatório |
calendario.validadeAposVencimento | Dias de validade após vencimento | Int32 | Obrigatório |
devedor.nome | Nome do devedor | String | Obrigatório |
devedor.cpf ou devedor.cpnj | Documento do devedor | String | Obrigatório |
valor.original | Valor do pix | String | Obrigatório |
valor.modalidadeAlteracao | Valor 0 não permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento. Valor padrão 0 quando não passado. | Int32 | Opcional |
valor.multa | Objeto referente a cobrança de multa após o vencimento (propriedades se tornam obrigatórias caso este seja declarado) | Object | Opcional |
valor.multa.modalidade | 1 – Valor fixo 2 – Percetual | Int32 | Opcional |
valor.multa.valorPerc | Percentual de acrescimo da multa | String | Opcional |
valor.juros | Objeto referente a cobrança de juros após o vencimento (propriedades se tornam obrigatórias caso este seja declarado) | Object | Opcional |
valor.juros.modalidade | Obrigatório – Modalidade de juros (1 – Valor (dias corridos), 2 – Percentual ao dia (dias corridos), 3 – Percentual ao mês (dias corridos), 4 – Percentual ao ano (dias corridos), 5 – Valor (dias úteis), 6 – Percentual ao dia (dias úteis), 7 – Percentual ao mês (dias úteis), 8 – Percentual ao ano (dias úteis)). | Int32 | Opcional |
valor.juros.valorPerc | Valor percentual dos juros | String | Opcional |
valor.desconto | Objeto referente aos descontos antes do vencimento (propriedades se tornam obrigatórias caso este seja declarado) | Object | Opcional |
valor.desconto.modalidade | Obrigatório – Modalidade de descontos (1 – Valor Fixo até a[s] data[s] informada[s], 2 – Percentual até a data informada, 3 – Valor por antecipação dia corrido, 4 – Valor por antecipação dia útil, 5 – Percentual por antecipação dia corrido, 6 – Percentual por antecipação dia útil. | Int32 | Opcional |
valor.desconto.valorPerc | Valor percentual do desconto | String | Opcional |
valor.desconto.descontoDataFixa.valorPerc | Valor percentual do desconto de data fixa. | String | Opcional |
valor.desconto.descontoDataFixa.data | Data fixa do desconto. | DateTime | Opcional |
valor.desconto.descontoDataFixa.modalidade | Obrigatório – Modalidade de descontos (1 – Valor Fixo até a[s] data[s] informada[s], 2 – Percentual até a data informada, 3 – Valor por antecipação dia corrido, 4 – Valor por antecipação dia útil, 5 – Percentual por antecipação dia corrido, 6 – Percentual por antecipação dia útil. | DateTime | Opcional |
valor.desconto.descontoDataFixa.valorPerc | Valor percentual | DateTime | Opcional |
chave | Chave PIX de recebimento | String | Obrigatório |
infoAdicionais.nome | Chave opcional. Usado para informações específicas. List<infoAdicionais> | String | Opcional |
infoAdicionais.valor | Valor opcional. Usado para informações específicas. List<infoAdicionais> | String | Opcional |
A reposta é um json informando os dados da cobrança e o código HTTP 201.
Abaixo segue um exemplo de reposta:
{
"calendario": {
"criacao": "2024-05-15T12:28:13.5683789-03:00",
"dataDeVencimento": "2024-05-20T00:00:00",
"validadeAposVencimento": 10
},
"valor": {
"original": "02.00",
"valor pago": null,
"modalidadeAlteracao": 1,
"multa": {
"modalidade": 1,
"valorPerc": "01.00"
},
"juros": {
"modalidade": 1,
"valorPerc": "01.01"
},
"desconto": {
"modalidade": 1,
"valorPerc": "01.01",
"descontoDataFixa": [
{
"data": "2024-05-20T00:00:00",
"valorPerc": "01.01",
"modalidade": 1
}
]
}
},
"correlationId": "b261ae06-15de-44d3-9279-f7be1c584af0",
"txid": "GXTcsp1QvVCBLxViHbi85DDpnkHpeD3ZB",
"endToEnd": "",
"status": "Pendente",
"devedor": {
"nome": "Joao Silva",
"documento": "68138423072"
},
"chave": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"pixCopiaECola": "00020101021226920014BR.GOV.BCB.PIX2570spi-h.bancosemear.com.br/qrcode/gi/v2/493640e818a94920869fc9be37cbd7765204000053039865802BR5923XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX***6304180F",
"qrCode": "iVBORw0KGgoAAAANSUhEUgAAAW0AAAFtAQAAAADkegaPAAAFeklEQVR4nO1bTa7ySAw0YsGSI+QmcDGkIHExuEkfgWUWT3jqpxvyRqORvtUnR7DII0kF6bndZbvsRP7JZ4kv/Av/wv8a/BkRu7zGcoq5LefnZTo8eLrLbHmPC24cf4CJuT58znw8Y8oH7gt5eDwvcXgdf6Z8xT71E8KVh+OWQC9YAZ99RsAUyxnX8Dv6scsUu63A8R0XZAA4wZ0Lfn7OjY/jFDbaErwtcbxOcU7cIkinCU+IQ/6HZWrCucygKBggM07HbNjpcHWt/52WefA0twAni4m7/ufwL9IrCtcHToCr+zwkrACuxtYO2ugET9Bu+B3KqsJvTZZZdrARDvuGrR2Bg3Y6foJ0Tu8oD8cKO/jSPIFYnEnqXgIH7AGwNmOxtkR9+JT3400hSLGpIQLfeHDGMSFoBaNyfTh8G6ZgMELcDdmIfCajgMBuvAESP42tXRrOuHsRlYW2dtIyYSdAAsIH4SJjaxeGA8R0kYxF7gox1q0pt1QEVpDO++D3ynAkxSQwJBtYcK41vyEBgVH4oK+JtavDGYzO+IM8I50ei6tJ0yFXZx4Z2gPl4UTi3z44FrMaEoFxV480eh3KCsOfIrCfYSO6fyaz5QjVuEgmaZnXBuA0hS/IrWEP58j9FKBditTm8nDtaudVLOetYbAaAk07XinrimHIwnDlkUOfGenxdVICQpp2lnkYhF0abi+fmDgqGFmZonIx+dBz6fpwI4c2cVJhoIxDq474nA97wgbgYfOAkhF85Q6+dZR5silAUa4pD3egRTalTU5TAIkHT0whe9a1Jr3CcIIYY0XOTCbpCVp6pSJMNoTcAlwUtW9h1c0ZZTZ82ycPTU+/C6HKcEtqXPqgcpFa/3DiyGSjq26rlLkuXOlil2F6UauwpEQ5VDvMuZJzSsNZz1ISD0rEcPW7Wx4RUjMUoJaNwElek0p3uDXlmuiCjFjM+swnQakLdw2EFFIPygDMI3VNLa04uyuyAbj6HpRhWMT3PoAaHcHgKwKzcrEBuGTUhEffUtQty+BUqtt18tbebQGuPCMsmYKrLz53i5bVwSiOsjycKSTjrpAS1w7J7ixFVnpHY4MgLbcWh/f0uD8Tx55hWTBXT1anqz5fWTg8WrysAOUNfZIU9fTUBJl8bh9+rwy/eZndjqWMqtikNMvt2Bcb0acNwCkrvriDX5p76UWP044RlffrUFYarioHIdciTepaz5YVoGSjtx5ZGI5/m6WOFONl57Ef+LtSKg8V/JJeC8MdaDUWkq2vugt7s1iq0x7xYYKycDqBxtPGM45NcgzqFWa2Xz5TFq7v19CGpjuwLrqStqQiK8GMtepWGO6u+uBqq1AUHW0tTShSwxi5WGG41fA+vOZ+pPQKtTy050VquQG4u1nXyXwmNdwinOtAglT3HuvDNWSZvR0bypvxae5reUrEzZ4NwD0rka53uhU41tUnKay/rZvsdeE3dyHdiX1p5tJR+cZYPDtevVmsNBwLrhLhYfkiPBaiGWJFJP3Eap6gMPzaR/TOqoE6V0/SMFTis+0zrWu+snDORfRZGImnfajA1rqPYuGwyjjKwtPDTU185vZVOI8cMiolnBUT1IU/ZxfxsowURdtDUqPUm92Y3asO966emzzh0Ef0oufSHLHV6YfFKsP5sZb6E25kqX11P46hf2mp7ymRwvA+AdMjsEYSPV1LG+mNHAnmm4DP/cWbrrDxvi1zaxYdx2hbfbiCr+Ac0ft0s8JRubPYWzYuDx+1+nn0KP0yzsnz73Nbj8vXhiNn1DLHzpPDtAKbPSe9gQSiW40fFIbL3/cc8UmPNLmw7y2AS+jVlVUYLgw3i7EauobGQvT23KI3cjRT0c2T5eF/8PnCv/Av/G/B/wFpq3gIH5up7QAAAABJRU5ErkJggg==",
"linkPagamento": "https://hml-semearpay.bancosemear.com.br/pay/pix/GXTcsp1QvVCBLxViHbi85DDpnkHpeD3ZB",
"infoAdicionais": [
{
"nome": "Geladeira",
"valor": "Geladeira cor branca duas portas"
}
],
"revisao": 0
}
Corpo (JSON) #
Propriedade | Descrição | Tipo |
---|---|---|
status | Status da cobrança: PENDENTE (indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida). | String |
calendario.validadeAposVencimento | Tempo de validade da chave (em dias). | int32 |
calendario.dataDeVencimento | Data de vencimento da cobrança | DateTime |
calendario.criacao | Data de criação do pix | DateTime |
correlationId | Identificador interno de referencia do pix | String |
txid | ID da transação | String |
devedor.nome | Nome do devedor | String |
devedor.documento | Documento do devedor | String |
valor.original | Valor do pix | String |
valor.modalidadeAlteracao | Valor 0 não permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento. Valor padrão 0 quando não passado. | Int32 |
valor.valor pago | Valor liquido pago | String |
valor.modalidadeAlteracao | Valor 0 não permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento | Int32 |
revisao | valor de vezes que pix foi revisado/alterado | int32 |
linkPagamento | Link de pagamento do PIX | String |
pixCopiaECola | Código do PIX | String |
qrCode | Imagem PNG do código QR PIX codificado em base64 | String |
chave | Chave PIX de recebimento | String |
infoAdicionais.nome | Chave opcional. Usado para informações específicas | String |
infoAdicionais.valor | Valor opcional. Usado para informações específicas | String |
valor.multa.modalidade | 1 – Valor fixo 2 – Percetual | int32 |
valor.multa.valorPerc | Valor percentual a ser aplicado em multa caso valor seja pago após vencimento de cobrança | String |
valor.juros.modalidade | Modalidade de juros (1 – Valor (dias corridos), 2 – Percentual ao dia (dias corridos), 3 – Percentual ao mês (dias corridos), 4 – Percentual ao ano (dias corridos), 5 – Valor (dias úteis), 6 – Percentual ao dia (dias úteis), 7 – Percentual ao mês (dias úteis), 8 – Percentual ao ano (dias úteis)) | int32 |
valor.juros.valorPerc | Valor percentual a ser aplicado nos juros aplicados caso pagamento após vencimento da cobrança | String |
valor.desconto.modalidade | Modalidade de descontos (1 – Valor Fixo até a[s] data[s] informada[s], 2 – Percentual até a data informada, 3 – Valor por antecipação dia corrido, 4 – Valor por antecipação dia útil, 5 – Percentual por antecipação dia corrido, 6 – Percentual por antecipação dia útil. | int32 |
valor.desconto.valorPerc | Valor percentual a ser aplicado no desconto | String |
valor.desconto.descontoDataFixa.modalidade | Modalidade de descontos (1 – Valor Fixo até a[s] data[s] informada[s], 2 – Percentual até a data informada, 3 – Valor por antecipação dia corrido, 4 – Valor por antecipação dia útil, 5 – Percentual por antecipação dia corrido, 6 – Percentual por antecipação dia útil | int32 |
valor.desconto.descontoDataFixa.data | Data utilizada para aplicar o desconto programado | DateTime |
valor.desconto.descontoDataFixa.valorPerc | Valor percentual a ser aplicado no desconto ate essa data(será aplicada dentro do limite de vencimento da cobrança) | String |