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 NameDescriptionOptional/Required
BatchIDID number for the batch; when clicked, opens detailed report.Optional
StartDateEstablishes the earliest date in the range for the transaction in the Withdrawal batch.Optional
EndDateEstablishes the latest date in the range for the transaction in the Withdrawal batch.Optional
OrderNumberThe unique identifier used to reference the invoice. It appears on the invoice and in the Payments Report in Portal.Optional
EmailThe customer's email address.Optional
PhoneThe customer's 10-digit max mobile phone number provided without formatting.

Example: 3055551212
Optional
LastNameThe account holder's last name.Optional
CardNumberThe last 4 digits of the card number used on the payment attempt.Optional
ExternalIDUnique identifier from an external system that is stored as the contact's CustomerID in their customer profile, if provided.Optional

Response Parameters

Parameter NameDescription
BatchIDA unique identifier from Everyware's partner that indicates the batch in which this transaction is bundled.
PaymentIDA unique identifier for the specific payment in the Everyware system.
ValidDated
PaymentTypeCan have a value of:

- Authorized
- Charged
- Chargeback
- Chargeback Alert
- Failed
- RDR Alert
- Refund
- Refund Failed
- Voided
CompanyThe Doing Business As name of the sales site (business) that processed the payment type.
CardNumberThe last four digits of the card used for the transaction.
OrderNumberA unique identifier in the Everyware system associated with the specific order/invoice.
CardNameThe name on the card that was used for the transaction.
ReceiptEmailThe email to which the receipt for the transaction was sent.
CustomField1May return any information configured by the user.
DescriptionThe description of the good or service purchased, refunded, etc.
AmountConvThe dollar amount corresponding to the convenience fee. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
AmountDeliveryThe dollar amount corresponding to the delivery fee for the service. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
AmountOther1A custom field that indicates another dollar amount associated with the payment. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
AmountOther2A custom field that indicates another dollar amount associated with the payment. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
TaxThe tax associated with the payment. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
AmountTipThe dollar amount that was provided as a tip. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
AmountDiscountThe dollar amount that was discounted. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will be negative.
AmountThe dollar amount that was processed for a payment type. If the payment type is "Voided", the value will be 0. If the payment type is "Refund", the value will correspond to the amount refunded.
ReserveThe reserve percentage, defined as the portion of funds held back by a payment processor or acquiring bank from a merchant's transactions to cover potential future chargebacks, refunds, or fraud.
FeeThe application fee applied by Everyware.
TransactionFeeThe sum of the transaction fee from Everyware's partner and Everyware's transaction fee.
TotalFeesIf payment type is not "Refund" or "Voided", this value is calculated by adding the Application Fee, Transaction Fee (from Everyware's partner), and the Everyware Transaction Fee together.

If the payment type is "Voided", the value will be 0.
Net
DateAddedThe date that the payment type was added to the Everyware system. For example, if a charge was processed via Everyware on 5-28-2024, this value will be 5-28-2024.

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