取引履歴を取得する

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

指定した期間/支払い/レポートのすべてのトランザクションを取得します。JSON、CSV、またはXLS形式でリストを取得できます。

通知

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>

年月日の形式で始まる期間。limitパラメータが渡された場合は必要ありません。

Example: datetime_from=2023-02-08

datetime_to

required

string <datetime>

年月日の形式で終了する期間。limitパラメータが渡された場合は必要ありません。datetime_fromとdatetime_toの差は92日を超えることはできません。

Example: datetime_to=2023-03-08

in_transfer_currency

required

integer

すべての財務データを配当通貨に変換します（既定では入金通貨が使用されます）。

show_total

required

boolean

レポートに合計を追加します。

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

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,
"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",
"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
}
}
}
]