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

# List payments

`GET /v1/payments`

Return a paginated list of payments your organization has received, newest first. Filter with query parameters for reconciliation and monitoring. List items carry a summary of each payment; call Retrieve a payment for the full object including fees, products, and status history.

## Query parameters

- `limit` integer
- `offset` integer
- `status_filter` 'created' | 'processing' | 'succeeded' | 'accepted' | 'failed' | 'expired' | 'cancelled' | 'refunded' | 'partially_refunded' | 'underpaid' | 'overpaid'

## Response `200`

Success - Payments list retrieved

- PaymentListResponse — A paginated list of payments.
  - `items` PaymentListItemResponse[], required — Payments for the current page.
    - `reference` string, nullable — Checkout reference for this payment when available.
    - `id` string, nullable — payment ID for retrieval and reconciliation.
    - `status` string, required — Current payment status for this payment.
    - `is_refundable` boolean, nullable — Whether this payment is currently eligible for refund operations.
    - `amount` string, required — Requested payment amount in `currency`.
    - `customer_name` string, required — Customer full name from checkout data. May be empty when unavailable.
    - `customer_email` string, required — Customer email from checkout data. May be empty when unavailable.
    - `amount_paid` string, nullable — Amount received so far for this payment.
    - `amount_remaining` string, nullable — Remaining amount expected before full completion.
    - `settlement_amount` string, nullable — Settlement-side amount captured for this payment.
    - `settlement_currency` string, nullable — Settlement currency code for `settlement_amount`.
    - `fee` string, nullable — Reserved fee field in list responses. May be null.
    - `vat` string, nullable — Reserved VAT field in list responses. May be null.
    - `currency` string, required — Payment currency code.
    - `meta` object, nullable — Public metadata attached to the payment when available.
    - `transaction_date` string, date-time, nullable — ISO 8601 timestamp when the payment was created.
    - `completed_at` string, date-time, nullable — ISO 8601 timestamp when the payment reached a successful terminal state.
  - `pagination` PaymentPagination, required — Pagination details for a payments list.
    - `next_cursor` string, nullable — Cursor for the next page, or `null` on the last page.
    - `prev_cursor` string, nullable — Cursor for the previous page, or `null` on the first page.
    - `has_more` boolean, required — Whether more results exist after this page.
    - `limit` integer, required — The page size that was applied.
    - `offset` integer, required — The offset that was applied.
    - `returned` integer, required — Number of items returned on this page.
    - `total` integer, required — Total number of payments matching the query.

## Other responses

- `400` — Bad Request - Validation errors or invalid request format. Check the `details` object for field-specific validation errors. Common causes: missing required fields, invalid data types, values outside allowed ranges, or invalid formats.
- `401` — Unauthorized - Invalid, missing, or expired API key. Verify your API key is correctly formatted and included in the Authorization header as `Bearer sk_sandbox_...` or `Bearer sk_live_...`. Check that your key hasn't been revoked.
- `403` — Forbidden - API key does not have permission for the requested resource. Verify you're using the correct organization's API key and that you're not trying to access another organization's data.
- `404` — Not Found - The requested resource does not exist. Verify the resource ID is correct and that it belongs to your organization.
- `429` — Too Many Requests - Rate limit exceeded. Standard tier allows 100 requests per minute per API key. Wait a few seconds before retrying. Check X-RateLimit-Reset header for when the window resets.
- `500` — Internal Server Error - An unexpected error occurred while processing the request. Retry with exponential backoff. If the issue persists, contact support with your request context.

---

[API](https://skmtc.dev/bachs/apis/bachs-api.md) · [All operations](https://skmtc.dev/bachs/apis/bachs-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bachs/bachs-api/revisions/f29efa8a22df/schema)