Skip to main content
GET
List limit checks

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Query Parameters

result
enum<string>

Only payments that passed, or only those that were blocked. Whether an Instant Payment fitted within its bank account's daily limit and was sent, or would have gone over it and was refused without being sent.

Available options:
PASSED,
BLOCKED
bankAccountId
string<uuid>

Only payments from this bank account.

businessCustomerOrganizationId
string<uuid>

Only payments from this Business Customer's bank accounts.

vspOrganizationId
string<uuid>

Only payments from bank accounts whose Business Customer sat beneath this VSP.

platformOrganizationId
string<uuid>

Only payments from bank accounts whose Business Customer sat beneath this Platform, directly or through a VSP.

startTime
string<date-time>

Only payments checked at or after this time (ISO 8601 with offset).

endTime
string<date-time>

Only payments checked before this time (ISO 8601 with offset).

limit
default:25

Number of items to return (default 25, max 100).

pagination_token
string

Opaque pagination token from a previous response.

Response

Returns limit checks.

A paginated response containing a page of results and navigation tokens.

data
object[]
required

The items in the current page.

nextPaginationToken
null | string

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page.

prevPaginationToken
null | string

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page.