Getting Payments Reports

Access Endpoint URL: https://rest.everyware.com/api/Report/GeneratePaymentReport [POST]

The GeneratePaymentReport method allows you to pull payment report data available in the Everyware portal View Payments table for a specified date range so you can display details in your system's reports and dashboards. You also have the option to filter the results by a few additional parameters.

🚧
Date Range must be limited to a maximum of 180 days.

Inbound Parameters

Filter payment report data with the following inputs.

Parameter	Description	Required or Optional
StartDate	Date of charge, invoice, or refund.	REQUIRED
EndDate	Date of charge, invoice, or refund.	REQUIRED
OrderNumber	Order Number can be found in the request or response from the CreatePayment or CreateInvoice API.	OPTIONAL
PhoneNumber	The phone number of the contact.	OPTIONAL
CardNumber	The last 4 digits of the card number used on the payment attempt.	OPTIONAL
PaymentType	1 - Virtual Terminal 2 - Invoice 3 - Subscription 4 - Cash 5 - POS 6 - BNPL	OPTIONAL
Transaction Type	Charge, Refund, Authorized, Voided, Failed, Chargeback, Under Review	OPTIONAL

Code Sample

{
    "StartDate": "2023-02-10",
    "EndDate": "2023-03-30",
    "OrderNumber": null,
    "PhoneNumber": "55555555555",
    "CardNumber": null,
    "TransactionType": null,
    "PaymentType": null
}

curl --location 'https://rest.everyware.com/api/report/generatepaymentreport' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
    "StartDate": "2023-02-10",
    "EndDate": "2023-03-30",
    "OrderNumber": null,
    "PhoneNumber": "55555555555",
    "CardNumber": null,
    "TransactionType": null,
    "PaymentType": null
}

{
    "IsSuccess": true,
    "Message": "The Payment Report has been created",
    "Data": [
        {
            "AccountName": "",
            "AccountNumber": null,
            "AccountType": "Master Card",
            "AddressCity": "Austin",
            "AddressCountry": "US",
            "AddressLine1": "123 Testing",
            "AddressLine2": "",
            "AddressState": "TX",
            "AmountPaid": 1.30,
            "InitialAmount": 1.3000,
            "Business": "Hello Sunshine Auto",
            "IsChargeBack": false,
            "ChargeBackDate": null,
            "Currency": "USD",
            "ExternalID": "",
            "IndividualID": 9096457,
            "DateAdded": "2023-03-29T11:01:24.07-05:00",
            "ModifiedDate": null,
            "ExpirationMonth": "10",
            "ExpirationYear": "29",
            "FailureCode": "",
            "Fee": 0.00,
            "Message": "",
            "Net": 1.30,
            "PaymentID": 15490433,
            "OrderNumber": "111111",
            "InvoiceID": "151791431",
            "PaymentMethod": "Card",
            "PaymentType": "Virtual Terminal",
            "TransactionStatus": "succeeded",
            "Status": "Charge",
            "Phone": "5555555555",
            "Provider": "",
            "ReceiptEmail": "[email protected]",
            "ReceiptNumber": "",
            "Refunded": false,
            "RefundedAmount": 0.0,
            "SalesRep": "",
            "Subcenter": "",
            "UserName": "S",
            "UserID": 16257,
            "Validated": "No",
            "Verified": false,
            "TransactionFee": 0.00,
            "TipAmount": 0.0000,
            "ConvenienceFee": 0.0000,
            "DeliveryFee": 0.0000,
            "OtherFee1": 0.0000,
            "OtherFee2": 0.0000,
            "PartialPayment": false,
            "ProductOrService": "New Patient Enrollment Fee",
            "Refund": null
        }

Inbound Parameters

Code Sample

Example Payment Report Portal View