Home

Descripción general

Quick start

Esta guía muestra el proceso de programación de pagos recurrentes, utilizando la interfaz del servicio web REST de Portal Carat.

Que necesitarás#

  • Registro activo en el entorno de aprobación de pagos en línea (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 : aplicación / json
  • merchant_id : {su código de tienda}
  • merchant_key: {clave de su tienda}

Solicitud:

{
"merchant_usn": "12055523043",
"order_id": "12055523043",
"authorizer_id": "2",
"schedule": {
"amount": "1",
"do_payment_now": "false",
"initial_date": "03/08/2025",
"number_of_times": "3",
"interval": "1",
"soft_descriptor": "Assinatura",
"show_times_invoice": "false"
},
"additional_data": {
"payer": {
"store_identification": "98253053045"
}
}
}
curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--data-binary
{
"merchant_usn":"12055523043",
"order_id":"12055523043",
"authorizer_id":"2",
"schedule":{
"amount":"1",
"do_payment_now":"false",
"initial_date":"03/08/2025",
"number_of_times":"3",
"interval":"1",
"soft_descriptor":"Assinatura",
"show_times_invoice":"false"
},
"additional_data":{
"payer":{
"store_identification":"98253053045"
}
}
}
--verbose

Resposta:

{
"code": "0",
"message": "OK. Transaction successful.",
"schedule": {
"status": "NOV",
"sid": "<sid>",
"amount": "1",
"order_id": "12055523043",
"merchant_usn": "12055523043"
}
}

[Obtenga más información sobre este servicio.] (Schedule-rest-begin.md)

Activando programación de horario#

Tipo de solicitud : POST

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

Complete el campo <sid> en la URL anterior con el SID obtenido en la respuesta de la fase de creación de la transacción anterior. Headers:

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

Solicitud:

{
"card": {
"number": "5555555555555555",
"expiry_date": "1222"
}
}
curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/schedules/<sid>"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Content-Type: application/json"
--data-binary
{
"card":{
"number":"5555555555555555",
"expiry_date":"1222"
}
}
--verbose

Resposta:

{
"code": "0",
"message": "OK. Transaction successful.",
"schedule": {
"status": "ATV",
"sid": "<sid>",
"schedule_usn": "170713000000040",
"amount": "1",
"initial_date": "03/08/2025",
"next_date": "03/08/2025",
"number_of_times": "3",
"soft_descriptor": "Assinatura",
"show_times_invoice": "false"
}
}

Más información sobre este servicio.

Verificando el estado del horario#

Tipo de solicitud : OBTENER

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

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

Headers:

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

Solicitud:

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

Resposta:

{
"code": "0",
"message": "OK. Transaction successful.",
"schedule": {
"status": "ATV",
"sid": "<sid>",
"schedule_usn": "170713000000050",
"authorizerId": "2",
"amount": "1",
"initial_date": "03/08/2025",
"next_date": "03/08/2025",
"number_of_times": "3",
"current_times": "0",
"soft_descriptor": "Assinatura",
"show_times_invoice": "false"
}
}

Más información sobre este servicio.