Payment Webhook

When Everyware receives a payment attempt for one of your contacts, it makes an asynchronous post to the webhook you have marked for this functionality.

🚧

Check Data Format

Please code to the Everyware data format so your endpoint will accept the data: application/x-www-form-urlencoded.

Parameters

Everyware sends the following parameters with its request as POST parameter:

ParameterDescription
PaymentSidA 36 character unique identifier for the payment attempt.
IndividualIDThis is the Everyware unique identifier for the contact.
ExternalIDThis is the unique identifier that you provided on the initial call to create the contact.
ExternalBusinessIDUnique identifier for the business provided by you.
EmailAddressThis is the email address of the contact.
PhoneThis is the phone number of the contact.
StatusIDThis is to identify if the payment attempt was a success or failure. β€œ0” will indicate success, and β€œ1” will indicate failure.
PaymentAmtThis is the dollar amount of the payment attempt.
PaymentDateThis is the date/time the payment attempt was made.
TransactionIDThis is the transaction identifier for the successful transaction, aka InvoiceID.
OrderNumberShows as the Invoice # on the customer facing invoice.
PaymentTypeThis is to identify if a full or partial payment was attempted. β€œP” will indicate partial, β€œF” will indicate full.
CardTypeThis is the type of card that was used for the payment attempt.
LastFourThis is the last 4 digits of the card number used on the payment attempt.
ResponseMessageThis is the response message that is provided for a failed payment attempt.
ServiceDescriptionDescription of the line item on the payment invoice.
ConfirmationCodeThis is an additional reference number from the backend, and may be equal to TransactionID

To set up the Payment Webhook, log into the Everyware portal, go to Settings, open the API Settings tab, and enter the username and password under Configure Webhooks.