Fepas HUB · e-SiTef

The merchant can configure e-SiTef transactions to be routed by several payment providers. One of them is FEPAS HUB.

The objective of this document is to describe the required configurations on e-SiTef to enable transactions to be routed by FEPAS HUB.

e-SiTef Interfaces Supported for Integration

You can use the following interfaces for integration with Fepas HUB routing:

REST Payment
REST Cancel
REST Logon
REST Table Load

ATTENTION:The schedule feature is not supported by this integration.

REST Payment

The following fields are complementary to the existing fields mentioned in the documentation Payment effectuation service.

REST Payment Effectuation

Payment Request

Parameter	Description	Format	Required
`resubmission_id`	ID for resubmitting a previously denied payment in certain cases as allowed by the issuer.	= 16 N	Cond.
`acquirer_id`	Routing code to be used on the transaction. It can assume the values listed in the Routing Codes table. If this field is not sent, the authorizer configuration will be used to define the routing.	< 4 N	NO
`authentication`	Attribute of type authentication
`terminal`	Attribute of type terminal
`card`	Attribute of type card
`mtt`	Attribute of type mtt

Payment Request Example

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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",
    },
    "resubmission_id": "0123456789012345"
}
--verbose

Payment Response

Parameter	Description	Format
`resubmission_id`	ID used for resubmitting in case of denied payment.	= 16 N
`payment`	Attribute of type payment
`card`	Attribute of type resp_card

Payment Response Example

{
    "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"
}

REST Payment Confirmation

The following fields are complementary to the existing fields mentioned in the documentation Payment confirmation service.

Confirmation Request

Parameter	Description	Format	Required
`issuer_scripts_results`	Issuer Scripts Results Mandatory if the transaction uses an EMV chip.	= N/A AN	Cond.

Confirmation Request Example

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef-hml/api/v1/payments/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr?confirm=true&issuer_scripts_results=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--header "merchant_id:xxxxxxxxxxxxxxx"
--header "merchant_key:xxxxxxxxxxx"
--verbose

Confirmation Response

No additional parameters are required.

Confirmation Response Example

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

REST Cancellation

REST Cancel Effectuation

The following fields are complementary to the existing fields mentioned in the documentation Cancel service.

Cancel Request

Parameter	Description	Format	Required
`terminal`	Attribute of type terminal
`card`	Attribute of type card
`authentication`	Attribute of type authentication

Cancel Request Example

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/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

Cancel Response

Parameter	Description	Format	Required
`cancellation`	Attribute of type cancellation

Cancel Response Example

{
    "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"
    }
}

Logon REST

The logon is a new and an exclusive feature of the e-SiTef FEPAS routing.

If the request version field is different from the response acquirer_table_load.version field, it is necessary to do a table load.

Logon Request

Parameter	Description	Format	Required
`authorizer_id`	Authorizer code.	< 4 N	YES
`acquirer_id`	Routing code to be used on the transaction. It can assume the values listed in the Routing codes table.	< 4 N	NO
`version`	It is the version of the parameters table related to an Authorizer. Each Authorizer may have a distinct version of those parameters. Attention: If the Merchant does not have any table to the informed Authorizer, this field must contain only zeroes.	< 8 N	YES
`terminal`	Attribute of type terminal NOTE: Just the `id` attribute is required in the `terminal` attribute during the Logon.

Logon Request Example

curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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

Logon Response

Parameter	Description	Format
`code`	e-SiTef response code. Any code different from ‘0’ represents a failure. To find more information, check the API Codes section.	< 4 N
`message`	e-SiTef response message.	< 500 AN
`acquirer_table`	Attribute of type acquirer_table

Logon Response Example

{
    "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"
    }
}

REST Table Load

The table load is a new and an exclusive feature of the e-SiTef FEPAS routing. This request can be made successfully only after a logon and will reuse the information returned by it (for instance, acquirer_table_load.usn, authorizer_id, version and terminal.id).

Table Load Request

Parameter	Description	Format	Required
`authorizer_id`	Authorizer code. It must have the same value as the one informed at the logon request.	< 4 N	YES
`acquirer_id`	Routing code to be used on the transaction. It can assume the values listed in the Routing Codes table. If this field is not sent, the authorizer configuration will be used to define the routing.	< 4 N	NO
`version`	It is the version of the parameters table related to an Authorizer. Each Authorizer may have a distinct version of those parameters. It must have the same value as the one informed at the Logon request. NOTE: If the Merchant does not have any table to the informed Authorizer, this field must contain only zeroes.	< 4 N	YES
`terminal`	Attribute of type terminal NOTE: Just the `id` attribute is required in the `terminal` attribute during the Tables load.

Table Load Request Example

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

Table Load Response

Parameter	Description	Format
`code`	e-SiTef response code. Any code different from ‘0’ represents a failure. To find more information, check the API Codes section.	< 4 N
`message`	e-SiTef response message.	< 500 AN
`acquirer_table`	Attribute of type acquirer_table

Table Load Response Example

{
    "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"
        }]
    }
}

Data Types

`authentication`

Parameter	Description	Format	Required
`pin`	Attribute of type authentication.pin

`authentication`.`pin`

Parameter	Description	Format	Required
`value`	Encrypted PIN. Mandatory when the cardholder types the password online.	< 16 AN	Cond.
`crypto`	Attribute of type pin.crypto

`pin`.`crypto`

Parameter	Description	Format	Required
`type`	PIN encryption process. It can assume the values listed in the PIN Encryption Process Codes table. This field is mandatory only when the PIN is sent.	= 3 N	Cond.
`ksn`	PIN encryption KSN. Mandatory when the cardholder types the password online.	< 20 AN	Cond.

`terminal`

Parameter	Description	Formato	Obrigatório
`id`	Terminal ID.	< 8 AN	SIM
`type`	Terminal Attendance Type. It can assume the values listed in the Terminal Attendance Type Codes table.	= 1 N	SIM
`input_mode`	Terminal input capability. It can assume the values listed in the Terminal Input Capability Codes table.	= 1 N	SIM
`pin_pad_physical_features`	PIN-pad physical features. It can assume the values listed in the PIN-pad Physical Feature Codes table.	= 1 N	SIM
`handling_type`	Password handling type. It can assume the values listed in the Password Handling Type Codes table.	= 1 N	SIM
`reader_capabilities`	Reader capabilities. It can assume the values listed in the Card Reader Capability Codes table.	= 1 N	SIM
`chip_conditions`	CHIP conditions. It can assume the values listed in the CHIP Condition Codes table.	= 1 N	SIM

`card`

Parameter	Description	Format	Required
`service_code`	This field has 3 digits and those three digits appear after the track 2 expiry date, according to the ISO/IEC 7813 standards. Track 2 example: ;1234567890123445=99011200XXXX00000000?* Service Code: 120.	= 3 N	Cond.
`bin`	The card BIN field must be sent when the transaction is typed or made by either track or chip. This field has 6 digits and those 6 digits appear after the track 2 starting sentinel, according to the ISO/IEC 7813 standards. Track 2 example: ;1234567890123445=99011200XXXX00000000?* Card BIN: 123456.	= 6 N	Cond.
`last4`	Credit card last four digits must be sent when the transaction is typed or made by either track or chip. Those four digits appear before the track 2 separator (“=”), according to the ISO/IEC 7813 standards. Track 2 example: ;1234567890123445=99011200XXXX00000000?* Last four digits: 3445.	= 6 N	Cond.
`track_1`	Track 1, encrypted according to the rules established between the Merchant and Software Express. This field is mandatory if the Track 1 is sent.	AN N/A	Cond.
`track_2`	Credit card Track 2 or client identification. The Track 2 is encrypted by hardware according to the rules established between the Merchant and Software Express. This field is mandatory if the Track 2 is sent.	< 99	Cond.
`subtype`	Credit card subtype. It can assume the values listed in the Subtype Codes table. Mandatory if the transaction is made with a voucher.	= 2 AN	Cond.
`crypto`	Attribute of type card.crypto
`pin`	Attribute of type card.pin
`pos_entry_mode`	Attribute of type pos_entry_mode
`emv`	Attribute of type emv
`number`	Card number (PAN). Used in the service(s): `Cancel`	LLvar n..99 N	Cond.
`expiry_date`	Card expiry date. Used in the service(s): `Cancel`	= 4 N	Cond.
`security_code`	Card security code. Used in the service(s): `Cancel`	= 6 N	Cond.

`card`.`crypto`

Parameter	Description	Format	Required
`ksn`	KSN of the PAN encryption.	< 20 AN	NO

`card`.`pin`

Parameter	Description	Format	Required
`value`	Encrypted PIN. Mandatory when the cardholder types the password online.	< 64	Cond.

`resp_card`

Parameter	Description	Format
`token`	HAn e-SiTef stored card HASH. It is forbidden to send an AN open card number (‘number’ field) and a stored card (‘token’ field) in the same request.	= 88 AN
`par`	PAR (Payment Account Reference).	= 29 AN

`pos_entry_mode`

Parameter	Description	Format	Required
`value`	Card input mode. It can assume the values listed in the Card Input Mode Codes table.	= 2 N	YES
`pin_capability`	Terminal PIN input capabilities. It can assume the values listed in the Terminal PIN Input Capability Codes table.	= 1 N	YES

`emv`

Parameter	Description	Format	Required
`card_sequence_number`	Card sequence number of the EMV card used (tag `5F34`). This field is mandatory only when the transaction uses an EMV chip and the card informs this data..	< 3 N	Cond.
`data`	This field holds the EMV tags of transactions using an EMV chip. Its contents are sent in ASCII bytes, in the following TLV format: type, length, content. For example, if we were to send: `Tag: 82` - (Application Interchange Profile), length: 2, content: 5800; `Tag: 9F27` - (Cryptogram Information Data), length: 1, content: 80; `Tag: 9F26` - (Application Cryptogram), length: 8, content b42433f98916b331. The resulting value would be: "data":"820258009F2701809F2608B42433F98916B331". This field is mandatory if the transaction uses an EMV chip.	< 999 N/A	Cond.

`mtt`

Parameter	Description	Format	Required
`id`	MTT transaction ID (Mass Transport Transaction). Informs the type of the requested transaction. It can assume the values listed in the MTT transaction ID Codes table.	= 1 N	Cond.
`first_journey_date`	MTT transaction first journey date, following the `MMDD` format.	= 4 N	Cond.

`payment`

Parameter	Description	Format
`acquirer_table_load_required`	This field shows whether an Authorizer table load must be done or not. `0` - Parameters are up-to-date. `1` - The parameters are outdated – the Merchant must do a Table Load.	= 1 N
`conciliation_authorizer_merchant_id`	Sale establishment code.	= 15
`authorization_terminal`	Attribute of type authorization_terminal

`cancellation`

Parameter	Description	Format
`acquirer_table_load_required`	Informs if the Merchant need to do a table load along with an Authorizer. `0` - Parameters are up-to-date. `1` - ‘1’ – Parameters are outdated – the Merchant must do a Table Load.	= 1 N
`conciliation_authorizer_merchant_id`	Código de Estabelecimento da Venda.	= 15 N
`authorization_terminal`	Attribute of type authorization_terminal

`authorization_terminal`

Parameter	Description	Format
`usn`	Authorization terminal USN.	= 6 N
`id`	Authorization terminal ID.	= 8 AN

`acquirer_table`

Parameter	Description	Format
`code`	FEPAS operation response code.	= 2 AN
`message`	FEPAS response message.	< 999 AN
`usn`	Operation USN.	= 6 N
`date`	Local date and time.	= 19 N
`authorizer_id`	Authorizer code.	< 4 N
`merchant_code`	Merchant code.	< 15 AN
`version`	It is the version of the parameters table related to an Authorizer. Each Authorizer may have a distinct version of those parameters. Attention: If the Merchant does not have any table to the informed Authorizer, this field must contain only zeroes.	< 8 N
`signature`	Parametrization signature.	< 999 AN
`acquirer_id`	Acquirer code. Returns in the service(s): `Table Load`	< 4 N
`acquirer_name`	Acquirer name. Returns in the service(s): `Table Load`	N/A AN
`credit_bins[]`	Attribute of type product_bins Returns in the service(s): `Table Load`
`debit_bins[]`	Attribute of type product_bins Returns in the service(s): `Table Load`
`emv_params[]`	Attribute of type emv_params Returns in the service(s): `Table Load`
`public_keys[]`	Attribute of type public_keys Returns in the service(s): `Table Load`
`mandatory_emv_tags[]`	Attribute of type mandatory_emv_tags Returns in the service(s): `Table Load`
`optional_emv_tags[]`	Attribute of type optional_emv_tags Returns in the service(s): `Table Load`
`emv_tags[]`	Attribute of type emv_tags Returns in the service(s): `Table Load`
`brand_per_credit_aid[]`	Attribute of type brand_per_x_aid Returns in the service(s): `Table Load`
`brand_per_debit_aid[]`	Attribute of type brand_per_x_aid Returns in the service(s): `Table Load`

`product_bins`

Parameter	Description	Format
`brand_code`	Card brand code. It can assume the values listed in the Brand Codes table.	= 2 AN
`is_voucher`	Identifies if the card is a voucher. Allowed values: `S` - Yes `N` - No	= 1 AN
`features`	Bits map composed by 1 binary byte (2 ASCII hexadecimal characters) that indicates the transaction input features. The 8 th position is the most significant bit and each bit represents a different feature. If a bit is equals `1`, the feature is present; if it is `0`, the feature is absent. Bit order: 87654321. The list of bits can be found in the Features Map.	= 2 AN
`subtype`	Card subtype. It can assume the values listed in the SubType Codes table.	= 2 AN
`bin`	Attribute of type bin

`bin`

Parameter	Description	Format
`start`	Range starting BIN.	= 9 N
`end`	Range ending BIN. This field has the same individual BIN validation as the previous field.	= 9 N

`emv_params`

Parameter	Description	Format
`aid_code`	AID code.	= 2 N
`aid_length`	AID length in bytes (from `05` to `16`).	= 2 N
`aid`	AID – Application Identifier.	= 32 H
`application_type`	Application type. Allowed values: `01` - Credit `02` - Debit	= 2 N
`application_name`	Application default tag.	= 61 AN
`default_value`	Application default value. `03` - EMV.	= 2 N
`version_opt_1`	Application Version Number (Terminal) – option `#1`.	= 4 h
`version_opt_2`	Application Version Number (Terminal) – option `#2`.	= 4 h
`version_opt_3`	Application Version Number (Terminal) – option `#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. It is the bits map that indicates the terminal capabilities. The format and values can be found in the Terminal Capabilities Map.	= 6 H
`terminal_capabilities_additional`	Additional Terminal Capabilities.	= 10 H
`terminal_type`	Terminal Type. It can assume the values listed in the Terminal Type Codes table.	= 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) (filled with bytes “00” to the right).	= 40 H
`ddol`	Default Dynamics Data Authentication Data Object List (DDOL) (filled with bytes “00” to the right).	= 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`	Informs if the contactless chip supports zero amount transactions. Allowed values: `0` - Does not support. `1` - Supports, but only if the transaction is online.	= 1 N
`contactless_mode`	Terminal AID handling capabilities if the card chip is contactless. It can assume the values listed in the Terminal AID Handling Capabilities Codes table.	= 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`	Informs the application selection mode to contactless cards. Allowed values: `0` - The application is selected automatically according to a priority list. `1` -A selection menu will be presented if there is any other compatible application.	= 1 N
`contactless` `_terminal_action` `_code_default`	Terminal Action Code – `Default` (for contactless cards).	= 10 H
`contactless` `_terminal_action` `_code_denied`	Terminal Action Code – `Denied` (for contactless cards).	= 10 H
`contactless` `_terminal_action` `_code_online`	Terminal Action Code – `Online` (for contactless cards).	= 10 H

`public_keys`

Parameter	Description	Format
`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`	Certification Authority Public Key Exponent (`1` ou `3`) length in bytes.	= 1 N
`certification_authority` `_public_key_exponent`	Certification Authority Public Key Exponent (left aligned).	= 6 H
`certification_authority` `_public_key_modulus_size`	Certification Authority Public Key Modulus (until `248`)length in bytes.	= 3 N
`certification_authority` `_public_key_modulus`	Certification Authority Public Key Modulus (left aligned).	= 496 H
`checksum_status`	Status do Check Sum (Hash SHA-1). Allowed values: `0` - Not used. `1` - Present.	= 1 N
`certification_authority` `_public_key_checksum`	Certification Authority Public Key Check Sum (Hash SHA-1).	= 40 h

`mandatory_emv_tags`

Parameter	Description	Format
`aid_code`	AID code.	= 2 N
`mandatory_emv_tags`	Mandatory EMV tags list. Those tags must be sent in the request messages or in the advice transactions EMV data of a complete EMV flow, both online and offline, after the First Generate AC. Example: `9F269F27959F10`.	N/A AN

`optional_emv_tags`

Parameter	Description	Format
`aid_code`	AID code.	= 2 N
`optional_emv_tags`	Optional EMV tags list. Those tags can be sent in the request messages or in the advice transactions EMV data of a complete EMV flow, both online and offline, after the First Generate AC.	N/A AN

`emv_tags`

Parameter	Description	Format
`aid_code`	AID code.	= 2 N
`all_emv_tags`	Bit 55 EMV tags list. Those tags must be sent in the Bit 55 of confirmation messages or in the advice transactions EMV data of a complete EMV flow, both online and offline, after the Second Generate AC. Example: `9F269F27959F10`.	N/A AN

`brand_per_x_aid`

Parameter	Description	Format
`aid_code`	AID code.	= 2 N
`brand_code`	Brand code.	= 3 N

Tables & Maps

Routing Codes

Código	Description
`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

Brand Codes

Código	Description
`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`	Unknown brand

Features Map

Bit	Description
`8`	Reserved for future use.
`7`	Magnetic transaction requires the last four digits.
`6`	Magnetic fallback allowed.
`5`	Reserved for future use.
`4`	Reserved for future use.
`3`	Magnetic transaction requires security code (CVV2/CVC2).
`2`	Reserved for future use.
`1`	No security code (CVV) or unreadable security code allowed.

Subtype Codes

Código	Description
`01`	Debit/Food Voucher.
`02`	Debit/Meal Voucher.
`03`	Debit/Culture Voucher.
`00`	Card is not of type Debit/Voucher.

Terminal Capabilities Map

Format:

ABCxxxxx DEFGKxxx HIJMxxxx

Position	Description
`A`	Card number typed.
`B`	Magnetic card.
`C`	Contact chip card.
`D`	Open PIN chip card verification.
`E`	Encrypted PIN online verification.
`F`	Signature on paper.
`G`	Encrypted PIN chip card verification.
`K`	“No CVM” (without bearer verification) method is allowed.
`H`	SDA – Static Data Authentication – of card with chip.
`I`	DDA - Dynamic Data Authentication – of card with chip.
`J`	Card capture.
`M`	Offline authentication CDA.

Terminal Type Codes

Code	Description
`21`	Online.
`22`	Off-line with online capability.
`23`	Only off-line.
`24`	Online, unattended.
`25`	Off-line with online capability, unattended.
`26`	Only off-line, unattended.

Terminal AID Handling Capabilities Codes

Code	Description
`0`	No support.
`1`	Supports VISA MSD.
`2`	Supports VISA qVSDC.
`3`	Supports MasterCard PayPass Mag Stripe.
`4`	Supports MasterCard PayPass M/Chip.
`5`	Supports Amex Expresspay Magstripe Mode.
`6`	Supports Amex Expresspay EMV Mode.

PIN Encryption Process Codes

Code	Description
`001`	3DES between the Merchant and the Authorizer (bypass Software Express).
`002`	3DES between the Merchant and Software Express. Software Express will do the translation for the Authorizer.
`003`	DUKPT 3DES between the Merchant and the Authorizer (bypass Software Express).
`004`	DUKPT 3DES between Merchant and Software Express. Software Express will do the translation for the Authorizer.

Terminal Attendance Type Codes

Code	Description
`0`	Terminal with cashier.
`2`	ATM.

Terminal PIN Input Capability Codes

Code	Description
`0`	Undefined.
`2`	No terminal (IVR/Voice).
`5`	Chip reader.

PIN-pad Physical Feature Codes

Code	Description
`3`	PIN-pad with chip reader.
`6`	PIN-pad with contactless and chip reader.

Password Handling Type Codes

Code	Description
`1`	No password.
`2`	Online password.
`3`	Off-line password.

Card Reader Capability Codes

Code	Description
`4`	Chip and magnetic stripe reader enabled.
`5`	Contactless and magnetic stripe reader enabled.
`6`	Contactless and chip reader enabled
`7`	Contactless, magnetic stripe and chip reader enabled. PIN- pad with chip reader.

Chip Condition Codes

Code	Description
`1`	Track without fallback.
`2`	Track with fallback.

Card Input Mode Codes

Code	Description
`01`	Card number manual input (typed).
`02`	Magnetic stripe.
`05`	Chip.
`07`	Contactless chip.
`81`	Magnetic stripe fallback (used when the chip reading fails and the first position of the track service code is equals to 2 or 6, indicating that the transaction was made using a card chip).
`91`	Contactless magnetic stripe.

Terminal PIN Input Capabilities Codes

Code	Description
`1`	PIN input capability is present.
`2`	PIN input capability is absent.

MTT transaction ID Codes

Code	Description
`1`	AVR (transaction must come with amount zero).
`2`	MTT credit transaction.
`3`	Debt Recovery (resubmission, necessary sending `resubmission_id` field)
`4`	E-commerce/MOTO Debt Recovery (for typed transactions).
`5`	Tap Online Debt Recovery (for contactless transactions).