Quick start

Este guia mostra o processo de efetivação de um pagamento à vista, utilizando a interface web service REST do Carat.

O que você precisará

• Cadastro ativo no ambiente de homologação do Carat (obtido com nossa equipe de suporte)
• Uma ferramenta capaz de realizar chamadas HTTP, como Postman, REST Client ou cURL

Criando a transação

Tipo de requisição: POST

URL: https://<URLPOSTMAN/>/e-sitef/api/v1/transactions

Headers:

• Content-Type: application/json
• merchant_id: {seu código de loja}
• merchant_key: {chave da sua loja}

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

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":"12042142155",
   "order_id":"12042142155",
   "installments":"1",
   "installment_type":"4",
   "authorizer_id":"2",
   "amount":"1"
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "status": "NOV",
    "nit": "<nit>",
    "order_id": "12042142155",
    "merchant_usn": "12042142155",
    "amount": "1"
  }
}

Saiba mais sobre esse serviço.

Efetuando o pagamento

Tipo de requisição: POST

URL: https://<URLPOSTMAN/>/e-sitef/api/v1/payments/<nit>

Preencha o campo <nit> na URL acima com o NIT obtido na resposta da fase anterior de criação da transação.

Headers:

• Content-Type: application/json
• merchant_id: {seu código de loja}
• merchant_key: {chave da sua loja}

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

curl
--request POST "https://{{url}}/e-sitef/api/v1/payments/<nit>"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "card":{
      "number":"5555555555555555",
      "expiry_date":"1222",
      "security_code":"601"
   }
}
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "authorizer_code": "000",
    "authorizer_message": "Transacao OK",
    "status": "CON",
    "nit": "<nit>",
    "order_id": "12042142155",
    "customer_receipt": "====CUPOM COMPRADOR====",
    "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
    "authorizer_id": "2",
    "acquirer_id": "229",
    "acquirer_name": "Bin",
    "authorizer_date": "13/04/2018T10:56",
    "authorization_number": "132324",
    "merchant_usn": "12042142155",
    "esitef_usn": "180413005038220",
    "sitef_usn": "132324",
    "host_usn": "999132324   ",
    "amount": "1",
    "payment_type": "C",
    "issuer": "2",
    "authorizer_merchant_id": "000000000000005",
    "payment_date": "13/04/2018T10:56"
  }
}

Saiba mais sobre esse serviço.

Verificando o estado do pagamento

Tipo de requisição: GET

URL: https://<URLPOSTMAN/>/e-sitef/api/v1/transactions/<nit>

Preencha o campo <nit> na URL acima com o NIT obtido na resposta da fase de criação da transação.

Headers:

• Content-Type: application/json
• merchant_id: {seu código de loja}
• merchant_key: {chave da sua loja}

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor<br/> <URLPOSTMAN/>

curl
--request GET "https://{{url}}/e-sitef/api/v1/transactions/<nit>"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Resposta:

{
  "code": "0",
  "message": "OK. Transaction successful.",
  "payment": {
    "authorizer_code": "000",
    "authorizer_message": "Transacao OK",
    "status": "CON",
    "nit": "<nit>",
    "order_id": "12042142155",
    "customer_receipt": "====CUPOM COMPRADOR====",
    "merchant_receipt": "====CUPOM ESTABELECIMENTO====",
    "authorizer_id": "2",
    "acquirer_id": "229",
    "acquirer_name": "Bin",
    "authorizer_date": "13/04/2018T10:56",
    "authorization_number": "132324",
    "merchant_usn": "12042142155",
    "esitef_usn": "180413005038220",
    "sitef_usn": "132324",
    "host_usn": "999132324   ",
    "amount": "1",
    "payment_type": "C",
    "issuer": "2",
    "authorizer_merchant_id": "000000000000005",
    "payment_date": "13/04/2018T10:56"
  }
}

Saiba mais sobre esse serviço.