InstitucionalBlogService DeskStatus Page

Consulta de fatura por ID

stable

Suggest Edits

Este endpoint permite que o cliente do parceiro Bankly consulte os dados de uma fatura específica, independentemente do seu status, por meio do seu identificador único (id).

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

  • Tenha sido aprovado na análise de crédito;
  • Tenha pelo menos um um cartão emitido;
  • Tenha pelo menos uma fatura emitida.

Requisição

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}' \ 

--request GET \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}' \ 
--header 'Authorization:  Bearer {Token}' \ 
--header 'accept: application/json' \ 
--header 'api-version: 1.0'

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:

ScopeDescrição
invoice.readConcede acesso para realizar consultas referentes à gestão de faturas.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
statementIdpathObrigatório. Identificador único da fatura, retornado na consulta de todas as faturas.

Corpo da requisição (Body)

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

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso. O retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescriçãoNúmero máximo de caracteres
statementIdintIdentificador único da fatura.—
monthintRepresenta o mês de vencimento da fatura.—
yearintRepresenta o ano de vencimento da fatura.—
cycleintIndicador do ciclo da fatura (por contrato de crédito).—
cycleCloseDatestringData de fechamento da fatura, no formato ISO 8601 - UTC.25
dueDateStartstringData inicial do período da fatura, no formato ISO 8601 - UTC.25
dueDateEndstringData final do período da fatura, no formato ISO 8601 - UTC.25
dueDatestringData de vencimento da fatura, no formato ISO 8601 - UTC.25
amountMinimalnumberValor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura.—
balancenumberValor total da fatura.—
cycleTypestringSituação da fatura, a qual pode ser “Open” (fatura aberta), “Future” (fatura futura), “Closed” (fatura fechada) e “DueDate” (fatura atrasada).—
documentNumberstringNúmero do documento de CPF ou CNPJ do titular do cartão.50
paymentStatusstringSituação do pagamento da fatura, a qual pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).—
statementItens[]array of objectsLista de objetos contendo informações sobre os itens da fatura.—
statementItens[].statementNumberintNúmero da parcela.—
statementItens[].statementTotalintTotal de parcelas.—
statementItens[].isCreditbooleanIndica se é uma operação de crédito (true) ou débito (false).—
statementItens[].transactionDatestringData em que ocorreu a transação, no formato ISO 8601 - UTC.25
statementItens[].transactionobjectObjeto que contém informações sobre a transação do item de fatura. Observação: os subcampos deste objeto somente serão retornados caso o item seja de uma transação bandeirada (compra, estorno ou outra ação realizada com o cartão). Caso se trate de encargos, pagamentos, anuidade etc., ele não será preenchido.—
statementItens[].transaction.merchantstringInformações referentes ao estabelecimento/comerciante que aceitou a transação. Seus campos são baseados na ISO 8583.—
statementItens[].transaction.mccstringCódigo MCC da transação.—
statementItens[].transaction.entrymodestringCódigo do modo de entrada utilizado na transação. Confira a lista com os possíveis códigos.—
statementItens[].transaction.mcgstringDescrição do tipo do MCC.—-
statementItens[].transaction.cardobjectObjeto que contém informações sobre o cartão utilizado na transação.—
statementItens[].transaction.card.proxystringIdentificador do cartão utilizado na transação.30
statementItens[].transaction.card.lastFourDigitsstringQuatro últimos dígitos do cartão.—
statementItens[].transaction.card.aliasstringApelido dado ao cartão.—
statementItens[].transaction.card.cardTypestringTipo do cartão, o qual pode ser “Physical” (físico) ou “Virtual” (virtual).—
statementItens[].amounts[]array of objectsLista de objetos contendo os valores de cada item de fatura.—
statementItens[].amounts[].amountTypestringIndicador do item de fatura, o qual pode ser “NotMapper” (não informado), “Local” (valor da moeda local), “Exchange” (valor em Dólar da transação, no caso de compra internacional) ou “Billet” (valor cobrado, em Real, ao cliente).—
statementItens[].amounts[].valuenumberValor do item da fatura.—
statementItens[].amounts[].currencystringCódigo da moeda, de acordo com a ISO-4217. Exemplo: BRL.3
statementItens[].fees[]array of objectsLista de objetos contendo informações sobre as taxas cobradas em saques e transações internacionais.—
statementItens[].fees[].feeTypestringTipo da taxa, o qual pode ser: “NotMapper” (não informado), “IOF” (Imposto de Operações Financeiras fixo da transação), “Markup” (taxa de conversão para proteção de mudanças de câmbio), “DailyIOF” (IOF diário em cima da fatura) e “Interest” (juros de transação cobrado pelo emissor).—
statementItens[].fees[].valuenumberValor da taxa.—
statementItens[].statementItemIdintIndicador do item de fatura.—
statementItens[].transactionDescriptionstringDescritivo do item da fatura.—
summaryobjectObjeto que contém informações resumidas sobre a fatura.—
summary.outstandingBalanceobjectObjeto que contém o saldo residual devedor da fatura anterior.—
summary.outstandingBalance.valuenumberValor total do saldo residual.Decimal (18,2)
summary.outstandingBalance.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedChargesobjectObjeto que contém o valor estimado de encargos caso a fatura seja rotativada.—
summary.estimatedCharges.iofobjectObjeto que contém o valor estimado do IOF caso a fatura seja rotativada.—
summary.estimatedCharges.iof.valuenumberValor total estimado do IOF.Decimal (18,2)
summary.estimatedCharges.iof.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.refinanceobjectObjeto que contém o valor que será refinanciado caso a fatura seja rotativada. Observação: o valor a ser refinanciado é a diferença entre o mínimo da fatura e o valor total.—
summary.estimatedCharges.refinance.valuenumberValor total a ser refinanciado.Decimal (18,2)
summary.estimatedCharges.refinance.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.interestobjectObjeto que contém o valor estimado do encargo de refinanciamento caso a fatura seja rotativada.—
summary.estimatedCharges.interest.valuenumberValor total estimado dos encargos de refinanciamento.Decimal (18,2)
summary.estimatedCharges.interest.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.trafficobjectObjeto que contém o valor estimado da multa caso a fatura seja rotativada.—
summary.estimatedCharges.traffic.valuenumberValor total estimado da multa.Decimal (18,2)
summary.estimatedCharges.traffic.currencystringCódigo da moeda com base na ISO-4217.3
summary.estimatedCharges.annualCetnumberPercentual anual do custo efetivo total da operação de rotativo.Decimal (18,2)
summary.estimatedCharges.monthlyCetnumberPercentual mensal do custo efetivo total da operação de rotativo.Decimal (18,2)
summary.installmentSummaryobjectObjeto que contém o resumo dos itens parcelados a vencer (itens de parcelamento que compõem a fatura aberta e faturas futuras).—
summary.installmentSummary.interestFreeobjectObjeto que contém a soma dos itens de parcela sem juros a vencer.—
summary.installmentSummary.interestFree.valuenumberValor total dos itens parcelados sem juros a vencer.Decimal (18,2)
summary.installmentSummary.interestFree.currencystringCódigo da moeda com base na ISO-4217.3
summary.installmentSummary.interestobjectObjeto que contém a soma dos itens de parcela com juros a vencer, com desconto dos encargos que compõem a parcela.—
summary.installmentSummary.interest.valuenumberValor total dos itens parcelados com juros a vencer, com desconto dos encargos que compõem a parcela.Decimal (18,2)
summary.installmentSummary.interest.currencystringCódigo da moeda com base na ISO-4217.3
summary.installmentSummary.interestWithoutDiscountobjectObjeto que contém a soma dos itens de parcela com juros a vencer, sem o desconto dos encargos que compõem a parcela.—
summary.installmentSummary.interestWithoutDiscount.valuenumberValor total dos itens parcelados com juros a vencer, sem o desconto dos que compõem a parcela.Decimal (18,2)
summary.installmentSummary.interestWithoutDiscount.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalCompositionobjectObjeto que contém os valores que compõem o valor de pagamento mínimo da fatura.—
summary.amountMinimalComposition.outstandingBalanceobjectObjeto que contém o saldo residual devedor da fatura anterior.—
summary.amountMinimalComposition.outstandingBalance.valuenumberValor total do saldo residual.Decimal (18,2)
summary.amountMinimalComposition.outstandingBalance.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalComposition.feesobjectObjeto que contém a soma dos valores de transações de encargos lançadas na fatura.—
summary.amountMinimalComposition.fees.valuenumberValor total dos itens de encargos lançados na fatura.Decimal (18,2)
summary.amountMinimalComposition.fees.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalComposition.refinanceobjectObjeto que contém a soma dos valores de transações de refinanciamento de fatura lançados na fatura.—
summary.amountMinimalComposition.refinance.valuenumberValor total dos itens de refinanciamento de fatura lançados em fatura.Decimal (18,2)
summary.amountMinimalComposition.refinance.currencystringCódigo da moeda com base na ISO-4217.3
summary.amountMinimalComposition.transactionsobjectObjeto que contém a soma dos valores das transações de débito lançadas em fatura.—
summary.amountMinimalComposition.transactions.valuenumberValor total das transações de débitos lançadas em fatura.Decimal (18,2)
summary.amountMinimalComposition.transactions.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummaryobjectObjeto que contém os valores totais das transações na fatura, agrupados por categoria de transação.—
summary.transactionsSummary. nationalPurchasingobjectObjeto que contém a soma dos valores das transações nacionais na fatura.—
summary.transactionsSummary.nationalPurchasing.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.internationalPurchasing[]array of objectsObjeto que contém a soma dos valores das transações internacionais na fatura.—
summary.transactionsSummary.internationalPurchasing[].valuenumberSoma dos valores das transações internacionais na fatura.Decimal (18,2)
summary.transactionsSummary.internationalPurchasing[].currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.feesobjectObjeto que contém a soma dos valores dos encargos lançados na fatura.—
summary.transactionsSummary.fees.valuenumberSoma dos valores das transações de encargos lançadas na fatura.Decimal (18,2)
summary.transactionsSummary.fees.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.debtAdjustmentsobjectObjeto que contém a soma dos valores dos ajustes a débito na fatura.—
summary.transactionsSummary.debtAdjustments.valuenumberSoma dos valores das transações de ajustes a débito na fatura.Decimal (18,2)
summary.transactionsSummary.debtAdjustments.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.creditAdjustmentsobjectObjeto que contém a soma dos valores das transações de ajustes a crédito na fatura.—
summary.transactionsSummary.creditAdjustments.valuenumberSoma dos valores das transações de ajustes a crédito na fatura.Decimal (18,2)
summary.transactionsSummary.creditAdjustments.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.payments.valuenumberSoma dos valores das transações de pagamentos.Decimal (18,2)
summary.transactionsSummary.payments.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.insuranceobjectObjeto que contém a soma dos valores de transações de seguro na fatura.—
summary.transactionsSummary.insurance.valuenumberSoma dos valores das transações de seguro na fatura.Decimal (18,2)
summary.transactionsSummary.insurance.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.annuityobjectObjeto que contém a soma dos valores de transações de anuidade na fatura.—
summary.transactionsSummary.annuity.valuenumberSoma dos valores das transações da anuidade na fatura.Decimal (18,2)
summary.transactionsSummary.annuity.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.withdrawobjectObjeto que contém a soma dos valores de transações de saque na fatura.—
summary.transactionsSummary.withdraw.valuenumberSoma dos valores das transações de saque na fatura.Decimal (18,2)
summary.transactionsSummary.withdraw.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.internationalWithdrawobjectObjeto que contém a soma dos valores de transações de saques internacionais na fatura.—
summary.transactionsSummary.internationalWithdraw.valuenumberSoma dos valores de transações de saque internacional na fatura.Decimal (18,2)
summary.transactionsSummary. internationalWithdraw.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsSummary.installmentobjectObjeto que contém a soma dos valores das transações parceladas na fatura atual.—
summary.transactionsSummary.installment.valuenumberSoma dos valores das transações parceladas na fatura atual.Decimal (18,2)
summary.transactionsSummary.installment.currencystringCódigo da moeda com base na ISO-4217.3
summary. transactionsCardsSummary[]array of objectsLista de objetos que contém os valores totais das transações da fatura, agrupados por cartão e divididos por categoria de transação.—
summary.transactionsCardsSummary[].cardobjectObjeto que contém as informações do cartão atrelado à transação.—
summary.transactionsCardsSummary[].card.typestringTipo do cartão, o qual pode ser “Virtual” ou “Physical”.10
summary.transactionsCardsSummary[].card.lastFourDigitisstringÚltimos quatro dígitos do cartão.4
summary.transactionsCardsSummary[].card.namestringNome exibido no cartão.20
summary.transactionsCardsSummary[].card. proxystringIdentificador único do cartão.30
summary.transactionsCardsSummary[]. totalDebitsobjectObjeto que contém a soma dos valores de transações dos itens de débito na fatura atual.—
summary.transactionsCardsSummary[].totalDebits.valuenumberSoma dos valores das transações dos itens de débito na fatura atual.Decimal (18,2)
summary.transactionsCardsSummary[].totalDebits.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].nationalPurchasingobjectObjeto que contém a soma dos valores de transações nacionais na fatura.—
summary.transactionsCardsSummary[].nationalPurchasing.valuenumberSoma dos valores das transações nacionais na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].nationalPurchasing.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].internationalPurchasing[]array of objectsLista de objetos que contém a soma dos valores de transações internacionais na fatura.—
summary.transactionsCardsSummary[].internationalPurchasing[].valuenumberSoma dos valores das transações internacionais na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].internationalPurchasing[].currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].feesobjectObjeto que contém a soma dos valores de transações dos encargos na fatura.—
summary.transactionsCardsSummary[].fees.valuenumberSoma dos valores das transações de encargos na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].fees.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].debtAdjustmentsobjectObjeto que contém a soma dos valores de transações de ajustes a débito na fatura.—
summary.transactionsCardsSummary[].debtAdjustments.valuenumberValor total das transações de ajustes a débito na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].debtAdjustments.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].creditAdjustmentsobjectObjeto que contém a soma dos valores de transações de ajustes a crédito na fatura.—
summary.transactionsCardsSummary[].creditAdjustments.valuenumberSoma dos valores das transações de ajustes a crédito na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].creditAdjustments.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].paymentsobjectObjeto que contém a soma dos valores de transações de pagamentos por cartão.—
summary.transactionsCardsSummary[].payments.valuenumberSoma dos valores das transações de pagamentos por cartão.Decimal (18,2)
summary.transactionsCardsSummary[].payments.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].insuranceobjectObjeto que contém a soma dos valores de transações de seguro na fatura.—
summary.transactionsCardsSummary[].insurance.valuenumberSoma dos valores das transações de seguro na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].insurance.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].annuityobjectObjeto que contém a soma dos valores de transações de anuidade na fatura.—
summary.transactionsCardsSummary[].annuity.valuenumberSoma dos valores das transações da anuidade na fatura.decimal(18,2)
summary.transactionsCardsSummary[].annuity.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].withdrawobjectObjeto que contém a soma dos valores de transações de saque na fatura.—
summary.transactionsCardsSummary[].withdraw.valuenumberSoma dos valores das transações de saque na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].withdraw.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].internationalWithdrawobjectObjeto que contém a soma dos valores de transações de saques internacionais na fatura.—
summary.transactionsCardsSummary[].internationalWithdraw.valuenumberSoma dos valores das transações de saques internacionais na fatura.Decimal (18,2)
summary.transactionsCardsSummary[].internationalWithdraw.currencystringCódigo da moeda com base na ISO-4217.3
summary.transactionsCardsSummary[].installmentobjectObjeto que contém a soma dos valores de transações parceladas na fatura atual.—
summary.transactionsCardsSummary[].installment.valuenumberSoma dos valores das transações parceladas na fatura atual.Decimal (18,2)
summary.transactionsCardsSummary[].installment.currencystringCódigo da moeda com base na ISO-4217.3
{
    "statementId": 0,
    "month": 0,
    "year": 0,
    "cycle": 0,
    "cycleCloseDate": "2022-10-25T17:21:35.407Z",
    "dueDateStart": "2022-10-25T17:21:35.407Z",
    "dueDateEnd": "2022-10-25T17:21:35.407Z",
    "dueDate": "2022-10-25T17:21:35.407Z",
    "amountMinimal": 0,
    "balance": 0,
    "cycleType": "Open",
    "documentNumber": "47742663023",
    "paymentStatus": "Pending",
    "previousBalance": {
        "value": 0,
        "currency": "BRL"
    },
    "statementItens": [
        {
            "statementNumber": 0,
            "statementTotal": 0,
            "isCredit": true,
            "transactionDate": "2022-10-25T17:21:35.407Z",
            "transactionType": "REFINANCE_CHARGES",
            "transaction": {
                "merchant": "string",
                "mcc": "string",
                "entrymode": "string",
                "mcg": "string",
                "card": {
                    "proxy": "string",
                    "lastFourDigits": "4815",
                    "alias": "string",
                    "cardType": "string"
                }
            },
            "amounts": [
                {
                    "amountType": "NotMapper",
                    "value": 0,
                    "currency": "string"
                }
            ],
            "fees": [
                {
                    "feeType": "NotMapper",
                    "value": 0
                }
            ],
            "statementItemId": 0,
            "transactionDescription": "string"
        }
    ],
    "summary": {
        "outstandingBalance": {
            "value": 107.35,
            "currency": "BRL"
        },
        "estimateCharges": {
            "iof": {
                "value": 495.98,
                "currency": "BRL"
            },
            "refinance": {
                "value": 495.98,
                "currency": "BRL"
            },
            "interest": {
                "value": 495.98,
                "currency": "BRL"
            },
            "trafficValue": {
                "value": 495.98,
                "currency": "BRL"
            },
            "annualCet": 495.98,
            "monthlyCet": 495.98
        },
        "installmentSummary": {
            "interestFree": {
                "value": 114.58,
                "currency": "BRL"
            },
            "interest": {
                "value": 114.58,
                "currency": "BRL"
            },
            "interestWithoutDiscount": {
                "value": 0,
                "currency": "BRL"
            }
        },
        "amountMinimalComposition": {
            "outstandingBalance": {
                "value": 107.35,
                "currency": "BRL"
            },
            "fees": {
                "value": 27.74,
                "currency": "BRL"
            },
            "refinance": {
                "value": 26.86,
                "currency": "BRL"
            },
            "transactions": {
                "value": 152.54,
                "currency": "BRL"
            }
        },
        "transactionsSummary": {
            "nationalPurchasing": {
                "value": 152.544,
                "currency": "BRL"
            },
            "internationalPurchasing": [
                {
                    "value": 152.544,
                    "currency": "BRL"
                },
                {
                    "value": 152.544,
                    "currency": "USS"
                }
            ],
            "fees": {
                "value": 152.544,
                "currency": "BRL"
            },
            "debtAdjustments": {
                "value": 152.544,
                "currency": "BRL"
            },
            "creditAdjustments": {
                "value": 152.544,
                "currency": "BRL"
            },
            "payments": {
                "value": 152.544,
                "currency": "BRL"
            },
            "insurance": {
                "value": 152.544,
                "currency": "BRL"
            },
            "annuity": {
                "value": 152.544,
                "currency": "BRL"
            },
            "withdraw": {
                "value": 152.544,
                "currency": "BRL"
            },
            "internationalWithdraw": {
                "value": 152.544,
                "currency": "BRL"
            },
            "installment": {
                "value": 152.544,
                "currency": "BRL"
            }
        },
        "transactionsCardsSummary": [
            {
                "card": {
                    "type": "virtual",
                    "lastFourDigitis": "1234",
                    "name": "cartão virtual",
                    "proxy": "45567984651321354654"
                },
                "totalDebits": {
                    "value": 0,
                    "currency": "BRL"
                },
                "nationalPurchasing": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "internationalPurchasing": [
                    {
                        "value": 152.544,
                        "currency": "BRL"
                    },
                    {
                        "value": 152.544,
                        "currency": "USS"
                    }
                ],
                "fees": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "debtAdjustments": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "creditAdjustments": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "payments": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "insurance": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "annuity": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "withdraw": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "internationalWithdraw": {
                    "value": 152.544,
                    "currency": "BRL"
                },
                "installment": {
                    "value": 152.544,
                    "currency": "BRL"
                }
            }
        ]
    }
}

Códigos dos tipos de transação

CódigoDescrição
REFINANCE_CHARGESEncargos de refinanciamento
INTEREST_ON_ARRESTJuros de mora
TRAFFIC_TICKETMulta
PURCHASE_BY_SIGHTCompra à vista
INSTALLMENT_WITHOUT_INTERESTParcela sem juros
DEBIT_ADJUSTMENTAjuste a débito
INSTALLMENTS_WITHOUT_INTERESTParcelado sem juros
INSTALLED_WITH_INTERESTParcelado com juros
PAYMENTPagamento
CREDIT_ADJUSTMENTAjuste a crédito
PARTIAL_CANCELLATION_OF_PURCHASECancelamento parcial de compra
WITHDRAWSaque
INTERNATIONAL_PURCHASECompra internacional
INTERNATIONAL_IOFIOF internacional
IOFImposto sobre Operações Financeiras
IOF_WITHDRAWALIOF sobre o saque
WITHDRAWAL_CHARGESEncargos de saque
ANNUITYAnuidade
WITHDRAWAL_RATETarifa de saque
RATE_CARD_ISSUANCETarifa de emissão de cartão
REFINANCE_INSTALLMENTParcela de refinanciamento
CANC_CREDIT_INSTALLMENTSCancelamento de crédito parcelamento
PREPAID_CHARGECarga de pré-pago
MEMBERSHIP_PAYMENTPagamento de adesão
PURCHASE_CANCELLATIONCancelamento de compra
CANC_INSTALLMENT_WITHOUT_INTERESTCancelamento de parcela sem juros
ANNUAL_REVERSALEstorno da anuidade
CREDIT_BY_INSTALLMENTCrédito por parcelamento
REFINANCE_CONTRACTContrato de refinanciamento
CANC_PARC_DE_REFCancelamento de parcela de refinanciamento
EXCHANGE_DIF_DEBITDébito de DIF cambial
DIF_EXCHANGE_CREDITCrédito de DIF cambial
REVERSAL_REFINING_CHARGESEstorno de encargos de refinanciamento
REVERSAL_INTERESTEstorno de juros de mora
FINE_REVERSALEstorno de multa
REVERSAL_IOFEstorno de IOF
CANCELLATION_AGREEMENT_REFINANCCancelamento do contrato de refinanciamento
CREDIT_BY_AGREEMENTCrédito por acordo
INSTALLMENT_OF_AGREEMENTParcela de acordo
AGREEMENT_CONTRACTContrato de acordo
CANCELLATION_OF_INSTALLMENT_AGREEMENTCancelamento de parcela de acordo
CANC_CREDIT_AGREEMENTCancelamento de crédito de acordo
CANCELLATION_CONTRACT_AGREEMENTCancelamento de contrato de acordo
CREDIT_BY_INSTALLMENT_CPCrédito por parcelamento compulsório
CP_REFINANCING_INSTALLMENTParcelamento de refinanciamento compulsório
CP_REFINANCE_CONTRACTContrato de refinanciamento compulsório
CANC_PARC_DE_REF_CPCancelamento do parcelamento de refinanciamento compulsório
CANC_CREDIT_INSTALLMENT_CPCancelamento de crédito do parcelamento compulsório
CANCELLATION_CONTRACT_REF_CPCancelamento do contrato de refinanciamento compulsório
DEBIT_PAYMENTPagamento com débito
CREDIT_VOUCHERVoucher de crédito
CANC_INSTALLMENTS_WITHOUT_INTERESTCancelamento de parcelas sem juros
CANC_IN_INSTALLMENTS_WITH_INTERESTCancelamento de parcelado com juros
CANC_INSTALLMENT_WITH_INTERESTCancelamento de parcelamento com juros
CANC_INTERNATIONAL_PURCHASECancelamento de compra internacional
CANC_IOF_INTERNATIONALCancelamento de IOF internacional
REVERSAL_INTERNATIONAL_WITHDRAWALEstorno de saque internacional
REVERSAL_DEBIT_PAYMENTEstorno de pagamento com débito
REVERSED_WITHDRAWALEstorno de saque
REVERSAL_RATE_WITHOUT_WITHDRAWALEstorno de tarifa de saque internacional
INTERNATIONAL_WITHDRAWALSaque internacional
FLAG_PAYMENTPagamento da bandeira
TED_CASH_OUTTED cash-out
TEF_CASH_OUTTEF cash-out
TED_CASH_INTED cash-in
DEBIT_REVERSALReversão de débito
REVERSAL_PAYMENTEstorno de pagamento de adesão
REVERSED_WITHDRAWAL_CHARGESEstorno de encargos de saque
PRE_PAID_RECHARGE_RATETarifa de recarga de pré-pago
PREPAID_RECHARGE_PERCENTAGEPercentual de recarga de pré-pago
MDRMerchant Discount Rate ou taxa de desconto do comerciante
REVERSAL_RATE_WITHDRAWALEstorno de tarifa de saque
REVERSAL_IOF_WITHDRAWALEstorno de IOF de saque

Código do modo de entrada (entryMode)

CódigoDescrição
00Modo de entrada do PAN desconhecido.
01Entrada do PAN manual.
02Entrada automática do PAN via leitura da tarja magnética. Para transações Plus, este código também significa que o conteúdo exato da faixa 2 está incluído e a verificação de CVV é possível.
03Entrada automática via leitor de código de barras.
04Entrada automática de PAN via leitor óptico de caracteres (OCR).
05Entrada automática de PAN via chip.
06Contactless obsoleto.
07Entrada automática de PAN via M/Chip sem contato.
08Contactless MChip obsoleto.
09Entrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data).
10Credencial em arquivo.
79Um terminal híbrido com conexão online com o adquirente falhou no envio de uma transação de chip fallback (em que DE 22, subcampo 1 = 80) ao emissor.
80O cartão com chip não foi capaz de processar/leitura da tarja magnética padrão.
81Entrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF.
82Entrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado).
90A tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível).
91Entrada automática do número da conta via tarja magnética sem contato.
95Apenas Visa – Chip com CVV não confiável.

👍

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.

Updated 5 days ago