---
title: "Search payments"
method: GET
path: "/rest/v2/payments"
tags: ["Payment Transaction"]
---

# Search payments

`GET /rest/v2/payments`

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

## Query parameters

- `customer-key` string, required
- `plan-key` string, required
- `page` integer, required
- `page-size` integer, required
- `isDescending` boolean, required
- `order-by` string, required

## Headers

- `api-key` string, required

## Response `200`

ok

- SearchGetPaymentTransactionPayload
  - `searchGetPaymentTransactions` SearchGetPaymentTransaction[]
    - `viewId` integer — Identifier for the transaction view.
    - `paymentId` integer — Unique identifier of the payment.
    - `transactionId` integer — Identifier of the transaction.
    - `achTransactionId` string — Identifier of the ACH transaction.
    - `paymentStatus` 'STARTED' | 'APPROVED' | 'DECLINED' | 'ERROR' — Current status of the payment.
    - `scheduledDateTime` string, date-time — Date when the payment was scheduled.
    - `fired` string, date-time — Date when the payment was initiated.
    - `completed` string, date-time — Date when the payment completed.
    - `exchangeId` string — Identifier used to trace the transaction exchange.
    - `result` string — Result message returned by the processor.
    - `planName` string — Name of the pricing or billing plan.
    - `merchantId` string — The merchant's unique identification number.
    - `customerKey` string — System generated customer key.
    - `amount` number — Transaction amount.
    - `authorizationCode` string — Authorization code returned by the processor.
    - `avsResult` string — Address Verification Service (AVS) result code.
    - `avsStreet` string — AVS street address.
    - `avsZip` string — AVS ZIP code.
    - `batchStringID` string — Processor batch identifier.
    - `billingIsShipping` integer — Indicates whether the billing address matches the shipping address.
    - `cardHolder` string — Name of the card holder.
    - `cardType` string — Type of the card.
    - `clientIp` string — IP address from which the transaction originated.
    - `comments` string — Additional comments associated with the transaction.
    - `created` string, date-time — Date when the transaction record was created.
    - `cscResult` string — CSC verification result.
    - `gatewayCustomerId` string — Identifier of the customer as stored in the payment gateway.
    - `description` string — Description associated with the transaction.
    - `emailAddress` string — Customer's email address.
    - `entryMethod` integer — Method used to enter the payment information.
    - `errorCode` string — Error code returned when the transaction fails.
    - `expired` integer — Indicates whether the payment or authorization has expired.
    - `expiryDate` string — Expiration date of the card.
    - `firstName` string — Customer's first name.
    - `invoice` string — Invoice number associated with the payment.
    - `lastFour` string — Last four digits of the card number.
    - `lastName` string — Customer's last name.
    - `locationCity` string — City where the transaction occurred.
    - `locationCountry` string — Country where the transaction occurred.
    - `locationMeta` string — Additional location metadata.
    - `locationState` string — State where the transaction occurred.
    - `orderId` string — Merchant-defined order identifier
    - `purchaseOrder` string — Purchase order number associated with the payment.
    - `reason` string — Reason provided for the transaction result
    - `refundTotal` string — Total amount refunded for the transaction.
    - `response` string — Processor response message.
    - `resultCode` string — Processor result code for the transaction.
    - `status` string — Overall transaction status.
    - `switchId` number — Identifier of the processing switch.
    - `transactionType` string — Type of transaction performed.
    - `voidCount` integer — Number of times the transaction was voided.
    - `batchId` number — Identifier of the batch that includes the transaction.
    - `originatorId` number — Identifier of the transaction originator.
    - `refTranId` number — Reference ID of the related transaction.
    - `terminalId` number — Identifier of the terminal used for processing.
    - `tipAmount` number — Tip amount applied to the transaction.
    - `originalAmount` number — Original transaction amount before adjustments.
    - `tipAdjusted` integer — Indicates whether the tip was adjusted.
    - `tipAdjustmentAmount` number — Amount used to adjust the tip.
    - `customerID` string — Unique identifier of the customer.
    - `customerTokenID` string — Tokenized identifier for the customer payment method.
    - `paymentType` string — Type of payment method used.
    - `planDetailKey` string — Identifier of the plan detail configuration.
    - `planKey` string — Unique identifier of the plan.
    - `paymentTransactionId` integer — Unique identifier of the payment transaction record.
    - `paymentTransactionKey` string — Unique key for the payment transaction.
  - `page` Page — Pagination metadata for the result set.
    - `number` integer — Index of the current page. Increment to request the next page.
    - `size` integer — Number of records returned per page.
    - `totalElements` integer — Total number of matching merchant records.
    - `last` boolean — Specifies whether the current page is the last in the result set.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/revisions/f37077c24b66/schema)