# 2 Payment Statement
# request URL
/api/v1/record/paymentList
# request method
- POST
# request params
parameter name | Is it mandatory | type of data | length | example | description |
---|---|---|---|---|---|
appId | mandatory | string | - | - | application APPID |
createDate | optional, if completeDate filed | string | 1-50 | 2022-01-01 | Transaction Create Date |
completeDate | optional, if createDate filed | string | 1-50 | 2022-01-01 | Transaction Complete Date |
page | mandatory | int | - | - | Page |
status | optional | string | 1-100 | - | PENDING、 COMPLETE、 FAILED |
timestamp | mandatory | string | 1-50 | 1679335338000 | Timestamp -2 minute validity period |
sign | mandatory | string | - | 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 | sign |
# response params
parameter name | type of data | example | description |
---|---|---|---|
code | int | 1000 | Status code see reference |
message | String | success | The message of status code |
data | Object | - | Response Data |
- records | List | - | Payment Record Data |
-- merchantOrderId | String | LT000000216 | Merchant order id |
-- transactionId | String | C1175679364396181358 | Transaction ID |
-- paymentMethod | String | QR Code | Payment Method |
-- paymentChannel | String | GCASH_STATIC_VA | Payment Channel |
-- amount | Double | 100.1 | Transaction amount(This is consistent with the reconciliation file downloaded from the merchant backend and represents the local currency amount. For example: 100.1p => 100.1p) |
-- fee | Double | 10.1 | Transaction fee(This is consistent with the reconciliation file downloaded from the merchant backend and represents the local currency amount. For example: 10.1p => 10.1p) |
-- name | String | 999100000198 | customer name |
-- mobile | String | 09123456789 | customer mobile |
-- status | String | COMPLETE | Transaction Status: PENDING、COMPLETE、FAILED |
-- appName | String | XXXXXX | AppName |
-- createTime | String | 2023-03-21 10:06:36 | Transaction Create Time |
-- completeTime | String | 2023-03-21 10:06:36 | Transaction Complete Time |
# successful response example
{
"code": 1000,
"message": "success",
"data": {
"records": [
{
"merchantOrderId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"transactionId": "C1175679364396181358",
"paymentMethod": "QR Code",
"paymentChannel": "QRPH_DYNAMIC_QR",
"amount": 100.0,
"fee": 20.0,
"name": "xxxx xxxx",
"mobile": null,
"status": "PENDING",
"appName": "paycools",
"createTime": "2023-03-21 10:06:36",
"completeTime": null
},
{
"merchantOrderId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"transactionId": "C1175679364504324838",
"paymentMethod": "Bank Transfer",
"paymentChannel": "INSTA_TRANSFER_ACC",
"amount": 100.0,
"fee": 20.0,
"name": "xxxx xxxx",
"mobile": "09123456789",
"status": "COMPLETE",
"appName": "paycools",
"createTime": "2023-03-21 10:08:24",
"completeTime": "2023-03-21 10:08:24"
},
{
"merchantOrderId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"transactionId": "C1175679364555430931",
"paymentMethod": "Bill Payment",
"paymentChannel": "GCASH_STATIC_VA",
"amount": 200.0,
"fee": 20.0,
"name": "xxxx xxxx",
"mobile": "09123456789",
"status": "COMPLETE",
"appName": "PayCools",
"createTime": "2023-03-21 10:09:15",
"completeTime": "2023-03-21 10:09:15"
},
{
"merchantOrderId": "xxxxxxxxxxxxxxxxxxxxxxxx",
"transactionId": "C1175679364577251000",
"paymentMethod": "Web Payment",
"paymentChannel": "GCASH_URL",
"amount": 100.0,
"fee": 20.0,
"name": "xxxx xxxx",
"mobile": "09123456789",
"status": "FAILED",
"appName": "paycools",
"createTime": "2023-03-21 10:09:37",
"completeTime": "2023-03-21 10:53:29"
}
],
"page": 1
}
}
# failed response example. code see reference
{
"code": 1002,
"message": "merchant white ip forbidden"
}