---
title: "Get list of transfers"
method: GET
path: "/v1/transfers"
---

# Get list of transfers

`GET /v1/transfers`

Get list of transfers

## Query parameters

- `beneficiary_id` string, uuid
- `keywords` string, uuid
- `status` 'scheduled' | 'processing' | 'paid' | 'failed' | 'canceled'
- `per_page` integer

## Headers

- `X-BUSINESS-API-KEY` string, required

## Response `200`

200

- object
  - `data` object[]
    - `id` string, required
    - `beneficiary` object, required
      - `id` string, required
      - `status` string
      - `country` string, required
      - `currency` string, required
      - `transfer_method` string, required
      - `transfer_type` string
      - `nickname` string, required
      - `remark` string, required
      - `holder_name` string, required
      - `holder_type` string, required
      - `bank_branch_code` string
      - `bank_routing_number` string, required
      - `account_number` string, required
      - `bank_name` string
      - `bank_id` string
      - `email` string, required
      - `is_favourite` boolean, required
      - `created_at` string, required
      - `updated_at` string, required
      - `deleted_at` unknown, required
    - `payment_currency` string, required
    - `payment_amount` number, required
    - `source_currency` string, required
    - `source_amount` number, required
    - `exchange_rate` string, required
    - `fee` object, required
      - `paid_by` 'payer' | 'beneficiary'
      - `amount` number
      - `currency` string
    - `discount_fee_rate` number, required
    - `fixed_fee` number, required
    - `discount_fee` number, required
    - `remark` string, required
    - `status` 'scheduled' | 'processing' | 'paid' | 'failed' | 'canceled', required
    - `attachment` string, required
    - `created_at` string, required
  - `links` object
    - `first` unknown, required
    - `last` unknown, required
    - `prev` unknown, required
    - `next` string, required
  - `meta` object
    - `path` string, required
    - `per_page` number, required
    - `next_cursor` string, required
    - `prev_cursor` unknown, required

---

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