# Get transactions

Returns the list of detailed information about successful and canceled transactions for a specified period. In response, you get information about payments, including data on fees, taxes, as well as order and user. You can get the list in JSON or CSV format. You can use this API call to perform financial reconciliation.


  NoticeThis API call does not contain the project_id path parameter, so you need to use the API key that is valid in all the company’s projects to set up authorization.

Endpoint: GET /merchants/{merchant_id}/reports/transactions/registry.{format}
Version: 2.0
Security: basicAuth

## Path parameters:

  - `merchant_id` (integer, required)
    Merchant ID.

  - `format` (string, required)
    Data format.
    Enum: "json", "csv", "xls"

## Query parameters:

  - `datetime_from` (string, required)
    Period start in the YYYY-MM-DD format. Not required if at least one of the following parameters is passed:transfer_idreport_id
    Example: "2023-02-08"

  - `datetime_to` (string, required)
    Period end in the YYYY-MM-DD format. Not required if at least one of the following parameters is passed:transfer_idreport_id The difference between datetime_from and datetime_to cannot be more than 92 days.
    Example: "2023-03-08"

  - `in_transfer_currency` (integer, required)
    Converts all financial data to the payout currency (the pay-in currency is used by default). Not required if at least one of the following parameters is passed:transfer_idreport_id

  - `show_total` (boolean)
    Whether to include the total transactions amount in the report. Available for export in CSV format only. true by default.

  - `merchant_of_records` (string,null)
    Merchant of Record. Can be xsolla, merchant, or not specified. If merchant, returns transactions made via the partner’s gateways. If xsolla, returns transactions made not via the partner’s gateways. If not specified, returns all transactions.
    Enum: "xsolla", "merchant"

  - `project_id` (integer)
    Project ID.

  - `show_dry_run` (boolean)
    Whether to include test transactions.

  - `transfer_id` (integer)
    Payout ID.

  - `report_id` (integer)
    Financial report ID.

  - `offset` (integer)
    Number of the element from which the list is generated (the count starts from 0).

  - `limit` (integer)
    Limit for the number of displayed transactions on the page. If this parameter is passed, you don’t need to pass the datetime_from and datetime_to parameters.

  - `status` (string)
    Transaction status.
    Enum: "done", "canceled", "error", "refunded"

## Response 200 fields (application/json):

  - `user` (object)
    User details.

  - `user.id` (string)
    User ID.

  - `user.email` (string)
    User email.

  - `user.name` (string)
    User screen name.

  - `user.phone` (string,null)
    User phone number.

  - `user.country` (string)
    Two-letter uppercase country code per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

  - `user.custom` (string,null)

  - `user.marketplace` (string)

  - `user.ip` (string)

  - `user_balance` (object)
    User balance.

  - `user_balance.payment_currency` (object)
    Preferred payment currency.

  - `user_balance.payment_currency.deduction_amount` (number)

  - `user_balance.payment_currency.payout_amount_from_balance` (number)

  - `user_balance.payment_currency.purchase_amount_from_balance` (number)

  - `transaction` (object)
    Transaction data.

  - `transaction.custom_parameters` (object,null)

  - `transaction.direct_account` (integer)

  - `transaction.dry_run` (integer)

  - `transaction.external_id` (string,null)

  - `transaction.id` (integer)

  - `transaction.payment_method` (object)

  - `transaction.payment_method.class` (string)

  - `transaction.payment_method.name` (string)

  - `transaction.project` (object)

  - `transaction.refund_reason` (string,null)

  - `transaction.refund_reason_comment` (string,null)

  - `transaction.status` (string)
    Enum: "created", "processing", "done", "canceled", "error", "refunded", "partiallyRefunded", "awaitingRefund", "disputeFee"

  - `transaction.transfer_date` (string)

  - `purchase` (object)
    Purchase details.

  - `purchase.friend` (object)

  - `purchase.friend.email` (string,null)

  - `purchase.friend.user_id` (string,null)

  - `purchase.items_amount` (integer)

  - `purchase.pin_codes` (object)

  - `purchase.pin_codes.amount` (number,null)

  - `purchase.pin_codes.content` (string,null)

  - `purchase.pin_codes.currency` (string,null)

  - `purchase.purchase_amount` (number)

  - `purchase.simple_checkout` (object)

  - `purchase.subscription` (object)

  - `purchase.subscription.plan_id` (integer,null)

  - `purchase.subscription.product_id` (string,null)

  - `purchase.subscription.product_name` (string,null)

  - `purchase.subscription.subscription_id` (integer,null)

  - `purchase.virtual_currency` (object)

  - `purchase.virtual_currency_amount` (integer)

  - `purchase.virtual_items` (object)

  - `payment_details` (object)
    Payment details.

  - `payment_details.chargebackPenalty` (object)

  - `payment_details.commission_agent` (object)

  - `payment_details.commission_agent.percent` (number)

  - `payment_details.commission_agent_fixed` (integer)

  - `payment_details.commission_ps` (object)

  - `payment_details.commission_ps.fixed_amount` (integer)

  - `payment_details.commission_ps_from_vat` (object)

  - `payment_details.commission_user` (object)

  - `payment_details.commission_xsolla` (object)

  - `payment_details.cpa_network_commission` (object)

  - `payment_details.payment` (object)

  - `payment_details.payment.amount_from_ps` (integer)

  - `payment_details.payout` (object)

  - `payment_details.payout.fx_rate` (number)

  - `payment_details.direct_wht` (object)

  - `payment_details.refundPenalty` (object)

  - `payment_details.repatriation_costs` (object)

  - `payment_details.sales_tax` (object)

  - `payment_details.vat` (object)

  - `payment_details.vat.user_amount` (integer)

  - `payment_details.vat.user_percent` (integer)