Schedule editing confirmation Service

After obtaining a SEID in the previous step, the merchant will be able to edit the schedule. All parameters sent will be considered for editing, which means that if you don't want to alter an attribute of the schedule, you just need to send the parameter with an empty value.

Call details#

Resource: /v1/schedules/edits/{seid}
HTTP Method: PUT
Request format: JSON
Response format: JSON
Header parameters:

Parameter	Description	Format	Mandatory
`merchant_id`	Merchant code on Carat Portal. The production and certification codes will be different.	< 15 AN	YES
`merchant_key`	Merchant authentication key on Carat Portal. The production and certification keys will be different.	< 80 AN	YES
`Content-Type`	It must be sent with the value `application/json`.	= 15 AN	YES

Examples#

Below are some examples of schedule editing service calls using the cURL tool.

Editing multiple attributes#

Request:

To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br

curl 
--request PUT "https://{{url}}/e-sitef/api/v1/schedules/edits/qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm02"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "status":"INA",
   "amount":"5555",
   "next_date":"15/07/2017",
   "installments":"2",
   "installment_type":"3",
   "soft_descriptor":"Assinatura",
   "show_times_invoice":"false",
   "card":{
      "expiry_date":"1222",
      "number":"5555555555555555"
   }
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"INA",
      "amount":"5555",
      "next_date":"15/07/2017",
      "number_of_times":"3",
      "current_times":"0",
      "installments":"2",
      "installment_type":"3",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "schedule_edit":{
      "status":"CON"
   }
}

Schedule inactivation#

Request:

To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br

curl 
--request PUT "https://{{url}}/e-sitef/api/v1/schedules/edits/qwertyuiopasdfghjklzxcvbnm0123456789qwertyuiopasdfghjklzxcvbnm02"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxxxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{
   "status":"INA"
}
--verbose

Response:

{
   "code":"0",
   "message":"OK. Transaction successful.",
   "schedule":{
      "status":"INA",
      "amount":"900",
      "next_date":"03/08/2017",
      "number_of_times":"3",
      "current_times":"0",
      "installments":"1",
      "installment_type":"4",
      "soft_descriptor":"Assinatura",
      "show_times_invoice":"false"
   },
   "schedule_edit":{
      "status":"CON"
   }
}

Request parameters#

The table below describes the request parameters of the schedule editing service:

Parameter	Description	Format	Mandatory
`status`	Schedule status. Can receive the following values: `ATV` – Activates the schedule. This value can be used on schedules with status `INA` (inactive). If the schedule is reactivated after its execution date, it will be re-scheduled to the same day in the next month. `INA` – Inactivates the schedule, which means that the payments previously scheduled won't be executed anymore.	= 3 AN	NO
`amount`	Amount in cents of the scheduled payments.	< 12 N	NO
`next_date`	Date of the next execution of the schedule in `DD/MM/YYYY` format. Only future dates are allowed with a day between 1 and 28.	= 10 D	NO
`installments`	Number of installments of each scheduled payment.	< 2 N	NO
`installment_type`	Financing type of each scheduled payment: Value `3` = installments with interest. Value `4` = installments without interest (this value must also be used for spot sales).	< 2 N	NO
`soft_descriptor`	Additional text that will be presented alongside the name of the establishment in the credit card invoice. Learn more	< 30 AN	NO
`show_times_invoice`	For finite time schedules, send this field with value `true` if you want to add at the end of the `soft_descriptor` field the current times/number of times (e.g. Subscription 3/12).	< 5 T/F	NO
card
`number`	Customer card number (PAN). If this parameter is sent, the card expiry date will also be altered.	< 19 N	NO
`expiry_date`	Card expiry date in `MMYY` format. If this parameter is sent, it's mandatory to also send the card number, which means it isn't possible to only alter the expiry date.	= 4 N	NO

Response parameters#

If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes the response parameters of the schedule editing service:

Parameter	Description	Format
`code`	Carat Portal response code. Any code different from `0`(zero) means failure. Learn more.	< 4 N
`message`	Carat Portal response message.	< 500 AN
schedule
`status`	Status of the schedule on Carat Portal. Learn more.	= 3 AN
`amount`	Amount of the scheduled payments specified by the merchant (in cents) on the creation of the transaction.	< 12 N
`next_date`	Execution date of the next scheduled payment in `DD/MM/YYYY` format.	= 10 D
`number_of_times`	Total quantity of scheduled payments.	< 3 N
`current_times`	Quantity of scheduled payments already executed.	< 3 N
`installments`	Number of installments to be used on the scheduled payments.	< 2 N
`installment_type`	Financing type to be used on the scheduled payments.	< 2 N
`soft_descriptor`	Additional text that will be presented alongside the name of the establishment in the credit card invoice. This functionality is available to the acquirers Cielo e-Commerce, PayPal, e-Rede, ElavonWS and Stone.	< 30 AN
`show_times_invoice`	For finite time schedules, send this field with value `true` if you want to add at the end of the `soft_descriptor` field the current times/number of times (e.g. Subscription 3/12).	< 5 T/F
schedule_edit
`status`	Schedule editing status on Carat Portal. It can assume the following values: `NOV` – New `EXP` – Expired `CON` – Confirmed `INV` – Invalid	= 3 AN