Quick start

Esta guía muestra el proceso de realizar un pago en efectivo utilizando la interfaz del servicio web REST de Portal Carat.

Que necesitarás#

  • Registro activo en el entorno de aprobación de Portal Carat (obtenido de nuestro equipo de soporte)
  • Una herramienta capaz de realizar llamadas HTTP, como Postman, REST Client o cURL

Creando la transacción#

Tipo de solicitud : POST

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions

Headers:

  • Content-Type: application/json
  • merchant_id: {tu código de tienda}
  • merchant_key: {la llave de tu tienda}

Solicitud:

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

Respuesta:

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

Obtenga más información sobre este servicio.

Realizar pago#

Tipo de solicitud : POST

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/payments/<nit>

Complete el campo <nit > en la URL anterior con el NIT obtenido en la respuesta de la fase anterior de creación de la transacción.

Headers:

  • Content-Type: application/json
  • merchant_id: {tú código de tienda}
  • merchant_key: {la llave de tu tienda}

Solicitud:

{
"card": {
"number": "5555555555555555",
"expiry_date": "1222",
"security_code": "601"
}
}
curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/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

Respuesta:

{
"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": "1005",
"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"
}
}

Obtenga más información sobre este servicio.

Comprobando el estado del pago#

Tipo de solicitud: GET

URL: https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions/<nit>

Complete el campo <nit > en la URL anterior con el NIT obtenido de la respuesta de la fase de creación de la transacción.

Headers:

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

Solicitud:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions/<nit>"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--verbose

Respuesta:

{
"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": "1005",
"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"
}
}

Obtenga más información sobre este servicio.