List Returns

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/return/list

Retrieve a filtered and paginated list of ACH return records matching the specified search criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Details required to retrieve all returns.

criteria

object

required

limit

int64

The total count of records that should be returned. Default limit: 100. Acceptable range: between 1 and 100.

offset

int64

Id of the last record returned with the current call. To filter by offset, sort by id is required i.e. either ASC or DESC sort by id.

pageNumber

int64

Page number for which the records should be returned.

pageSize

int64

Number of records to be returned per page. Default limit: 100.

getTotalCount

boolean

To get, in response, the total count of the records that can be fetched using the filter in API request.

sortOptions

object

Headers

PromiseMode

string

enum

required

This is a mandatory field, user must provide input either 'ALWAYS' or 'NEVER'. 'NEVER' - For immediate response, 'ALWAYS' - For later response.

Allowed:

Responses

400

The request could not be processed. Check for missing required fields, invalid values, or incorrect data formats.

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

500

An unexpected error occurred on the Passport server while processing the request.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Request completed successfully as expected.