Autorização e confirmação (Authorization)

stable

O processo de autorização consiste numa série de análises internas realizadas pelo Bankly para autorizar o processamento de uma transação com um cartão.

Após a autorização, ocorre o processo de confirmação, no qual o valor é de fato liquidado e o dinheiro é depositado na conta do recebedor.

Todos os eventos relacionados à autorização e à confirmação de transações com o cartão serão comunicados ao destinatário através de mensagens.

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

contextnameDescrição
AuthorizationTRANSACTION_WAS_PROCESSEDA transação foi processada, podendo ser aprovada ou não. Este evento pode ser disparado individualmente caso a transação não seja autorizada ou quando é enviado um voucher por meio de uma autorização (sem uma compra efetuada).
AuthorizationTRANSACTION_WAS_REVERTEDA transação foi revertida parcial ou totalmente.
AuthorizationTRANSACTION_WAS_EXPIREDO tempo de reserva de saldo da transação expirou e a transação foi revertida. Esse fluxo ocorre em transações pré-pagas.
AuthorizationCONFIRMATION_WAS_PROCESSEDA transação foi confirmada parcial ou totalmente.
AuthorizationCANCELATION_WAS_PROCESSEDA transação foi cancelada.
AuthorizationVOUCHER_WAS_PROCESSEDO voucher (crédito) foi lançado na conta do cliente.

Fluxo dos eventos

O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:

🚧

Importante

É possível que os eventos TRANSACTION_WAS_PROCESSED e VOUCHER_WAS_PROCESSED sejam disparados isoladamente. Verifique o tipo de transação e o seu resultado para maior esclarecimento.

Identificador (entityId)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de autorização, o entityId é o identificador único da transação (authorizationTransactionId).

Dados dos eventos

TRANSACTION_WAS_PROCESSED

Este evento sinaliza que a transação foi processada, podendo ser aprovada ou não. Ele pode ser disparado individualmente caso a transação não seja autorizada ou quando é enviado um voucher por meio de uma autorização (sem uma compra efetuada).

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
accountobjectObjeto que contém informações sobre a conta bancária.
account.branchstringNúmero da agência bancária.
account.numberstringNúmero da conta.
account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
amountobjectObjeto que contém informações sobre o valor da transação.
amount.valuenumberValor da transação.
amount.currencystringCódigo da moeda com base na ISO-4217.
withoutFeeAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
withoutFeeAmount.valuenumberValor da transação sem taxas.
withoutFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
iofAmountobjectObjeto que contém informações sobre o valor calculado do IOF da transação.
iofAmount.valuenumberValor calculado do IOF da transação.
iofAmount.currencystringCódigo da moeda com base na ISO-4217.
markupAmountobjectObjeto que contém informações sobre o valor calculado do markup da transação.
markupAmount.valuenumberValor calculado do markup.
markupAmount.currencystringCódigo da moeda com base na ISO-4217.
withdrawalFeeAmountobjectObjeto que contém informações sobre o valor da tarifa de saque (somente para transações de saque).
withdrawalFeeAmount.valuenumberValor da tarifa de saque.
withdrawalFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
feesobjectObjeto que contém informações sobre as taxas aplicadas na transação.
fees.markupnumberPercentual do markup.
fees.iofnumberPercentual do IOF.
fees.dollarExchangeRateobjectObjeto que contém informações sobre a cotação atual do dólar, em reais.
fees.dollarExchangeRate.valuenumberCotação atual do dólar, em reais.
fees.dollarExchangeRate.currencystringCódigo da moeda local com base na ISO-4217.
deniedRulesarray of stringsMotivos pelos quais a transação foi negada. Confira a lista dos possíveis motivos de negação no final da página.
statusstringSituação da transação, a qual pode ser “SUCCESS” ou “DENIED”.
transactionTimeStampstringData e a hora em que ocorreu a transação, no formato ISO 8601 - UTC.
channelobjectObjeto que contém informações sobre o canal por onde passam os dados recebidos da rede de cartões.
channel.settlementobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.settlement.valuenumberValor da transação sem taxas.
channel.settlement.currencystringCódigo da moeda com base na ISO-4217.
channel.localAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.localAmount.valuenumberValor da transação sem taxas.
channel.localAmount.currencystringCódigo da moeda local com base na ISO-4217.
channel.entryModeobjectObjeto que contém informações sobre o modo de entrada do cartão.
channel.entryMode.codestringCódigo do modo de entrada de acordo com a ISO-8583.
channel.entryMode.descriptionstringDescrição do modo de entrada.
channel.entryMode.cardPresentbooleanIndica se este modo de entrada está presente no cartão.
channel.authorizationCodestringIdentificador da transação da rede do cartão.
channel.transactionTypeobjectObjeto que contém informações sobre o tipo da transação de acordo com a ISO-8583.
channel.transactionType.codestringCódigo da transação, o qual pode ser: “00”, “01”, ou “20”.
channel.transactionType.descriptionstringDescrição do código, a qual pode ser “purchase” para “00”, “withdraw” para “01” ou “voucher” para “20”.
channel.walletobjectObjeto que contém informações sobre a carteira utilizada na transação. Confira a lista com as possíveis carteiras na tabela ao final da página.
channel.wallet.codestringCódigo da carteira.
channel.wallet.namestringNome da carteira.
channel.retrievalReferenceNumberstringIdentificador de transação da rede do cartão.
channel.merchantobjectObjeto que contém informações referentes ao estabelecimento/comerciante que aceitou a transação. Seus campos são baseados na ISO-8583.
channel.merchant.mccstringCódigo mcc da transação.
channel.merchant.mcgstringDescrição do tipo do mcc.
channel.merchant.citystringCidade do merchant para identificar parte de sua localização.
channel.merchant.stateOrCountryCodestringCódigo do estado ou do país do merchant para identificar parte da sua localização.
channel.merchant.statestringEstado do merchant para identificar parte de sua localização
channel.merchant.namestringNome do merchant.
channel.merchant.zipCodestringCódigo postal do merchant.
channel.merchant.terminalIdstringIdentificador do terminal do merchant.
channel.merchant.acquirerCodestringCódigo do credenciador.
channel.numberOfInstallmentsnumberQuantidade de parcelas da transação.
channel.mtistringMTI (Message Type Indicator), código que identifica o tipo da transação.
channel.processingCodestringIdentificador que indica o tipo de transação, o tipo de conta remetente e tipo de conta destinatária.
channel.passwordPresentbooleanIndica se a senha do cartão foi informada na autorização.
channel.preAuthorizationbooleanEm caso de pré-autorização, esse campo retornará TRUE. Caso contrário, FALSE.
authorizationIdnumberIdentificador da autorização da processadora.
channel.namestringNome do canal que iniciou a transação no banco. No contexto do autorizador, o canal será sempre “CARD_NETWORK”.
authorizationTransactionIdstringIdentificador da transação gerado pela plataforma de autorização do Bankly.
cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
card.proxystringCódigo identificador do cartão.
card.aliasstringApelido definido pelo proprietário do cartão.
card.functionstringFunção do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”.
card.typestringTipo do cartão, o qual pode ser: “Physical” ou “Virtual”.
card.programIdstringIdentificador do programa ao qual o cartão pertence.
card.fourLastDigitsstringQuatro últimos dígitos do cartão.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplos de payloads
{
   "entityId": "3af1dddc-3b71-4261-8707-81162b412e6a",
   "companyKey": "COMPANY_KEY",
   "name": "TRANSACTION_WAS_PROCESSED",
   "timestamp": "2024-01-22T17:16:30.5847204Z",
   "correlationId": "53c7ee96-e15d-497d-930a-22dc7b82f029",
   "context": "Authorization",
   "idempotencyKey": "53c7ee96-e15d-497d-930a-22dc7b82f029",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 11,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 11,
         "currency": "BRL"
      },
      "deniedRules": [],
      "status": "SUCCESS",
      "transactionTimeStamp": "2022-11-09T21:42:02",
      "channel": {
         "settlement": {
            "value": 11,
            "currency": "USD"
         },
         "localAmount": {
            "value": 11,
            "currency": "BRL"
         },
         "entryMode": {
            "code": "07",
            "description": "PAN auto-entry via contactless M/Chip",
            "cardPresent": true
         },
         "authorizationCode": "RZNZPW",
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "wallet": {
            "code": "0",
            "name": "Unknown"
         },
         "retrievalReferenceNumber": "136248133",
         "merchant": {
            "mcc": "5411",
            "mcg": "Supermarkets",
            "city": "FORTALEZA     ",
            "stateOrCountryCode": "BRA",
            "state": "",
            "name": "teste",
            "zipCode": "",
            "terminalId": "TM000018",
            "acquirerCode": "998653213"
         },
         "numberOfInstallments": 1,
         "processingCode": "000000",
         "passwordPresent": false,
         "mti": "0200",
         "preAuthorization": true,
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "3af1dddc-3b71-4261-8707-81162b412e6a",
      "card": {
         "programId": "128",
         "proxy": "0000000000000000000",
         "fourLastDigits": "2817",
         "alias": "Debito",
         "function": "Debit",
         "type": "Physical"
      }
   }
}
{
   "entityId": "67293c59-d42e-459d-9121-e7a0d091cbd6",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_PROCESSED",
   "timestamp": "2024-03-26T20:02:30.0018652Z",
   "correlationId": "833db6f5-f8db-459a-adaa-747ca1d55595",
   "context": "Authorization",
   "idempotencyKey": "833db6f5-f8db-459a-adaa-747ca1d55595",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
         "ispb": "13140088",
         "code": "332",
         "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 21.8,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 19.92,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0.88,
         "currency": "BRL"
         },
      "markupAmount": {
         "value": 1,
         "currency": "BRL"
         },
      "fees": {
         "markup": 0.05,
         "iof": 0.0438,
         "dollarExchangeRate": {
            "value": 4.9798,
            "currency": "BRL"
         }
      },
      "deniedRules": [],
      "status": "SUCCESS",
      "transactionTimeStamp": "2022-11-09T21:42:02",
      "channel": {
         "settlement": {
            "value": 4,
            "currency": "USD"
         },
         "localAmount": {
            "value": 4,
            "currency": "USD"
         },
         "entryMode": {
            "code": "81",
            "description": "PAN/Token entry via electronic commerce with optional Identity Check-AAV or DSRP cryptogram in UCAF.",
            "cardPresent": false
         },
         "authorizationCode": "RZNZPW",
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "wallet": {
            "code": "0",
            "name": "Unknown"
         },
         "retrievalReferenceNumber": "136248133",
         "merchant": {
            "mcc": "5411",
            "mcg": "Supermarkets",
            "city": "new york",
            "stateOrCountryCode": "USA",
            "state": "",
            "name": "amazon",
            "zipCode": "",
            "terminalId": "TM000018",
            "acquirerCode": "998653213"
         },
         "numberOfInstallments": 1,
         "processingCode": "000000",
         "passwordPresent": false,
         "mti": "0200",
         "preAuthorization": true,
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "67293c59-d42e-459d-9121-e7a0d091cbd6",
      "card": {
      "programId": "128",
         "proxy": "2340281000243642749",
         "fourLastDigits": "2817",
         "alias": "Debito",
         "function": "Debit",
         "type": "Physical"
      }
   }
}
{
   "entityId": "8e658cd4-144d-4d8e-8230-629b968f2c37",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_PROCESSED",
   "timestamp": "2024-03-27T19:11:09.9238238Z",
   "correlationId": "c78b4105-def2-474e-bb40-88eba351cb6f",
   "context": "Authorization",
   "idempotencyKey": "c78b4105-def2-474e-bb40-88eba351cb6f",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "deniedRules": [],
      "status": "SUCCESS",
      "transactionTimeStamp": "2024-03-27T16:11:09.712-03:00",
      "channel": {
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "BRL"
         },
         "entryMode": {
            "code": "81",
            "description": "PAN/Token entry via electronic commerce with optional Identity Check-AAV or DSRP cryptogram in UCAF.",
            "cardPresent": false
         },
         "authorizationCode": "6841317932663276",
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "wallet": {
            "code": "0",
            "name": "Unknown"
         },
         "retrievalReferenceNumber": "6841317932663276",
         "merchant": {
            "mcc": "5199",
            "mcg": "Food",
            "city": "sao paula",
            "stateOrCountryCode": "BRA",
            "state": "",
            "name": "TESTE",
            "zipCode": "",
            "terminalId": ""
         },
         "numberOfInstallments": 1,
         "authorizationId": 6841317932663276,
         "passwordPresent": false,
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "8e658cd4-144d-4d8e-8230-629b968f2c37",
      "card": {
         "programId": "107",
         "proxy": "2229141001432904325",
         "alias": "Credito pos",
         "function": "Pos",
         "type": "Virtual"
      }
   }
}
{
   "entityId": "9d35e782-09ac-4e28-a6f5-b8719862b6c8",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:14:47.456964Z",
   "correlationId": "e374cad4-72f5-4f1b-8a6e-7d8f1888fa5b",
   "context": "Authorization",
   "idempotencyKey": "e374cad4-72f5-4f1b-8a6e-7d8f1888fa5b",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "amount": {
         "value": 2,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 2,
         "currency": "BRL"
      },
      "deniedRules": [],
      "status": "SUCCESS",
      "transactionTimeStamp": "2024-03-27T21:14:46.357Z",
      "channel": {
         "settlement": {
            "value": 2,
            "currency": "USD"
         },
         "localAmount": {
            "value": 2,
            "currency": "BRL"
         },
         "entryMode": {
            "code": "81",
            "description": "PAN/Token entry via electronic commerce with optional Identity Check-AAV or DSRP cryptogram in UCAF.",
            "cardPresent": false
         },
         "authorizationCode": "a0043fb1-7647-43d9-b9e9-abef41d4d51f",
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "wallet": {
            "code": "111",
            "name": "Unknown"
         },
         "retrievalReferenceNumber": "a0043fb1-7647-43d9-b9e9-abef41d4d51f",
         "merchant": {
            "mcc": "5311",
            "mcg": "Department",
            "city": "Luxemburg     ",
            "stateOrCountryCode": "BRA",
            "state": "",
            "name": "TESTE",
            "zipCode": "",
            "terminalId": "62683744",
            "acquirerCode": "7133380"
         },
         "numberOfInstallments": 1,
         "processingCode": "003100",
         "passwordPresent": true,
         "mti": "0100",
         "preAuthorization": false,
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "9d35e782-09ac-4e28-a6f5-b8719862b6c8",
      "card": {
         "programId": "31",
         "proxy": "2307171003721696184",
         "fourLastDigits": "4237",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      }
   }
}
{
   "entityId": "bffcc517-f310-4e96-a4d0-5b35d0e12df4",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_PROCESSED",
   "timestamp": "2024-03-27T12:55:58.0015373Z",
   "correlationId": "055897de-d9be-403b-9a0f-af7616e61315",
   "context": "Authorization",
   "idempotencyKey": "055897de-d9be-403b-9a0f-af7616e61315",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "amount": {
         "value": 10.9,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 9.96,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0.44,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0.5,
         "currency": "BRL"
      },
      "fees": {
         "markup": 0.05,
         "iof": 0.0438,
         "dollarExchangeRate": {
            "value": 4.9798,
            "currency": "BRL"
         }
      },
      "deniedRules": [],
      "status": "SUCCESS",
      "transactionTimeStamp": "2024-03-27T12:55:56.657Z",
      "channel": {
         "settlement": {
            "value": 2,
            "currency": "USD"
         },
         "localAmount": {
            "value": 2,
            "currency": "USD"
         },
         "entryMode": {
            "code": "81",
            "description": "PAN/Token entry via electronic commerce with optional Identity Check-AAV or DSRP cryptogram in UCAF.",
            "cardPresent": false
         },
         "authorizationCode": "bb9d9ecc-0fa8-472d-8ce2-b810acd6824a",
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "wallet": {
            "code": "111",
            "name": "Unknown"
         },
         "retrievalReferenceNumber": "bb9d9ecc-0fa8-472d-8ce2-b810acd6824a",
         "merchant": {
            "mcc": "5311",
            "mcg": "Department",
            "city": "Luxemburg     ",
            "stateOrCountryCode": "USA",
            "state": "",
            "name": "TESTE",
            "zipCode": "",
            "terminalId": "62683744",
            "acquirerCode": "7133380"
         },
         "numberOfInstallments": 1,
         "processingCode": "003100",
         "passwordPresent": true,
         "mti": "0100",
         "preAuthorization": false,
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "bffcc517-f310-4e96-a4d0-5b35d0e12df4",
      "card": {
         "programId": "31",
         "proxy": "2307171003721696184",
         "fourLastDigits": "4237",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      }
   }
}
{
   "entityId": "647ef3fe-82a0-4b88-8103-aebf70b24832",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_PROCESSED",
   "timestamp": "2024-03-27T19:16:46.375026Z",
   "correlationId": "4fef24ea-a033-440a-b418-d68f18acb7cc",
   "context": "Authorization",
   "idempotencyKey": "4fef24ea-a033-440a-b418-d68f18acb7cc",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "amount": {
         "value": 5.45,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 4.98,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0.22,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0.25,
         "currency": "BRL"
      },
      "fees": {
         "markup": 0.05,
         "iof": 0.0438,
         "dollarExchangeRate": {
            "value": 4.9798,
            "currency": "BRL"
         }
      },
      "deniedRules": [],
      "status": "SUCCESS",
      "transactionTimeStamp": "2024-03-27T19:16:44.952Z",
      "channel": {
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "USD"
         },
         "entryMode": {
            "code": "81",
            "description": "PAN/Token entry via electronic commerce with optional Identity Check-AAV or DSRP cryptogram in UCAF.",
            "cardPresent": false
         },
         "authorizationCode": "4b418674-0fbd-4363-a2e0-ae545f68cb95",
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "wallet": {
            "code": "111",
            "name": "Unknown"
         },
         "retrievalReferenceNumber": "4b418674-0fbd-4363-a2e0-ae545f68cb95",
         "merchant": {
            "mcc": "5311",
            "mcg": "Department",
            "city": "Luxemburg     ",
            "stateOrCountryCode": "USA",
            "state": "",
            "name": "TESTE",
            "zipCode": "",
            "terminalId": "62683744",
            "acquirerCode": "7133380"
         },
         "numberOfInstallments": 1,
         "processingCode": "003100",
         "passwordPresent": true,
         "mti": "0100",
         "preAuthorization": false,
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "647ef3fe-82a0-4b88-8103-aebf70b24832",
      "card": {
         "programId": "31",
         "proxy": "2307171003721696184",
         "fourLastDigits": "4237",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      }
   }
}

TRANSACTION_WAS_REVERTED

Este evento sinaliza que a transação foi revertida parcial ou totalmente.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
accountobjectObjeto que contém informações sobre a conta bancária.
account.branchstringNúmero da agência bancária.
account.numberstringNúmero da conta.
account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
amountobjectObjeto que contém informações sobre o valor da transação.
amount.valuenumberValor da transação.
amount.currencystringCódigo da moeda com base na ISO-4217.
withoutFeeAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
withoutFeeAmount.valuenumberValor da transação sem taxas.
withoutFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
iofAmountobjectObjeto que contém informações sobre o valor calculado do IOF da transação.
iofAmount.valuenumberValor calculado do IOF da transação.
iofAmount.currencystringCódigo da moeda com base na ISO-4217.
markupAmountobjectObjeto que contém informações sobre o valor calculado do markup da transação.
markupAmount.valuenumberValor calculado do markup.
markupAmount.currencystringCódigo da moeda com base na ISO-4217.
withdrawalFeeAmountobjectObjeto que contém informações sobre o valor da tarifa de saque (somente para transações de saque).
withdrawalFeeAmount.valuenumberValor da tarifa de saque.
withdrawalFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
dollarExchangeRateobjectObjeto que contém informações sobre a cotação atual do dólar, em reais.
dollarExchangeRate.valuenumberCotação atual do dólar, em reais.
dollarExchangeRate.currencystringCódigo da moeda local com base na ISO-4217.
reversalReasonnumberMotivo da reversão da transação. Exemplo: “SystemFault”, “PosRequest”, “DebitReversal”.
channelobjectObjeto que contém informações sobre o canal por onde passam os dados recebidos da rede de cartões.
channel.settlementobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.settlement.valuenumberValor da transação sem taxas.
channel.settlement.currencystringCódigo da moeda com base na ISO-4217.
channel.localAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.localAmount.valuenumberValor da transação sem taxas.
channel.localAmount.currencystringCódigo da moeda local com base na ISO-4217.
channel.namestringNome do canal que iniciou a transação no banco. No contexto do autorizador, o canal será sempre “CARD_NETWORK”.
channel.mtistringMTI (Message Type Indicator), código que identifica o tipo da transação.
channel.processingCodestringIdentificador que indica o tipo de transação, o tipo de conta remetente e tipo de conta destinatária.
authorizationTransactionIdstringIdentificador da transação gerado pela plataforma de autorização do Bankly.
cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
card.proxystringCódigo identificador do cartão.
card.aliasstringApelido definido pelo proprietário do cartão.
card.functionstringFunção do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”.
card.fourLastDigitsstringQuatro últimos dígitos do cartão.
card.typestringTipo do cartão, o qual pode ser: “Physical” ou “Virtual”.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplos de payloads
{
   "entityId": "30409c8e-7171-454d-a914-d893b4c12489",
   "companyKey": "COMPANY_KEY",
   "name": "TRANSACTION_WAS_REVERTED",
   "timestamp": "2024-02-14T15:10:47.1125195Z",
   "correlationId": "93c72a03-5954-449d-b40a-d438a662963d",
   "$schema": : "Authorization",
   "idempotencyKey": "93c72a03-5954-449d-b40a-d438a662963d",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 17,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 17,
         "currency": "BRL"
      },
      "reversalReason": "DebitReversal",
      "channel": {
         "settlement": {
            "value": 6,
            "currency": "USD"
         },
         "localAmount": {
            "value": 6,
            "currency": "BRL"
         },
         "mti": "0420",
         "processingCode": "000000",
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "30409c8e-7171-454d-a914-d893b4c12489",
      "card": {
         "proxy": "0000000000000000000",
         "fourLastDigits": "2817",
         "alias": "Debito",
         "function": "Debit"
      }
   }
}
{
   "entityId": "cbe35d61-78d3-40d0-878d-bf47b0862acd",
   "companyKey": "",
   "name": "TRANSACTION_WAS_REVERTED",
   "timestamp": "2024-03-26T20:03:47.5885398Z",
   "correlationId": "67293c59-d42e-459d-9121-e7a0d091cbd6",
   "context": "Authorization",
   "idempotencyKey": "67293c59-d42e-459d-9121-e7a0d091cbd6",
   "data": {
      "account": {
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 4,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 4,
         "currency": "BRL"
      },
      "reversalReason": "PosRequest",
      "channel": {
         "settlement": {
            "value": 4,
            "currency": "USD"
         },
         "localAmount": {
            "value": 4,
            "currency": "USD"
         },
         "mti": "0420",
         "processingCode": "003100",
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "cbe35d61-78d3-40d0-878d-bf47b0862acd",
      "card": {
         "proxy": "",
         "fourLastDigits": "",
         "alias": "",
         "function": "Debit"
      }
   }
}
{
   "entityId": "781d7c95-d753-4e5b-8f2d-8da64ef6ea5b",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_REVERTED",
   "timestamp": "2024-03-27T19:15:23.3118399Z",
   "correlationId": "6dd61028-d3c9-459e-86c3-0c716d2fdeb9",
   "context": "Authorization",
   "idempotencyKey": "6dd61028-d3c9-459e-86c3-0c716d2fdeb9",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "reversalReason": "SystemFault",
      "channel": {
         "settlement": {
            "value": 1,
            "currency": "BRL"
         },
         "localAmount": {
            "value": 1,
            "currency": "BRL"
         },
         "mti": "0120",
         "processingCode": "003000",
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "781d7c95-d753-4e5b-8f2d-8da64ef6ea5b",
      "card": {
         "proxy": "2229141001432904325",
         "fourLastDigits": "1647",
         "alias": "Teste",
         "function": "Pos"
      }
   }
}
{
   "entityId": "dba95aa4-8044-43ef-8218-2172378e52f6",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_REVERTED",
   "timestamp": "2024-03-27T21:19:18.1532688Z",
   "correlationId": "dba95aa4-8044-43ef-8218-2172378e52f6",
   "context": "Authorization",
   "idempotencyKey": "dba95aa4-8044-43ef-8218-2172378e52f6",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "amount": {
         "value": 2,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 2,
         "currency": "BRL"
      },
      "reversalReason": "PosRequest",
      "channel": {
         "settlement": {
            "value": 2,
            "currency": "USD"
         },
         "localAmount": {
            "value": 2,
            "currency": "BRL"
         },
         "mti": "0400",
         "processingCode": "003100",
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "dba95aa4-8044-43ef-8218-2172378e52f6",
      "card": {
         "proxy": "2307171003721696184",
         "fourLastDigits": "4237",
         "alias": "Novo",
         "function": "Pre"
      }
   }
}
{
   "entityId": "781d7c95-d753-4e5b-8f2d-8da64ef6ea5b",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_REVERTED",
   "timestamp": "2024-03-27T16:12:29.3121489Z",
   "correlationId": "f2c524e6-1a7c-4926-9798-9226fa075bce",
   "context": "Authorization",
   "idempotencyKey": "f2c524e6-1a7c-4926-9798-9226fa075bce",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 3,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "dollarExchangeRate": {
         "value": 11.8312,
         "currency": "BRL"
      },
      "reversalReason": "SystemFault",
      "channel": {
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "USD"
         },
         "mti": "0120",
         "processingCode": "003000",
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "781d7c95-d753-4e5b-8f2d-8da64ef6ea5b",
      "card": {
         "proxy": "2229141001432904325",
         "fourLastDigits": "1647",
         "alias": "Teste Marcelo",
         "function": "Pos"
      }
   }
}
{
   "entityId": "337395bc-8356-411f-9f4b-c628f7cf35d0",
   "companyKey": "ACESSO",
   "name": "TRANSACTION_WAS_REVERTED",
   "timestamp": "2024-03-27T20:38:57.4432474Z",
   "correlationId": "337395bc-8356-411f-9f4b-c628f7cf35d0",
   "context": "Authorization",
   "idempotencyKey": "337395bc-8356-411f-9f4b-c628f7cf35d0",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "amount": {
         "value": 10.9,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 9.96,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0.44,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0.5,
         "currency": "BRL"
      },
      "dollarExchangeRate": {
         "value": 4.9798,
         "currency": "BRL"
      },
      "reversalReason": "PosRequest",
      "channel": {
         "settlement": {
            "value": 2,
            "currency": "USD"
         },
         "localAmount": {
            "value": 2,
            "currency": "USD"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "337395bc-8356-411f-9f4b-c628f7cf35d0",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre"
      }
   }
}

TRANSACTION_WAS_EXPIRED

Este evento sinaliza que o tempo de reserva de saldo da transação expirou e a transação foi revertida. Esse fluxo ocorre em transações pré-pagas.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
authorizationTransactionIdstringIdentificador da transação gerado pela plataforma de autorização do Bankly.
cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
card.proxystringCódigo identificador do cartão.
card.aliasstringApelido definido pelo proprietário do cartão.
card.functionstringFunção do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”.
card.typestringTipo do cartão, o qual pode ser: “Physical” ou “Virtual”.
accountobjectObjeto que contém os dados da conta e da licença bancária.
account.branchstringNúmero da agência bancária.
account.numberstringNúmero da conta.
account.bankobjectObjeto que contém os dados bancários.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload
{
      "entityId": "a1349dde-817a-4913-91d0-84fa2d787755",
      "companyKey": "COMPANY_KEY",
      "name": "TRANSACTION_WAS_EXPIRED",
      "timestamp": "2022-04-25T12:00:02.2180183Z",
      "correlationId": "9b76feea-98a0-4001-b2bf-ab83ae57adce",
      "context": "Authorization",
      "idempotencyKey": "9b76feea-98a0-4001-b2bf-ab83ae57adce",
      "metadata": null,
      "data": {
         "authorizationTransactionId": "a1349dde-817a-4913-91d0-84fa2d787755",
         "card": {
            "proxy": "0000000000000000000",
            "alias": "0921",
            "function": "Pre",
            "type": null
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções De Pagamento S.A."
            }
         },
      }
   }

CONFIRMATION_WAS_PROCESSED

Este evento sinaliza que a transação foi confirmada parcial ou totalmente.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
accountobjectObjeto que contém os dados da conta e da licença bancária.
account.branchstringNúmero da agência bancária.
account.numberstringNúmero da conta.
account.bankobjectObjeto que contém os dados bancários.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
amountobjectObjeto que contém informações sobre o valor da transação.
amount.valuenumberValor da transação.
amount.currencystringCódigo da moeda com base na ISO-4217.
withoutFeeAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
withoutFeeAmount.valuenumberValor da transação sem taxas.
withoutFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
iofAmountobjectObjeto que contém informações sobre o valor calculado do IOF da transação.
iofAmount.valuenumberValor calculado do IOF da transação.
iofAmount.currencystringCódigo da moeda com base na ISO-4217.
markupAmountobjectObjeto que contém informações sobre o valor calculado do markup da transação.
markupAmount.valuenumberValor calculado do markup.
markupAmount.currencystringCódigo da moeda com base na ISO-4217.
withdrawalFeeAmountobjectObjeto que contém informações sobre o valor da tarifa de saque (somente para transações de saque).
withdrawalFeeAmount.valuenumberValor da tarifa de saque.
withdrawalFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
channelobjectObjeto que contém informações sobre o canal por onde passam os dados recebidos da rede de cartões.
channel.numberOfInstallmentsnumberQuantidade de parcelas da transação.
channel.settlementobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.settlement.valuenumberValor da transação sem taxas.
channel.settlement.currencystringCódigo da moeda com base na ISO-4217.
channel.localAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.localAmount.valuenumberValor da transação sem taxas.
channel.localAmount.currencystringCódigo da moeda local com base na ISO-4217.
channel.namestringNome do canal que iniciou a transação no banco. No contexto do autorizador, o canal será sempre “CARD_NETWORK”.
channel.mtistringMTI (Message Type Indicator), código que identifica o tipo da transação.
channel.processingCodestringIdentificador que indica o tipo de transação, o tipo de conta remetente e tipo de conta destinatária.
channel.preAuthorizationbooleanEm caso de pré-autorização, esse campo retornará TRUE. Caso contrário, FALSE.
channel.passwordPresentbooleanIndica se a senha do cartão foi informada na autorização.
feesobjectObjeto que contém informações sobre as taxas aplicadas na transação.
fees.markupnumberPercentual do markup.
fees.iofnumberPercentual do IOF.
fees.dollarExchangeRateobjectObjeto que contém informações sobre a cotação atual do dólar, em reais.
fees.dollarExchangeRate.valuenumberCotação atual do dólar, em reais.
fees.dollarExchangeRate.currencystringCódigo da moeda local com base na ISO-4217.
authorizationTransactionIdstringIdentificador da transação gerado pela plataforma de autorização do Bankly.
cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
card.proxystringCódigo identificador do cartão.
card.aliasstringApelido definido pelo proprietário do cartão.
card.functionstringFunção do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”.
card.typestringTipo do cartão, o qual pode ser: “Physical” ou “Virtual”.
card.fourLastDigitsstringQuatro últimos dígitos do cartão.
clearingDatestringData de confirmação processada pela plataforma de autorização do Bankly, no formato ISO 8601 - UTC.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplos de payloads
{
   "entityId": "8e658cd4-144d-4d8e-8230-629b968f2c37",
   "companyKey": "DREDD",
   "name": "CONFIRMATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T19:13:38.167855Z",
   "correlationId": "8e658cd4-144d-4d8e-8230-629b968f2c37",
   "idempotencyKey": "8e658cd4-144d-4d8e-8230-629b968f2c37",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 3,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "channel": {
         "numberOfInstallments": 1,
         "settlement": {
            "value": 1,
            "currency": "BRL"
         },
         "localAmount": {
            "value": 1,
            "currency": "BRL"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "8e658cd4-144d-4d8e-8230-629b968f2c37",
      "card": {
         "proxy": "2229991000033350752",
         "alias": "POSAAAB",
         "function": "Pos",
         "type": "Virtual"
      },
      "clearingDate": "2024-03-27T19:13:38.1677725Z"
   }
}
{
   "entityId": "9d35e782-09ac-4e28-a6f5-b8719862b6c8",
   "companyKey": "ACESSO",
   "name": "CONFIRMATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:17:00.5978554Z",
   "correlationId": "a0043fb1-7647-43d9-b9e9-abef41d4d51f",
   "idempotencyKey": "a0043fb1-7647-43d9-b9e9-abef41d4d51f",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 2,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 2,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "withdrawalFeeAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "channel": {
         "numberOfInstallments": 1,
         "settlement": {
            "value": 2,
            "currency": "BRL"
         },
         "localAmount": {
            "value": 2,
            "currency": "BRL"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "9d35e782-09ac-4e28-a6f5-b8719862b6c8",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      },
      "clearingDate": "2024-03-27T21:17:00.5977209Z"
   }
}
{
   "entityId": "8bc266ae-a294-4a95-bfc5-2a498685e1f1",
   "companyKey": "DREDD",
   "name": "CONFIRMATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T16:13:40.9382818Z",
   "correlationId": "8bc266ae-a294-4a95-bfc5-2a498685e1f1",
   "idempotencyKey": "8bc266ae-a294-4a95-bfc5-2a498685e1f1",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 3,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "channel": {
         "numberOfInstallments": 1,
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "USD"
         },
         "name": "CARD_NETWORK"
      },
      "fees": {
         "markup": 0,
         "iof": 0.05,
         "dollarExchangeRate": {
            "value": 11.8312,
            "currency": "BRL"
         }
      },
      "authorizationTransactionId": "8bc266ae-a294-4a95-bfc5-2a498685e1f1",
      "card": {
         "proxy": "2229991000033350752",
         "alias": "POSAAAB",
         "function": "Pos",
         "type": "Virtual"
      },
      "clearingDate": "2024-03-27T16:13:40.9381516Z"
   }
}
{
   "entityId": "59c5d036-707f-40d5-95aa-90d0c4693dd0",
   "companyKey": "ACESSO",
   "name": "CONFIRMATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:11:10.7184543Z",
   "correlationId": "b435a1ad-3129-48ee-a116-ab933f984942",
   "idempotencyKey": "b435a1ad-3129-48ee-a116-ab933f984942",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 10.9,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 9.96,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0.44,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0.5,
         "currency": "BRL"
      },
      "withdrawalFeeAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "channel": {
         "numberOfInstallments": 1,
         "settlement": {
            "value": 2,
            "currency": "USD"
         },
         "localAmount": {
            "value": 2,
            "currency": "USD"
         },
         "name": "CARD_NETWORK"
      },
      "fees": {
         "markup": 0.050200803212851405,
         "iof": 0.0438,
         "dollarExchangeRate": {
            "value": 4.9798,
            "currency": "BRL"
         }
      },
      "authorizationTransactionId": "59c5d036-707f-40d5-95aa-90d0c4693dd0",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      },
      "clearingDate": "2024-03-27T21:11:10.7122003Z"
   },
}

CANCELATION_WAS_PROCESSED

Este evento sinaliza que a transação foi cancelada.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
channelobjectObjeto que contém informações sobre o canal por onde passam os dados recebidos da rede de cartões.
channel.transactionTypeobjectObjeto que contém informações sobre o tipo da transação de acordo com a ISO-8583.
channel.transactionType.codestringCódigo da transação, o qual pode ser: “00”, “01”, ou “20”.
channel.transactionType.descriptionstringDescrição do código, a qual pode ser “purchase” para “00”, “withdraw” para “01” ou “voucher” para “20”.
channel.namestringNome do canal que iniciou a transação no banco. No contexto do autorizador, o canal será sempre “CARD_NETWORK”.
channel.mtistringMTI (Message Type Indicator), código que identifica o tipo da transação.
channel.processingCodestringIdentificador que indica o tipo de transação, o tipo de conta remetente e tipo de conta destinatária.
channel.preAuthorizationbooleanEm caso de pré-autorização, esse campo retornará TRUE. Caso contrário, FALSE.
channel.passwordPresentbooleanIndica se a senha do cartão foi informada na autorização.
authorizationTransactionIdstringIdentificador da transação gerado pela plataforma de autorização do Bankly.
cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
card.proxystringCódigo identificador do cartão.
card.aliasstringApelido definido pelo proprietário do cartão.
card.functionstringFunção do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”.
card.typestringTipo do cartão, o qual pode ser: “Physical” ou “Virtual”.
card.fourLastDigitsstringQuatro últimos dígitos do cartão.
accountobjectObjeto que contém os dados da conta e da licença bancária.
account.branchstringNúmero da agência bancária.
account.numberstringNúmero da conta.
account.bankobjectObjeto que contém os dados bancários.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
clearingDatestringData de confirmação processada pela plataforma de autorização do Bankly, no formato ISO 8601 - UTC.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplos de payloads
{
   "entityId": "f6180b66-a222-4ced-80b2-665baa987125",
   "companyKey": "ACESSO",
   "name": "CANCELATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T19:14:30.0793863Z",
   "correlationId": "f6180b66-a222-4ced-80b2-665baa987125",
   "idempotencyKey": "f6180b66-a222-4ced-80b2-665baa987125",
   "context": "Authorization",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "channel": {
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "f6180b66-a222-4ced-80b2-665baa987125",
      "card": {
         "proxy": "2229141001432904325",
         "alias": "Teste Marcelo",
         "function": "Pos",
         "type": "Virtual"
      },
      "clearingDate": "2024-03-27T19:14:30.0793805Z"
   }
}
{
   "entityId": "9d35e782-09ac-4e28-a6f5-b8719862b6c8",
   "companyKey": "ACESSO",
   "name": "CANCELATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:18:03.1131609Z",
   "correlationId": "a0043fb1-7647-43d9-b9e9-abef41d4d51f",
   "idempotencyKey": "a0043fb1-7647-43d9-b9e9-abef41d4d51f",
   "context": "Authorization",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "channel": {
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "9d35e782-09ac-4e28-a6f5-b8719862b6c8",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      },
      "clearingDate": "2024-03-27T21:18:03.1131521Z"
   }
}
{
   "entityId": "384b9d4e-2cca-43eb-87c5-9e42fd454e57",
   "companyKey": "ACESSO",
   "name": "CANCELATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T18:56:06.6073527Z",
   "correlationId": "384b9d4e-2cca-43eb-87c5-9e42fd454e57",
   "idempotencyKey": "384b9d4e-2cca-43eb-87c5-9e42fd454e57",
   "context": "Authorization",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "channel": {
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "384b9d4e-2cca-43eb-87c5-9e42fd454e57",
      "card": {
         "proxy": "2229141001432904325",
         "alias": "Teste Marcelo",
         "function": "Pos",
         "type": "Virtual"
      },
      "clearingDate": "2024-03-27T18:56:06.6073474Z"
   }
}
{
   "entityId": "59c5d036-707f-40d5-95aa-90d0c4693dd0",
   "companyKey": "ACESSO",
   "name": "CANCELATION_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:12:08.7761582Z",
   "correlationId": "b435a1ad-3129-48ee-a116-ab933f984942",
   "idempotencyKey": "b435a1ad-3129-48ee-a116-ab933f984942",
   "context": "Authorization",
   "data": {
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "channel": {
         "transactionType": {
            "code": "00",
            "description": "Purchase"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "59c5d036-707f-40d5-95aa-90d0c4693dd0",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      },
      "clearingDate": "2024-03-27T21:12:08.7761486Z"
   }
}

VOUCHER_WAS_PROCESSED

Este evento sinaliza que o voucher (crédito) foi lançado na conta do cliente.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

NomeTipoDescrição
amountobjectObjeto que contém informações sobre o valor da transação.
amount.valuenumberValor da transação.
amount.currencystringCódigo da moeda com base na ISO-4217.
withoutFeeAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
withoutFeeAmount.valuenumberValor da transação sem taxas.
withoutFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
iofAmountobjectObjeto que contém informações sobre o valor calculado do IOF da transação.
iofAmount.valuenumberValor calculado do IOF da transação.
iofAmount.currencystringCódigo da moeda com base na ISO-4217.
markupAmountobjectObjeto que contém informações sobre o valor calculado do markup da transação.
markupAmount.valuenumberValor calculado do markup.
markupAmount.currencystringCódigo da moeda com base na ISO-4217.
withdrawalFeeAmountobjectObjeto que contém informações sobre o valor da tarifa de saque (somente para transações de saque).
withdrawalFeeAmount.valuenumberValor da tarifa de saque.
withdrawalFeeAmount.currencystringCódigo da moeda com base na ISO-4217.
accountobjectObjeto que contém informações sobre a conta bancária.
account.branchstringNúmero da agência bancária.
account.numberstringNúmero da conta.
account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
channelobjectObjeto que contém informações sobre o canal por onde passam os dados recebidos da rede de cartões.
channel.authorizationCodestringIdentificador da transação da rede do cartão.
channel.entryModeobjectObjeto que contém informações sobre o modo de entrada do cartão.
channel.entryMode.codestringCódigo do modo de entrada de acordo com a ISO-8583.
channel.entryMode.descriptionstringDescrição do modo de entrada.
channel.retrievalReferenceNumberstringIdentificador de transação da rede do cartão.
channel.merchantobjectObjeto que contém informações referentes ao estabelecimento/comerciante que aceitou a transação. Seus campos são baseados na ISO-8583.
channel.merchant.mccstringCódigo mcc da transação.
channel.merchant.mcgstringDescrição do tipo do mcc.
channel.merchant.citystringCidade do merchant para identificar parte de sua localização.
channel.merchant.stateOrCountryCodestringCódigo do estado ou do país do merchant para identificar parte da sua localização.
channel.merchant.statestringEstado do merchant para identificar parte de sua localização
channel.merchant.namestringNome do merchant.
channel.merchant.zipCodestringCódigo postal do merchant.
channel.merchant.terminalIdstringIdentificador do terminal do merchant.
channel.merchant.acquirerCodestringCódigo do credenciador.
channel.settlementobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.settlement.valuenumberValor da transação sem taxas.
channel.settlement.currencystringCódigo da moeda com base na ISO-4217.
channel.localAmountobjectObjeto que contém informações sobre o valor da transação sem taxas.
channel.localAmount.valuenumberValor da transação sem taxas.
channel.localAmount.currencystringCódigo da moeda local com base na ISO-4217.
channel.namestringNome do canal que iniciou a transação no banco. No contexto do autorizador, o canal será sempre “CARD_NETWORK”.
channel.mtistringMTI (Message Type Indicator), código que identifica o tipo da transação.
channel.processingCodestringIdentificador que indica o tipo de transação, o tipo de conta remetente e tipo de conta destinatária.
channel.preAuthorizationbooleanEm caso de pré-autorização, esse campo retornará TRUE. Caso contrário, FALSE.
channel.passwordPresentbooleanIndica se a senha do cartão foi informada na autorização.
feesobjectObjeto que contém informações sobre as taxas aplicadas na transação.
fees.markupnumberPercentual do markup.
fees.iofnumberPercentual do IOF.
fees.dollarExchangeRateobjectObjeto que contém informações sobre a cotação atual do dólar, em reais.
fees.dollarExchangeRate.valuenumberCotação atual do dólar, em reais.
fees.dollarExchangeRate.currencystringCódigo da moeda local com base na ISO-4217.
authorizationTransactionIdstringIdentificador da transação gerado pela plataforma de autorização do Bankly.
cardobjectObjeto que contém informações sobre o cartão utilizado na transação.
card.proxystringCódigo identificador do cartão.
card.aliasstringApelido definido pelo proprietário do cartão.
card.functionstringFunção do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”.
card.typestringTipo do cartão, o qual pode ser: “Physical” ou “Virtual”.
card.fourLastDigitsstringQuatro últimos dígitos do cartão.
clearingDatestringData de confirmação processada pela plataforma de autorização do Bankly, no formato ISO 8601 - UTC.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplos de payloads
  
{
   "entityId": "6fe0d212-deea-4136-81ea-46cdf39adcd0",
   "companyKey": "ACESSO",
   "name": "VOUCHER_WAS_PROCESSED",
   "timestamp": "2024-03-27T19:16:09.5193972Z",
   "correlationId": "6fe0d212-deea-4136-81ea-46cdf39adcd0",
   "idempotencyKey": "6fe0d212-deea-4136-81ea-46cdf39adcd0",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "channel": {
         "authorizationCode": "2753887863392639",
         "entryMode": {
            "description": "EletronicCommerceSecureWithUCAF"
         },
         "retriavelReferenceNumber": "2753887863392639",
         "merchant": {
            "mcc": "5199",
            "mcg": "Food",
            "city": "sao paulo",
            "stateOrCountryCode": "BRA",
            "state": "BRA",
            "name": "TESTE"
         },
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "BRL"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "6fe0d212-deea-4136-81ea-46cdf39adcd0",
      "card": {
         "proxy": "2229141001432904325",
         "alias": "Teste",
         "function": "Pos",
         "type": "Virtual"
      },
      "clearingDate": "2024-03-27T19:16:09.519187Z"
   }
}
{
   "entityId": "0be4e9b4-f7c4-4cc0-bbce-ae2559825b09",
   "companyKey": "ACESSO",
   "name": "VOUCHER_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:20:43.0953888Z",
   "correlationId": "4bc5ff16-6ad7-4c82-92a4-4a2f0506a9dc",
   "idempotencyKey": "4bc5ff16-6ad7-4c82-92a4-4a2f0506a9dc",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "withdrawalFeeAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "channel": {
         "authorizationCode": "8ab241a1-bc35-49e9-9217-2e60419c7ef1",
         "entryMode": {
            "code": "600450S99111",
            "description": "Unknown"
         },
         "retriavelReferenceNumber": "8ab241a1-bc35-49e9-9217-2e60419c7ef1",
         "merchant": {
            "mcc": "5311",
            "mcg": "Department",
            "city": "Luxemburg",
            "stateOrCountryCode": "BRA",
            "state": "BRA",
            "name": "TESTE",
            "terminalId": "62683744",
            "acquirerCode": "7133380"
         },
         "settlement": {
            "value": 1,
            "currency": "BRL"
         },
         "localAmount": {
            "value": 1,
            "currency": "BRL"
         },
         "name": "CARD_NETWORK"
      },
      "authorizationTransactionId": "0be4e9b4-f7c4-4cc0-bbce-ae2559825b09",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      },
      "clearingDate": "2024-03-27T21:20:43.0949333Z"
   }
}
{
   "entityId": "243c4601-8566-43ef-996d-5b1c7c12773d",
   "companyKey": "ACESSO",
   "name": "VOUCHER_WAS_PROCESSED",
   "timestamp": "2024-03-27T19:08:50.8827932Z",
   "correlationId": "243c4601-8566-43ef-996d-5b1c7c12773d",
   "idempotencyKey": "243c4601-8566-43ef-996d-5b1c7c12773d",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 1,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "Acesso Soluções De Pagamento S.A."
         }
      },
      "channel": {
         "authorizationCode": "6616082999618248",
         "entryMode": {
            "description": "EletronicCommerceSecureWithUCAF"
         },
         "retriavelReferenceNumber": "6616082999618248",
         "merchant": {
            "mcc": "5199",
            "mcg": "Food",
            "city": "New York",
            "stateOrCountryCode": "USA",
            "state": "USA",
            "name": "TESTE"
         },
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "USD"
         },
         "name": "CARD_NETWORK"
      },
      "fees": {
         "markup": 0,
         "iof": 0,
         "dollarExchangeRate": {
            "value": 11.8312,
            "currency": "BRL"
         }
      },
      "authorizationTransactionId": "243c4601-8566-43ef-996d-5b1c7c12773d",
      "card": {
         "proxy": "2229141001432904325",
         "alias": "Teste Marcelo",
         "function": "Pos",
         "type": "Virtual"
      },
      "clearingDate": "2024-03-27T19:08:50.8825477Z"
   }
}
{
   "entityId": "769f4520-b8dc-433d-bcb4-d2ec5e374a0e",
   "companyKey": "ACESSO",
   "name": "VOUCHER_WAS_PROCESSED",
   "timestamp": "2024-03-27T21:13:44.2484841Z",
   "correlationId": "4bc5ff16-6ad7-4c82-92a4-4a2f0506a9dc",
   "idempotencyKey": "4bc5ff16-6ad7-4c82-92a4-4a2f0506a9dc",
   "context": "Authorization",
   "data": {
      "amount": {
         "value": 1,
         "currency": "BRL"
      },
      "withoutFeeAmount": {
         "value": 4.98,
         "currency": "BRL"
      },
      "iofAmount": {
         "value": 0.22,
         "currency": "BRL"
      },
      "markupAmount": {
         "value": 0.25,
         "currency": "BRL"
      },
      "withdrawalFeeAmount": {
         "value": 0,
         "currency": "BRL"
      },
      "account": {
         "branch": "0001",
         "number": "15164",
         "bank": {
            "ispb": "13140088",
            "code": "332",
            "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
         }
      },
      "channel": {
         "authorizationCode": "b8ad8932-016f-44eb-aa83-86941e5bfbc5",
         "entryMode": {
            "code": "600450S99111",
            "description": "Unknown"
         },
         "retriavelReferenceNumber": "b8ad8932-016f-44eb-aa83-86941e5bfbc5",
         "merchant": {
            "mcc": "5311",
            "mcg": "Department",
            "city": "Luxemburg",
            "stateOrCountryCode": "USA",
            "state": "USA",
            "name": "TESTE",
            "terminalId": "62683744",
            "acquirerCode": "7133380"
         },
         "settlement": {
            "value": 1,
            "currency": "USD"
         },
         "localAmount": {
            "value": 1,
            "currency": "USD"
         },
         "name": "CARD_NETWORK"
      },
      "fees": {
         "markup": 0.050200803212851405,
         "iof": 0.0438,
         "dollarExchangeRate": {
            "value": 4.9798,
            "currency": "BRL"
         }
      },
      "authorizationTransactionId": "769f4520-b8dc-433d-bcb4-d2ec5e374a0e",
      "card": {
         "proxy": "2307171003721696184",
         "alias": "Novo",
         "function": "Pre",
         "type": "Physical"
      },
      "clearingDate": "2024-03-27T21:13:44.2466853Z"
   }
}

Exemplos de conteúdo do campo wallet

CódigoDescrição
101MasterpassByMastercard
103ApplePay
216GooglePay
217SamsungPay
327MerchantTokenizationProgram
0Unknown
00Unknown

Motivos para uma transação negada (deniedRules)

O evento de autorização TRANSACTION_WAS_PROCESSED traz o campo deniedRules, que pode conter os seguintes motivos de negação:

Bankly

MotivoDescrição
NOT_ALLOWED_ADVICE_FOR_DENIED_TRANSACTION_HOLDA reversão por falha sistêmica não foi permitida porque a autorização foi negada.
OPERATION_NOT_IMPLEMENTEDA interpretação da requisição recebida não resultou em nenhuma operação válida (autorização, advice ou reversão).
DUPLICATED_TRANSACTIONTransação duplicada.
TRANSACTION_NOT_EXISTSTransação não existe.
BLOCKED_BY_CARD_INTEGRATIONErro de comunicação interna com o serviço de cartão.
NOT_ALLOWED_WITHDRAWALNão é permitido saque.
NOT_ALLOWED_PURCHASE_INTERNATIONALNão é permitida compra internacional.
NOT_ALLOWED_PURCHASE_ONLINENão é permitida compra online.
NOT_ALLOWED_PURCHASE_PHYSICALNão é permitida compra física.
NOT_ALLOWED_PRE_AUTHORIZATIONNão é permitida pré-autorização.
NOT_ALLOWED_MORE_THAN_ONE_INSTALLMENTNão é permitido parcelamento.
CONSTITUTION_NOT_FOUNDErro interno na consulta de configurações do cartão.
NOT_ALLOWED_CONTACTLESSNão é permitido contactless.
NOT_ALLOWED_MCCMCC não permitido.
NOT_ALLOWED_CARD_NOT_VALIDCartão não ativo.
NOT_ALLOWED_CARD_LOCKEDCartão bloqueado.
NOT_ALLOWED_CARD_CANCELEDCartão cancelado.
NOT_ALLOWED_CARD_IS_BUILDINGCartão ainda em processo de impressão.
NOT_ALLOWED_REVERSAL_AMOUNT_GREATER_THAN_ORIGINAL_AMOUNTReversão não permitida, pois o valor é maior que o original.
NOT_ALLOWED_REVERSAL_FOR_ALREADY_PROCESSED_TRANSACTION_IN_SECOND_INSTANCENão é permitida a reversão para a transação já conciliada.
NOT_ALLOWED_PARTIAL_WITHDRAWAL_REVERSALNão é permitida a reversão de saque parcial.
BLOCKED_BY_CORE_BANK_VALIDATIONFalha na integração com core bancário.
BLOCKED_BY_LIMIT_VALIDATIONBloqueado por validação de limite de quantidade de transações ou montante por CPF por ciclo (transacional, diário ou mensal).
BLOCKED_BY_RISK_ANALYSISBloqueado para análise de risco (enviado em transações pré-pagas).
BLOCKED_BY_RISK_ANALYSIS_AND_LIMIT_VALIDATIONBloqueado por análise de risco e validação de limite.
INVALID_OPERATIONA compra foi passada em uma operação (débito ou crédito) não permitida.
NOT_ALLOWED_CARD_WITH_STATUS_CREATEDCartão com status de Criação.
NOT_ALLOWED_CARD_WITH_STATUS_BLOCKEDCartão com status Bloqueado.
NOT_ALLOWED_CARD_WITH_STATUS_WARNINGCartão com status de Atenção.
NOT_ALLOWED_CARD_WITH_STATUS_CANCELLED_OR_CLIENTORDERCartão com status Cancelado.
NOT_ALLOWED_CARD_WITH_STATUS_FRAUDCartão com status de Fraude.
NOT_ALLOWED_CARD_WITH_STATUS_LOSTCartão com status Perdido.
NOT_ALLOWED_CARD_WITH_STATUS_ROBBED_OR_THEFTCartão com status Roubado.
NOT_ALLOWED_CARD_WITH_STATUS_DELETEDCartão com status Excluído.
NOT_ALLOWED_CARD_WITH_STATUS_UNRECEIVEDCartão com status Não Recebido.
NOT_ALLOWED_CARD_WITH_STATUS_INOPERATIVECartão com status Inoperante.
NOT_ALLOWED_PURCHASE_WITH_CURRENCY_UNMATCH_COUNTRYA compra foi realizada em BRL, mas o estabelecimento é internacional.
NOT_ALLOWED_CARD_WITH_STATUS_OTHERCartão com status Outros.
TRANSACTION_IS_NOT_ON_HOLDTransação já revertida.
NOT_ALLOWED_REVERSAL_CURRENCY_UNMATCH_ORIGINAL_CURRENCYMoeda de reversão diferente da utilizada na autorização.

Core bancário

MotivoDescrição
INSUFFICIENT_BALANCESaldo insuficiente.
AUTHORIZATION_HOLD_NOT_FOUNDErro ao tentar reverter uma autorização não efetuada.
WITHDRAWAL_LIMIT_EXCEEDEDO limite de retirada de dinheiro no core bancário foi excedido.
CORE_BANK_INTEGRATION_ERRORErro ao integrar com o core bancário.

Processadora

MotivoDescrição
INVALID_PASSWORDA senha informada na compra/saque não é válida.
PAN_NOT_FOUND_IN_PCI_DATABASECartão não encontrado pela processadora.
INVALID_EXPIRATION_DATEData de expiração inválida.
NOT_ALOWED_PURCHASE_WITH_STRIPE_CARDNão é permitido passar a compra com a tarja do cartão.
INVALID_ENTRY_MODENão é permitido passar a compra com a tarja do cartão, pois a máquina só aceita chip.
CVV_VALIDATION_WITH_SAFETY_AUTHENTICATION_MODE_VALIDATIONCVV inválido.
UNSAFETY_TRANSACTION_WITHOUT_VALIDATION_METHODNão foi informado nenhum dado de segurança, no momento da transação.
CVV_VALIDATION_WITH_EXPIRATION_DATE_VALIDATIONCartão temporário utilizado após o término do seu prazo de vida.
ANTI_FRAUD_VALIDATIONTransação pós-paga negada no antifraude do Bankly.
CANCEL_REQUEST_UNMATCH_ORIGINAL_TRANSACTIONTransação original não encontrada na processadora.
LIMIT_EXCEEDEDLimite da processadora excedido.
TIMEOUTTempo de comunicação expirado.
COMUNICATION_FAILComunicação indisponível.
CRIPTOGRAM_VALIDATION_HSMFalha na validação de segurança do criptograma.
OBSOLET_CARDHOLDER_VALIDATIONMétodo de validação do usuário é obsoleto.
INVALID_OPERATION_FOR_THE_PROGRAM_OR_ACCOUNTNão é permitido o parcelamento de compra com cartão de débito ou crédito pré.
NOT_ALOWED_TRANSACTION_DATE_BIGGER_THAN_CARD_EXPIRATION_DATECartão expirado.
RETRY_QUANTITY_EXCEEDEDNúmero de tentativas de senha foi excedido.
ATCDiscrepância entre o ATC (Application Transaction Counter) do chip e do autorizador.
NOT_ALLOWED_PURCHASE_FOR_BLOCKED_ACCOUNTConta bloqueada.
CRIPTOGRAM_VALIDATION_PER_ENTRY_MODECriptograma não enviado para o modo de entrada escolhido.

Código do modo de entrada (entryMode)

codedescriptionDescrição
00UnknownModo de entrada do PAN desconhecido.
01ManualEntrada do PAN manual.
02MagneticStripeEntrada 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.
03BarCodeReaderEntrada automática via leitor de código de barras.
04OCREntrada automática de PAN via leitor óptico de caracteres (OCR).
05ChipEntrada automática de PAN via chip.
06ContactlessObsoleteContactless obsoleto.
07ContactlessMChipEntrada automática de PAN via M/Chip sem contato.
09EletronicCommerceEntrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data).
10CredentialOnFileCredencial em arquivo.
79HybridTerminalFailedConnectionUm 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.
80ChipCapableTerminalO cartão com chip não foi capaz de processar/leitura da tarja magnética padrão.
81EletronicCommerceSecureWithUCAFEntrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF.
82ServerEntrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado).
90MagneticStripeFullTrackDataA tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível).
91ContactlessMagneticStripeEntrada automática do número da conta via tarja magnética sem contato.
95VisaApenas Visa – Chip com CVV não confiável.

📘

Nota

Os valores de entryMode descritos na tabela acima são provenientes da bandeira do cartão e podem sofrer alterações e/ou acréscimos.