e-SiTef

e-SiTef

  • Portal do Desenvolvedor
  • Fale Conosco
  • English

›REST Payment

REST Payment

  • Overview
  • Quick start
  • Transaction creation service
  • Payment effectuation service
  • Payment confirmation service
  • Transaction status query
  • Multiple transactions status query
  • Card query service
  • Payment with multiple payment methods service
  • Payment with multiple payment methods confirmation service
  • External origin payment confirmation service

REST Store

  • Overview

REST Cancel

  • Flow
  • Quick start
  • Cancel via host
  • Cancel external origin
  • Cancel creation service
  • Cancel service

REST Pre-Authorization

  • Overview
  • Quick start
  • Pre-Authorization Creation Service
  • Pre-Authorization effectuation service
  • Pre-Authorization Status Query
  • Pre-Authorization Editing Service
  • Pre-Authorization Editing External Origin Service
  • Pre-Authorization Increment Service
  • Card Query Service
  • Pre-Authorization Capture Service
  • Pre-Authorization Capture External Origin Service

REST Schedule

  • Overview
  • Quick start
  • Transaction creation service
  • Schedule activation service
  • Execution of the scheduled payments
  • Schedule editing flow
  • Quick start: schedule editing
  • Schedule editing creation service
  • Schedule editing service

REST Recharge

  • Overview
  • Quick start
  • Recharge creation service
  • List dealers service
  • List branch data service
  • Recharge effectuation service
  • Recharge confirmation service
  • Recharge query service

HTML Payment

  • Overview
  • Quick start
  • Initializing a payment transaction
  • Status notification
  • Transaction status query
  • Payment with card storage
  • Pages Customization
  • Payment link
  • Split Payment
  • Payment with multiple payment methods
  • 3DS 2.0 Integration

HTML Pre-Authorization

  • Overview

HTML Recharge

  • Overview
  • Quick start
  • Initializing a Recharge transaction

REST Generic Operations

  • Overview
  • Token creation service
  • Generic operation service

JavaScript Payment

  • Overview
  • Quick start
  • Transaction creation service
  • Virtual store's payment page
  • Transaction query service

JavaScript Store

  • Overview
  • Quick start
  • Transaction creation service
  • Virtual store's page

Merchant Web Page

  • Introduction
  • Access to web page
  • Two-Factor Authentication
  • User Configuration
  • Configure Authorizers
  • Transaction Report
  • Daily Summary Report
  • Store Report
  • Recharge Report
  • Analytical Report
  • Transaction Cancellation
  • Schedule
  • Configure Risk Analysis
  • Configure Order Authorizers
  • Users Administration
  • Generate Payment Link

Retry

  • Overview
  • Flow
  • Retry and Schedule

SiTef Routings

  • Bradescard
  • Cetelem
  • GetnetLac
  • Orbitall
  • Vero
  • Bin
  • Sipag

Non SiTef Routings

  • Banco do Brasil
  • Banrisul Vero
  • Cielo e-Commerce
  • EPX
  • e.Rede Rest
  • Fepas HUB
  • Getnet WS
  • GlobalPayments WS
  • IPG
  • Itaú Shopline
  • Mercado Pago
  • PagSeguro
  • PayPal
  • SafraPay
  • Stone WS

Digital Wallet

  • Overview
  • VEE Digital Wallet via CardSE
  • Pix via CardSE
  • Google Pay
  • Visa Checkout
  • Masterpass
  • Samsung Pay
  • Apple Pay
  • Configuration for Digital Wallets

Anti-Fraud Integration

  • Overview
  • Risk analysis service on the HTML Interface
  • Risk analysis response
  • Manual review flow
  • Fraud notification service
  • ClearSale
  • CyberSource
  • Konduto
  • Fraud Detect

General Information

  • Authorizers
  • Digital Certificates
  • API codes
  • Soft Descriptor
  • Signature authentication

Batch Registrations

  • Batch Store Registration
  • Batch Routing Configuration

REST Merchants Registration

  • Overview
  • Quick start
  • Token creation service
  • Merchant creation service
  • Merchant editing service
  • Merchant query service
  • Merchant status query service
  • List merchants service
  • API codes

3DS Server

  • Overview
  • Quick start
  • Transaction creation service
  • Authentication service
  • Transaction query service
  • Challenge messages
  • Decoupled notification
  • Initiating a 3DS Method
  • API codes

Card query service

It’s possible to use the NIT of a payment with status NOV (new) to query the card’s BIN (first six digits) on SiTef to obtain data about its capabilities (possibility of payment with installments, maximum number of installments, requirement of the security code, etc.), or knowing which authorizer of the merchant is the most suited for the payment.

In the case of transactions with Visa Checkout, this service also returns card and customer data returned by Visa.

Flow

Consulta Cartão

Flow description:

  1. The merchant creates a transaction on e-SiTef passing information such as the merchant ID, number of installments and the order ID and obtains as response a NIT (Transaction Identifier Number).
  2. The merchant sends the NIT obtained in the previous step and the data of the card to be queried. Then, e-SiTef returns data about the capabilities of the card.
  3. The merchants then proceeds consuming the payment effectuation service, passing the NIT and the customer’s card data. In case of success, the payment transaction will change its status to CON (confirmed).

Call details

  • Resource: /v1/payments/{nit}/cards
  • HTTP Method: POST
  • Request format: JSON
  • Response format: JSON
  • Header parameters:
ParameterDescriptionFormatMandatory
merchant_idMerchant code on e-SiTef. The production and certification codes will be different.< 15 ANYES
merchant_keyMerchant authentication key on e-SiTef. The production and certification keys will be different.< 80 ANYES
Content-TypeIt must be sent with the value application/json.= 15 ANYES

Obs.: although it’s a query, the POST method was chosen for security reasons.

Examples

Below are some examples of the card query service call using the cURL tool.

Card query with authorizer

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555"
   },
   "authorizer_id":"1"
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV"
   },
   "card":{
      "acquirer_name":"Redecard",
      "authorizer_id":"1",
      "authorizer_response_code":"000",
      "is_customer_id_required":"false",
      "is_expiry_date_required":"true",
      "is_installment_funding_enabled":"true",
      "is_security_code_required":"true",
      "is_spot_sale_enabled":"true",
      "is_with_interest_sale_enabled":"true",
      "is_without_interest_sale_enabled":"true",
      "max_installments_with_interest":"12",
      "min_installments_with_interest":"01",
      "prefixes":{
         "TRAT":"2",
         "PERIFERICO":"1",
         "CSEG":"2"
      }
   }
}

Card query without authorizer

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"6543210987654321"
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV"
   },
   "card":{
      "acquirer_name":"Redecard",
      "authorizer_id":"1",
      "authorizer_response_code":"000",
      "is_customer_id_required":"false",
      "is_expiry_date_required":"true",
      "is_installment_funding_enabled":"true",
      "is_security_code_required":"true",
      "is_spot_sale_enabled":"true",
      "is_with_interest_sale_enabled":"true",
      "is_without_interest_sale_enabled":"true",
      "max_installments_with_interest":"12",
      "min_installments_with_interest":"01",
      "prefixes":{
         "TRAT":"2",
         "PERIFERICO":"1",
         "CSEG":"2"
      }
   }
}

Visa Checkout card query

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "wallet_transaction_id":"4444444444444444444"
   },
   "authorizer_id":"406"
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "payment":{
      "status":"NOV"
   },
   "card":{
      "acquirer_name":"Redecard",
      "authorizer_id":"406",
      "authorizer_response_code":"000",
      "is_customer_id_required":"false",
      "is_expiry_date_required":"true",
      "is_installment_funding_enabled":"true",
      "is_security_code_required":"true",
      "is_spot_sale_enabled":"true",
      "is_with_interest_sale_enabled":"true",
      "is_without_interest_sale_enabled":"true",
      "max_installments_with_interest":"12",
      "min_installments_with_interest":"01",
      "prefixes":{
         "TRAT":"2",
         "PERIFERICO":"1"
      },
      "visa_checkout_data":{
         "payment_request":{
            "currency_code":"BRL",
            "subtotal":"115.5",
            "total":"115.5",
            "order_id":"09387",
            "source_id":"LOJAVISACHECK"
         },
         "user_data":{
            "user_first_name":"Comprador",
            "user_last_name":"Esitef",
            "user_full_name":"Comprador Esitef",
            "user_name":"esitef2@gmail.com",
            "user_email":"esitef2@gmail.com",
            "enc_user_id":"c5DmPXTXC3VwZywsFESEGAqiLM5PXSZG7hgyQgRv0j8=",
            "user_personal_id":"12345678909"
         },
         "creation_time_stamp":1502206049403,
         "payment_instrument":{
            "id":"AWUU0/rQrmKCMx+C740kBefZP2GNsdAMYUTXAzCPk+M=",
            "last_four_digits":"1010",
            "bin_six_digits":"406897",
            "verification_status":"VERIFIED",
            "expired":"false",
            "issuer_bid":"10029901",
            "nick_name":"Cartão PAN",
            "name_on_card":"aaaaaaaaaa vvvvvvvvvv",
            "card_first_name":"aaaaaaaaaa",
            "card_last_name":"vvvvvvvvvv",
            "payment_type":{
               "card_brand":"VISA",
               "card_type":"CREDIT"
            },
            "billing_address":{
               "person_name":"aaaaaaaaaa vvvvvvvvvv",
               "first_name":"aaaaaaaaaa",
               "last_name":"vvvvvvvvvv",
               "line1":"qqqqqqqqqq",
               "line2":"eeeeee",
               "line3":"wwwwwwwww",
               "city":"cccccccc",
               "state_province_code":"SP",
               "postal_code":"01238010",
               "country_code":"BR",
               "phone":"987654321",
               "default":"false"
            },
            "card_arts":{
               "card_art":[
                  {
                     "base_image_file_name":"https://sandbox.secure.checkout.visa.com/VmeCardArts/lg_visa_card.png",
                     "height":105,
                     "width":164
                  }
               ]
            },
            "expiration_date":{
               "month":"11",
               "year":"2022"
            }
         },
         "risk_data":{
            "advice":"UNAVAILABLE",
            "score":0,
            "avs_response_code":"0",
            "cvv_response_code":"0",
            "age_of_account":"704"
         },
         "visa_checkout_guest":"false"
      }
   }
}

Card Query with financing plans

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"6543210987654321"
   },
   "authorizer_id":"313"
}
--verbose

Response:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV"
    },
    "card": {
        "acquirer_name": "Via Certa Financiadora",
        "authorizer_id": "313",
        "authorizer_response_code": "000",
        "is_customer_id_required": "false",
        "is_expiry_date_required": "true",
        "is_installment_funding_enabled": "true",
        "is_security_code_required": "true",
        "is_spot_sale_enabled": "true",
        "is_with_interest_sale_enabled": "true",
        "is_without_interest_sale_enabled": "true",
        "max_installments_with_interest": "99",
        "min_installments_with_interest": "00",
        "prefixes": {
            "CADSENHA": "11",
            "NPSAQ": "0199",
            "ECHO": "MIG3DH00000"
        },
        "financing_plan_list": [
            {
                "cod_plano": "0201",
                "tipo_plano": "02",
                "desc_plano": "Plano de Teste para CDC 01                        ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0301",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 01                ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0201",
                "tipo_plano": "02",
                "desc_plano": "Plano de Teste para CDC 01                        ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0202",
                "tipo_plano": "02",
                "desc_plano": "Plano de Teste para CDC 02                        ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0301",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 01                ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0302",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 02                ",
                "parc_plano": "99"
            },
            {
                "cod_plano": "0303",
                "tipo_plano": "03",
                "desc_plano": "Plano de Teste para Saque e CDC 03                ",
                "parc_plano": "99"
            }
        ]
    }
}

Card query with additional data for iCards via SITef routing

Request:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"6543210987654321"
   },
   "authorizer_id":"38"
}
--verbose

Response:

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "card": {
        "acquirer_name": "iCards",
        "authorizer_id": "38",
        "authorizer_response_code": "000",
        "is_customer_id_required": "true",
        "is_expiry_date_required": "true",
        "is_installment_funding_enabled": "true",
        "is_security_code_required": "true",
        "is_spot_sale_enabled": "true",
        "is_with_interest_sale_enabled": "true",
        "is_without_interest_sale_enabled": "true",
        "max_installments_with_interest": "12",
        "min_installments_with_interest": "01",
        "prefixes": {
            "NPSAQ": "0299",
            "CAPTPPRE": "1",
            "XCAPPREAUT": "11"
        },
        "is_customer_postal_code_required": "true",
        "is_card_holder_required": "true"
    },
    "payment": {
        "status": "NOV"
    }
}

Card query with additional data for IPG routing

Requisição:

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/cards"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
  "card":{
    "number":"4036952187654321"
  },
  "routing_id":"414"
}
--verbose

Response:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV"
  },
  "details": [
    {
      "brand": "VISA",
      "brand_product_id": "VI",
      "card_function": "CREDIT",
      "issuer_country": "USA",
      "issuer_name": "Simulation"
    },
    {
      "brand": "VISA",
      "brand_product_id": "VI",
      "card_function": "DEBIT",
      "issuer_country": "BRA",
      "issuer_name": "Simulation"
    }
  ]
}

Request parameters

The table below describes the request parameters of the card query service:

ParameterDescriptionFormatMandatory
authorizer_idCode of the authorizer on e-SiTef. Learn more. This field is only mandatory when the wallet_transaction_id field is sent.
If this parameter is absent, e-SiTef assumes it's a credit card.
< 3 NCOND.
card
numberCustomer card number (PAN).< 19 NYES
tokenHASH of a card stored on e-SiTef. It’s not allowed to send an ‘open’ card number (number field) and a stored card (token field) on the same request.= 88 ANNO
wallet_transaction_idDigital wallet transaction ID. Currently, this functionality is only available to the Visa Checkout authorizer.
It isn’t allowed to send an "open" card number (number field), a stored card (token field) and a wallet_transaction_id on the same request.
< 25 ANNO
do_par_inquiryInforms if the VISA PAR Inquiry request will be performed. The response value will be returned on the response par field.

Allowed values:
true - PAR request will be sent.
false - PAR request will not be sent.

Default value: false
< 5 ANO

Response parameters

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes de response parameters of the card query service:

ParameterDescriptionFormat
codee-SiTef response code. Any code different from 0 means failure. Learn more.< 4 N
messagee-SiTef response message.< 500 AN
payment
statusStatus of the payment transaction on e-SiTef. Learn more.= 3 AN
card
authorizer_codeAuthorizer response code.< 10 AN
authorizer_messageAuthorizer response message.< 500 AN
acquirer_nameRouting name, e.g.: Cielo< 256 AN
authorizer_idCode of the authorizer (use this ID when making the payment).< 3 N
is_customer_id_requiredIndicates the requirement of collecting the customer ID.< 5 T/F
is_expiry_date_requiredIndicates the requirement of collecting the card expiry date.< 5 T/F
is_installment_funding_enabledIndicates if installment funding is enabled.< 5 T/F
is_security_code_requiredIndicates the requirement of collecting the security code.< 5 T/F
is_spot_sale_enabledIndicates if spot sale is enabled.< 5 T/F
is_with_interest_sale_enabledIndicates if installments with interest are enabled.< 5 T/F
is_without_interest_sale_enabledIndicates if installments without interest are enabled.< 5 T/F
max_installments_with_interestMaximum number of installments with interest.< 2 N
min_installments_with_interestMinimum number of installments with interest.< 2 N
visa_checkout_dataObject with the data returned by Visa Checkout.O
financing_plan_listFinancing plans list object, returned when the card is configured to be routed by Via Certa Financiadora. A financing plan is made by fields below:
cod_plano: financing plan identifier code. It must be sent in payment effectuation service;
tipo_plano: financing plan type code;
desc_plano: financing plan description text. It can be shown to the customer;
parc_plano: maximum amount of installments in financing plan.
O
is_customer_postal_code_requiredIndicates the requirement of hte user’s postal code (CEP in Brazil)< 5 T/F
parPAR value returned by VISA of the field do_par_inquiry was sent with the value true on the request.< 32 AN
card.prefixes[] This field contains the prefixes (additional data) returned by SiTef.
keyPrefix name.< 1024 AN
valuePrefix value.< 1024 AN
details[] This field contains details returned by IPG routing
brandThe card brand.< 1024 AN
brand_product_idThe product ID of the brand.< 1024 AN
card_functionCard function.CREDIT,
DEBIT,
PREPAID,
VOUCHER,
UNDEFINED
commercialCardIndicates whether it is a corporate or non-corporate card.CORPORATE,
NON_CORPORATE
issuer_countryThe country of the issuer.< 1024 AN
issuer_nameThe name of the issuer.< 1024 AN
← Multiple transactions status queryPayment with multiple payment methods service →
  • Flow
  • Call details
  • Examples
    • Card query with authorizer
    • Card query without authorizer
    • Visa Checkout card query
    • Card Query with financing plans
    • Card query with additional data for iCards via SITef routing
    • Card query with additional data for IPG routing
  • Request parameters
  • Response parameters
e-SiTef
Relacionamento com o cliente
+55 (11) 3170-5300+55 (11) 4766-8000comercial@softwareexpress.com.br
Acessos
Portal do DesenvolvedorPortal e-SiTefVersão para impressão
Copyright © 2021 Software Express Informática Ltda - Todos os direitos reservados