Payment schedules

You can now set up recurring payments. Add a payment_schedule object to POST /payment_orders and Mambu Payments generates the follow-up payment orders on the cadence you define. No changes are required to existing integrations.

What's new

• New object payment_schedule, with statuses active, paused, blocked and disabled.
• New optional payment_schedule object on POST /payment_orders, with interval (day, week, month, year, end_of_month), interval_count and end_date. Invalid values return 400.
• New field payment_schedule_id on payment_order. It is returned in the POST /payment_orders response and set on every payment order generated by the schedule.
• New filter payment_schedule_id on GET /payment_orders.
• New endpoints:
  • GET /payment_schedules: list schedules, filtered by status, interval or original_payment_id.
  • GET /payment_schedules/{id}: retrieve a schedule.
  • POST /payment_schedules/{id}/pause: stop generation, keeping next_payment_date.
  • POST /payment_schedules/{id}/activate: resume a paused schedule. Missed dates are skipped.
  • POST /payment_schedules/{id}/disable: stop the schedule permanently.
• New field original_payment_details on payment_schedule. It holds the amount, currency, connected_account_id, originating_account, originating_account_id, receiving_account, receiving_account_id and direct_debit_mandate_id of the original payment order.
• New webhook topic payment_schedule, with event types active, updated, paused, blocked and disabled.
• New permissions payments.view_payment_schedules and payments.edit_payment_schedules, included in the Admin and Manager default roles.
• Dashboard: new Payments > Payment schedules section, a Schedule section in the payment order creation form, and a Payment schedule ID filter on Payment orders.

The feature is gated by the payment_schedule feature flag. Contact your account manager to enable it.

Read the guide