Ticket

A loja tem a possibilidade de configurar o roteamento de transações feitas com cartões da crédito e débito no Carat por vários meios de pagamento, um desses meios é o Ticket REST. Esta é a plataforma e-commerce da adquirente Ticket. No caso da ticket as transações serão feitas apenas por débito utilizando Alimentação, Refeição, Flex e Super Flex.

ATENÇÃO: É necessário solicitar ao suporte para cadastrar o CNPJ da loja vinculada com a Ticket, caso já não esteja registrado.

Será usada a nomenclatura "Ticket REST" para referenciar o roteamento no Carat.

Interfaces Carat suportadas para integração#

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

Fluxos#

Nesta seção serão apresentadas as particularidades do fluxo transacional Ticket REST.

Atualmente, o Ticket REST não permite parcelamento, ou seja, o campo installments_type deve receber o valor 4. O campo installments deve receber o valor de 1 parcela.

Criação de Transação de Pagamento (REST)#

Exemplo de requisição de criação de transação para Pagamento REST:

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

Resposta

{
    "code": "0",
    "message": "OK. Transaction successful.",
    "payment": {
        "status": "NOV",
        "nit": "bc930a37f74fc71330096efd7d2d41eca5a0611b62f8a16125c21cbc1177f083",
        "order_id": "14111112826",
        "merchant_usn": "14111112826",
        "amount": "30"
    }
}
--verbose

Pagamento REST#

Campos relevantes na etapa de efetivação do pagamento:

Exemplo de requisição de efetivação de transação para Pagamento REST:

ATENÇÃO: o campo de data de validade do cartão (card.expiry_date) não é obrigatório para a efetivação do 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/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

Resposta

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

Cancelamento#

O Cancelamento de uma transação pode ser feito via Web Service REST e através do Portal do Lojista.

As solicitações de cancelamento podem ser realizadas em até 180 dias, somente no valor total da transação original de pagamento.

ATENÇÃO: o campo de data de validade do cartão (card.expiry_date) não é obrigatório para a efetivação do cancelamento.

Exemplo de requisição de criação de transação para Cancelamento REST:

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/cancellations/"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "esitef_usn":"190129022924690"
}
--verbose

Resposta

{
    "code": "0",
    "message": "OK. Transaction successful."
}
--verbose

Exemplo de requisição de efetivação de transação para Cancelamento REST:

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/2ccd49b410268c8332ef9e4aeb9d1e481a662944814ce24226bc3502b04013f9"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
    "card": {
        "number": "6026514493311762"
    },
    "amount": "30"
}
--verbose

Resposta

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

Home

Interfaces Carat suportadas para integração#

Fluxos#

Criação de Transação de Pagamento (REST)#

Pagamento REST#

Cancelamento#