Everyware DocsAPI Base URL
All documentation

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
  </td><td>
    Optional
  </td></tr><tr><td>
    LastName
  </td><td>
    The account holder's last name.
  </td><td>
    Optional
  </td></tr><tr><td>
    CardNumber
  </td><td>
    The last 4 digits of the card number used on the payment attempt.
  </td><td>
    Optional
  </td></tr><tr><td>
    ExternalID
  </td><td>
    Unique identifier from an external system that is stored as the contact's CustomerID in their customer profile, if provided.
  </td><td>
    Optional
  </td></tr></tbody></table>

Response Parameters

Parameter Name Description
BatchID A unique identifier from Everyware's partner that indicates the batch in which this transaction is bundled.
PaymentID A unique identifier for the specific payment in the Everyware system.
ValidDated
PaymentType Can have a value of: 
    * Authorized
    * Charged
    * Chargeback
    * Chargeback Alert
    * Failed
    * RDR Alert
    * Refund
    * Refund Failed
    * Voided
  </td></tr><tr><td>
    Company
  </td><td>
    The *Doing Business As* name of the sales site (business) that processed the payment type.
  </td></tr><tr><td>
    CardNumber
  </td><td>
    The last four digits of the card used for the transaction.
  </td></tr><tr><td>
    OrderNumber
  </td><td>
    A unique identifier in the Everyware system associated with the specific order/invoice.
  </td></tr><tr><td>
    CardName
  </td><td>
    The name on the card that was used for the transaction.
  </td></tr><tr><td>
    ReceiptEmail
  </td><td>
    The email to which the receipt for the transaction was sent.
  </td></tr><tr><td>
    CustomField1
  </td><td>
    May return any information configured by the user.
  </td></tr><tr><td>
    Description
  </td><td>
    The description of the good or service purchased, refunded, etc.
  </td></tr><tr><td>
    AmountConv
  </td><td>
    The 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.
  </td></tr><tr><td>
    AmountDelivery
  </td><td>
    The 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.
  </td></tr><tr><td>
    AmountOther1
  </td><td>
    A 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.
  </td></tr><tr><td>
    AmountOther2
  </td><td>
    A 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.
  </td></tr><tr><td>
    Tax
  </td><td>
    The 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.
  </td></tr><tr><td>
    AmountTip
  </td><td>
    The 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.
  </td></tr><tr><td>
    AmountDiscount
  </td><td>
    The 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.
  </td></tr><tr><td>
    Amount
  </td><td>
    The 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.
  </td></tr><tr><td>
    Reserve
  </td><td>
    The 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.
  </td></tr><tr><td>
    Fee
  </td><td>
    The application fee applied by Everyware.
  </td></tr><tr><td>
    TransactionFee
  </td><td>
    The sum of the transaction fee from Everyware's partner and Everyware's transaction fee.
  </td></tr><tr><td>
    TotalFees
  </td><td>
    If 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.
  </td></tr><tr><td>
    Net
  </td><td></td></tr><tr><td>
    DateAdded
  </td><td>
    The 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.
  </td></tr></tbody></table>

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": "HelloSunshine@gmail.com ",
            "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"
        },
        {