Update Schedule Details

This API is used to update an individual Schedule. To cancel only one scheduled occurrence, set status to 11 (CANCELLED). An updated transaction date must not result in an immediate/same-day payment.

Service Code: 93

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Scheduler ID.

string
required
length between 32 and 32

Schedule ID.

Body Params
string
required
length between 32 and 32

Unique 32-character string. Transaction identifier on the partner system.

string
required
length between 32 and 32

Reference number generated by Ayoconnect during the Create Scheduler API. Identifies the original Scheduler creation transaction and is used for tracking across subsequent Scheduler requests.

string
required
length between 6 and 6

This field is a 6 char merchant identifier that is unique per each merchant. The exact value is disclosed to each merchant separately.

amount
object

Conditional. Amount associated with the scheduled payment.

date

Conditional. Updated Schedule transaction date in YYYY-MM-DD format. Same-day/immediate payment is not supported.

integer
enum

Conditional. Schedule status to be updated. Use 11 to cancel this individual Schedule.

Allowed:
Headers
date-time
required

Request timestamp in ISO 8601 format.

string
required

Request signature generated by the partner.

string
required

Unique request identifier provided by the partner.

string
required

Partner identifier.

string
required

Channel identifier.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json