Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Payments

Get batch payment by ID

Get the details of an existing batch payment by ID

get/batchpayments/{id}

Path parameters

idstring required

id given when batch request was made

Response

OK

idstring

Unique id for the Batch Payment. 10 characters long

externalReferencestring

External reference, if provided

status'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'CANCELLED'

Current status of batch.

totalPaymentsinteger

Total count of payments in this batch

currentUserCanApproveboolean

Whether the user is allowed to approve this batch, based on their approval limits, and applicable configuration

paymentDetailsobject

Summary of payments and approvals, per currency (as a 3-alpha currency code)

currentUserCanCancelboolean

Whether the user is allowed and currently able to cancel at least one of the payments in this batch

createdDatestring date-time

Datetime when the batch payment was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

createdBystring

ID of the user that created the payment

processingDateFromstring date

Earliest processing date in the batch file or the batch creation date if the file does not have any dates. Date format 'yyyy-MM-dd'

processingDateTostring date

Last processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'

earliestScheduledPaymentDatestring date

Earliest processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'

requiredApprovalCountinteger

The number of required approvals for the batch. Applicable to batch payments of submissionType BATCH

strictboolean

Strict processing flag. Whether the entire batch should fail on any individual payment validation failure

Example response

{
  "id": "D920000001",
  "externalReference": "aReference_00001",
  "status": "ACCEPTED",
  "totalPayments": 9123,
  "currentUserCanApprove": true,
  "approvals": [
    {
      "approvedBy": "U2100021",
      "approvedOn": "2022-06-25"
    }
  ],
  "createdDate": "2017-01-28T01:01:01+0000",
  "processingDateFrom": "2017-01-28",
  "processingDateTo": "2017-01-28",
  "earliestScheduledPaymentDate": "2017-01-28"
}