Cancelamento de ajuste financeiro

Este endpoint permite ao parceiro cancelar um ajuste forçado de débito ou crédito, de forma total ou parcial.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

Um ajuste financeiro tenha sido previamente executado, e o parceiro possua o identificador do ajuste criado (forceOperationId).

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/invoices/adjustments/{forceOperationId}/cancel \

--request  POST/
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/adjustments/{forceOperationId}/cancel' \ 
--header 'api-version: 1.0' \ 
--header 'x-bkly-version: 01-04-2023' \ 
--header 'x-user-Id: 35268974710' \
--header 'authorization: Bearer {{token}}' \ 
--header 'idempotency-key: a022daad-d001-49e5-b4a2-61d0a6dc43b4' \ 
--header 'x-bkly-correlation-id: 9d15fdb6-592f-4cbd-9403-e3f28694be49' \ 
--header 'Content-Type: application/json' \ 
--data '{ 
  "client": {  
    "contractNumber": "97845256234", 
    "documentNumber": "38551169890" 
 }, 
  "transaction": { 
    "amount":10, 
    "forceOperationId": "67ac6b20-02a5-486c-b40e-32a970ded442", 
    "originalIdempotencyKey": "1116abe9-28a0-4156-b50f-fa7ffbdcb742", 
    "cancelFees": true, 
    "descriptor": "teste cancel", 
    "authorization_id": 2203553101
   }
}'

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
`invoice.adjustment`	Concede acesso para a realização de lançamentos de ajustes de crédito ou débito, assim como de seu cancelamento.

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-correlation-id`	Informe um GUID, sendo um novo cada requisição.
`x-bkly-version`	Indica a versão do contrato. É alterada somente quando há quebra de contrato. O padrão definido é: yyyy-mm-dd , que se refere à data da quebra de contrato. No caso deste endpoint será sempre 01-04-2023.
`idempotency-key`	Informe um UUID, sendo um novo a cada requisição.
`x-user-id`	Documento do cliente, o qual é proprietário da conta de ajuste.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição	Especificação
`forceOperationId`	`path`	Obrigatório. Identificador único do ajuste financeiro retornado no endpoint de realização de ajuste financeiro.	Insira o GUID.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`client`	`object`	Obrigatório*. Objeto que deverá conter informações sobre o titular do cartão de crédito.	—
`client.contractNumber`	`string`	Obrigatório*. Número do contrato vigente.	—
`client.documentNumber`	`string`	Obrigatório*. Número do documento (CPF ou CNPJ).	Informe somente os números.
`transaction`	`object`	Obrigatório*. Objeto que deverá conter informações sobre o ajuste que será forçosamente lançado na fatura em aberto.	—
`transaction.amount`	`number`	Valor monetário do ajuste. Importante: Caso não informado será cancelado o valor total da operação.	Informe somente números.
`transaction.forceOperationId`	`string`	Obrigatório. Identificador único do ajuste financeiro retornado no endpoint* de realização de ajuste financeiro.	—
`transaction.originalIdempotencyKey`	`string`	Obrigatório*. `IdempotencyKey` utilizado no ajuste financeiro.	—
`transaction.cancelFees`	`boolean`	Indica se é desejado o cancelamento das taxas da operação (true) ou não (false). Importante: as taxas somente poderão ser canceladas uma única vez.	—
`transaction.descriptor`	`string`	Obrigatório*. Descrição do ajuste financeiro realizado.	Máximo de 256 caracteres. Este campo não aceita caracteres especiais.
`transaction.authorization_id`	`string`	Obrigatório. Identificador da transação gerado pela processadora. Dica**: informe o valor retornado no campo `authorizationId` do evento TRANSACTION_CREATED, que é disparado após a realização do ajuste.	—

{ 
  "client": { 
    "companyKey": "ACESSO", 
    "contractNumber": "97845256234", 
    "documentNumber": "38551169890" 
 }, 
  "transaction": { 
    "amount":10, 
    "adjustmentId": "67ac6b20-02a5-486c-b40e-32a970ded442", 
    "originalIdempotencyKey": "1116abe9-28a0-4156-b50f-fa7ffbdcb742",
    "cancelFees": true, 
    "descriptor": "teste cancel", 
    "authorization_id": 2203553101
   }
}

Resposta (Response)

O status code 202 indicará que o ajuste está sendo cancelado com sucesso.

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.