Alteração da data de vencimento
stable pós
Este endpoint possibilita que o cliente do parceiro Bankly altere a data de vencimento da fatura de seu cartão.
Pré-requisitos
Para que seja possível utilizar este endpoint, é necessário que:
- A nova data de vencimento esteja dentro das datas predefinidas no programa do cartão;
- Seja enviado uma data de vencimento diferente da data que a fatura já possui atualmente. Por exemplo:
se a data de vencimento atual da fatura for 02, a data enviada na solicitação de troca de vencimento não pode ser 02.
Requisição (Request)
Requisição HTTP
PUT https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/duedate-expiration
--request PUT
--url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/duedate-expiration'\
--header 'api-version: 1.0'\
--header 'x-bkly-license: f64197e4-80b3-4820-bfae-1419049b15b5'\
--header 'Authorization: Bearer {{Token}}'\
--data '
{
"documentNumber": "00000000000",
"day": 19
}
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
card.update | Concede acesso para atualizar informações do cartão. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-bkly-license | Obrigatório. Identificador da licença bancária utilizada pelo parceiro. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
proxy | path | Código identificador do cartão. | Insira somente números, sem caracteres especiais. |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
documentNumber | string | Obrigatório. Número do documento (CPF ou CNPJ). | Insira somente números, sem caracteres especiais. |
day | integer | Obrigatório. Novo dia de vencimento da fatura do cartão. Exemplo: 2, 8, 10 etc. | — |
{
"documentNumber": "47742663023",
"day": 5
}
Resposta (Response)
Os status code 204 indicará que a solicitação foi aceita e que a data de vencimento da fatura do cartão foi alterada com sucesso.
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | 110 | Expiration Day Not Available | O dia de pagamento informado é diferente dos possíveis dias de pagamento permitidos no programa. |
| 404 | 100 | Program Not Found | Programa não encontrado. |
| 404 | 002 | Card Not Found | Cartão não encontrado. |
| 409 | 033 | Invalid operation for card pre | Operação não permitida para cartão pré-pago. |
| 409 | EXPIRATION_DAY_IS_THE_SAME_CONFIGURED | Expiration day is the same already configured! | Data de vencimento já cadastrada. |
| 409 | OPERATION_INVALID_FOR_ADDITIONAL | Operation invalid For Additional Cards. | Não é permitido vincular um cartão adicional a uma conta bancária. |
| 500 | 014 | Error Save Card Events | Erro ao salvar os dados do cartão. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 1 day ago