# 3 Payout Statement
# request URL
/api/v1/record/payoutList
# 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 | - | Payout Record Data |
| -- merchantOrderId | String | LT000000216 | Merchant order id |
| -- transactionId | String | C1175679364396181358 | Transaction ID |
| -- 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) |
| -- remittingBank | String | Union Bank | Payment Method |
| -- remittingAccount | String | 915****5678 | Payment Channel |
| -- recipientName | String | xxxx****xxxx | customer name |
| -- recipientAccount | String | 091****6789 | customer mobile |
| -- receivingChannel | String | GCASH | customer mobile |
| -- status | String | COMPLETE | Transaction Status: PENDING、COMPLETE、FAILED |
| -- 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": "xxxxxxxxxxxxxxxxxx",
"transactionId": "xxxxxxxxxxxxxxxxxx",
"amount": 100.0,
"fee": 15.0,
"remittingBank": "Union Bank Of The Philippines",
"remittingAccount": "091****5678",
"recipientName": "xxx***xxx",
"recipientAccount": "915****6789",
"appName": "paycools",
"status": "PENDING",
"receivingChannel": "GCASH",
"createTime": "2023-03-20 17:54:28",
"completeTime": null
},
{
"merchantOrderId": "xxxxxxxxxxxxxxxxxx",
"transactionId": "xxxxxxxxxxxxxxxxxx",
"amount": 100.0,
"fee": 15.0,
"remittingBank": "Union Bank Of The Philippines",
"remittingAccount": "915****5678",
"recipientName": "xxx***xxx",
"recipientAccount": "091****6789",
"appName": "paycools",
"status": "FAILED",
"receivingChannel": "GCASH",
"createTime": "2023-03-20 20:18:57",
"completeTime": "2023-03-20 20:19:25"
},
{
"merchantOrderId": "xxxxxxxxxxxxxxxxxx",
"transactionId": "xxxxxxxxxxxxxxxxxx",
"amount": 100.0,
"fee": 15.0,
"remittingBank": "Union Bank Of The Philippines",
"remittingAccount": "915****5678",
"recipientName": "xxx***xxx",
"recipientAccount": "091****6789",
"appName": "paycools",
"status": "COMPLETE",
"receivingChannel": "GCASH",
"createTime": "2023-03-20 20:21:10",
"completeTime": "2023-03-20 20:21:21"
}
],
"page": 1
}
}
# failed response example. code see reference
{
"code": 1002,
"message": "merchant white ip forbidden"
}