列示所有操作

Xsolla Developers

或

前往发布商帐户

列示所有操作Server-sideAdmin

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

返回指定时间段内成功和取消的交易的详细信息列表。您可以在响应中获得付款信息，包括费用、税以及订单和用户的数据。您可以获得JSON或CSV格式的列表。您可以使用此 API调用进行财务对账。

注意

此API调用不包含project_id路径参数，因此您需要使用在您公司的所有项目中都有效的API密钥来设置授权。

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer 商户ID。
format required	string 数据格式。 Enum: "json" "csv" "xls"

query Parameters

datetime_from

required

string <datetime>

开始日期，使用YYYY-MM-DD格式。如传入了以下任一参数，则此参数非必需：

limit
transfer_id
report_id

Example: datetime_from=2023-02-08

datetime_to

required

string <datetime>

结束日期，使用YYYY-MM-DD格式。如传入了以下任一参数，则此参数非必需：

limit
transfer_id
report_id

datetime_from和datetime_to之间的间隔不得超过92天。

Example: datetime_to=2023-03-08

in_transfer_currency

required

integer

将所有财务数据转换为支付出账货币（默认使用支付入账货币）。如传入了以下任一参数，则此参数非必需：

transfer_id
report_id

show_total

boolean

是否在报告中包含交易总额。仅适用于CSV格式导出，默认值为true。

merchant_of_records

string or null

在册商户。可以是xsolla、merchant或不指定。如果为merchant，则返回通过合作伙伴直接帐户进行的交易。如果为xsolla，则返回非通过合作伙伴直接帐户进行的交易。如未指定，则返回所有交易。

Enum:	Description
merchant	返回通过合作伙伴直接帐户进行的交易。
xsolla	返回非通过合作伙伴直接帐户进行交易。

project_id

integer

项目ID。

show_dry_run

boolean

是否包括测试交易。

transfer_id

integer

交易传输 ID。

report_id

integer

财务报告 ID。

offset

integer

元素编号，从该元素开始生成列表（从0开始数）。

limit

integer

页面上显示的交易数限制。如传入了此参数，则不必传入datetime_from和datetime_to参数。

status

string

交易状态。

Enum: "done" "canceled" "error"

Responses

200

交易列表已成功返回。

Request samples

curl -i -X GET \
  -u <merchant_id>:<api_key> \
  'https://api.xsolla.com/merchant/v3/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=string&datetime_to=string&in_transfer_currency=0&show_total=true&merchant_of_records=xsolla&project_id=0&show_dry_run=true&transfer_id=0&report_id=0&offset=0&limit=0&status=done'

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
},
"direct_wht": {"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
},
"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,
"product_id": null,
"product_name": 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": "smith123",
"ip": "209.11.22.33",
"marketplace": "Pay Station",
"name": "Tom",
"phone": null
},
"user_balance": {"payment_currency": {"deduction_amount": 0,
"payout_amount_from_balance": 0.02,
"purchase_amount_from_balance": 0.02
}
}
}
]