API Reference

Update Scheduler Details

patch
https://sandbox.api.of.ayoconnect.id/api/v1.0/scheduler/

This API is used to update Scheduler details. Cancelling the entire Scheduler is handled by this API by setting schedulerStatus to 4 (CANCELLED).

The API also supports updating the customer's accountToken and bankCode. This allows a customer to rebind their bank account or card and continue the existing payment schedule without creating a new Scheduler.

Every Update Scheduler request is processed asynchronously in the background. The API acknowledges the request first, while the Scheduler update is completed independently in the background.

Service Code: 91

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

Scheduler 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.

string

Conditional required. Account token created after successful account binding. Required when bankCode is provided.

string
length between 3 and 3

Conditional required. Unique identifier of the bank. Required when accountToken is provided.

integer
enum

Conditional. Scheduler status to be updated. Use 4 to cancel the Scheduler.

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

Updated 24 days ago

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

Updated 24 days ago

Did this page help you?