Create a Payment Run
Enable your customers to create and manage payment runs within your product using the API.
Before buyers can create payment runs, they must:
- Complete onboarding
- Assign the Creator role to at least 1 user
- Link at least 1 bank account
To create a payment run your customers must provide a list of payments which include the paymentAmount and supplier bank details where the payment is to be made.
A payment run can be created by a user who has the Creator role. Learn more about the different roles in our guide.
The API endpoint will return the unique id for the created payment run with a PENDING_CONFIRMATION as a status. If you are subscribed and watching the payment run events you will also receive an event with the status update.
Learn how to confirm and authorise a payment run, by reading the guide.
A payment run can contain no more then 1,000 payments. If you have a payment run that contains more then 1,000 transactions you will have to create another payment run.