Payment Transaction

Search Payments

get

Retrieve a list of payments based on search and filter criteria.

Query parameters

customer-keystringRequired

Filters payment by the unique identifier of the associated customer.

plan-keystringRequired

Filters results by the unique identifier of the payment plan.

pageintegerRequired

Specifies the page number of results to return when pagination is applied.

page-sizeintegerRequired

Specifies the number of results to return per page.

isDescendingbooleanRequired

Specifies the sort order of the results. Set to true for descending order. Default is true.

order-bystringRequired

Specifies the field used to sort the results.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/payments

HTTPcURLJavaScriptPython

GET /rest/v2/payments?customer-key=text&plan-key=text&page=1&page-size=1&isDescending=true&order-by=text HTTP/1.1
api-key: text
Accept: */*

{
  "searchGetPaymentTransactions": [
    {
      "viewId": 1,
      "paymentId": 1,
      "transactionId": 1,
      "achTransactionId": "text",
      "paymentStatus": "STARTED",
      "scheduledDateTime": "2026-02-03T09:06:28.719Z",
      "fired": "2026-02-03T09:06:28.719Z",
      "completed": "2026-02-03T09:06:28.719Z",
      "exchangeId": "text",
      "result": "text",
      "planName": "text",
      "merchantId": "text",
      "customerKey": "text",
      "amount": 1,
      "authorizationCode": "text",
      "avsResult": "text",
      "avsStreet": "text",
      "avsZip": "text",
      "batchStringID": "text",
      "billingIsShipping": 1,
      "cardHolder": "text",
      "cardType": "text",
      "clientIp": "text",
      "comments": "text",
      "created": "2026-02-03T09:06:28.719Z",
      "cscResult": "text",
      "gatewayCustomerId": "text",
      "description": "text",
      "emailAddress": "text",
      "entryMethod": 1,
      "errorCode": "text",
      "expired": 1,
      "expiryDate": "text",
      "firstName": "text",
      "invoice": "text",
      "lastFour": "text",
      "lastName": "text",
      "locationCity": "text",
      "locationCountry": "text",
      "locationMeta": "text",
      "locationState": "text",
      "orderId": "text",
      "purchaseOrder": "text",
      "reason": "text",
      "refundTotal": "text",
      "response": "text",
      "resultCode": "text",
      "status": "text",
      "switchId": 1,
      "transactionType": "text",
      "voidCount": 1,
      "batchId": 1,
      "originatorId": 1,
      "refTranId": 1,
      "terminalId": 1,
      "tipAmount": 1,
      "originalAmount": 1,
      "tipAdjusted": 1,
      "tipAdjustmentAmount": 1,
      "customerTokenID": "text",
      "customerID": "text",
      "paymentTransactionKey": "text",
      "paymentTransactionId": 1,
      "planDetailKey": "text",
      "planKey": "text",
      "paymentType": "text"
    }
  ],
  "page": {
    "number": 4,
    "size": 4,
    "sort": {
      "field": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "first": true,
    "last": true,
    "total-pages": 4,
    "number-of-elements": 102,
    "total-elements": 102
  }
}