Get all payments

get

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/payment

Returns a paged list of payments matching the supplied filter criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

merchantId

int32

Merchant Id

replayId

int64

Filter by replay identifier to retrieve a specific payment (e.g. terminal transaction lookup after timeout).

transactionType

string

Type of the transaction

tenderType

string

Tender Type

status

string

The status.

source

string

The Source.

batch

string

The batch.

minAmount

double

The minimum amount.

maxAmount

double

The maximum amount.

filter

string

Full text filter.

startDate

date-time

The start date.

endDate

date-time

The end date.

dateType

string

enum

Date range: Day, Yesterday, Week, Month, Last7, Last30, Year, Lifetime, Custom

hasReviewIndicator

boolean

Whether the payment has loss prevention indicator

limit

int32

Defaults to 10

The limit.

offset

int32

Defaults to 0

The offset.

isB2B

boolean

Defaults to false

MXB2B App

includeTotals

boolean

Defaults to false

Include payment totals in result (saleCount, refundCount, netAmount, etc.).

includeCustomer

boolean

Defaults to false

Include customer information with each payment.

includeInvoices

boolean

Defaults to false

Return invoice information with the payment.

Responses

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.

400The request could not be accepted by the MXM server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

401The request could not be authenticated. The API key or access token may be missing, invalid, or expired.

403The authenticated user does not have permission to perform this action on the requested resource.

422The MXM server understood the request but was unable to process it due to semantic errors or invalid field values in the request body.

500An unexpected error occurred on the MXM server. If the issue persists, please contact support.

503The MXM server is temporarily unable to handle the request. Please retry after a short delay.