---
title: "Get a list of payments"
method: GET
path: "/payments"
---

# Get a list of payments

`GET /payments`

[Available in Production/Sandbox environment] Retrieve payments made via bank transfer or PayNow

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `sort` string
- `filter[currency]` string
- `filter[from]` string
- `filter[to]` string
- `filter[paymentMethodType]` string
- `filter[status]` string

## Headers

- `X-XFERS-APP-API-KEY` string, required
- `X-PUBLIC-KEY-ID` string
- `X-TIMESTAMP` string
- `X-NONCE` string
- `X-SIGNATURE` string

## Response `200`

200

- object
  - `data` object[]
    - `id` string — Payment contract ID.
    - `type` string — Payment type.
    - `attributes` object
      - `idempotencyId` string — Idempotency ID for this transaction.
      - `currency` string — Transaction currency.
      - `amount` string — Transaction amount.
      - `fees` string — Additional transaction fees charged.
      - `status` string — Transaction status.
      - `createdAt` string — Timestamp when the transaction was created.
      - `senderInformation` object — Sender information.
        - `accountHolderName` string — Sender's bank account holder name.
        - `accountNumber` string — Sender's bank account number.
        - `bankName` string — Sender's bank name.
        - `endToEndRef` string — End user’s added comments/notes.
        - `swiftBic` string — Sender's bank SWIFT/BIC code.
        - `transactionRemarks` unknown
      - `paymentMethod` object — Payment method details.
        - `id` string — Payment method ID.
        - `referenceId` string — Reference ID.
        - `base64EncodedImage` string — [PayNow only] Base64-encoded PayNow QR image for the PayNow payment method.
        - `expiresAt` string — [PayNow only] Timestamp when the transaction QR expires.
        - `accountNo` string — [Bank transfer only] Bank account number.
        - `bankShortCode` string — [Bank transfer only] Bank short code.
        - `recipientName` string — [Bank transfer only] Recipient name.
      - `blockedReasons` unknown[] — Reason blocking the transaction, if any.
        - unknown
  - `meta` object — Metadata about the returned list, such as pagination details.
    - `total` integer — Total count.
    - `pages` integer — Page size.
  - `links` object — URLs related to the paginated result set.
    - `self` string — The URL of the current request/page.

---

[API](https://skmtc.net/straitsx/apis/straitsx-sandbox-base-url.md) · [All operations](https://skmtc.net/straitsx/apis/straitsx-sandbox-base-url/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/straitsx/straitsx-sandbox-base-url/versions/9ceee2969aeb/schema)
