> For the complete documentation index, see [llms.txt](https://developers.bead.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/can-i-view-payments-with-a-payment-api-key.md).

# Can I view payments with a Payment API key?

Yes. If you have a terminal-scoped Payment API key that can create a payment, you can also use that same key to retrieve payment history using the Payments endpoint filtered by terminalId.

This is the simplest way to confirm that payments are being created and to review recent transactions during early sandbox testing, without needing integrator admin credentials.

{% hint style="warning" %}
**`GET /Payments` is deprecated.** It still works, so existing sandbox tooling keeps running. For new work, use [Merchant Payments](https://developers.bead.xyz/reporting/merchant-payments.md) (`GET /Merchants/{id}/payments`) or [Partner Payments](https://developers.bead.xyz/reporting/partner-payments.md) (`GET /Partners/{id}/payments`). To check a single payment with a terminal Payment API key, use `GET /Payments/{paymentId}/tracking`.
{% endhint %}

### What this is for

Common use cases:

* Confirm a payment attempt was received and recorded by Bead
* Poll for new payments after launching a hosted payment page
* Show a basic “recent payments” list in a sandbox demo UI
* Diagnose “did the request reach Bead” without relying on network logs

### Credentials required

You need:

* A Payment API key (terminal scoped)
* A terminalId associated with that key

You do not need:

* Integrator admin credentials
* Access to integrator reporting endpoints (for example, /merchants/{id}/payments or /terminals/{id}/payments)

### Endpoint

`GET /Payments?TerminalId={terminalId}&Page={page}&PageSize={pageSize}` (deprecated)

This article focuses on `TerminalId` only to keep the quick start narrow and consistent with the most common sandbox setup.

### Example request (curl)

Copy and paste, then replace the placeholders with your values.

```bash
curl -X 'GET' \
  'https://api.test.devs.beadpay.io/Payments?TerminalId=<TERMINAL_ID>&Page=0&PageSize=50' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: <PAYMENT_API_KEY>'
```

Placeholder notes:

* \<TERMINAL\_ID> looks like a hex string similar to: 69a09eb79f5a9af290440fdd
* \<PAYMENT\_API\_KEY> is your terminal-scoped Payment API key value

### Example response

The response is a paged envelope of payment records, the same record shape returned by Merchant Payments. The example is abbreviated.

```json
{
  "data": [
    {
      "id": "<PAYMENT_ID>",
      "terminalId": "<TERMINAL_ID>",
      "paymentCode": "PMT-10452",
      "tenderType": "usdcBase",
      "statusCode": "completed",
      "created": "2026-02-27T12:34:56Z",
      "updated": "2026-02-27T12:35:41Z",
      "amounts": {
        "requested": {
          "inRequestedCurrency": { "amount": 12.34, "amountPrecision": 2, "currencyId": 101 }
        },
        "paid": {
          "inPaymentCurrency": { "amount": 12.34, "amountPrecision": 2, "currencyId": 207 }
        }
      },
      "refundLifecycleStatus": "notStarted"
    }
  ],
  "total": 1,
  "page": 0
}
```

See [Payment Statuses](https://developers.bead.xyz/payments/payment-statuses.md) for the meaning of each `statusCode`.

### Pagination guidance

Use these parameters:

* `Page`: zero-based page index (0 is the first page)
* `PageSize`: number of records per page, up to 100

Examples:

* First page, 50 results:
  * `Page=0&PageSize=50`
* Second page, 50 results:
  * `Page=1&PageSize=50`

For deeper guidance on pagination and sorting, see:\
[Pagination and sorting](https://developers.bead.xyz/reporting/payment-history-concepts/pagination-and-sorting.md)

### Recommended quick check workflow

1. Create a payment using your terminal Payment API key.
2. Call `GET /Payments/{paymentId}/tracking` with the `paymentId` from the create response to confirm the payment exists and see its status.
3. If you need a list of recent payments on the terminal, call `GET /Payments?TerminalId=...` while it remains available, or move to Merchant Payments when you have merchant level access.
4. For outcomes, use payment webhooks or the tracking endpoint, and use payment history as a supporting view.

### Common questions

#### Can I use merchantId instead?

Use [Merchant Payments](https://developers.bead.xyz/reporting/merchant-payments.md) (`GET /Merchants/{id}/payments`) when you have merchant level access. It is the supported replacement for listing a merchant's payments.

#### Why do I see older payments from other tests?

If multiple testers reuse the same terminalId, you will see each other’s payments. Use a unique terminal per tester if you want isolated history.

#### How fresh is the data?

In sandbox, payment records should appear quickly after creation. If you do not see a payment immediately, wait a few seconds and retry.

### Troubleshooting

#### 401 Unauthorized or 403 Forbidden

Most common causes:

* The X-Api-Key header is missing or invalid
* You are using the wrong key type (not a terminal Payment API key)
* The key is not authorized for the terminalId provided

How to fix:

* Confirm you are using the terminal-scoped Payment API key you were issued for sandbox
* Confirm the terminalId matches the scope of that key
* Confirm you are calling the sandbox base URL:
  * [https://api.test.devs.beadpay.io](https://api.test.devs.beadpay.io/)

#### 400 Bad Request

Most common causes:

* terminalId format is invalid
* `Page` or `PageSize` are missing or not integers

How to fix:

* Start from the sample curl and replace only \<TERMINAL\_ID> and \<PAYMENT\_API\_KEY>
* Ensure `Page` and `PageSize` are numeric values

#### Empty results but you know you made a payment

Most common causes:

* You used a different terminal for payment creation than the one you are querying
* You are querying the wrong environment base URL

How to fix:

* Confirm the terminalId used to create the payment matches the terminalId in the query
* Confirm you are using the test environment URL shown above

### Related pages

* [Test crypto transactions](https://developers.bead.xyz/payments/test-crypto-transactions.md)
* [How to test Klarna payments](https://developers.bead.xyz/faqs-and-troubleshooting/environment-and-testing/how-to-test-klarna-payments.md)
* [Pagination and sorting](https://developers.bead.xyz/reporting/payment-history-concepts/pagination-and-sorting.md) (payment history concepts)
* [Merchant Payments](https://developers.bead.xyz/reporting/merchant-payments.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.bead.xyz/faqs-and-troubleshooting/payments-faqs/can-i-view-payments-with-a-payment-api-key.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
