v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Payments

Retrieve payments

The ability to get the details of payments using various pieces of information, e.g. using Account ID, retrieve all payments in that account. Can get details of one particular payment based on the unique payment reference number.

get/payments

Query parameters

idstring

Payment ID. If specified then all other parameters are ignored. Use ids to search for multiple payment IDs

idsstring[]

fromCreatedDatestring

Payments created date equal or after to this date. Mandatory Parameter(except when 'id', 'ids', 'fxQuoteId' or 'modifiedSince' parameter is used)

Example:2016-01-01T01:01:01+0000

Payments created date equal or after to this date. Mandatory Parameter(except when 'id', 'ids', 'fxQuoteId' or 'modifiedSince' parameter is used)

toCreatedDatestring

Payments created date equal or before to this date

modifiedSincestring

Payments modified date equal or before to this date

fromUpdatedDatestring

Payments updated date equal or after to this date.

Example:2016-01-01T01:01:01+0000

Payments updated date equal or after to this date.

toUpdatedDatestring

Payments updated date equal or before to this date.

Example:2016-01-01T01:01:01+0000

Payments updated date equal or before to this date.

sourceAccountIdstring

The source account ID

hasExternalReferenceboolean

True if the API should return all items that have externalReference. False the API should return all items that don't have externalReference

externalReferencestring

External reference can only have alphanumeric characters plus underscore, hyphen and space

statusstring[]

type'PAYIN' | 'PAYOUT' | 'RETURN'

The payment type to search for.

excludeBatchPaymentsboolean

Exclude payments which are part of a batch with submission type BATCH

batchPaymentIdstring

Filter on batch

reversalsboolean

Filter on reversals

schemeIdstring

Filter on scheme ID

approvalStatusstring[]

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

currencystring[]

minAmountnumber

Payments amount equal or greater than this amount

Example:5.5

Payments amount equal or greater than this amount

maxAmountnumber

Payments amount equal or less than this amount

Example:50.5

Payments amount equal or less than this amount

fromPaymentScheduledDatestring date-time

Payments scheduled date equal or after to this date

Example:2022-01-01T01:01:01+0000

Payments scheduled date equal or after to this date

toPaymentScheduledDatestring date-time

Payments scheduled date equal or before to this date and in absence of fromPaymentDate, payments executed prior to 180 days from this date

Example:2023-01-01T01:01:01+0000

Payments scheduled date equal or before to this date and in absence of fromPaymentDate, payments executed prior to 180 days from this date

customerIdstring[]

Filter on customer ID

[
  "C1234567"
]

currentUserCanApproveboolean

Only return payments the current user can approve.

Example:true

Only return payments the current user can approve.

sortFieldstring

Sort by field. Sorted by createdDate if not present

sortOrderstring

Sorting order:

asc -> ascending
desc -> descending

Sorting order:

asc -> ascending
desc -> descending

pageinteger

The page to fetch. 0 indexed

sizeinteger

The size of the page(s)

Response

sizeinteger required

Page size

totalSizeinteger required

Total count

pageinteger required

Current page number, 0-based, i.e first page = 0, second page = 1

totalPagesinteger required

Total pages

Example response

{
  "content": [
    {
      "id": "P000001ABC",
      "createdDate": "2017-01-28T01:01:01.010+0000",
      "externalReference": "aReference_00001",
      "paymentScheduledDate": "2017-01-28T01:01:01.010+0000",
      "approvals": [
        {
          "approvedBy": "U2100021",
          "approvedOn": "2022-06-25"
        }
      ]
    }
  ]
}