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

# Get a list of payments for a customer profile v1

`GET /{customer_profile_id}/deposits`

## Request

- Base URL: `https://api-sandbox.straitsx.com/v1/customer_profile`
- URL: `https://api-sandbox.straitsx.com/v1/customer_profile/{customer_profile_id}/deposits`
- 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[created_after]` string
- `filter[created_before]` string
- `filter[currency]` 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[]
  - `id` string: Payment contract ID.
  - `type` string: Transaction type. Either `Direct bank transfer` or `paynowTransaction`.
  - `idempotency_id` string: Idempotency ID for the transaction.
  - `amount` string: Transaction amount.
  - `fees` string, nullable: Additional transaction fees charged.
  - `status` string: Transaction status.
  - `bank_account_no` string, nullable: Bank account number from the payment method.
  - `merchant_ref` string, nullable: Merchant reference ID.
  - `blocked_reasons` object[]: Reasons blocking the transaction, if any.
    - `code` string: Blocked reason code.
  - `currency` string: Transaction currency.
  - `end_to_end_ref` string, nullable: End user's added comments/notes.
  - `transaction_remarks` string, nullable: Transaction remarks from the sender.
  - `payment_method` union: Payment method details. Shape varies by transaction type (bank transfer vs PayNow).
    - object
      - `id` string: Payment method unique ID.
      - `reference_id` string: Payment method reference ID.
      - `account_no` string: Bank account number.
      - `bank_short_code` string: Bank abbreviation code.
      - `bank_name` string, nullable: Full bank name.
      - `bank_address` string, nullable: Bank address.
      - `bank_country` string, nullable: Bank country.
      - `swift_bic` string: Bank SWIFT/BIC code.
      - `recipient_name` string: Recipient display name.
    - object
      - `id` string: Payment method unique ID.
      - `reference_id` string: Payment method reference ID.
      - `virtual_payment_address` string: PayNow virtual payment address (UEN or proxy).
      - `base64_encoded_image` string: Base64-encoded QR code image.
      - `qr_code_data` string: Raw QR code data string.
      - `expires_at` string: QR code expiry timestamp.
  - `sender_information` object: Structured sender details.
    - `account_holder_name` string, nullable: Sender's account holder name.
    - `account_number` string, nullable: Sender's account number.
    - `bank_short_code` string, nullable: Sender's bank abbreviation code.
    - `bank_name` string, nullable: Sender's bank name.
    - `end_to_end_ref` string, nullable: End-to-end reference from sender.
    - `swift_bic` string, nullable: Sender's bank SWIFT/BIC code.
    - `transaction_remarks` string, nullable: Transaction remarks from sender.
  - `sender_bank` string, nullable: Sender bank name.
  - `sender_bank_account_no` string, nullable: Sender's bank account number.
  - `sender_bank_account_holder_name` string, nullable: Sender's bank account holder name.
  - `sender_bank_swift_bic` string, nullable: Sender's bank SWIFT/BIC code.
  - `created_at` string: Timestamp when the transaction was created (Singapore timezone).
  - `updated_at` string: Timestamp when the transaction was last updated (Singapore timezone).
  - `customer_profile_id` string: Customer Profile ID associated with this payment.

---

[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)