Activate Schedule

import ResponseCodes from './codigos-de-resposta.md';
import ApiDoc from '../../../../../src/components/api-doc/ApiDoc';

After creating a schedule without immediate payment and obtaining a SID, it’s possible to proceed to the next step of the flow: calling the schedule activation service. For schedules with immediate payment, use the payment effectuation service instead.

Call details

• Resource: /v1/schedules/{sid}
• HTTP Method: POST
• Request format: JSON
• Response format: JSON
• Header parameters:

Examples

Below is an example of the schedule activation service call using the cURL tool.

Request:

To use this example, don't forget to define the variable {{url}} with the value

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

Response:

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

Request parameters

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

Response parameters

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