Get All Payments

Get All Payments

get

Get All Payments

The Get all payments operation retrieves information about your payments. This operation returns a default of 200 payment records per call.

Resource URL

https://api.stubcloudprod.com/sellers/sales /payments/v3

Query Parameters


Name Values Description
filters

**Optional Parameter** Filter criteria that will be used to refine the set of payment records. Syntax: `property:value` Multiple filters can be provided separated by comma. Possible filter parameters: - `dateLastModified: yyyy-MM-dd'T'hh:mi:ss'Z'` - `paymentInitiatedDate: yyyy-MM-dd'T'hh:mi:ss'Z'` Examples: - `filters=dateLastModified:[2018-11-16T06:43:55ZTO2018-11-16T06:43:55Z]` - `paymentInitiatedDate:2016-12-09 TO 2017-01-01` - `paymentInitiatedDate:[2016-12-09T00:00:00.000Z TO 2017-01-01T23:59:59.000Z]` - `paymentInitiatedDate:[NOW TO *]` - `paymentInitiatedDate:[NOW-30DAYS TO NOW]` Default: Last 90 days

sort

Optional Parameter: A pair of space-separated tokens that specifies how the payment transactions are sorted. - First token identifies property of the payment transactions for sorting. For the first token, you can specify any one of the following properties: `orderID`, `paymentAmount`, `status`, `paymentType`, `paymentInitiatedDate` - Second token specifies the direction of the sort. For the second token, you can specify one of the following types: `asc` for ascending order, `desc` for descending order Example: `paymentAmount asc`, `paymentInitiatedDate desc`

start

The index of the first payment transaction, within the filtered and sorted set. Indices are 0-based i.e., the syntax for specifying the first sale is start=0.

rows

The number of transactions you wish to retrieve. Default is 200, which is also the maximum number of rows returned by this API at a time


Header Parameters


Name Values Description
Authorization
(required)

To generate an access token, use the [generateToken API](https://developer.stubhub.com/oauth/apis/post/accesstoken). Note that you will need to add a 'Bearer ' prefix to your access token. Otherwise, you'll get an 'Invalid Access Token' error

Accept
(required)

application/json

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 404
    404

    Not Found

  • 401
    401

    Not authorized to access the listing

  • 403
    403

    Forbidden

  • 500
    500

    accountmanagement.sales.systemError

Resource Summary

Security

Content Type

application/json

Category

Get All Payments

Working...