---
title: "Get a list of all xs2a.pay transaction objects"
method: GET
path: "/payments"
tags: ["XS2A.pay"]
---

# Get a list of all xs2a.pay transaction objects

`GET /payments`

Get a list of all xs2a.pay transactions, or filter using query parameters.

## Query parameters

- `sender_holder` string
- `sender_iban` string
- `sender_bic` string
- `sender_account_number` string
- `sender_bank_code` string
- `sender_country_id` 'DE' | 'AT' | 'CH' — The 2-letter country code
- `recipient_holder` string
- `recipient_iban` string
- `recipient_bic` string
- `recipient_country_id` 'DE' | 'AT' | 'CH' — The 2-letter country code
- `amount` number, float
- `purpose` string
- `per_page` integer
- `page` integer
- `from` string, date-time
- `to` string, date-time
- `since` string, date-time

## Response `200`

Request successfully processed

- PayTransactionList
  - `total` integer — Total number of results.
  - `per_page` integer — Number of objects per page
  - `current_page` integer — Current page.
  - `last_page` integer — Last page, usually the total of available pages.
  - `from` integer — Showing results from index element.
  - `to` integer — Showing results to index element.
  - `data` PayObject[]
    - `id` string — Transaction id
    - `transaction` string — Internal XS2A transaction id. This id will be the same for the whole transaction
    - `sender_holder` string — Account holder of the sender account
    - `sender_iban` string — IBAN of the sender account
    - `sender_bic` string — BIC of the sender account
    - `sender_bank_name` string — Name of the sender bank
    - `sender_country_id` 'DE' | 'AT' | 'CH' — The 2-letter country code
    - `recipient_holder` string — Account holder of the recipient account
    - `recipient_iban` string — IBAN of the recipient account
    - `recipient_bic` string — BIC of the recipient account
    - `recipient_bank_name` string — Name of the recipient bank
    - `recipient_country_id` 'DE' | 'AT' | 'CH' — The 2-letter country code
    - `purpose` string — Purpose of transfer
    - `amount` number, float — Amount to transfer
    - `currency_id` 'EUR' | 'CHF' — The id of the currency to be used.
    - `testmode` string — Indicates whether or not it is a test transaction
    - `payment_status` 'NONE' | 'RECEIVED' | 'LOSS' — Payment status of the transaction. By default, this will be `NONE` and will not automatically be set to anything else, unless you are using the account reconciliation feature, or you are changing it yourself (either via the dashboard or the API). The status `NONE` means that the payment was initiated but not found on the recipient account (default value). The status `RECEIVED` means that the payment was found on the recipient account, which is determined either by the mentioned reconciliation feature or manually by you. `LOSS` means, that the payment has not been found on the recipient account after >= 5 days. Maintaining clean and accurate tracking of `payment_status` helps you with fraud prevention. It allows you to specify rules in our fraud prevention tool (e.g. how many pending transactions (status `NONE`) you allow from a certain bank account.)
    - `metadata` Metadata, nullable — An array of data which will be passed back to your application. With this field you can for example pass information about your customer ids, order ids and the like back to your application. Please beware of some restrictions for the metadata field: maximum of 3 values, maximum of a key length of 20 characters, maximum length of values is 128 characters. For privacy protection reason it is not allowed to use this field for transferring personal data (e.g. names or addresses).
    - `merchant_id` string — Data will be returned unchanged
    - `object` string — Object type, in this case a xs2a_payment

## Other responses

- `401` — Authentication failed API key missing or not valid
- `403` — Forbidden Access blocked
- `404` — Product not enabled or Not found The requested object does not exist on the server
- `422` — Validation failed Something is wrong with the user input
- `500` — An internal server problem occurred

---

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