Getting Detailed Withdrawals Reports

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

You can use the GetWithdrawalDetails method to extract transaction data from within a Withdrawal Batch. Information can be extracted based on a specified transaction date range or an individual account holder.

Inbound Parameters

Parameters should be passed in a single JSON-body object.

Parameter Name	Description	Optional/Required
BatchID	ID number for the batch; when clicked, opens detailed report.	Optional
StartDate	Establishes the earliest date in the range for the transaction in the Withdrawal batch.	Optional
EndDate	Establishes the latest date in the range for the transaction in the Withdrawal batch.	Optional
OrderNumber	The unique identifier used to reference the invoice. It appears on the invoice and in the Payments Report in Portal.	Optional
Email	The customer's email address.	Optional
Phone	The customer's 10-digit max mobile phone number provided without formatting. Example: 3055551212	Optional
LastName	The account holder's last name.	Optional
CardNumber	The last 4 digits of the card number used on the payment attempt.	Optional
ExternalID	Unique identifier from an external system that is stored as the contact's CustomerID in their customer profile, if provided.	Optional

Code Sample

{
  "BatchID": "234567",
  "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": "234567",
  "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"
        },
        {