This feature enables customers to schedule forward-dated and recurring outbound payments.

📘

Notes:

• The Create and Update Scheduled Payment features are available through the UI portal. To access these features on the B2B platform, please submit a request to our CSM team or use UI Portal (GraphQL).
• You can retrieve scheduled payment details and also cancel scheduled payments through the B2B APIs.

Schedule Payment Flow

Create & Update a Schedule Payment using UI portal - GraphQL

• As the feature to create and update scheduled payments is not available through the B2B API, we recommend using our GraphQL mutations. You can use the createScheduledPayment mutation to create a scheduled payment by accountId, and the updateSchedulePayment mutation to update an existing payment using the paymentId.
• You can initiate a scheduled payment, to set up regular transfers to external accounts or pay your bills using BPAY. This can be achieved by defining the receipientDetails.recipientType request object.
  • ACCOUNT: Use this type for regular transfers by BSB and Account Number.
  • BPAY: Use this type for bill payments.
• Upon executing the mutation, you will receive the scheduled payment details, including the transaction outcome, in the response.
• For more detailed information on the createScheduledPayment and updateSchedulePayment mutations, please refer to our GraphQL mutation document

APIs

Get Scheduled Payments by Account Id

• Endpoint to get the details of a scheduled payment by ID. This will return all the recurring payments of the account, regardless of the status of the transaction.

API Reference: Get Scheduled Payments by Account ID

Get Scheduled Payment by Payment Id

• This endpoint is used to retrieve payment details by paymentId for a specific accountId.

API Reference: Get Scheduled Payment by Payment ID for an Account

Cancel Scheduled Payment

• This endpoint is used to cancel an existing scheduled payment by the paymentId of an account.
• The transaction record will not be deleted, but a status will be applied to indicate it is no longer being used.

API Reference: Cancel Scheduled Payment