Fepas HUB

A loja tem a possibilidade de configurar o roteamento de transações feitas no Carat por vários meios de pagamento, um desses meios é o FEPAS HUB.

O objetivo desta documentação é descrever os campos disponíveis no Carat para viabilizar a venda no FEPAS HUB.

ATENÇÃO: Este roteamento por enquanto é somente para transações contactless de transporte.

Interfaces Carat suportadas para integração#

É possível utilizar as seguintes interfaces para a integração com o roteamento Fepas HUB:

Pagamento REST
Cancelamento REST
Pré-authorização REST
Logon REST
Carga de Tabelas REST

ATENÇÃO: A funcionalidade de agendamento não é suportada para este roteamento.

Pagamento REST#

Os campos a seguir são complementares aos menciados na documentação de Serviço de efetivação de pagamento.

Efetivação de Pagamento REST#

Requisição de Pagamento#

Parâmetro	Descrição	Formato	Obrigatório
`resubmission_id`	ID usado para ressubmeter um pagamento negado anteriormente em determinados casos conforme permitido pelo emissor.	= 16 N	Cond.
`acquirer_id`	Código do roteamento a ser utilizado na transação. Pode assumir os valores dos códigos descritos na tabela Códigos de Roteamento. Caso este campo não seja enviado, a configuração da autorizadora da loja será utilizada para definir o roteamento.	< 4 N	NÃO
`original_authorization_number`	Número de autorização da transação original.	< 6 AN	Cond.
`authorizer_mac`	MAC da transação compra de (todas Bandeiras) 4 posicoes ASCII Merchant Advice Code (MAC).	< 4 AN	Cond.
`authorization_terminal`	Atributo do tipo authorization_terminal

`authentication`	Atributo do tipo authentication
`terminal`	Atributo do tipo terminal
`card`	Atributo do tipo card
`mtt`	Atributo do tipo mtt

Exemplo de Requisição de Pagamento#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef-hml/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "card":{
        "expiry_date":"1222",
        "crypto":{
            "ksn":"xxxxxxxxxxx"
        },
        "track_2":"****************************************",
        "pos_entry_mode":{
            "value":"07",
            "pin_capability":"2"
        },
        "emv":{
            "card_sequence_number":"xxxxxx",
            "data":"820258009F2701809F2608B42433F98916B3319F36020074"
        }
    },
    "terminal":{
        "id":"SE111111",
        "type":"2",
        "input_mode":"5",
        "pin_pad_physical_features":"6",
        "handling_type":"1",
        "reader_capabilities":"7"
    },
    "mtt": {
        "id": "1",
        "first_journey_date": "0925",
        "vehicle_id": "012345678901234567",
        "gps_location": "050.167958;-097.133000"
    },
    "resubmission_id": "0123456789012345"
}
--verbose

Resposta de Pagamento#

Parâmetro	Descrição	Formato
`resubmission_id`	ID a ser usado para ressubmeter em caso de pagamento negado.	= 16 N
`payment`	Atributo do tipo payment
`card`	Atributo do tipo resp_card

Exemplo de Resposta de Pagamento#

{
    "code":"0",
    "message":"OK. Transaction successful."
    "payment":{
        "authorizer_code":"000",
        "authorizer_message":"Transacao OK",
        "status":"CON",
        "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
        "order_id":"13034649671",
        "customer_receipt":"====CUPOM COMPRADOR====",
        "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
        "authorizer_id":"2",
        "acquirer_id":"0005",
        "acquirer_name":"FEPAS HUB",
        "authorizer_date":"07/08/2018T16:52",
        "authorization_number":"132030",
        "merchant_usn":"13034649671",
        "esitef_usn":"170713097340300",
        "sitef_usn":"132030",
        "host_usn":"999132030",
        "tid": "000030000016",
        "payment_date":"07/08/2018T16:52",
        "amount":"1000",
        "payment_type":"C",
        "issuer":"2",
        "authorizer_merchant_id":"000000000000005",
        "acquirer_table_load_required":"0",
        "conciliation_authorizer_merchant_id":"6887542",
        "authorization_terminal":{
            "usn":"555845",
            "id":"SE111111"
        }
    },
    "resubmission_id": "0123456789012345"
}

Confirmação de Pagamento REST#

Os campos a seguir são complementares aos menciados na documentação de Serviço de confirmação de pagamento.

Requisição de Confirmação#

Parâmetro	Descrição	Formato	Obrigatório
`issuer_scripts_results`	Issuer Scripts Results Presente se a transação for efetuada com chip EMV.	= N/A AN	Cond.

Exemplo de Requisição de Confirmação#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request PUT "https://{{url}}/e-sitef-hml/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr?confirm=true&issuer_scripts_results=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--header "merchant_id:xxxxxxxxxxxxxxx"
--header "merchant_key:xxxxxxxxxxx"
--verbose

Resposta de Confirmação#

Não há campos adicionais.

Exemplo de Resposta de Confirmação#

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "CON"
  }
}

Cancelamento REST#

Efetivação de Cancelamento REST#

Os campos a seguir são complementares aos menciados na documentação de Serviço de cancelamento.

Requisição de Cancelamento#

Parâmetro	Descrição	Formato	Obrigatório
`terminal`	Atributo do tipo terminal
`card`	Atributo do tipo card
`authentication`	Atributo do tipo authentication

Exemplo de Requisição de Cancelamento#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request PUT "https://{{url}}/e-sitef/api/v1/cancellations/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "card":{
        "crypto":{
            "ksn":"xxxxxxxxxxx"
        },
        "pos_entry_mode":{
            "value":"81",
            "pin_capability":"1"
        },
        "track_2":"****************************************",
        "expiry_date":"1222"
    },
    "terminal":{
        "id":"SE111111",
        "type":"0",
        "input_mode":"5",
        "pin_pad_physical_features":"3",
        "handling_type":"1",
        "reader_capabilities":"4",
        "chip_conditions":"2"
    },
    "authentication":{
        "pin":{
            "crypto":{
                "type":"002"
            }
        }
    },
    "amount":"1500"
}
--verbose

Resposta de Cancelamento#

Parâmetro	Descrição	Formato	Obrigatório
`cancellation`	Atributo do tipo cancellation

Exemplo Resposta de Cancelamento#

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "cancellation": {
    "authorizer_code": "00",
    "authorizer_message": "Sucesso",
    "status": "CON",
    "nit": "10f53cd3dab3222e5e37b725dfe368331958866a2d07c4ba7f382a8c5f42fd9e",
    "order_id": "03110843259",
    "customer_receipt": "=== RECIBO DE CANCELAMENTO ===",
    "authorizer_id": "2",
    "acquirer_id": "412",
    "acquirer_name": "FEPAS HUB",
    "authorizer_date": "03/09/2018T11:09",
    "authorization_number": "030020",
    "merchant_usn": "3110843259",
    "esitef_usn": "180903014387861",
    "sitef_usn": "000060",
    "host_usn": "999030021",
    "tid": "000030000014",
    "amount": "1500",
    "payment_type": "C",
    "authorizer_merchant_id": "000000000100250",
    "conciliation_authorizer_merchant_id": "000000000100250",
    "authorization_terminal": {
      "usn": "030021",
      "id": "F1000001"
    },
    "esitef_date": "03/09/2018T11:09",
    "is_host_cancel": "false"
  }
}

Pré-Autorização REST#

Os campos a seguir são complementares aos menciados na documentação de Serviço de efetivação de pré-autorização.

Efetivação de Pré-autorização REST#

Requisição de Pré-autorização#

Parâmetro	Descrição	Formato	Obrigatório
`resubmission_id`	ID usado para ressubmeter um pagamento negado anteriormente em determinados casos conforme permitido pelo emissor.	= 16 N	Cond.
`acquirer_id`	Código do roteamento a ser utilizado na transação. Pode assumir os valores dos códigos descritos na tabela Códigos de Roteamento. Caso este campo não seja enviado, a configuração da autorizadora da loja será utilizada para definir o roteamento.	< 4 N	NÃO
`authentication`	Atributo do tipo authentication
`terminal`	Atributo do tipo terminal
`card`	Atributo do tipo card
`mtt`	Atributo do tipo mtt

Exemplo de Requisição de Pré-autorização#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef-hml/api/v1/preauthorizations/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "card":{
        "expiry_date":"1222",
        "crypto":{
            "ksn":"xxxxxxxxxxx"
        },
        "track_2":"****************************************",
        "pos_entry_mode":{
            "value":"07",
            "pin_capability":"2"
        },
        "emv":{
            "card_sequence_number":"xxxxxx",
            "data":"820258009F2701809F2608B42433F98916B3319F36020074"
        }
    },
    "terminal":{
        "id":"SE111111",
        "type":"2",
        "input_mode":"5",
        "pin_pad_physical_features":"6",
        "handling_type":"1",
        "reader_capabilities":"7"
    },
    "mtt": {
        "id": "1",
        "first_journey_date": "0925",
        "vehicle_id": "012345678901234567",
        "gps_location": "050.167958;-097.133000"
    },
    "resubmission_id": "0123456789012345"
}
--verbose

Resposta de Pré-autorização#

Parâmetro	Descrição	Formato
`resubmission_id`	ID a ser usado para ressubmeter em caso de pagamento negado.	= 16 N
`pre_authorization`	Atributo do tipo pre_authorization
`card`	Atributo do tipo resp_card

Exemplo de Resposta de Pré-autorização#

{
    "code":"0",
    "message":"OK. Transaction successful.",
    "pre_authorization":{
        "authorizer_code":"000",
        "authorizer_message":"Transacao OK",
        "status":"CON",
        "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
        "customer_receipt":"====CUPOM COMPRADOR====",
        "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
        "authorizer_id":"2",
        "order_id":"13034649671",
        "acquirer_name":"FEPAS HUB",
        "acquirer_id":"0005",
        "authorization_number":"132030",
        "merchant_usn":"13034649671",
        "authorizer_date":"07/08/2018T16:52",
        "esitef_usn":"170713097340300",
        "sitef_usn":"132030",
        "host_usn":"999132030",
        "amount":"1000",
        "tid": "000030000016",
        "issuer":"2",
        "payment_type":"C",
        "authorizer_merchant_id":"000000000000005",
        "acquirer_table_load_required":"0",
        "conciliation_authorizer_merchant_id":"6887542",
        "authorization_terminal":{
            "usn":"555845",
            "id":"SE111111"
        }
    },
    "resubmission_id": "0123456789012345"
}

Captura de Pré-Autorização REST#

Os campos a seguir são complementares aos menciados na documentação de Serviço de captura de pré-autorização.

Exemplo de Requisição de Captura de Pré-autorização#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef-hml/api/v1/preauthorizations/capture/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--header "merchant_id:xxxxxxxxxxxxxxx"
--header "merchant_key:xxxxxxxxxxx"
--data-binary
{
    "card":{
        "expiry_date":"1222",
        "crypto":{
            "ksn":"xxxxxxxxxxx"
        },
        "track_2":"****************************************",
        "pos_entry_mode":{
            "value":"07",
            "pin_capability":"2"
        },
        "emv":{
            "card_sequence_number":"xxxxxx",
            "data":"820258009F2701809F2608B42433F98916B3319F36020074"
        }
    },
    "terminal":{
        "id":"SE111111",
        "type":"2",
        "input_mode":"5",
        "pin_pad_physical_features":"6",
        "handling_type":"1",
        "reader_capabilities":"7"
    }
--verbose

Resposta de Captura de Pré-autorização#

Não há campos adicionais.

Exemplo de Resposta de Captura de Pré-autorização#

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "capture": {
        "authorizer_code":"000",
        "authorizer_message":"Transacao OK",
        "status":"CON",
        "nit":"1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
        "customer_receipt":"====CUPOM COMPRADOR====",
        "merchant_receipt":"====CUPOM ESTABELECIMENTO====",
        "authorizer_id":"2",
        "order_id":"13034649671",
        "acquirer_name":"FEPAS HUB",
        "acquirer_id":"0005",
        "authorization_number":"132030",
        "merchant_usn":"13034649671",
        "authorizer_date":"07/08/2018T16:52",
        "esitef_usn":"170713097340300",
        "sitef_usn":"132030",
        "host_usn":"999132030",
        "amount":"1000",
        "issuer":"2",
        "payment_type":"C",
        "authorizer_merchant_id":"000000000000005"
  }
}

Logon REST#

O Logon é uma funcionalidade exclusiva do roteamento FEPAS.

Caso o campo version enviado na requisição esteja diferente do campo acquirer_table_load.version da resposta, será necessário realizar a Carga de Tabelas.

Requisição de Logon#

Parâmetro	Descrição	Formato	Obrigatório
`authorizer_id`	Código da autorizadora.	< 4 N	SIM
`acquirer_id`	Código do roteamento a ser utilizado na transação. Pode assumir os valores dos códigos descritos na tabela Códigos de Roteamento. Caso este campo não seja enviado, a configuração da autorizadora da loja será utilizada para definir o roteamento.	< 4 N	NÃO
`version`	Versão das tabelas de parâmetros presentes na rede de captura referente a um Autorizador. Cada Autorizador terá uma versão distinta de parâmetros. Nota: Caso ainda não haja tabelas no estabelecimento, enviar zeros.	< 8 N	SIM
`terminal`	Atributo do tipo terminal NOTA: Apenas o atributo `id` contido no atributo do tipo `terminal` é necessário no Logon.

Exemplo de Requisição de Logon#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/acquirer_tables"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "authorizer_id":"2",
    "version":"4",
    "terminal": {
        "id":"ES000001"
    }
}
--verbose

Resposta de Logon#

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Para maiores informações, consulte a seção de Códigos da API.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
`acquirer_table`	Atributo do tipo acquirer_table

Exemplo de Resposta de Logon#

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "acquirer_table": {
    "code": "00",
    "message": "Sucesso",
    "acquirer_id": "5",
    "acquirer_name": "Redecard",
    "usn": "000230",
    "merchant_code": "000000000100250",
    "version": "40361885",
    "signature": "R8yxlnT24sSm1Zt77Jj44pohO8LapTNjWt1nqV8zGKg=",
    "date": "06/09/2018T11:32:31"
  }
}

Carga de Tabelas REST#

A Carga de Tabelas é uma funcionalidade exclusiva do roteamento FEPAS. Esta requisição só pode ser executada após o Logon e reutiliza as informações retornadas por este, como os valores dos campos: acquirer_table.usn, authorizer_id, version e terminal.id.

Requisição de Carga de Tabelas#

Parâmetro	Descrição	Formato	Obrigatório
`authorizer_id`	Código da autorizadora. Deve ser o mesmo valor do Logon.	< 4 N	SIM
`acquirer_id`	Código do roteamento a ser utilizado na transação. Pode assumir os códigos descritos na tabela Códigos de Roteamento. Caso este campo não seja enviado, a configuração da autorizadora da loja será utilizada para definir o roteamento.	< 4 N	NÃO
`version`	Versão das tabelas de parâmetros presentes na rede de captura referente a um Autorizador. Cada Autorizador terá uma versão distinta de parâmetros. Deve ser o mesmo valor do Logon NOTA: Caso ainda não haja tabelas no estabelecimento, enviar zeros.	< 4 N	SIM
`terminal`	Atributo do tipo terminal NOTA: Apenas o atributo `id` contido no atributo do tipo `terminal` é necessário na Carga de Tabelas.

Exemplo de Requisição de Carga de Tabelas#

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request PUT "https://{{url}}/e-sitef/api/v1/acquirer_tables/<valor do acquirer_table.usn>"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "authorizer_id":"2",
    "version":"4",
    "terminal": {
        "id":"ES000001"
    }
}
--verbose

Resposta de Carga de Tabelas#

Parâmetro	Descrição	Formato
`code`	Código de resposta do Carat. Qualquer código diferente de `0` significa falha. Para maiores informações, consulte a seção de Códigos da API.	< 4 N
`message`	Mensagem de resposta do Carat.	< 500 AN
`acquirer_table`	Atributo do tipo acquirer_table

Exemplo de Resposta de Carga de Tabelas#

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "acquirer_table": {
    "code": "00",
    "message": "Sucesso",
    "acquirer_id": "5",
    "acquirer_name": "Redecard",
    "usn": "000230",
    "merchant_code": "000000000100250",
    "version": "40361885",
    "signature": "R8yxlnT24sSm1Zt77Jj44pohO8LapTNjWt1nqV8zGKg=",
    "date": "06/09/2018T11:41:49",
    "credit_bins": [
      {
        "bin": {
          "start": "549202000",
          "end": "549202999"
        },
        "brand_code": "005",
        "is_voucher": "N",
        "features": "24",
        "subtype": "00"
      },
      {
        "bin": {
          "start": "549221000",
          "end": "549221999"
        },
        "brand_code": "005",
        "is_voucher": "N",
        "features": "24",
        "subtype": "00"
      }
    ],
    "public_keys": [
      {
        "rid": "A000000004",
        "certification_authority_public_key_index": "F3",
        "certification_authority_public_key_exponent_size": "1",
        "certification_authority_public_key_exponent": "03",
        "certification_authority_public_key_modulus_size": "144",
        "certification_authority_public_key_modulus": "98F0C770F23864C2E",
        "checksum_status": "1",
        "certification_authority_public_key_checksum": "FCB86DA7076023DB8F38D992680175A839FFC9A6"
      },
      {
        "rid": "A000000004",
        "certification_authority_public_key_index": "F1",
        "certification_authority_public_key_exponent_size": "1",
        "certification_authority_public_key_exponent": "03",
        "certification_authority_public_key_modulus_size": "176",
        "certification_authority_public_key_modulus": "A0DCF4BDE19C3546B4B",
        "checksum_status": "1",
        "certification_authority_public_key_checksum": "55CD192717EE59A8E80A2B2D77528F6552F23BBE"
      }
    ],
    "emv_params": [
      {
        "aid_code": "01",
        "aid_length": "07",
        "aid": "A0000000041010                 ",
        "application_type": "01",
        "application_name": "                ",
        "default_value": "03",
        "version_opt1": "0002",
        "version_opt2": "0002",
        "version_opt3": "0002",
        "terminal_country_code": "076",
        "transaction_currency_code": "986",
        "transaction_currency_exponent": "2",
        "merchant_id": "000000000100250",
        "merchant_category_code": "0000",
        "terminal_id": "00000000",
        "terminal_capabilities": "E0F0C8",
        "terminal_capabilities_additional": "FF80B0F001",
        "terminal_type": "22",
        "terminal_action_code_default": "FE50BCA000",
        "terminal_action_code_denial": "0000000000",
        "terminal_action_code_online": "FE50BCF800",
        "terminal_floor_limit": "00000000",
        "transaction_category_code": "R",
        "tdol": "9F02065F2A029A039C0195059F37040000000000",
        "ddol": "9F37040000000000000000000000000000000000",
        "authorization_response_code_offline_approved": "Y1",
        "authorization_response_code_offline_declined": "Z1",
        "authorization_response_code_unable_online_offline_approved": "Y3",
        "authorization_response_code_unable_online_offline_declined": "Z3",
        "contactless_zero_amount": "1",
        "contactless_mode": "4",
        "contactless_transaction_limit": "05F5E0FF",
        "contactless_floor_limit": "00000000",
        "contactless_cvm_limit": "00001389",
        "contactless_application_version": "0000",
        "contactless_selection_mode": "1",
        "contactless_terminal_action_code_default": "FC509C8800",
        "contactless_terminal_action_code_denied": "0000000000",
        "contactless_terminal_action_code_online": "FC509C8800"
      },
      {
        "aid_code": "02",
        "aid_length": "07",
        "aid": "A0000000043060                  ",
        "application_type": "02",
        "application_name": "                ",
        "default_value": "03",
        "version_opt1": "0002",
        "version_opt2": "0002",
        "version_opt3": "0002",
        "terminal_country_code": "076",
        "transaction_currency_code": "986",
        "transaction_currency_exponent": "2",
        "merchant_id": "000000000100250",
        "merchant_category_code": "0000",
        "terminal_id": "00000000",
        "terminal_capabilities": "E0D0C8",
        "terminal_capabilities_additional": "FF80B0F001",
        "terminal_type": "22",
        "terminal_action_code_default": "FE50BCA000",
        "terminal_action_code_denial": "0000000000",
        "terminal_action_code_online": "FE50BCF800",
        "terminal_floor_limit": "00000000",
        "transaction_category_code": "R",
        "tdol": "9F02065F2A029A039C0195059F37040000000000",
        "ddol": "9F37040000000000000000000000000000000000",
        "authorization_response_code_offline_approved": "Y1",
        "authorization_response_code_offline_declined": "Z1",
        "authorization_response_code_unable_online_offline_approved": "Y3",
        "authorization_response_code_unable_online_offline_declined": "Z3",
        "contactless_zero_amount": "1",
        "contactless_mode": "4",
        "contactless_transaction_limit": "05F5E0FF",
        "contactless_floor_limit": "00000000",
        "contactless_cvm_limit": "00001389",
        "contactless_application_version": "0000",
        "contactless_selection_mode": "1",
        "contactless_terminal_action_code_default": "FC501C8800",
        "contactless_terminal_action_code_denied": "0000800000",
        "contactless_terminal_action_code_online": "FC501C8800"
      }
    ],
    "emv_tags": [
      {
        "aid_code": "46",
        "all_emv_tags": "9f269f109f379f36959c9f025f2a829f1a9f03"
      },
      {
        "aid_code": "45",
        "all_emv_tags": "9f269f109f379f36959c9f025f2a829f1a9f03"
      }
    ],
    "mandatory_emv_tags": [
      {
        "aid_code": "46",
        "mandatory_emv_tags": "9f269f109f379f36959c9f025f2a829f1a9f03"
      },
      {
        "aid_code": "45",
        "mandatory_emv_tags": "9f269f109f379f36959c9f025f2a829f1a9f03"
      }
    ],
    "optional_emv_tags": [
      {
        "aid_code": "46",
        "optional_emv_tags": "5f3484"
      },
      {
        "aid_code": "45",
        "optional_emv_tags": "5f3484"
      }
    ],
    "brand_per_credit_aid": [
      {
        "aid_code": "01",
        "brand_code": "002"
      },
      {
        "aid_code": "01",
        "brand_code": "004"
      }
    ],
    "brand_per_debit_aid": [
      {
        "aid_code": "02",
        "brand_code": "002"
      },
      {
        "aid_code": "02",
        "brand_code": "005"
      }
    ]
  }
}

Tipos de Dados#

`authorization_terminal`#

Parâmetro	Descrição	Formato	Obrigatório
`usn`	NSU do Terminal da Autorização da transação original	= 6 N	Cond.
`local_date_time`	Data e hora local da transação original (formato 'MMddHHmmss')	= 10 N	Cond.

`authentication`#

Parâmetro	Descrição	Formato	Obrigatório
`pin`	Atributo do tipo authentication.pin

`authentication`.`pin`#

Parâmetro	Descrição	Formato	Obrigatório
`value`	PIN Criptografado. Obrigatório quando for digitada a senha online do portador do cartão.	< 16	Cond.
`crypto`	Atributo do tipo pin.crypto

`pin`.`crypto`#

Parâmetro	Descrição	Formato	Obrigatório
`type`	Processo de Criptografia do PIN. Pode assumir os valores dos códigos descritos na tabela Códigos de Processo de Criptografia. Obrigatório apenas quando o PIN é enviado.	= 3	Cond.
`ksn`	KSN da criptografia do PIN. Obrigatório quando for digitada a senha online do portador do cartão.	< 20 AN	Cond.

`terminal`#

Parâmetro	Descrição	Formato	Obrigatório
`id`	Identificação do terminal.	< 8 AN	SIM
`type`	Tipo do Atendimento do Terminal. Pode assumir os valores dos códigos descritos na tabela Códigos de Tipo de Atendimento de Terminal.	= 1 N	SIM
`input_mode`	Capacidade de entrada do terminal. Pode assumir os valores dos códigos descritos na tabela Códigos de Capacidade de Entrada do Terminal.	= 2 N	SIM
`pin_pad_physical_features`	Características Físicas do PIN-pad. Pode assumir os valores dos códigos descritos na tabela Códigos de Características Físicas do Terminal.	= 1 N	SIM
`handling_type`	Tipo de tratamento da senha. Pode assumir os valores dos códigos descritos na tabela Códigos de Tipo de tratamento da Senha.	= 1 N	SIM
`reader_capabilities`	Habilitação de Leitores de Cartão. Pode assumir os valores dos códigos descritos na tabela Códigos de Habilitação de Leitores de Cartão.	= 1 N	SIM
`chip_conditions`	Condições do CHIP. Pode assumir os valores dos códigos descritos na tabela Códigos de Condições do CHIP.	= 1 N	SIM

`card`#

Parâmetro	Descrição	Formato	Obrigatório
`service_code`	Service Code, campo obrigatório quando o tipo de transação for trilha ou chip. Este campo prevê 3 posições, sendo os 3 dígitos após a data de validade da trilha 2, de acordo com a norma ISO/IEC 7813. Exemplo de trilha 2: ;1234567890123445=99011200XXXX00000000?* Service Code: 120.	= 3 N	Cond.
`bin`	BIN do Cartão, campo obrigatório para transações digitadas, trilha ou chip. Este campo prevê 6 posições, sendo os 6 primeiros dígitos após a sentinela de início da trilha 2, de acordo com a norma ISO/IEC 7813. Exemplo de trilha 2: ;1234567890123445=99011200XXXX00000000?* Bin do cartão: 123456.	= 6 N	Cond.
`last4`	4 últimos dígitos do cartão, Campo obrigatório para transações digitadas, trilha ou chip. Este campo prevê 4 posições, sendo os 4 últimos dígitos antes do separador ("=") da trilha 2, de acordo com a norma ISO/IEC 7813. Exemplo de trilha 2: ;1234567890123445=99011200XXXX00000000?* 4 últimos dígitos: 3445.	= 6 N	Cond.
`track_1`	Início da trilha 1 criptografada, conforme regra acordada entre a Loja e a Software Express. Presente se lida a trilha 1.	AN N/A	Cond.
`track_2`	Leitura da Trilha 2 do cartão ou da identificação do cliente. Criptografado por hardware, conforme regra acordada entre a Loja e a Software Express. Presente se lida a trilha 2.	< 99	Cond.
`subtype`	Subtipo do cartão. Pode assumir os valores dos códigos descritos na tabela Códigos de Subtype. Obrigatório em caso de compra com cartão voucher.	= 2 AN	Cond.
`crypto`	Atributo do tipo card.crypto
`pin`	Atributo do tipo card.pin
`pos_entry_mode`	Atributo do tipo pos_entry_mode
`emv`	Atributo do tipo emv
`number`	Número do Cartão (PAN). Utilizado no(s) serviço(s) de: `Cancelamento`	LLvar n..99 N	Cond.
`expiry_date`	Data de Vencimento do Cartão. Utilizado no(s) serviço(s) de: `Cancelamento`	= 4 N	Cond.
`security_code`	Código de Segurança do Cartão. Utilizado no(s) serviço(s) de: `Cancelamento`	= 6 N	Cond.

`card`.`crypto`#

Parâmetro	Descrição	Formato	Obrigatório
`ksn`	KSN (Key Serial Number) da criptografia do PAN e trilha 2 (campo card.track_2). Usado na criptografia DUKPT. Obrigatório quando for utilizado o tipo de criptografia do PAN/trilha 2 DUKPT (004). Se ausente é assumido o tipo de criptografia do PAN 3DES (002).	= 20 AN	COND
`ksn_trac_1`	KSN (Key Serial Number) da criptografia da trilha 1 (campo card.track_1). Usado na criptografia DUKPT. Obrigatório quando for utilizado o tipo de criptografia da trilha 1 DUKPT (004), se ausente, o FEPAS é assumido tipo de criptografia do PAN 3DES (002).	= 20 AN	COND

`card`.`pin`#

Parâmetro	Descrição	Formato	Obrigatório
`value`	PIN Criptografado. Obrigatório quando for digitada a senha online do portador do cartão.	< 64	Cond.

`resp_card`#

Parâmetro	Descrição	Formato
`token`	HASH de um cartão armazenado no Carat. Não é permitido enviar um número de cartão aberto (campo 'number') e um cartão armazenado (campo 'token') na mesma requisição.	= 88 AN
`par`	PAR (Payment Account Reference).	= 29 AN

`pos_entry_mode`#

Parâmetro	Descrição	Formato	Obrigatório
`value`	Modo de entrada do cartão. Pode assumir os valores dos códigos descritos na tabela Códigos de Modo de Entrada.	= 2 N	SIM
`pin_capability`	Capacidade do terminal em relação à entrada de PIN. Pode assumir os valores dos códigos descritos na tabela Códigos de Capacidade de Entrada PIN.	= 1 N	SIM

`emv`#

Parâmetro	Descrição	Formato	Obrigatório
`card_sequence_number`	Número de sequência do Cartão. Corresponde à via do cartão EMV em tratamento (tag `5F34`). Só enviar se a transação efetuada for com chip EMV e o cartão informar este dado.	< 3 N	Cond.
`data`	Contém as tags EMV, em transações processadas por meio de chip EMV. Seu conteúdo é enviado em bytes no formato ASCII seguindo o formato TLV: tipo, tamanho, conteúdo. Por exemplo, se formos enviar: `Tag: 82` - (Application Interchange Profile), tamanho: 2, valor: 5800; `Tag: 9F27` - (Cryptogram Information Data), tamanho: 1, valor: 80; `Tag: 9F26` - (Application Cryptogram), tamanho: 8, valor: b42433f98916b331. O campo resultante ficaria: "data":"820258009F2701809F2608B42433F98916B331"	< 999 N/A	Cond.

`mtt`#

Parâmetro	Descrição	Formato	Obrigatório
`id`	ID transação MTT (Mass Transport Transaction). Informa qual o tipo da transação solicitada. Pode assumir os valores dos códigos descritos na tabela Códigos de ID de Transação MTT.	= 1 N	Cond.
`first_journey_date`	Data da primeira viagem de transação MTT. Segue o formato: `MMDD`. Obrigatório para MTT	= 4 N	Cond.
`vehicle_id`	Identificação do veículo. Obrigatório para MTT	= 18 N	NÃO
`gps_location`	Localização GPS, deve ser enviado nas transações MTT com a localização do veículo em latitude e longitude decimal, por exemplo: 050.167958;-097.133000 (xxx.nnnnnn;-xxx.nnnnnn), onde: “xxx” – Grau corresponde; “.” – Separador de Grau e Minutos; “nnnnnn” – Minutos convertidos em fração de graus; “;” – Separador de Latitude e Longitude; “-“ – Indicação de graus negativos.	< 24 AN	NÃO
`transport_mode_indicator`	Indicador do modo de transporte. Obrigatório para MTT. Tabela de Indicador do Modo de Transporte	< = 2 N	NÃO

`payment`#

Parâmetro	Descrição	Formato
`acquirer_table_load_required`	Informa se a Loja necessita realizar uma Carga de Tabelas junto a um Autorizador. `0` - Parâmetros atualizados. `1` - Parâmetros desatualizados - Loja necessita realizar Carga de Tabelas.	= 1 N
`conciliation_authorizer_merchant_id`	Código de Estabelecimento da Venda.	= 15
`authorization_terminal`	Atributo do tipo authorization_terminal

`pre_authorization`#

Parâmetro	Descrição	Formato
`acquirer_table_load_required`	Informa se a Loja necessita realizar uma Carga de Tabelas junto a um Autorizador. `0` - Parâmetros atualizados. `1` - Parâmetros desatualizados - Loja necessita realizar Carga de Tabelas.	= 1 N
`conciliation_authorizer_merchant_id`	Código de Estabelecimento da Venda.	= 15
`authorization_terminal`	Atributo do tipo authorization_terminal

`cancellation`#

Parâmetro	Descrição	Formato
`acquirer_table_load_required`	Informa se a Loja necessita realizar uma Carga de Tabelas junto a um Autorizador. `0` - Parâmetros atualizados; `1` - Parâmetros desatualizados - Loja necessita realizar Carga de Tabelas.	= 1 N
`conciliation_authorizer_merchant_id`	Código de Estabelecimento da Venda.	= 15 N
`authorization_terminal`	Atributo do tipo authorization_terminal

`authorization_terminal`#

Parâmetro	Descrição	Formato
`usn`	NSU do Terminal da Autorização.	= 6 N
`id`	Identificação do Terminal da Autorização.	= 8 AN

`acquirer_table`#

Parâmetro	Descrição	Formato
`code`	Código de resposta da operação no FEPAS.	= 2 AN
`message`	Mensagem de resposta do FEPAS.	< 999 AN
`usn`	NSU da operação.	= 6 N
`date`	Data e hora local.	= 19 N
`authorizer_id`	Código da autorizadora.	< 4 N
`merchant_code`	Código do estabelecimento.	< 15 AN
`version`	Versão das tabelas de parâmetros presentes na rede de captura referente a um Autorizador. Cada Autorizador terá uma versão distinta de parâmetros. NOTA: Caso ainda não haja tabelas no estabelecimento, serão enviados zeros.	< 8 N
`signature`	Identificação do Terminal da Autorização.	< 999 AN
`acquirer_id`	Código da adquirente. Retornado no(s) serviço(s) de: `Carga de Tabelas`	< 4 N
`acquirer_name`	Nome da adquirente. Retornado no(s) serviço(s) de: `Carga de Tabelas`	N/A AN
`credit_bins[]`	Atributo do tipo product_bins Retornado no(s) serviço(s) de: `Carga de Tabelas`
`debit_bins[]`	Atributo do tipo product_bins Retornado no(s) serviço(s) de: `Carga de Tabelas`
`emv_params[]`	Atributo do tipo emv_params Retornado no(s) serviço(s) de: `Carga de Tabelas`
`public_keys[]`	Atributo do tipo public_keys Retornado no(s) serviço(s) de: `Carga de Tabelas`
`mandatory_emv_tags[]`	Atributo do tipo mandatory_emv_tags Retornado no(s) serviço(s) de: `Carga de Tabelas`
`optional_emv_tags[]`	Atributo do tipo OPTIONAL_EMV_TAGS Retornado no(s) serviço(s) de: `Carga de Tabelas`
`emv_tags[]`	Atributo do tipo emv_tags Retornado no(s) serviço(s) de: `Carga de Tabelas`
`brand_per_credit_aid[]`	Atributo do tipo brand_per_x_aid Retornado no(s) serviço(s) de: `Carga de Tabelas`
`brand_per_debit_aid[]`	Atributo do tipo brand_per_x_aid Retornado no(s) serviço(s) de: `Carga de Tabelas`

`product_bins`#

Parâmetro	Descrição	Formato
`brand_code`	Contém o código identificando a bandeira do range. Pode assumir os valores dos códigos descritos na tabela Códigos de Bandeira.	= 2 AN
`is_voucher`	Informa se o cartão é do tipo Voucher. Valores possíveis: `S` - Sim `N` - Não	= 1 AN
`features`	Mapa de bits composto por 1 byte binário (2 caracteres ASCII hexadecimal) indicando as características da coleta da transação. A posição 8 corresponde ao bit mais significativo. Se o bit estiver ligado, a funcionalidade correspondente estará habilitada. Ordem do byte: 87654321 A relação dos bits pode ser consultada no Mapa de Features.	= 2 AN
`subtype`	Subtipo do cartão. Pode assumir os valores dos códigos descritos na tabela Códigos de Subtype.	= 2 AN
`bin`	Atributo do tipo bin

`bin`#

Parâmetro	Descrição	Formato
`start`	Contém o BIN inicial do Range.	= 9 N
`end`	Contém o BIN final do Range (este campo é igual ao anterior quando tratamento individual de BIN).	= 9 N

`emv_params`#

Parâmetro	Descrição	Formato
`aid_code`	Código do AID.	= 2 N
`aid_length`	Tamanho do AID, em bytes (de `05` a `16`).	= 2 N
`aid`	AID - Application Identifier (alinhado à esquerda).	= 32 H
`application_type`	Tipo de Aplicação. Valores possíveis: `01` - Crédito `02` - Débito	= 2 N
`application_name`	Etiqueta default da aplicação.	= 61 AN
`default_value`	Padrão da aplicação. `03` - EMV.	= 2 N
`version_opt_1`	Application Version Number (Terminal) - opção `#1`.	= 4 h
`version_opt_2`	Application Version Number (Terminal) - opção `#2`.	= 4 h
`version_opt_3`	Application Version Number (Terminal) - opção `#3`.	= 4 h
`terminal_country_code`	Terminal Country Code.	= 3 N
`transaction_currency_code`	Transaction Currency Code.	= 3 N
`transaction_currency_exponent`	Transaction Currency Exponent.	= 1 N
`merchant_id`	Merchant Identifier.	= 15 AN
`merchant_category_code`	Merchant Category Code.	= 4 N
`terminal_id`	Terminal Identification.	= 8 AN
`terminal_capabilities`	Terminal Capabilities. É o mapa de bits indicando as capacidades do terminal. O formato e os valores podem ser consultados no Mapa de Capacidades do Terminal.	= 6 H
`terminal_capabilities_additional`	Additional Terminal Capabilities.	= 10 H
`terminal_type`	Terminal Type. Pode assumir os valores dos códigos descritos na tabela Códigos de Tipo de Terminal.	= 2 N
`terminal_action_code_default`	Terminal Action Code - `Default`.	= 10 H
`terminal_action_code_denial`	Terminal Action Code – `Denial`.	= 10 H
`terminal_action_code_online`	Terminal Action Code – `Online`.	= 10 H
`terminal_floor_limit`	Terminal Floor Limit.	= 8 H
`transaction_category_code`	Transaction Category Code.	= 1 AN
`tdol`	Transaction Category Code. Default Transaction Certificate Data Object List (TDOL) (completado com bytes "00" à direita).	= 40 H
`ddol`	Default Dynamics Data Authentication Data Object List (DDOL) (completado com bytes "00" à direita).	= 40 H
`authorization` `_response_code` `_offline_approved`	Authorization Response Code - offline approved.	= 2 AN
`authorization` `_response_code` `_offline_declined`	Authorization Response Code - offline declined.	= 2 AN
`authorization` `_response_code` `_unable_online_offline_approved`	Authorization Response Code - unable to go online - offline approved.	= 2 AN
`authorization` `_response_code` `_unable_online_offline_declined`	Authorization Response Code - unable to go online - offline declined.	= 2 AN
`contactless_zero_amount`	Indica a ação para cartão com chip sem contato se o valor da transação estiver zerado. Valores possíveis: `0` - Não suporta. `1` - Suporta, porém somente online.	= 1 N
`contactless_mode`	Capacidade de tratamento do terminal para o referido AID, caso este seja localizado em um cartão com chip sem contato. Pode assumir os valores dos códigos descritos na tabela Códigos de Capacidade de Tratamento de Terminal.	= 1 N
`contactless_transaction_limit`	Terminal/Reader Contactless Transaction Limit.	= 8 H
`contactless_floor_limit`	Terminal/Reader Contactless Floor Limit.	= 8 H
`contactless_cvm_limit`	Terminal/Reader CVM Required Limit.	= 8 H
`contactless_application_version`	PayPass Mag Stripe Application Version Number (Terminal).	= 4 H
`contactless_selection_mode`	Indica a forma de seleção da aplicação do cartão sem contato. Valores possíveis: `0` - A aplicação é selecionada automaticamente pela prioridade. `1` - Deve ser mostrado menu de seleção caso exista outra aplicação compatível.	= 1 N
`contactless` `_terminal_action` `_code_default`	Terminal Action Code – `Default` (para cartões sem contato).	= 10 H
`contactless` `_terminal_action` `_code_denied`	Terminal Action Code – `Denied` (para cartões sem contato).	= 10 H
`contactless` `_terminal_action` `_code_online`	Terminal Action Code – `Online` (para cartões sem contato).	= 10 H

`public_keys`#

Parâmetro	Descrição	Formato
`rid`	RID - Registered Application Provider Identifier.	= 10 H
`certification_authority` `_public_key_index`	Certification Authority Public Key Index.	= 2 H
`certification_authority` `_public_key_exponent_size`	Tamanho em bytes do Certification Authority Public Key Exponent (`1` ou `3`).	= 1 N
`certification_authority` `_public_key_exponent`	Certification Authority Public Key Exponent (alinhado à esquerda).	= 6 H
`certification_authority` `_public_key_modulus_size`	Tamanho em bytes do Certification Authority Public Key Modulus (até `248`).	= 3 N
`certification_authority` `_public_key_modulus`	Certification Authority Public Key Modulus (alinhado à esquerda).	= 496 H
`checksum_status`	Status do Check Sum (Hash SHA-1). Valores possíveis: `0` - Não utilizado. `1` - Presente.	= 1 N
`certification_authority` `_public_key_checksum`	Certification Authority Public Key Check Sum (Hash SHA-1).	= 40 h

`mandatory_emv_tags`#

Parâmetro	Descrição	Formato
`aid_code`	Código AID.	= 2 N
`mandatory_emv_tags`	Contém a lista de Tags EMV obrigatórias a serem enviadas nos dados EMV das mensagens de solicitação ou advice de transações do fluxo EMV Completo, tanto online como off-line, após o First Generate AC. Exemplo: `9F269F27959F10`.	N/A AN

`optional_emv_tags`#

Parâmetro	Descrição	Formato
`aid_code`	Código AID.	= 2 N
`optional_emv_tags`	Contém a lista de Tags EMV opcionais a serem enviadas nos dados EMV das mensagens de solicitação ou advice de transações do fluxo EMV Completo, tanto online como off-line, após o First Generate AC.	N/A AN

`emv_tags`#

Parâmetro	Descrição	Formato
`aid_code`	Código AID.	= 2 N
`all_emv_tags`	Contém a lista de Tags EMV a serem enviadas no Bit 55 das mensagens de confirmação ou advice de transações do fluxo EMV Completo, tanto online como off-line, após o Second Generate AC. Exemplo: `9F269F27959F10`.	N/A AN

`brand_per_x_aid`#

Parâmetro	Descrição	Formato
`aid_code`	Código AID.	= 2 N
`brand_code`	Contém o código AID.	= 3 N

Tabelas & Mapas#

Códigos de Roteamento#

Código	Descrição
`2005`	Rede
`2013`	GoodCard
`2047`	Sorocred
`2052`	Tricard
`2054`	Up Brasil
`2072`	Bigcard
`2077`	Valecard
`2094`	Cabal
`2125`	Cielo
`2201`	VR
`2206`	Global Payments
`2265`	Stone
`2309`	Adiq
`5001`	Alelo

Códigos de Bandeira#

Código	Descrição
`001`	Visa
`002`	Mastercard
`003`	Amex
`005`	Hipercard
`006`	Diners
`008`	JCB
`012`	Sorocred
`014`	Policard
`016`	Elo
`017`	Cabal
`043`	Tricard
`054`	Valecard
`058`	VR
`065`	Alelo
`158`	Bigcard
`235`	Up
`999`	Bandeira desconhecida

Mapa de Features#

Regra de coleta de senha com trilha na Compra:

Verifica se o service code está ligado (bit 8);
Se estiver, então utiliza o service code para determinar a coleta de senha; ou
Caso contrário, utiliza o bit 7 para determinar a coleta de senha.

Regra de coleta de senha com trilha no Cancelamento:

Verifica se o service code está ligado (bit 8);
Se estiver, então utiliza o service code para determinar a coleta de senha; ou
Caso contrário, utiliza o bit 6 para determinar a coleta de senha.

Tabela para o Byte 1#

Bit	Descrição
`8`	Permite entrada digitada.
`7`	Solicita os últimos 4 dígitos (trilha).
`6`	Permite Fallback magnético.
`5`	Permite Fallback digitado.
`4`	Reservado para uso futuro.
`3`	Transação magnética solicita CVV2/CVC2.
`2`	Solcita código de segurança (digitada).
`1`	Permite CVV inexistente ou ilegível.

Tabela para o Byte 2#

Bit	Descrição
`8`	Usa service code para determinar se solicita senha (trilha).
`7`	Solicita senha (trilha).
`6`	Solicita senha no cancelamento (trilha).
`5`	Solicita senha (digitada).
`4`	Solicita CPF (DNI para Argentina).
`3`	Solicita código do plano.
`2`	Solicita tipo de conta (corrente ou poupança).
`1`	Valida data de validade do cartão.

Tabela para o Byte 3#

Bit	Descrição
`8`	Solicita código de segurança para pagamento de fatura magnética (trilha).
`7`	Solicita código de segurança para pagamento de fatura digitada.
`6`	Permite código de segurança inexistente ou ilegível para pagamento de fatura.
`5`	Processa chip no cancelamento.
`4`	Processa chip no pagamento de fatura.
`3`	Reservado para uso futuro.
`2`	Reservado para uso futuro.
`1`	Reservado para uso futuro.

Códigos de Subtype#

Código	Descrição (preenchid com `00` quando cartão não for débito/voucher)
`00`	O cartão não é um débito/voucher
`01`	Débito/Voucher Alimentação
`02`	Débito/Voucher Refeição
`03`	Débito/Voucher Cultura
`04`	Débito/Voucher Combustível
`05`	Débito/Voucher Benefício
`19`	Débito/Voucher Outros (Indefinido)
`25`	Débito/PEI (Pagamentos Electrónicos Inmediatos)

Mapa de Capacidades do Terminal#

Formato:

ABCxxxxx DEFGKxxx HIJMxxxx

Posição	Descrição
`A`	Digitação de número do cartão.
`B`	Cartão magnético.
`C`	Cartão com chip de contatos.
`D`	Verificação em cartão com chip de PIN "em aberto".
`E`	Verificação online de PIN com criptografia.
`F`	Assinatura em papel.
`G`	Verificação em cartão com chip de PIN com criptografia.
`K`	Aceita o método "No CVM" (sem verificação do portador).
`H`	SDA - Autenticação estática de dados do cartão com chip.
`I`	DDA - Autenticação dinâmica de dados do cartão com chip.
`J`	Captura de cartão.
`M`	Autenticação offline CDA.

Códigos de Tipo de Terminal#

Código	Descrição
`21`	Online.
`22`	Off-line com capacidade online.
`23`	Somente off-line.
`24`	Online, não atendido.
`25`	Off-line com capacidade online, não atendido.
`26`	Somente off-line, não atendido.

Códigos de Capacidade de Tratamento de Terminal#

Código	Descrição
`0`	Não suporta.
`1`	Suporta VISA MSD.
`2`	Suporta VISA qVSDC.
`3`	Suporta MasterCard PayPass Mag Stripe.
`4`	Suporta MasterCard PayPass M/Chip.
`5`	Suporta Amex Expresspay Magstripe Mode.
`6`	Suporta Amex Expresspay EMV Mode.

Códigos de Processo de Criptografia#

Código	Descrição
`001`	3DES entre Loja e Autorizador (bypass Software Express).
`002`	3DES entre Loja e Software Express, que realiza o translate para Autorizador.
`003`	DUKPT 3DES entre Loja e Autorizador (bypass Software Express).
`004`	DUKPT 3DES entre Loja e Software Express, que realiza o translate para Autorizador.

Códigos de Tipo de Atendimento do Terminal#

Código	Descrição
`0`	Terminal com atendimento (estabelecimento possui operador para o terminal).
`2`	Terminal com auto-atendimento.

Códigos de Capacidade de Entrada do Terminal#

Código	Descrição
`0`	Indefinido.
`2`	Sem terminal (URA/Voz).
`5`	Leitor de chip.

Códigos de Características Físicas do Terminal#

Código Posição 1	Descrição
`1`	Sem PIN-pad
`3`	PIN-pad com leitor de chip.
`6`	PIN-pad com leitor de chip e cartão sem contato.

Código Posição 2	Descrição
`0`	PIN-pad sem leitor magnético.
`1`	PIN-pad com leitor magnético.

Códigos de Tipo de tratamento da Senha#

Código	Descrição
`1`	Sem senha.
`2`	Senha online.
`3`	Senha off-line.

Códigos de Habilitação de Leitores de Cartão#

Código	Descrição
`4`	Leitor tarja e chip habilitados.
`5`	Leitor tarja e cartão sem contato habilitado.
`6`	Leitor chip e cartão sem contato habilitado.
`7`	Leitor tarja, chip e cartão sem contato habilitado. PIN-pad com leitor de chip.

Códigos de Condições do CHIP#

Código	Descrição
`1`	Trilha sem fallback.
`2`	Trilha com fallback.

Códigos de Modo de Entrada#

Código	Descrição
`01`	Entrada manual do número do cartão (digitado).
`02`	Tarja magnética.
`05`	Chip.
`07`	Contactless chip.
`81`	Fallback para tarja magnética (usado quando ocorre falha na leitura do chip e a posição 1 do Service Code da trilha = 2 ou 6, sinalizando cartão com chip).
`89`	E-commerce
`91`	Contactless tarja magnética.

Códigos de Capacidade de Entrada PIN#

Código	Descrição
`0`	Não aplicável
`1`	Tem capacidade de entrada de PIN
`2`	Não tem capacidade de entrada de PIN.

Códigos de ID de Transação MTT#

Código	Descrição
`1`	AVR (transação deve vir com o valor zerado).
`2`	Transação de Valor Agregado – Crédito, Pré-Autorização ou Débito.
`3`	Debt Recovery (ressubmissão, necessário enviar o campo `resubmission_id`).
`4`	Debt Recovery e-commerce/MOTO (para transações digitadas).
`5`	Debt Recovery tap online (para transações contactless).
`6`	KFT (Known Fare Transaction – ou Transação de Valor Conhecido). Este modelo aceita transações de Crédito ou Débito.
`7`	Debt Recovery tap online para KFT.
`8`	Atualização de ATC (transação com valor zerado).

Códigos de Capacidade de Entrada pin#

Código	Descrição
`0`	Não aplicável
`1`	Tem capacidade de entrada de PIN
`2`	Não tem capacidade de entrada de PIN

Tabela de Indicador do Modo de Transporte#

Código	Descrição
`00`	Desconhecido
`01`	Ônibus urbano
`02`	Ônibus interurbano
`03`	Metrô
`04`	Trem coletivo
`05`	Trem
`06`	Veículo transportado pela água
`07`	Pedágio
`08`	Estacionamento
`09`	Táxi
`10`	Trem de alta velocidade
`11`	Ônibus rural
`12`	Trem expresso
`13`	Veículo para trânsito
`14`	Veículo auto-drive
`15`	Veículo treino
`16`	Locomotiva
`17`	Veículo motorizado
`18`	Trailer
`19`	Trem regional
`20`	Transporte entre cidade
`21`	Trem funicular
`22`	Bonde, bondinho

Home

Interfaces Carat suportadas para integração#

Pagamento REST#

Efetivação de Pagamento REST#

Requisição de Pagamento#

Exemplo de Requisição de Pagamento#

Resposta de Pagamento#

Exemplo de Resposta de Pagamento#

Confirmação de Pagamento REST#

Requisição de Confirmação#

Exemplo de Requisição de Confirmação#

Resposta de Confirmação#

Exemplo de Resposta de Confirmação#

Cancelamento REST#

Efetivação de Cancelamento REST#

Requisição de Cancelamento#

Exemplo de Requisição de Cancelamento#

Resposta de Cancelamento#

Exemplo Resposta de Cancelamento#

Pré-Autorização REST#

Efetivação de Pré-autorização REST#

Requisição de Pré-autorização#

Exemplo de Requisição de Pré-autorização#

Resposta de Pré-autorização#

Exemplo de Resposta de Pré-autorização#

Captura de Pré-Autorização REST#

Exemplo de Requisição de Captura de Pré-autorização#

Resposta de Captura de Pré-autorização#

Exemplo de Resposta de Captura de Pré-autorização#

Logon REST#

Requisição de Logon#

Exemplo de Requisição de Logon#

Resposta de Logon#

Exemplo de Resposta de Logon#

Carga de Tabelas REST#

Requisição de Carga de Tabelas#

Exemplo de Requisição de Carga de Tabelas#

Resposta de Carga de Tabelas#

Exemplo de Resposta de Carga de Tabelas#

Tipos de Dados#

authorization_terminal#

authentication#

authentication.pin#

pin.crypto#

terminal#

card#

card.crypto#

card.pin#

resp_card#

pos_entry_mode#

emv#

mtt#

payment#

pre_authorization#

cancellation#

authorization_terminal#

acquirer_table#

product_bins#

bin#

emv_params#

public_keys#

mandatory_emv_tags#

optional_emv_tags#

emv_tags#

brand_per_x_aid#

Tabelas & Mapas#

Códigos de Roteamento#

Códigos de Bandeira#

Mapa de Features#

Tabela para o Byte 1#

Tabela para o Byte 2#

Tabela para o Byte 3#

Códigos de Subtype#

Mapa de Capacidades do Terminal#

Códigos de Tipo de Terminal#

Códigos de Capacidade de Tratamento de Terminal#

Códigos de Processo de Criptografia#

Códigos de Tipo de Atendimento do Terminal#

Códigos de Capacidade de Entrada do Terminal#

Códigos de Características Físicas do Terminal#

`authorization_terminal`#

`authentication`#

`authentication`.`pin`#

`pin`.`crypto`#

`terminal`#

`card`#

`card`.`crypto`#

`card`.`pin`#

`resp_card`#

`pos_entry_mode`#

`emv`#

`mtt`#

`payment`#

`pre_authorization`#

`cancellation`#

`authorization_terminal`#

`acquirer_table`#

`product_bins`#

`bin`#

`emv_params`#

`public_keys`#

`mandatory_emv_tags`#

`optional_emv_tags`#

`emv_tags`#

`brand_per_x_aid`#