API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Make a batch payment

post
https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments

As well as supporting individual payment requests, the Modulr payment platform can also handle multiple payment objects in the same request. This endpoint allows you to make a new batch payment.

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

Details of Batch request

string
length between 0 and 50

Your reference for this Batch of payments

boolean

Flag to control if the entire batch fails for any individual payment validation failure

string
enum

BATCH restricts operations to batch level. BULK (default) allows payment level operations such as approval

Allowed:
payments
array of objects
required
length between 1 and 2147483647

List of payments. Need at least 1 and maximum of 10000

payments*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 days ago

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

Updated 10 days ago