---
title: "List Payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List Payments

`GET /payments`

## Request

- Base URL: `https://openapi.n3xt.io`
- URL: `https://openapi.n3xt.io/payments`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/n3xt/apis/n3xt-api-documentation/docs/payments/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of all payments made by the authenticated user.

## Query parameters

- `status` string
- `walletId` string
- `startDate` string
- `endDate` string
- `amountGreaterThan` string
- `amountLessThan` string
- `senderBusinessId` string
- `recipientBusinessId` string
- `businessId` string
- `description` string
- `orderBy` 'createdAt' | 'updatedAt'
- `order` 'asc' | 'desc'
- `limit` number, double
- `offset` number, double

## Response `200`

The list of payments was retrieved successfully.

- union
  - Payment[]
    - `id` string, required
    - `sender` string
    - `senderBusinessId` string
    - `senderBusinessName` string
    - `senderWalletAddress` string
    - `recipient` string
    - `recipientBusinessId` string
    - `recipientBusinessName` string
    - `recipientWalletAddress` string
    - `amount` union, required
      - string
      - number, double
    - `status` 'queued' | 'requested' | 'initiated' | 'lockbox' | 'released' | 'cancelled' | 'declined' | 'completed' | 'failed' | 'burned' | 'minted' | 'transferred' | 'confirmed' | 'reverted', required
    - `description` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `totalCount` number, double
    - `rowNum` number, double
  - ErrorResponse
    - `error` string, required

## Other responses

- `400`: Bad Request - Invalid request parameters.
- `401`: Unauthorized - Invalid or missing authentication token.
- `404`: Not Found - No payments associated with this user were found.
- `500`: An unexpected server error occurred while trying to retrieve the payments.

---

[API](https://skmtc.dev/n3xt/apis/n3xt-api-documentation.md) - [All operations](https://skmtc.dev/n3xt/apis/n3xt-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/n3xt/apis/n3xt-api-documentation/revisions/c634c45cd5b4?raw)