Retrieve payments

get https://api-sandbox.modulrfinance.com/api-sandbox-token/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.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

string

Payment ID. If specified then all other parameters are ignored

fromCreatedDate

string

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

toCreatedDate

string

Payments created date equal or before to this date

modifiedSince

string

Payments modified date equal or before to this date

sourceAccountId

string

The source account ID

hasExternalReference

boolean

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

externalReference

string

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

status

array of strings

status

type

string

Defaults to PAYOUT

The payment type to search for.

excludeBatchPayments

boolean

Defaults to false

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

batchPaymentId

string

Filter on batch

reversals

boolean

Filter on reversals

schemeId

string

Filter on scheme ID

approvalStatus

array of strings

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

approvalStatus

currency

array of strings

currency

minAmount

number

Payments amount equal or greater than this amount

maxAmount

number

Payments amount equal or less than this amount

fromPaymentScheduledDate

date-time

Payments scheduled date equal or after to this date

toPaymentScheduledDate

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

customerId

array of strings

Filter on customer ID

customerId

currentUserCanApprove

boolean

Only return payments the current user can approve.

sortField

string

Sort by field. Sorted by createdDate if not present

sortOrder

string

Sorting order:

asc -> ascending
desc -> descending

page

int32

≥ 0

Defaults to 0

The page to fetch. 0 indexed

size

int32

≥ 1

The size of the page(s)

Responses

200OK

400Bad Request