> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List payments

> List the payments an account has made, with their receipt links; returns one page of payments with amounts in minor currency units.

`veryfront__list_payments`

Requires account.billing.read.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Read-only.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `sort_by` | `string` | No | Sort field of the returned page. Defaults to "date". Pages follow Stripe order, newest first; sorting orders the returned page only. Default: `"date"`. Values: `"date"`, `"amount"`. |
| `sort_order` | `string` | No | Sort order of the returned page. Defaults to "desc". Default: `"desc"`. Values: `"asc"`, `"desc"`. |
| `limit` | `integer` | No | Maximum number of payments to return, 1 to 100. Defaults to 20. Default: `20`. Minimum: `1`. Maximum: `100`. |
| `cursor` | `string` | No | Opaque cursor pointing at the next page. Omit it to read the first page. Minimum length: `1`. |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_payments",
    "arguments": {}
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `data` | `object[]` | Yes | Primary result records returned by the tool. |
| `page_info` | `object` | Yes | Pagination cursor values for traversing the result set. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "sort_by": {
      "type": "string",
      "enum": [
        "date",
        "amount"
      ],
      "description": "Sort field of the returned page. Defaults to \"date\". Pages follow Stripe order, newest first; sorting orders the returned page only.",
      "default": "date"
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort order of the returned page. Defaults to \"desc\".",
      "default": "desc"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Maximum number of payments to return, 1 to 100. Defaults to 20.",
      "default": 20
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "description": "Opaque cursor pointing at the next page. Omit it to read the first page."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_payments tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "status": {
            "type": [
              "string",
              "null"
            ],
            "description": "Lifecycle status for the returned record."
          },
          "paid": {
            "type": "boolean"
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable description returned by the tool."
          },
          "receipt_url": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "null",
                "description": "The receipt url returned by the tool."
              }
            ]
          },
          "invoice_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "payment_intent_id": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "status",
          "paid",
          "amount",
          "currency",
          "created_at",
          "description",
          "receipt_url",
          "invoice_id",
          "payment_intent_id"
        ],
        "additionalProperties": false
      },
      "description": "Primary result records returned by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_payments tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__list_payments` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.