---
title: "Get shop payments"
method: GET
path: "/payments"
---

# Get shop payments

`GET /payments`

## Query parameters

- `status` 'ACCEPTED' | 'PENDING' | 'CANCELED'
- `limit` integer
- `starting_after` string
- `starting_after_timestamp` string

## Headers

- `Host` string, required
- `Date` string, required
- `Digest` string, required
- `Authorization` string, required
- `x-satispay-deviceinfo` string
- `x-satispay-devicetype` 'SMARTPHONE' | 'TABLET' | 'CASH REGISTER' | 'POS' | 'PC' | 'ECOMMERCE_PLUGIN'
- `x-satispay-os` string
- `x-satispay-osv` string
- `x-satispay-apph` string
- `x-satispay-appn` string
- `x-satispay-appv` string
- `x-satispay-tracking-code` string

## Response `200`

OK

- object
  - `has_more` boolean — Indicates whether there are additional items available beyond the current list.
  - `data` object[]
    - `id` string — The unique payment id. <br> <br> This can be used for every eventual subsequent operations on the payment, including refunds.
    - `code_identifier` string — The Satispay code identifier. <br> <br> This string can be encoded in a QR code that can be scanned by the user. <br> This property is only available in `MATCH_CODE` flow payments.
    - `type` string — The current payment type. <br> <br> `TO_BUSINESS` <br> This type is used for payments from a consumer to a merchant. <br> <br> `REFUND_TO_BUSINESS` <br> This type is used for payments from a merchant to a consumer (e.g. refunds).
    - `amount_unit` integer — The payment amount in cents. <br> <br> For example, the amount `€12.40` is being represented as `1240` cents.
    - `currency` 'EUR' — The payment currency.
    - `status` string — The current payment status. <br> This will depend on the request query param `status`. <br> <br> `PENDING` <br> The payment is created and awaits user interaction, such as scanning the QR code. <br> <br> `ACCEPTED` <br> The payment has been accepted and succesfully executed. <br> <br> `CANCELED` <br> The payment has been canceled, this could happen if: <br> - the consumer's explicitely declines it in the Satispay app. <br> - the merchant cancels it via the [Update payment API](https://developers.satispay.com/reference/-payment) with a `CANCEL` action. <br> - the payment reaches the `expiration_date` while in a `PENDING` or `AUTHORIZED` status.
    - `expired` boolean — The current payment expiration status. <br> <br> It becomes `true` once it reaches the `expiration_date` without being accepted or canceled.
    - `metadata` object — The additional metadata for the payment.
    - `sender` object — The sender payment actor.
      - `id` string — The unique sender id. <br> <br> This will only be available once the payment will be matched with a consumer.
      - `type` string — The sender type. <br> <br> `CONSUMER` <br> This sender type is used when the payment goes from a consumer to a merchant. <br> <br> `SHOP` <br> This sender type is used when the payment goes from a merchant to a consumer (e.g. refunds payments).
      - `name` string — The sender name. <br> <br> This will only be available once the payment will be matched with a consumer.
    - `receiver` object — The receiver payment actor.
      - `id` string — The unique receiver id.
      - `type` string — The receiver type. <br> <br> `CONSUMER` <br> This receiver type is used when the payment goes from a merchant to a consumer. <br> <br> `SHOP` <br> This receiver type is used when the payment goes from a consumer to a merchant (e.g. refunds payments).
    - `daily_closure` object — This property is available only for `ACCEPTED` payments and with type `TO_BUSINESS`.
      - `id` string — The [daily closure](https://developers.satispay.com/reference/retrieve-daily-closure) id.
      - `date` string — The [daily closure](https://developers.satispay.com/reference/retrieve-daily-closure) date.
    - `insert_date` string — The UTC payment creation datetime.
    - `expire_date` string — The UTC payment expiration datetime.

## Other responses

- `400` — 400 Bad Request
- `401` — 401 Unauthorized
- `403` — 403 Forbidden or invalid authorization header

---

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