查找交易

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

基于特定搜索参数获取交易列表。将在执行请求5到10分钟内在API的响应中返回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

string <datetime>

日期范围的开始时间。

datetime_to

string <datetime>

日期范围的结束时间。

project_id

integer

项目ID。

transaction_id

integer

交易ID。

type

string

在搜索结果中显示的交易类型：

Enum:	Description
all	所有交易。
canceled	取消的交易（测试交易除外）。
test	测试交易。
transferred	成功的交易（测试交易除外）。

phone

string

用户电话号码（采用国际格式）。

user_id

string

存储在己侧的游戏内唯一用户ID。请确保传入现有用户ID。如遇到错误，请参阅常见问题回答。

user_name

string

用户名。

user_custom

string

用户标识的自定义参数。

string <= 100 characters

用户电子邮件。

external_id

string

游戏中的交易ID。值对于每个用户付款必须唯一。

offset

integer

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

limit

integer

页面上元素数量的限制。

status

string

一种交易状态。

Enum:	Description
awaitingRefund	交易正在等待退款决定。用户申请退款后，艾克索拉客户支持将手动处理该申请并作出决定。
canceled	有两种可能场景：交易被支付系统侧取消。例如用户帐户中资金不足。已对用户退款。
created	用户发起了交易但交易尚未被处理。
done	交易已成功处理。
error	处理交易时发生了错误。此类支付可通过联系艾克索拉客户支持进行退款。
partiallyRefunded	用户收到了部分退款。
processing	交易正在处理中。
refunded	退款已退回用户的艾克索拉余额。
review	交易处理被反欺诈系统暂停，当前正对交易进行额外验核。

Responses

200

OK.

Request samples

Response samples

application/json

[{"payment_details": {"payment": {"amount": 7.96,
"amount_from_ps": 7.96,
"currency": "RUB"
},
"sales_tax": {"amount": 0,
"percent": 0
}
},
"payment_system": {"decline_reason": null
},
"purchase": {"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"simple_checkout": {"amount": 7.96,
"currency": "RUB"
},
"subscription": {"name": null
},
"virtual_currency": {"amount": 0,
"name": null
},
"virtual_items": null
},
"transaction": {"create_date": "2021-10-20",
"dry_run": 0,
"external_id": "example-external-id",
"id": 123456789,
"is_refund_allowed": 0,
"payment_method": {"id": 1,
"name": "PayPal"
},
"project": {"id": 123456,
"name": "Example"
},
"refund_reason": null,
"status": "done",
"transfer_date": "2021-10-20"
},
"user": {"country": "RU",
"custom": null,
"email": "email@example.com",
"id": "example-id",
"name": "Example",
"phone": null
}
}
]