Consulta de ajuste financeiro

Este endpoint permite que o cliente do parceiro Bankly consulte um ajuste financeiro utilizando o ID retornado no endpoint Realização de ajuste financeiro.

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

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

--request GET \  
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/adjustments/{forceOperationId}' \ 
--header 'api-version: 1.0' \ 
--header 'x-bkly-version: 01-04-2023' \ 
--header 'authorization: Bearer {{token}}' \ 
--header 'x-bkly-correlation-id: 9d15fdb6-592f-4cbd-9403-e3f28694be49'

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 realizar consultas referentes a ajustes de crédito ou débito lançados.

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-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.
`x-bkly-correlation-id`	Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

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 um GUID.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 201 indicará que a solicitação foi aceita e retornará um objeto contendo informações sobre o ajuste financeiro.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Número máximo de caracteres
`correlationId`	`string`	Identificador da correlação entre transações.	36
`client`	`object`	Objeto que contém informações sobre o titular do cartão de crédito.	—
`client.documentNumber`	`string`	Número do documento (CPF ou CNPJ).	11 (CPF) ou 14 (CNPJ)
`client.contractNumber`	`string`	Número do contrato vigente.	12
`client.companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.	7
`transaction`	`object`	Objeto que contém informações sobre a operação que foi forçosamente lançada na fatura em aberto.	—
`transaction.idempotencyKey`	`string`	Chave de idempotência (`idempotencyKey`) utilizada na criação do ajuste.	36
`transaction.amount`	`object`	Objeto que contém informações sobre o valor monetário do ajuste.	—
`transaction.amount.value`	`number`	Valor monetário do ajuste.	—
`transaction.amount.currency`	`string`	Código da moeda com base na ISO - 4217.	3
`transaction.transactionType`	`string`	Código que identifica a transação de crédito ou débito. Confira a tabela dos possíveis códigos de transação.	6
`transaction.descriptor`	`string`	Descrição do ajuste financeiro realizado.	17
`transaction.date`	`string`	Data e hora da realização do ajuste financeiro, no formato ISO 8601 - UTC.	29
`cancelledTransactions[]`	`array of objects`	Lista de objetos contendo informações sobre os ajustes financeiros cancelados. Importante: esta lista somente será retornada caso algum ajuste financeiro tenha sido cancelado.	—
`cancelledTransactions[].amount`	`number`	Valor do ajuste cancelado.	—
`cancelledTransactions[].originalIdempotencyKey`	`string`	Chave de idempotência originada no momento da criação do ajuste.	36
`cancelledTransactions[].idempotencyKey`	`string`	Chave de idempotência utilizada no cancelamento do ajuste.	36
`cancelledTransactions[].forceOperationId`	`string`	Identificador do ajuste financeiro realizado.	36
`cancelledTransactions[].cancelFees`	`boolean`	Indica se as taxas foram canceladas (true) ou não (false).	—
`cancelledTransactions[].authorization_id`	`int`	Código de autorização do ajuste financeiro.	10
`cancelledTransactions[].descriptor`	`string`	Descrição do ajuste financeiro cancelado.	6
`cancelledTransactions[].date`	`string`	Data e hora do cancelamento do ajuste financeiro, no formato ISO 8601 - UTC.	29

{ 
    "correlationId": "9d15fdb6-592f-4cbd-9403-e3f28694be49", 
    "client": { 
        "documentNumber": "97845256234", 
        "contractNumber": "ACESSO123456", 
        "companyKey": "ACESSO" 
    }, 
    "transaction": { 
        "idempotencyKey": "17691d13-6d80-42ad-bf99-2cdde34d832e", 
        "amount": 78458.7, 
        "currency": "BRL", 
        "transactionType": "090907", 
        "descriptor": "Credit adjustment", 
        "date": "2023-10-17T15:52:11.298+00:00" 
    }, 
    "cancelledTransactions": [ 
        { 
            "amount": 100.78, 
            "originalIdempotencyKey": "232bdf69-191d-43e7-456d-2346a80919b7",
            "idempotencyKey": "872bdf69-191c-43e7-877d-1356a80919a9",
            "forceOperationId" : "ec35f747-0f07-17dd-81ec-4f0a21cf769d",
            "cancelFees": true, 
            "authorization_id": 2194960667, 
            "descriptor": "Cancel", 
            "date": "2023-10-17T15:56:57.424+00:00" 
        } 
    ] 
}

Códigos dos tipos de transação

Código	Descrição
REFINANCE_CHARGES	Encargos de refinanciamento
INTEREST_ON_ARREST	Juros de mora
TRAFFIC_TICKET	Multa
PURCHASE_BY_SIGHT	Compra à vista
INSTALLMENT_WITHOUT_INTEREST	Parcela sem juros
DEBIT_ADJUSTMENT	Ajuste a débito
INSTALLMENTS_WITHOUT_INTEREST	Parcelado sem juros
INSTALLED_WITH_INTEREST	Parcelado com juros
PAYMENT	Pagamento
CREDIT_ADJUSTMENT	Ajuste a crédito
PARTIAL_CANCELLATION_OF_PURCHASE	Cancelamento parcial de compra
WITHDRAW	Saque
INTERNATIONAL_PURCHASE	Compra internacional
INTERNATIONAL_IOF	IOF internacional
IOF	Imposto sobre Operações Financeiras
IOF_WITHDRAWAL	IOF sobre o saque
WITHDRAWAL_CHARGES	Encargos de saque
ANNUITY	Anuidade
WITHDRAWAL_RATE	Tarifa de saque
RATE_CARD_ISSUANCE	Tarifa de emissão de cartão
REFINANCE_INSTALLMENT	Parcela de refinanciamento
CANC_CREDIT_INSTALLMENTS	Cancelamento de crédito parcelamento
PREPAID_CHARGE	Carga de pré-pago
MEMBERSHIP_PAYMENT	Pagamento de adesão
PURCHASE_CANCELLATION	Cancelamento de compra
CANC_INSTALLMENT_WITHOUT_INTEREST	Cancelamento de parcela sem juros
ANNUAL_REVERSAL	Estorno da anuidade
CREDIT_BY_INSTALLMENT	Crédito por parcelamento
REFINANCE_CONTRACT	Contrato de refinanciamento
CANC_PARC_DE_REF	Cancelamento de parcela de refinanciamento
EXCHANGE_DIF_DEBIT	Débito de DIF cambial
DIF_EXCHANGE_CREDIT	Crédito de DIF cambial
REVERSAL_REFINING_CHARGES	Estorno de encargos de refinanciamento
REVERSAL_INTEREST	Estorno de juros de mora
FINE_REVERSAL	Estorno de multa
REVERSAL_IOF	Estorno de IOF
CANCELLATION_AGREEMENT_REFINANC	Cancelamento do contrato de refinanciamento
CREDIT_BY_AGREEMENT	Crédito por acordo
INSTALLMENT_OF_AGREEMENT	Parcela de acordo
AGREEMENT_CONTRACT	Contrato de acordo
CANCELLATION_OF_INSTALLMENT_AGREEMENT	Cancelamento de parcela de acordo
CANC_CREDIT_AGREEMENT	Cancelamento de crédito de acordo
CANCELLATION_CONTRACT_AGREEMENT	Cancelamento de contrato de acordo
CREDIT_BY_INSTALLMENT_CP	Crédito por parcelamento compulsório
CP_REFINANCING_INSTALLMENT	Parcelamento de refinanciamento compulsório
CP_REFINANCE_CONTRACT	Contrato de refinanciamento compulsório
CANC_PARC_DE_REF_CP	Cancelamento do parcelamento de refinanciamento compulsório
CANC_CREDIT_INSTALLMENT_CP	Cancelamento de crédito do parcelamento compulsório
CANCELLATION_CONTRACT_REF_CP	Cancelamento do contrato de refinanciamento compulsório
DEBIT_PAYMENT	Pagamento com débito
CREDIT_VOUCHER	Voucher de crédito
CANC_INSTALLMENTS_WITHOUT_INTEREST	Cancelamento de parcelas sem juros
CANC_IN_INSTALLMENTS_WITH_INTEREST	Cancelamento de parcelado com juros
CANC_INSTALLMENT_WITH_INTEREST	Cancelamento de parcelamento com juros
CANC_INTERNATIONAL_PURCHASE	Cancelamento de compra internacional
CANC_IOF_INTERNATIONAL	Cancelamento de IOF internacional
REVERSAL_INTERNATIONAL_WITHDRAWAL	Estorno de saque internacional
REVERSAL_DEBIT_PAYMENT	Estorno de pagamento com débito
REVERSED_WITHDRAWAL	Estorno de saque
REVERSAL_RATE_WITHOUT_WITHDRAWAL	Estorno de tarifa de saque internacional
INTERNATIONAL_WITHDRAWAL	Saque internacional
FLAG_PAYMENT	Pagamento da bandeira
TED_CASH_OUT	TED cash-out
TEF_CASH_OUT	TEF cash-out
TED_CASH_IN	TED cash-in
DEBIT_REVERSAL	Reversão de débito
REVERSAL_PAYMENT	Estorno de pagamento de adesão
REVERSED_WITHDRAWAL_CHARGES	Estorno de encargos de saque
PRE_PAID_RECHARGE_RATE	Tarifa de recarga de pré-pago
PREPAID_RECHARGE_PERCENTAGE	Percentual de recarga de pré-pago
MDR	Merchant Discount Rate ou taxa de desconto do comerciante
REVERSAL_RATE_WITHDRAWAL	Estorno de tarifa de saque
REVERSAL_IOF_WITHDRAWAL	Estorno de IOF de saque

👍
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.