Getting Withdrawal Batch Reports
Access Endpoint URL: https://rest.everyware.com/api/Default/GetWithdrawals[POST]
The GetWithdrawals method allows you to extract the following deposit batch data for captured charges within a specified Payout date range: batch numbers, number of transactions per batch, total batch amount before adjustments, number of transactions, number of refunds, refunded amount, total chargeback amount, transaction fee amount, other fee amounts, the final amount deposited after adjustments and the date of the batch payout.
Data Access
Note: Access to Withdrawals Report data depends on the payment processor or gateway configuration for the site.
Inbound Parameters
| Parameter Name | Description | Required/Not |
|---|---|---|
| StartDate | Start of date range for withdrawal batches | REQUIRED |
| EndDate | End of date range for withdrawal batches | OPTIONAL |
Code Sample
{
"StartDate": "9-1-22",
"EndDate": "9-7-22"
}
curl --location 'https://rest.everyware.com/api/Default/GetWithdrawals' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
"StartDate": "9-1-22",
"EndDate": "9-7-22"
}
{
"IsSuccess": true,
"Message": null,
"Data": [
{
"BatchNumber": 123456,
"SalesCount": 2,
"SalesAmount": 2.00,
"RefundCount": 0,
"RefundAmount": 0.0000,
"Gross": 2.00,
"ChargebacksAmount": 0.00,
"TransFees": 0.00,
"TotalFees": -0.55,
"WithdrawalAmount": 1.45,
"WithdrawalDate": "2022-09-06T12:00:00"
},
{
"BatchNumber": 7891011,
"SalesCount": 3,
"SalesAmount": 6.00,
"RefundCount": 0,
"RefundAmount": 0.00,
"Gross": 6.00,
"ChargebacksAmount": 0.00,
"TransFees": 0.00,
"TotalFees": -0.89,
"WithdrawalAmount": 5.11,
"WithdrawalDate": "2022-09-02T12:00:00"
}
]
}
Example Withdrawals Batch Report Portal View
Updated 5 months ago