CommonApiVersion 1.0.0
Query Settlement Details
https://pay.globepay.co/api/v1.0/gateway/partners/{partner_code}/transactionsThis Api will list all transactions with the settlement this day, containing all payment methods(include no gateway methods) and all payment channels such as payment, GlobePay discount cashback, refunds, credit for failure refunds, system pay back, cashback account income/outcome, etc.
Notice: A payment order or refund order can contains several transaction records
Header
| Field | Description |
|---|---|
Accept | application/json |
Content-Type | application/json |
Path Variable
| Field | Type | Description |
|---|---|---|
partner_code | String | Required, Partner code |
Query Params
| Field | Type | Description |
|---|---|---|
date | String | Required, Transaction date. Format as 'yyyyMMdd'，GMT+8 |
time | Long | Required, UTC timestamp in milliseconds |
nonce_str | String | Required, Random string |
sign | String | Required, Sign |
ROOT
| Field | Type | Description |
|---|---|---|
return_code | String | Execution result,SUCCESS |
result_code | String | Process result |
settle_from | String | Transaction date from,yyyyMMdd |
settle_to | String | Transaction date to, yyyyMMdd |
settle_days | String | Settle delay(T+n) |
transaction_count | int | transaction record count |
order_count | int | payment order count |
refund_count | int | refund order count |
total_credit | int | Total credit amount (GBP cent) |
total_debit | int | Total debit amount (GBP cent) |
total_surcharge | int | Total surcharge amount(GBP cent) |
total_transfer | int | Total amount sending to merchant's bank account(GBP cent) |
settle_surcharge | int | Total settlement surcharge amount(GBP cent) |
dispute_surcharge | int | Total dispute surcharge amount(GBP cent) |
transactions | JSON[] | transaction list |
transactions
| Field | Type | Description |
|---|---|---|
transaction_time | String | Trade time, format as yyyyMMddHHmmss，GMT+8 |
order_id | String | GlobePay Order ID |
partner_order_id | String | Partner Order ID |
channel_order_id | String | Order ID in payment channel (Alipay/Alipay Plus/Wechat) |
refund_id | String | GlobePay Refund ID (Only in refunds or refunds failure cashback) |
partner_refund_id | String | Partner refund ID (Only in refunds or refunds failure cashback) |
gateway | String | Payment method
|
channel | String | Payment Channel (Alipay, Wechat, AlipayPlus) |
type | String | Trade Direction
|
currency | String | currency(GBP/CNY) |
total_amount | int | Total payment amount, which uses the base unit of order currency |
input_amount | int | Order input amount, which uses the base unit of order currency |
settle_amount | int | Amount to make settlement, GBP cents |
surcharge_rate | String | Transaction fee rate for the relevant payment channel (x%) |
surcharge | int | Transaction fees charged for the relevant transaction, GBP cents |
transfer_amount | int | Amount send to merchant's bank account, GBP cents |
exchange_rate | double | Using exchange rate |
remark | String | Remark |
ERROR
| Name | Description |
|---|---|
return_code | Error Code |
return_msg | Error Description |
Error Code
| Name | Description |
|---|---|
SYSTEMERROR | Exception inside system |
INVALID_SHORT_ID | Partner code is invalid or there is no partner associated with this code |
SIGN_TIMEOUT | Sign expired, the difference between time and the server time is more than 5 minutes |
INVALID_SIGN | Invalid sign |
PARAM_INVALID | Parameters are invalid. See return_msg for more details. |
NOT_PERMITTED | Gateway payment permission has not been enabled for this partner |
INVALID_CHANNEL | Channel name is not available, check the Capitalize |