Manual do Dev
InstitucionalBlogService DeskStatus Page

Confirmação

Confira os eventos relativos a confirmação.

beta

Suggest Edits

Contexto e nome do evento

Nos eventos de confirmação, o campo context sempre informará “Authorization”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:

Nome do evento (name)Descrição
CONFIRMATION_WAS_PROCESSEDA transação foi confirmada parcial ou totalmente.
CANCELATION_WAS_PROCESSEDA transação foi cancelada.
VOUCHER_WAS_PROCESSEDO voucher (crédito) foi lançado na conta do cliente.

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 authorizationTransactionId (identificador único da transação).

Exemplos de eventos

{ 
  "entityId": "215a51e6-9934-423a-8f15-321f6301bc34", 
  "companyKey": "COMPANY_KEY", 
  "name": "CONFIRMATION_WAS_PROCESSED", 
  "timestamp": "2022-04-25T09:18:02.0901117Z", 
  "correlationId": "215a51e6-9934-423a-8f15-321f6301bc34", 
  "metadata": null, 
  "data": { 
    "amount": { 
      "value": 52.9, 
      "currency": "BRL" 
    }, 
    "withoutFeeAmount": { 
      "value": 52.9, 
      "currency": "BRL" 
    }, 
    "iofAmount": { 
      "value": 0.0, 
      "currency": "BRL" 
    }, 
    "markupAmount": { 
      "value": 0.0, 
      "currency": "BRL" 
    }, 
    "withdrawalFeeAmount": { 
      "value": 0.0, 
      "currency": "BRL" 
    }, 
    "channel": { 
      "numberOfInstallments": 1, 
      "settlement": { 
        "value": 52.9,
        "currency": "USD" 
      }, 
      "localAmount": { 
        "value": 52.9, 
        "currency": "BRL" 
      }, 
      "name": "CARD_NETWORK" 
    }, 
    "fees": { 
      "markup": 0.0, 
      "iof": 0.0, 
      "dollarExchangeRate": { 
        "value": 0.0, 
        "currency": "BRL" 
      } 
    }, 
    "authorizationTransactionId": "215a51e6-9934-423a-8f15-321f6301bc34", 
    "card": { 
      "proxy": "0000000000000000000", 
      "alias": "Card Physic Pos", 
      "function": "Pos", 
      "type": null 
    }, 
    "clearingDate": "2022-04-25T09:18:02.0900356Z" 
  }, 
  "idempotencyKey": "215a51e6-9934-423a-8f15-321f6301bc34", 
  "context": "Authorization" 
}

{ 
  "entityId": "2ed8a63c-e3e3-4093-8094-9ce0635b2404", 
  "companyKey": "COMPANY_KEY", 
  "name": "CANCELATION_WAS_PROCESSED", 
  "timestamp": "2022-04-25T09:10:36.9474645Z", 
  "correlationId": "2ed8a63c-e3e3-4093-8094-9ce0635b2404", 
  "metadata": null, 
  "data": { 
    "channel": { 
      "transactionType": { 
        "code": "00", 
        "description": "Purchase" 
      }, 
      "name": "CARD_NETWORK" 
    }, 
    "authorizationTransactionId": "2ed8a63c-e3e3-4093-8094-9ce0635b2404", 
    "card": { 
      "proxy": "0000000000000000000", 
      "alias": "Card Physic Pos", 
      "function": "Pos", 
      "type": null 
    }, 

    "clearingDate": "2022-04-25T09:10:36.9474585Z" 
  }, 
  "idempotencyKey": "2ed8a63c-e3e3-4093-8094-9ce0635b2404", 
  "context": "Authorization" 
}

{ 
  "entityId": "6c8e5350-a4ac-4a9a-a8b7-9835633bf51d", 
  "companyKey": "COMPANY_KEY", 
  "name": "VOUCHER_WAS_PROCESSED", 
  "timestamp": "2022-04-25T03:04:28.9712289Z", 
  "correlationId": "ae72c7d2-91bb-4f55-918b-1a84ca678019", 
  "metadata": null, 
  "data": { 
    "amount": { 
      "value": 100.0,
      "currency": "BRL" 
    }, 

    "withoutFeeAmount": { 
      "value": 100.0, 
      "currency": "BRL" 
    }, 
    "iofAmount": { 
      "value": 0.0, 
      "currency": "BRL" 
    }, 
    "markupAmount": { 
      "value": 0.0, 
      "currency": "BRL" 
    }, 
    "withdrawalFeeAmount": { 
      "value": 0.0, 
      "currency": "BRL" 
    }, 
    "account": { 
      "label": null, 
      "branch": "0001", 
      "number": "1234567", 
      "type": null, 
      "status": null, 
      "bank": { 
        "ispb": "13140088", 
        "code": "332", 
        "name": "Acesso Soluções De Pagamento S.A." 
      }, 
      "balance": null, 
      "pockets": null 
    }, 
    "channel": { 
      "authorizationCode": "SYUTM0", 
      "entryMode": { 
        "code": "090550S99001", 
        "description": "EletronicCommerceSecureWithUCAF" 
      }, 
      "retrievalReferenceNumber": "100284045256", 
      "merchant": { 
        "mcc": "8999", 
        "mcg": "Ecommerce", 
        "city": "MARINGA", 
        "stateOrCountryCode": "BRA", 
        "state": "BRA", 
        "name": "MERCADO", 
        "zipCode": null, 
        "terminalId": "10250284", 
        "acquirerCode": "012088" 
      }, 
      "settlement": { 
        "value": 100.0, 
        "currency": "USD" 
      }, 
      "localAmount": { 
        "value": 100.0, 
        "currency": "BRL" 
      }, 
      "name": "CARD_NETWORK" 
    }, 
    "fees": null, 
    "authorizationTransactionId": "a5275aa0-2d34-4564-a320-1202c5d52c9b", 
    "card": { 
      "proxy": "0000000000000000000", 
      "alias": "Fulaninho", 
      "function": "Pre", 
      "type": "Virtual" 
    }, 
    "clearingDate": "2022-04-25T03:04:28.970992Z" 
  }, 
  "idempotencyKey": "ae72c7d2-91bb-4f55-918b-1a84ca678019", 
  "context": "Authorization" 
}

🚧

Importante

Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.

Objeto data nos eventos de confirmação

O objeto data traz detalhes específicos do evento transmitido. No caso de eventos de confirmação, esse objeto poderá conter os seguintes campos:

  • account: os dados da conta do pagador;
    • label: nome dado à conta no momento de sua configuração;
    • branch: número da agência;
    • bank: objeto contendo o ISPB, o código e o nome do banco a qual a conta pertence;
    • number: número da conta;
  • amount: objeto contendo o valor total da transação e a moeda utilizada;
  • withoutFeeAmount: objeto contendo o valor da transação sem taxas e a moeda utilizada;
  • iofAmount: valor calculado do IOF da transação;
  • markupAmount: valor calculado do markup da transação;
  • withdrawalFeeAmount: valor da tarifa de saque (somente para transações de saque);
  • fees: taxas aplicadas na transação;
    • markup: o percentual do markup;
    • iof: o percentual do IOF;
    • dollarExchangeRate: objeto contendo a cotação atual do dólar e a moeda em que ele é cotado;
  • status: status da transação, o qual pode ser: “SUCCESS” ou “DENIED”;
  • transactionTimeStamp: a data e a hora em que ocorreu a transação;
  • channel: canal por onde passam as informações recebidas da rede de cartões;
    • numberOfInstallments: quantidade de parcelas da transação;
    • transactionType: tipo da transação de acordo com a ISO 8583;
      • code: código da transação, o qual pode ser: “00”, “01”, ou “20”;
      • description: descrição do código, a qual pode ser “purchase” para “00”, “withdraw” para “01” ou “voucher” para “20”;
    • settlement: objeto contendo o valor da transação sem taxas e a moeda utilizada;
    • localAmount: objeto contendo o valor da transação sem taxas e a moeda do local da transação.
    • entryMode:
      • code: o código do modo de entrada de acordo com a ISO 8583;
      • description: a descrição do modo de entrada;
      • cardPresent: define se este modo de entrada está presente no cartão;
    • authorizationCode: um identificador da transação da rede do cartão;
    • wallet: objeto contendo o código e a descrição da carteira. Veja alguns exemplos na tabela ao final da página;
    • retrievalReferenceNumber: um identificador de transação da rede do cartão;
    • merchant: informações referentes ao estabelecimento/comerciante que aceitou a transação. Seus campos são baseados na ISO 8583:
      • mcc: o código mcc da transação;
      • mcg: a descrição do tipo do mcc;
      • city: a cidade do merchant para identificar parte de sua localização;
      • stateOrCountryCode: o código do estado ou do país do merchant para identificar parte da sua localização;
      • state: estado do merchant para identificar parte de sua localização;
      • name: nome do merchant;
      • zipCode: CEP do merchant;
      • terminalId: id do terminal do merchant;
      • acquirerCode: código do credenciador;
    • authorizationId: identificador da autorização da processadora;
    • name: nome do canal que iniciou a transação no banco. No contexto do autorizador, o canal será sempre “CARD_NETWORK”;
  • authorizationTransactionId: o identificador da transação gerado pela plataforma de autorização do Bankly;
  • dollarExchangeRate: a cotação atual do dólar, em reais;
  • card:
    • proxy: código identificador do cartão;
    • alias: apelido definido pelo proprietário do cartão;
    • function: função do cartão, a qual pode ser: “Pre”, “Pos”, “Debit”;
    • type: tipo do cartão, o qual pode ser: “Physical” ou “Virtual”;
  • reversalReason: motivo da reversão da transação. Exemplo: “SystemFault”, “PosRequest”, “DebitReversal”;
  • clearingDate: data de confirmação processada pela plataforma de autorização do Bankly.

Exemplos de conteúdo do campo wallet

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

📘

Nota

No contexto de autorização (Authorization), os subcampos type, status, pockets, balance e label do campo Account geralmente são enviados como null.

Updated 11 months ago