API Reference
Help CentreService DeskStatus PageDashboard | ProductionDashboard | UATTest Bank

Create or amend a Payment Scheduler

post
https://api-uat.azupay.com.au/v1/paymentAgreement//scheduler

Creates a scheduler against an active payment agreement, or amends the existing one.
Upsert keyed on paymentAgreementId. Amendments require the current version.

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

The payment agreement the scheduler is attached to

Body Params

Create/amend request envelope.

PaymentScheduler
object
required

Scheduler attached to an active PayTo payment agreement. On create/amend, status accepts ACTIVE or INACTIVE only;
other lifecycle states (PAUSED, CANCELLED, COMPLETED) may appear on read responses.

Responses

Updated 3 days ago

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

Updated 3 days ago