---
title: "Get a list of payments for a customer profile v2"
method: GET
path: "/{customer_profile_id}/payments"
---

# Get a list of payments for a customer profile v2

`GET /{customer_profile_id}/payments`

## Request

- Base URL: `https://api-sandbox.straitsx.com/v1/customer_profile`
- URL: `https://api-sandbox.straitsx.com/v1/customer_profile/{customer_profile_id}/payments`
- Auth: none required

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

## Path parameters

- `customer_profile_id` string, required

## 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. Either `bankTransferTransaction` or `paynowTransaction`.
    - `attributes` object
      - `idempotencyId` string: Idempotency ID for the transaction.
      - `customerProfileId` string: Customer profile ID.
      - `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 (Singapore timezone).
      - `senderInformation` object: Sender information.
        - `accountHolderName` string, nullable: Sender's bank account holder name.
        - `accountNumber` string, nullable: Sender's bank account number.
        - `bankShortCode` string, nullable: Sender's bank abbreviation code.
        - `bankName` string, nullable: Sender's bank name.
        - `endToEndRef` string, nullable: End user's added comments/notes.
        - `swiftBic` string, nullable: Sender's bank SWIFT/BIC code.
        - `transactionRemarks` string, nullable: Transaction remarks from sender.
      - `paymentMethod` union: Payment method details. Shape varies by transaction type.
        - object
          - `id` string: Payment method unique ID.
          - `referenceId` string: Payment method reference ID.
          - `accountNo` string: Bank account number.
          - `bankShortCode` string: Bank abbreviation code.
          - `bankName` string, nullable: Full bank name.
          - `bankAddress` string, nullable: Bank address.
          - `bankCountry` string, nullable: Bank country.
          - `swiftBic` string, nullable: Bank SWIFT/BIC code.
          - `recipientName` string: Recipient display name.
        - object
          - `id` string: Payment method unique ID.
          - `referenceId` string: Payment method reference ID.
          - `virtualPaymentAddress` string: PayNow virtual payment address (UEN or proxy).
          - `base64EncodedImage` string: Base64-encoded QR code image.
          - `expiresAt` string: QR code expiry timestamp.
      - `blockedReasons` object[]: Reasons blocking the transaction, if any.
        - `code` string: Blocked reason code.
  - `meta` object
    - `total` integer: Total number of results.
    - `pages` integer: Total number of pages.
  - `links` object
    - `self` string: Link to the current page.

---

[API](https://skmtc.dev/straitsx/apis/sandbox-customer-profile-api-sandbox-prod.md) - [All operations](https://skmtc.dev/straitsx/apis/sandbox-customer-profile-api-sandbox-prod/llms.txt) - [OpenAPI document](https://skmtc.dev/straitsx/apis/sandbox-customer-profile-api-sandbox-prod/revisions/fba039809316?raw)