---
title: "Copy of List Retailers Transfers"
method: POST
path: "/list-1"
---

# Copy of List Retailers Transfers

`POST /list-1`

## Request

- Base URL: `https://api.tap.company/v4/destination`
- URL: `https://api.tap.company/v4/destination/list-1`
- Auth: API key in header `Authorization`

This endpoint will return all the transfers happend from the marketplace to the selected retailers.

## Request body

- object
  - `limit` number: The records limit, the default is 50. The minimum is 1 and the maximum is 50
  - `page_no` number: The page number is starting from 0 until the [total_count/limit]
  - `period` object, required
    - `date` object, required
      - `from` number, required
      - `to` number, required
  - `merchants` string[]: To filter by the merchant IDs
  - `payouts` string[]
  - `retailers` string[]: To filter by the retailer IDs
  - `destination_transactions` string[]
  - `transfers` string[]
  - `mobile` string
  - `email` string
  - `customers` string[]: To filter by the customers IDs
  - `payment_methods` string[]: To filter by the payment methods, for example: VISA,MASTERCARD,MADA
  - `charges` string[]: To filter by the charge IDs
  - `sources` string[]: To filter by the token IDs
  - `filters` object
    - `currency` string[]: To filter by currency with iso-3 format (SAR,KWD,AED,...)
    - `payment_scheme` string[]: To filter by the payment scheme such us VISA, MASTERCARD and MADA

## Response `200`

Successful response

- object
  - `live_mode` string, required
  - `count` number
  - `total_count` string
  - `has_more` boolean
  - `transfers` object[]
    - `id` string
    - `object` string
    - `live_mode` boolean
    - `created` string
    - `status` string
    - `currency` string
    - `amount` string
    - `charge` object
      - `id` string
      - `object` string
      - `customer_initiated` boolean
      - `method` string
      - `status` string
      - `amount` number
      - `currency` string
      - `threeDSecure` boolean
      - `card_threeDSecure` boolean
      - `save_card` boolean
      - `merchant_id` string
      - `description` string
      - `metadata` object
        - `booking_id` string
        - `user_id` string
      - `transaction` object
        - `authorization_id` string
        - `timezone` string
        - `created` string
        - `expiry` object
          - `period` number
          - `type` string
        - `amount` string
        - `currency` string
        - `date` object
          - `created` number
          - `completed` number
          - `posted` number
      - `reference` object
        - `track` string
        - `payment` string
        - `transaction` string
        - `order` string
        - `acquirer` string
        - `gateway` string
      - `response` object
        - `code` string
        - `message` string
      - `security` object
        - `threeDSecure` object
          - `id` string
          - `status` string
      - `acquirer` object
        - `id` string
        - `response` object
          - `code` string
          - `message` string
        - `country` string
        - `name` string
        - `mid` string
      - `gateway` object
        - `response` object
          - `code` string
          - `message` string
        - `id` string
        - `name` string
      - `card` object
        - `object` string
        - `first_six` string
        - `first_eight` string
        - `scheme` string
        - `brand` string
        - `last_four` string
        - `name` string
        - `expiry` object
          - `month` string
          - `year` string
        - `registered` string
        - `issuer_name` string
      - `customer` object
        - `registered` string
        - `id` string
        - `first_name` string
        - `email` string
      - `merchant` object
        - `country` string
        - `currency` string
        - `name` string
        - `id` string
        - `legacy_id` string
      - `location` object
        - `ip` string
        - `country` string
        - `city` string
      - `source` object
        - `object` string
        - `type` string
        - `payment_type` string
        - `channel` string
        - `id` string
        - `on_file` string
        - `payment_method` string
      - `redirect` object
        - `status` string
        - `url` string
      - `post` object
        - `status` string
        - `url` string
      - `destinations` object
        - `amount` string
        - `currency` string
        - `count` string
        - `destination` object[]
          - `name` string
          - `amount` string
          - `currency` string
          - `transfer` object
            - `id` string
            - `amount` string
            - `currency` string
      - `refunds` object
        - `summary` object
          - `charge_amount` string
          - `refund_amount` string
          - `refunded_count` string
          - `remaing_amount` string
          - `remaing_percentage` string
      - `net` object
        - `currency` string
        - `amount` string
        - `base` object
          - `amount` string
          - `currency` string
          - `vat` string
      - `issuer` object
        - `id` string
        - `name` string
        - `country` string
        - `region` string
        - `issuer_region` object
          - `code` string
          - `name` string
      - `authentication` object
        - `acsEci` string
        - `transaction_status` string
        - `threeDSecure` object
          - `id` string
          - `acs_eci` string
          - `authentication_token` string
          - `transaction_id` string
          - `version` string
          - `acs_trans_id` string
          - `message_version` string
          - `trans_status` string
          - `mode` string
          - `type` string
          - `status` string
          - `provider` string
        - `id` string
        - `status` string
        - `data` object
          - `asc_eci` string
          - `type` string
      - `activities` object[]
        - `id` string
        - `object` string
        - `created` string
        - `status` string
        - `currency` string
        - `amount` string
        - `remarks` string
        - `txn_id` string
      - `auto_reversed` boolean
      - `payment` object
        - `type` string
        - `account` string
        - `method` string
        - `scheme` string
        - `authentication` string
        - `card` string
        - `wallet` string
      - `exchange` object
        - `requested` object
          - `amount` string
          - `currency` string
        - `capture` object
          - `amount` string
          - `currency` string
          - `rate` string
        - `settlement` object
          - `amount` string
          - `currency` string
          - `rate` string
      - `balance` object
        - `id` string
        - `status` string
        - `settlement` object
          - `id` string
          - `scheduled` integer
          - `activities` object[]
            - `object` string
            - `status` string
            - `date` integer
        - `payout` object
          - `id` string
          - `scheduled` string
          - `activities` object[]
            - `object` string
            - `status` string
            - `date` string
      - `browser` object
        - `name` string
        - `agent` string
      - `device` object
        - `type` string
        - `location` object
          - `ip` string
          - `country` string
          - `city` string
          - `region` object
            - `code` string
            - `name` string
      - `submerchant` object
        - `id` string
        - `name` string
        - `mcc` string
        - `address` object
          - `city` string
          - `country` string
          - `street` string
      - `protect` object
        - `id` string
        - `status` string
    - `reversals` object[]
      - `id` string
      - `refund_id` string
      - `created` string
      - `amount` string
      - `currency` string
    - `merchant` object
      - `payment_provider` string
      - `retailer` object
        - `id` string: The retailer ID of this transfer.
        - `currency` string: The currency of this retailer.
      - `id` string: The merchant ID.
      - `legacy_id` string: The legacy ID of the merchant (for old setups).
    - `exchange` object
      - `requested` object
        - `amount` string
        - `currency` string
      - `capture` object
        - `amount` string
        - `currency` string
        - `rate` string
    - `retailer` object
      - `destination_id` string
      - `status` string
      - `display_name` string
      - `wallet_id` string

---

[API](https://skmtc.dev/tap/apis/destinationsv4.md) - [All operations](https://skmtc.dev/tap/apis/destinationsv4/llms.txt) - [OpenAPI document](https://skmtc.dev/tap/apis/destinationsv4/revisions/cb42a144b8cd?raw)