v1

latestOpenAPI 3.0.12026-08-063289122.7 KB
PaymentRequests

Get all Payment Requests for selected organizationId.

get/v1/payments

Query parameters

searchClientIdstring

Search by client identifier

searchRecipientstring

Search by recipient

searchStatusstring

Search by payment request status, comma separated (E.G. "AUTHORIZED, IN_PROGRESS" will fetch only payments with AUTHORIZED and IN_PROGRESS status).

searchClientAccessstring

Environment on which the call has been invoked, comma separated (e.g. "PRODUCTION, SANDBOX", or "SANDBOX"). Blank returns all.

sortBystring

Sort response by clientId, recipient, status

sortDirectionstring

Sort direction "desc" or "asc"

pageIndexinteger

Page index

pageSizeinteger

Items per page

Response

Request was fulfilled and Payment Requests are listed.

totalItemsCountinteger