Ticket

The merchant has the possibility to configure the routing of transactions made with credit and debit cards in the Carat by various means of payment, and one of them is Ticket REST. This is Ticket acquirer's e-commerce platform. In the case of the ticket, transactions will be made only by debit using Alimentação, Refeição, Flex e Super Flex.

ATTENTION: It may be necessary to ask support team to register the merchant's ID (CNPJ) linked with Ticket, if not already registered.

The nomenclature "Ticket REST" will be used to refer to the routing in Carat.

Integration supported interfaces

You can use the following interfaces to integrate with Ticket REST routing:

• REST Payment
• REST Cancel
• HTML Payment
• Cancel via Carat Portal Merchant's Portal

Flows

This section will present the specific or relevant fields of Ticket REST transactional flow.

Currently, Ticket REST does not allow installments with interest from the card issuer, so the installments_type field must receive value 4. The field installments must receive the value of 1.

Payment Transaction Creation (REST)

Transaction creation for REST Payment example:

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":"123456789",

"order_id":"pedido001",

"amount":"30",

"authorizer_id":"70",

"installments":"1",

"installment_type":"4"

}

--verbose

Response:

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"status": "NOV",

"nit": "bc930a37f74fc71330096efd7d2d41eca5a0611b62f8a16125c21cbc1177f083",

"order_id": "14111112826",

"merchant_usn": "14111112826",

"amount": "30"

}

}

--verbose

REST Payment

Relevant fields in the call described in Payment effectuation service:

ATTENTION: card expiry date field (card.expiry_date) is optional for payment effectuation.

REST Payment example:

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/payments/2ccd49b410268c8332ef9e4aeb9d1e481a662944814ce24226bc3502b04013f9"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-binary

{

"card": {

"number": "6026514493311762",

"security_code": "669"

}

}

--verbose

Response

{

"code": "0",

"message": "OK. Transaction successful.",

"payment": {

"authorizer_code": "00",

"authorizer_message": "APPROVED",

"status": "CON",

"nit": "bc930a37f74fc71330096efd7d2d41eca5a0611b62f8a16125c21cbc1177f083",

"order_id": "14111112826",

"customer_receipt": " DEBITO \n \n ESTAB: TICKETREST \n DATA: 19/09/2022 HORA: 17:19:10 \n CODIGO PEDIDO: 14111112826 \n \n ID TRANSACAO: \n 429d9e3b-e190-4e16-9efe-e2a98c8650cd \n \n AUTORIZACAO: 306034 \n VALOR: 0,30 \n \n (e-SiTef) \n \n1a VIA - CLIENTE \n \n",

"merchant_receipt": " DEBITO \n \n ESTAB: TICKETREST \n DATA: 19/09/2022 HORA: 17:19:10 \n CODIGO PEDIDO: 14111112826 \n \n ID TRANSACAO: \n 429d9e3b-e190-4e16-9efe-e2a98c8650cd \n \n AUTORIZACAO: 306034 \n VALOR: 0,30 \n NSU e-SiTef: 220919108106350 \n \n (e-SiTef) \n \n2a VIA - ESTABELECIMENTO \n \n",

"authorizer_id": "70",

"acquirer_id": "417",

"acquirer_name": "TicketRest",

"authorizer_date": "19/09/2022T17:18",

"authorization_number": "306034",

"merchant_usn": "14111112826",

"esitef_usn": "220919108106350",

"host_usn": "1",

"tid": "429d9e3b-e190-4e16-9efe-e2a98c8650cd",

"amount": "30",

"payment_type": "D",

"balance": "9.9998914131E8",

"payment_date": "19/09/2022T17:19"

}

}

--verbose

REST Cancel

Canceling a transaction can be done on Web Service REST and through Merchant's Portal.

Cancel requests can be made after 180 days and only in full value of the original payment transaction.

ATTENTION: card expiry date field (card.expiry_date) is optional for payment cancellation.

Transaction creation for REST Cancel example:

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/cancellations/"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-binary

{

"esitef_usn":"190129022924690"

}

--verbose

Response

{

"code": "0",

"message": "OK. Transaction successful."

}

--verbose

REST Cancel example:

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

curl

--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/cancellations/2ccd49b410268c8332ef9e4aeb9d1e481a662944814ce24226bc3502b04013f9"

--header "Content-Type: application/json"

--header "merchant_id: xxxxxxxx"

--header "merchant_key: xxxxxxxxxxx"

--data-binary

{

"card": {

"number": "6026514493311762"

},

"amount": "30"

}

--verbose

Response

{

"code": "0",

"message": "OK. Transaction successful.",

"cancellation": {

"authorizer_code": "00",

"authorizer_message": "APPROVED",

"status": "CON",

"nit": "e98c3cef86b22baae112223eee1cf5f2a8d82d4e3b38f633f07d9b34ecde8544",

"order_id": "14111112826",

"customer_receipt": " CANCELAMENTO DE VENDA \n1a VIA - CLIENTE \nDATA: 19/09/2022 HORA: 18:41:49 \nAUTORIZ. DA TRN. DE PGTO.: 73f5356c-2ea3-4e31-bdcc-c8f6326b6a24\n \nVALOR TOTAL DO CANCELAMENTO: 0,30 \n \nSOLICITACAO DE CANCELAMENTO REGISTRADA. \n \n (e-SiTef) \n",

"merchant_receipt": " CANCELAMENTO DE VENDA \n2a VIA - ESTABELECIMENTO \nDATA: 19/09/2022 HORA: 18:41:49 \nAUTORIZ. DA TRN. DE PGTO.: 73f5356c-2ea3-4e31-bdcc-c8f6326b6a24\n \nVALOR TOTAL DO CANCELAMENTO: 0,30 \n \nSOLICITACAO DE CANCELAMENTO REGISTRADA. \n \n (e-SiTef) \n",

"authorizer_id": "70",

"acquirer_id": "417",

"acquirer_name": "TicketRest",

"authorizer_date": "19/09/2022T18:39",

"authorization_number": "306053",

"merchant_usn": "14111112826",

"esitef_usn": "220919108107251",

"host_usn": "37",

"tid": "9dff3440-6488-4872-9660-04779d81c3da",

"amount": "30",

"payment_type": "D",

"esitef_date": "19/09/2022T18:41",

"is_host_cancel": "false"

}

}

--verbose