Bradescard

The merchant has the possibility to configure the routing of transactions made in Carat Portal, one of these routings is Bradescard.

Supported Carat Portal interfaces#

We will use the following interfaces for integration with Bradescard routing:

REST Payment
HTML Payment
REST Cancellation
Cancellation via Merchant's Portal
REST Generic operations for Bradescard queries

Bradescard query service#

In the Bradescard queries, it is possible to make the statement summary query and to make the balance query of a specific card.

Call details#

The Bradescard query service is provided by the generic operation interface (Learn more). The Bradescard query operation is mandatory the authenticity token for each query performed, so it is necessary to obtain the token (Learn more) and then perform the generic operation call (Learn more).

The Bradescard query is identified with operation code 172 (use this value in the operation field in the request).

Parameters of Bradescard queries#

Below are the parameters that are used by the request for Bradescard query operation.

Parameter	Description	Format	Mandatory
`date`	Fiscal date.	N	No
`time`	Fiscal hour.	N	No
`subfunction`	Query transaction subfunction. The following queries are planned: 01 - Balance query 02 - Statement Summary query	2 N	No
`card_entry_mode`	Entry mode. The possible values for this field are: 1 – Magnetic card 2 – Card number entered	1 N	Yes
`card_number`	This field must be filled with the card number.	N	Conditional Yes, if `card_entry_mode_type` is equal to "2"
`track1`	This field must be filled with the track 1 of the card.	< 99 AN	Conditional Yes, if `card_entry_mode_type` is equal to "1"
`track2`	This field must be filled with the track 2 of the card.	< 99 N	Conditional Yes, if `card_entry_mode_type` is equal to "1"
`card_expiry_date`	Card expiration date.	4 N (MMYY)	Conditional Yes, if `card_entry_mode_type` is equal to "2"
`card_security_code`	Security code.	< 10 N	Conditional Yes, if requested in the card query (Learn more).
`card_issue_date`	Card issue date.	6 N (MMYYYY)	Conditional Yes, if requested in the card query (Learn more).

Response parameters#

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. In the table below is the description of the response parameters of the Bradescard query service:

Parameter	Description
`response_code`	Carat Portal response code.
`response_message`	Reply message from Carat Portal.
`authorizer_response_code`	Authorizer response code.
`authorizer_response_message`	Authorizer reply message.
`parameters.date`	Date.
`parameters.time`	Hour.
`parameters.acquirer_id`	Acquirer id in SiTef.
`parameters.host_usn`	Host USN.
`parameters.sitef_usn`	SiTef USN.
`parameters.institution_response_code`	Authorizer/acquirer response code.
`parameters.institution_name`	Institution Name.
`parameters.authorization_number`	Authorization number.
`parameters.affiliation_code`	Merchant affiliation code in authorizer/acquirer.
`parameters.confirmation_data`	Confirmation data.
`parameters.customer_receipt`	Customer's receipt.
`parameters.merchant_receipt`	Merchant's receipt.
`parameters.sale_response_data`	Sale response data.

Response codes

See reference on API codes - response codes

Additional parameters#

The fields below must be inserted inside the additional_data structure of transaction creation call. (Learn more)

Parameter	Description	Format	Mandatory
additional_data	Element for sending additional data.
`skip_cycles_days`	Indicates the payment postponement in days for credit purchases in installments.	< 2 N	NO
`skip_cycles_periods`	Indicates the payment postponement in periods or cycles for credit purchases in installments.	< 2 N	NO
`free_installments_indicator`	Indicates the existence of free installment. 1-Indicates true 0 or not informed-indicates false	1 N	NO
`card_holder_biometric_authentication`	Information regarding biometric authentication.	< 6 AN	NO

Parameters details#

Parameter	Explanation
`skip_cycles_days`	Number of days in 99 format. Example: 30 Absence indicates non-use of this functionality.
`skip_cycles_periods`	Number of periods or cycles in 99 format. Example 01 Absence indicates non-use of this functionality.
`free_installments_indicator`	0-Indicates without free installment. 1-Indicates with free installment. Absence is assumed with the value 0
`card_holder_biometric_authentication`	X;Y where X - Authentication type code, with values: 1-Customer since MM/YY (Y Format is YYMM) 2-Biometrics (without sending values in Y) 3-Account stored (without sending values in Y) Y-Information regarding the type of authentication of the cardholder. Example: `1;2304` `2`

Example#

Below is a example of the transaction creation service call using the cURL tool.

Request:

To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br

curl 
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header “merchant_key: xxxxxxxxxxx”
--data-binary
{
   "merchant_usn":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1000",
    "additional_data": {
         "skip_cycles_days": "45",
         "free_installments_indicator": "1"
    }
}
--verbose

Response:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr",
    "order_id": "12042142155",
    "merchant_usn": "12042142155",
    "amount": "1000"
  }
}

Bradescard Voucher#

Bradescard Voucher allows a customer who does not yet have a Bradescard's card to make a purchase with this card in a Bradescard's partner store. This case is exclusive for Bradescard route.

In this case, there are two scenarios:

The store do have a Bradescard card printer, so it prints the card on the fly;
The store does not have a Bradescard Card Printer, so it generates a request and receive a PDF containing all necessary information to carry out the transaction.

Supported Carat Portal Interfaces#

We will use the following interfaces for integration with Bradescard Voucher routing:

REST Payment
REST Cancellation
Cancellation via Merchant's Portal

REST Payment#

Payment using Bradescard Voucher follows REST Payments default transactional flow, being differentiated by sending the following mandatory fields during the payment step:

card.number - fictional card number;
acquirer.authorization_number - voucher authorization code.

Other fields related to card date are not used.

Cancellation#

The cancellation of transactions via Bradescard Voucher follows the existing flow, without the need of sending extra fields new.

For cancellation via Merchant's Portal, it is necessary to fill the card number used in the transaction.

For more details, refer to the following documentation:

Balance and Statement Inquiries#

The Bradescard Voucher does not allow balance and statement inquiries.

Home