GET
List payment requests (v2)

Authorizations

Authorization
string
header
required

The user's access_token from authentication. The program and environment come from the token.

Path Parameters

customerId
string
required

Customer identifier.

accountId
string
required

Account identifier. The account determines which optional features and limits apply.

Query Parameters

status
string

PENDING, PENDING_TM, INITIATED, PENDING_CANCELLATION, COMPLETED, FAILED (comma-separated). Default: PENDING,PENDING_TM,INITIATED,PENDING_CANCELLATION.

paymentStatus
string

Alias for status; status wins when both are sent.

type
string

CUSTOMER, BATCH, CARD, SETTLEMENT, FEE (comma-separated). Default: CUSTOMER,BATCH,CARD,SETTLEMENT: SETTLEMENT rows come back unless you pass an explicit type.

id
string

Filter to specific payment requests by id (comma-separated). paymentRequestId is accepted as an alias.

subType
string

REFUND, COLLECT, SEND, SCHEDULED, AUTHORIZATION (comma-separated).

providerRequestId
string

Filter by provider-side request id (comma-separated).

batchItemId
string

Filter by batch item id (comma-separated).

childAccountId
string

Filter by child account on prepaid master accounts (comma-separated).

transactionMonitoring
string

Filter by transaction-monitoring state (comma-separated). A filter only: the state itself is not returned on this surface.

isDirectDebit
enum<string>

Filter SEPA direct debit COLLECT rows. true = only direct debits; false = exclude direct debits (also matches rows that never stamped the flag).

Available options:
true,
false,
1,
0
currency
string
startDate
string<date>
endDate
string<date>
page
integer
default:1

Page number, from 1. page × limit may not exceed 10000: deeper pages are a search error.

Required range: 1 <= x <= 10000
limit
integer
default:10
Required range: 1 <= x <= 10000
sortBy
string
default:createdDateTime
sortOrder
enum<string>
default:desc
Available options:
asc,
desc

Response

One page of payment requests

success
enum<boolean>
required
Available options:
true
data
object[]
required
total
integer
required

Matches across all pages

page
integer
limit
integer