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

# List payments

`GET /api/v1/payments`

## Request

- Base URL: `https://merchant.zahlo.eu`
- URL: `https://merchant.zahlo.eu/api/v1/payments`
- Auth: API key in header `x-api-key`

List payments. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

## Query parameters

- `limit` integer
- `startingAfter` string
- `endingBefore` string
- `customerId` string

## Response `200`

Successful response

- object
  - `object` 'list', required
  - `data` Payment[], required
    - `id` string, required
    - `object` 'payment', required
    - `livemode` boolean, required
    - `createdAt` string, date-time, required
    - `status` 'pending' | 'succeeded' | 'failed' | 'cancelled', required
    - `amountMinor` integer, required
    - `amountRefundedMinor` integer, required
    - `refunded` boolean, required
    - `currency` string, required
    - `paymentMethod` object, nullable
      - `type` string
    - `outcome` object
      - `threeDSecure` string, nullable
      - `riskLevel` string, nullable
      - `providerReason` string, nullable
    - `customerId` string, nullable
    - `subscriptionId` string, nullable
    - `checkoutSessionId` string, nullable
    - `paymentLinkId` string, nullable
    - `receiptNumber` string, nullable
    - `receiptUrl` string, nullable
    - `reference` string, nullable
    - `metadata` object, required: Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.
    - `disputed` boolean, required
  - `hasMore` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `404`: Resource not found
- `409`: Request conflicts with existing state

---

[API](https://skmtc.dev/zahlo/apis/zahlo-merchant-api.md) - [All operations](https://skmtc.dev/zahlo/apis/zahlo-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zahlo/apis/zahlo-merchant-api/revisions/8fcbef981e0d?raw)