Get transactions

get/merchants/{merchant_id}/reports/transactions/registry.{format}

Gets all transactions for a specified period/payout/report. You can get the list in JSON, CSV, or XLS format.

Notice

This 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.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer Merchant ID.
format required	string Data format. Enum: "json" "csv" "xls"

query Parameters

datetime_from

required

string <datetime>

Period start in the YYYY-MM-DD format. Not required if the limit parameter is passed.

Example: datetime_from=2023-02-08

datetime_to

required

string <datetime>

Period end in the YYYY-MM-DD format. Not required if the limit parameter is passed. The difference between datetime_from and datetime_to cannot be more than 92 days.

Example: datetime_to=2023-03-08

in_transfer_currency

required

integer

Converts all financial data to the payout currency (the pay-in currency is used by default).

show_total

required

boolean

Adds totals to the report.

merchant_of_records

string or 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:	Description
merchant	Returns transactions made via the partner’s gateways.
xsolla	Returns transactions made not via the partner’s gateways.

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"

Responses

200

The list of transactions was successfully returned.

Request samples

Response samples

application/json

[{"payment_details": {"chargebackPenalty": {"amount": 0
},
"commission_agent": {"amount": 0,
"percent": 0
},
"commission_agent_fixed": 0,
"commission_ps": {"amount": 0,
"fixed_amount": 0,
"percent": 0
},
"commission_ps_from_vat": {"amount": 0
},
"commission_user": {"amount": 0.01,
"percent": 33.33
},
"commission_xsolla": {"amount": 0,
"fixed_amount": 0,
"percent": 5
},
"cpa_network_commission": {"amount": 0,
"percent": 0
},
"payment": {"amount": 0.03,
"amount_from_ps": 0,
"currency": "USD"
},
"payout": {"amount": 0.02,
"amount_from_ps": 0,
"currency": "RUB",
"fx_rate": 64.1386407767,
"percent": 100
},
"direct_wht": {"amount": 0,
"percent": 0
},
"refundPenalty": {"amount": 0
},
"repatriation_costs": {"amount": 0,
"percent": 0
},
"sales_tax": {"amount": 0,
"percent": 0
},
"vat": {"amount": 0,
"percent": 0,
"user_amount": 0,
"user_percent": 0
}
},
"purchase": {"friend": {"email": null,
"user_id": null
},
"items_amount": 1,
"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"purchase_amount": 0.02,
"simple_checkout": {"amount": null,
"currency": null
},
"subscription": {"name": null,
"plan_id": null,
"subscription_id": null
},
"virtual_currency": {"amount": 0.02,
"currency": "USD"
},
"virtual_currency_amount": 1,
"virtual_items": {"amount": null,
"content": null,
"currency": null
}
},
"transaction": {"custom_parameters": null,
"direct_account": 0,
"dry_run": 0,
"external_id": null,
"id": 418756634,
"payment_method": {"class": "Digital Payment Methods",
"id": 2760,
"name": "Your Balance"
},
"project": {"id": 21092,
"name": "Smith"
},
"refund_reason": null,
"refund_reason_comment": null,
"status": "done",
"transfer_date": "2019-02-11T13:32:00+03:00"
},
"user": {"country": "US",
"custom": null,
"email": "email@example.com",
"id": "a.smith",
"marketplace": "Pay Station",
"name": "Tom",
"phone": null,
"ip": "209.11.22.33"
},
"user_balance": {"payment_currency": {"deduction_amount": 0,
"payout_amount_from_balance": 0.02,
"purchase_amount_from_balance": 0.02
}
}
}
]