---
title: "GET /api/payments"
method: GET
path: "/api/payments"
tags: ["api", "payments"]
---

# GET /api/payments

`GET /api/payments`

Get Payments

## Query parameters

- `top` string
- `skip` string
- `paymentRequestId` string
- `checkoutId` string
- `reference` string — The reference to filter for
- `gatewayId` string — The payment gateway id to filter for
- `createdAt` object — Range of dates to filter by when the payment was created in ISO format.
  - `$gt` string, date-time — value is greater than
  - `$gte` string, date-time — value is greater than or equal
  - `$lt` string, date-time — value is less than
  - `$lte` string, date-time — value is less than or equal
  - `$eq` string, date-time — value is equal
  - `$ne` string, date-time — value is not equal

## Response `200`

OK

- GETPaymentsGetPayments200Response
  - `docs` PaymentRequestResource[]
    - `_id` string, required — The ID of the payment request
    - `secret` string, required — The secret token of the payment request
    - `amount` number, float — The amount which needs to be paid
    - `currency` 'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' — An ISO 4217 3-character code of the currency
    - `checkoutId` string — The ID of the checkout that request belongs to
    - `subscriptionId` string — The ID of the subscription that request belongs to
    - `paymentPlanId` string — The ID of the payment plan that request belongs to
    - `paymentGatewayId` string — The ID of the payment gateway responsible for the payment
    - `reference` string
    - `processors` PaymentRequestProcessorResource[]
      - `paymentGatewayType` 'stripe' | 'paypal' | 'adyen' | 'custom' | 'cardconnect' | 'worldline' | 'shift4' | 'authorizenet' | 'wallee' | 'square' | 'payfast' | 'touchnet' | 'transact' | 'unzer' | 'monext' | 'vivenuPayments' | 'ebanx' | 'rapyd' | 'momentusPayments' | 'additional-payment-method', required
      - `paymentGatewayId` string
      - `reference` string
      - `redirectUrl` string
      - `data` union
        - boolean
        - number
        - object
        - string
      - `createdAt` string, date-time, required — An ISO timestamp indicating when the payment request processor was created
    - `status` 'NEW' | 'SUCCEEDED' | 'CANCELED', required
    - `history` object[]
      - `type` 'payment_request.created' | 'payment_request.details_submitted' | 'payment_request.verified' | 'payment_request.confirmed' | 'payment_request.succeeded' | 'payment_request.canceled', required
      - `date` string, date-time, required — An ISO timestamp indicating when the history entry was added
      - `data` union
        - boolean
        - number
        - object
        - string
    - `applications` object[]
      - `amount` number, float, required — The amount of the application
      - `method` 'deposit' | 'customer_balance', required — The method of the application
    - `customer` object
      - `customerId` string — The ID of the customer of the payment request
      - `email` string, email — The email of the user of the payment request
      - `country` string — The country of the user of the payment request
    - `sellerId` string, required
    - `expiresAt` string, date-time — An ISO timestamp indicating when the payment request will expire and a new one will be created if requested
    - `createdAt` string, date-time, required — An ISO timestamp indicating when the payment request was created
    - `updatedAt` string, date-time, required — An ISO Timestamp indicating when the payment request was last updated
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)