API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In

Get batch payments by a given set of parameters

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

This endpoint allows for a user who has submitted multiple batch to use some criteria to get the batch payments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
id
array of strings

List of batch payment IDs

id
string
length between 0 and 50

Batch payments External Reference contains this text.

date

Batch payments created date equal or after to this date.

batchPaymentStatuses
array of strings
batchPaymentStatuses
paymentStatuses
array of strings
paymentStatuses
approvalStatus
array of strings

Payment approval status, multiple statuses can be specified by repeating the parameter

approvalStatus
boolean

Only return batch payments the current user can approve.

string

Limit results by the customer which created the batch payment request

string
enum

Limit results to batches with submission type specified

Allowed:
int32
Defaults to 0

Page to fetch (0 indexed)

int32
≤ 500
Defaults to 20

Size of Page to fetch

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 26 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 26 days ago