---
title: "Fetch Merchant Transactions"
method: POST
path: "/api/merchant/{key}/fetch-all-payments"
tags: ["Payment APIs"]
---

# Fetch Merchant Transactions

`POST /api/merchant/{key}/fetch-all-payments`

## Path parameters

- `key` string, required

## Headers

- `X-Portone-Client-Key` string
- `Authorization` string

## Request body

- object
  - `page` integer, required — The page number of the data to be fetched.
  - `size` integer, required — The page size of the data to be fetched.
  - `from` string, required — The from Date to fetch the sub-merchant.
  - `to` string, required — The to Date to fetch the sub-merchant.
  - `environment` 'live' | 'sandbox', required — The environment of the transaction is either live OR sandbox

## Response `200`

Successful response

- object
  - `body` MerchantTransactionsAPIResponseContent — The object containing the response of Fetch Merchant transactions API
    - `content` MerchantTransactionsContent[] — The array of transaction details objects.
      - `currency` string — The currency of the transaction.
      - `amount` number, double — The amount of the transaction.
      - `order_ref` string — The unique order reference of the transaction generated by the PortOne.
      - `channel_order_ref` string — The unique order reference of the transaction generated by PSP.
      - `merchant_order_ref` string — The unique order reference of the transaction generated by the merchant.
      - `status` string — The status of the transaction. Refer PortOne docs for additional details.
      - `channel_key` string — The unique Channel Key of the transaction. Refer PortOne docs for additional details.
      - `method_name` string — The unique Payment Method Key of the transaction. Refer PortOne docs for additional details.
      - `method_key` string — The method key used for the transaction.
      - `channel_logo` string — The PSP logo url.
      - `method_sub_type` string — The sub type of the Payment Method. Refer PortOne docs for additional details.
      - `status_code` string — The status code of the transaction.
      - `status_reason` string — The status reason of the transaction.
      - `status_channel_reason` string — The status channel reason of the transaction.
      - `created_at` string — The date timestamp of the transaction.
      - `is_refund_allowed` boolean — The boolean flag indicating whether refund is allowed for the transaction.
      - `is_multi_refund_allowed` boolean — The boolean flag indicating whether multple partial refunds are allowed for the transaction.
      - `remit_status` string — The status of the remittance.
      - `created_by` string — The creator's email address.
      - `subscription_order_ref` string — The subscription order reference.
      - `is_cross_border_transaction` boolean — Boolean flag to identify if the transaction is a cross border transaction.
      - `country_code` string — The correct country code for the transaction.
      - `buyer_name` string — The buyer name of the transaction.
      - `buyer_email` string — The buyer email of the transaction.
      - `buyer_phone` string — The buyer phone number of the transaction.
      - `buyer_address1` string — The buyer address of the transaction.
      - `buyer_address2` string — The buyer address of the transaction.
      - `buyer_city` string — The buyer city of the transaction.
      - `buyer_country` string — The country code of the buyer doing the transaction.
      - `signature_hash` string — The signature hash generated for the transaction details. Refer PortOne docs for additional details.
      - `source` string — The source of the transaction. API or checkout.
      - `payment_method_used` string — The actual payment method used for the transaction.
      - `merchant_key` string — The unique PortOne key of the merchant.
      - `merchant_email_address` string — The email_address of the merchant.
      - `channel_name` string — The channel_name of the PSP used in transaction.
      - `refund_completed` boolean — The boolean flag indicating whether refunds is completed for the transaction.
      - `user_agent` string — The user_agent of the the device from which the transaction is created.
      - `ip_address` string — The IP address of the device from which the transaction is created.
      - `description` string — The description of the transaction.
      - `link_order_ref` string — The unique order reference of link.
      - `payment_link_ref` string — The unique order reference of payment link.
      - `merchant_name` string — The name of the merchant.
      - `recon_status` string — The status recon for the transaction.
      - `user_configured_field1` string — Custom user configured field 1
      - `user_configured_field2` string — Custom user configuration field 2
      - `user_configured_field3` string — Custom user configuration field 3
      - `user_configured_field4` string — Custom user configuration field 4
      - `user_configured_field5` string — Custom user configuration field 5
      - `payment_link_merchant_order_ref` string — The payment link merchant order reference.
    - `total_elements` number — The number of total_elements in the response.
    - `total_pages` number — The number of total_pages in the response.
    - `size` number — The size of the current page.
    - `page` number — The current page number.
    - `number_of_elements` number — The number of elements in the current page.
  - `message` string — The description of the API request execution result
  - `status_code` string — The status code of API response
  - `status_reason` string — The status reason of API response

## Other responses

- `400` — Failure response
- `401` — Failure response

---

[API](https://skmtc.net/portone/apis/payment-apis.md) · [All operations](https://skmtc.net/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portone/payment-apis/revisions/f3ccea652555/schema)