Home

Visión General

Quick start

Esta guía muestra el proceso de cancelación de un pago utilizando la interfaz del servicio web REST de Portal Carat.

Que necesitarás#

  • esitef_usn de un pago confirmado en Carat. Más información
  • Una herramienta capaz de realizar llamadas HTTP, como Postman, REST Client o cURL
  • Una aplicación capaz de recibir llamadas POST HTTPS

Creación de la transacción de cancelación#

Tipo de solicitud : POST

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

Headers:

  • Content-Type: application/json
  • merchant_id: {su código de tienda}
  • merchant_key : {clave de su tienda}

Solicitud: Complete el campo <nsu_pago> en la solicitud abajo con el esitef_usn obtenido en la respuesta de pago.

{
"esitef_usn": "<nsu_pago>"
}
curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/cancellations"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"esitef_usn":"<nsu_pago>"
}
--verbose

Recibo de autenticidad POST:

@RestController
public class MyAuthenticityController {
@PostMapping(value = "/myauthenticity",
consumes = "application/x-www-form-urlencoded; charset=utf-8")
public ResponseEntity<String> myAuthenticity(@RequestParam Map<String, String> request) {
Log.info("nit = " + request.get("nit"));
// ...
// armazena o NIT do cancelamento
// ...
return new ResponseEntity<>("OK", HttpStatus.OK);
}
}

Respuesta:

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

Obtenga más información sobre este servicio.

Cancelación de pago#

Tipo de solicitud : PUT

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

Complete el campo <nit> en la URL anterior con el NIT obtenido del POST de autenticidad. Headers:

  • Content-Type: application/json
  • merchant_id: {seu código de loja}
  • merchant_key: {clave de su tienda}

Solicitud:

{
"card": {
"number": "5555555555555555",
"expiry_date": "1222",
"security_code": "601"
},
"amount": "1"
}
curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/cancellations/<nit>"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
"card":{
"number":"5555555555555555",
"expiry_date":"1222",
"security_code":"601"
},
"amount":"1"
}
--verbose

Respuesta:

{
"code": "0",
"message": "OK. Transaction successful.",
"cancellation": {
"authorizer_code": "000",
"authorizer_message": "Transacao OK",
"status": "CON",
"nit": " <nit>",
"order_id": "09062259711",
"customer_receipt": "=== COMPROVANTE ===",
"merchant_receipt": "=== COMPROVANTE ===",
"authorizer_id": "2",
"acquirer_id": "1005",
"acquirer_name": "Redecard",
"authorizer_date": "09/11/2017T18:23",
"authorization_number": "092423",
"merchant_usn": "9062259711",
"esitef_usn": "171109108051261",
"sitef_usn": "092424",
"host_usn": "999092424 ",
"amount": "1",
"payment_type": "C",
"issuer": "2",
"authorizer_merchant_id": "000000000000005",
"esitef_date": "09/11/2017T18:23",
"is_host_cancel": "false"
}
}

Obtenga más información sobre este servicio.

Comprobación del estado de cancelación#

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 del POST de autenticidad. Headers:

  • Content-Type: application/json
  • merchant_id: {su código de tienda}
  • merchant_key: {clave de su tienda}

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.",
"cancellation": {
"authorizer_code": "000",
"authorizer_message": "Transacao OK",
"status": "CON",
"nit": " <nit>",
"order_id": "09062259711",
"customer_receipt": "=== COMPROVANTE ===",
"merchant_receipt": "=== COMPROVANTE ===",
"authorizer_id": "2",
"acquirer_id": "1005",
"acquirer_name": "Redecard",
"authorizer_date": "09/11/2017T18:23",
"authorization_number": "092423",
"merchant_usn": "9062259711",
"esitef_usn": "171109108051261",
"sitef_usn": "092424",
"host_usn": "999092424 ",
"amount": "1",
"payment_type": "C",
"issuer": "2",
"authorizer_merchant_id": "000000000000005",
"esitef_date": "09/11/2017T18:23",
"is_host_cancel": "false"
}
}

Obtenga más información sobre este servicio.