Getting Detailed Withdrawals Reports

Access Endpoint URL: https://rest.everyware.com/api/Default/GetWithdrawalsDetails [POST]

The GetWithdrawalsDetails method allows you to extract transaction data from within a Withdrawal Batch, for a specified transaction date range and individual Account Holder.

Inbound Parameters

Parameter Name	Description	Required/Not
BatchID	ID number for the batch, when clicked opens detailed report.	REQUIRED
StartDate	Start of date range for transaction in the Withdrawal batch.	REQUIRED
EndDate	End of date range for transaction in the Withdrawal batch.	REQUIRED
OrderNumber	The unique identifier used to reference the invoice. It appears on the invoice and in the Payments Report in Everyware.	OPTIONAL
Email	Email address of customer.	OPTIONAL
Phone	Mobile phone number of customer, provided in 10 digit format: 3055551212.	OPTIONAL
LastName	Account Holder's last name.	OPTIONAL
CardNumber	The last 4 digits of the card number used on the payment attempt.	OPTIONAL
ExternalID	Unique identifier stored as the contact's CustomerID in their customer profile, if provided.	OPTIONAL

Code Sample

{
  "BatchID": "",
  "StartDate": "",
  "EndDate": "",
  "OrderNumber": "",
  "Email": "",
  "Phone": "",
  "LastName": "",
  "CardNumber": "",
  "ExternalID": ""
}

curl --location 'https://rest.everyware.com/api/Default/GetWithdrawalsDetails' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' 
{
  "BatchID": "",
  "StartDate": "",
  "EndDate": "",
  "OrderNumber": "",
  "Email": "",
  "Phone": "",
  "LastName": "",
  "CardNumber": "",
  "ExternalID": ""
}

{
    "IsSuccess": true,
    "Message": null,
    "Data": [
        {
            "BatchID": 234567,
            "PaymentID": 5759864,
            "ValidDated": "Yes",
            "PaymentType": "Charge",
            "Company": "DBA",
            "CardNumber": "",
            "OrderNumber": "E4777726",
            "CardName": "Card Holder Name",
            "ReceiptEmail": "[email protected] ",
            "CustomField1": "",
            "Description": "Acct 555555 Secure Payment",
            "AmountConv": 0.00,
            "AmountDelivery": 0.00,
            "AmountOther1": 0.00,
            "AmountOther2": 0.00,
            "Tax": 0.00,
            "AmountTip": 0.00,
            "AmountDiscount": 0.00,
            "Amount": 147.11,
            "Reserve": 0.00,
            "Fee": 0.00,
            "TransactionFee": 0.00,
            "TotalFees": 0.00,
            "Net": 147.11,
            "DateAdded": "2022-06-07T14:53:06.557-05:00"
        },
        {