Creating a Payment

Create a new payment in the system.

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

The CreatePayment method allows for a 'Virtual Terminal' payment type to be processed. It allows you to run a card or bank account payment method.

Inbound Parameters

Parameter NameDescriptionRequired/Not
FirstNameFirst Name of customerREQUIRED
LastNameLast Name of customerREQUIRED
Address1First line of customer’s billing street addressREQUIRED

(May not always be required. Depends on your gateway)
Address2Second line of customer’s billing street addressOptional
CityCustomer’s billing address cityREQUIRED
StateCodeCustomer’s billing state code, in two letter format, so “Florida” = “FL”REQUIRED
PostalCodeCustomer’s billing zipcodeREQUIRED
CountryCodeCustomer’s billing country code, in two letter format, so “United States” = “US” (default)REQUIRED
EmailCustomer’s email, standard format ([email protected])REQUIRED
MobilePhoneMobile phone number of customer, provided in 10 digit format: 3055551212.

Must be a valid mobile number or the transaction will be declined
REQUIRED
ChargeTypeCharge – Charge a Credit Card or ACH account in a single transaction (default)

For ACH 🏦 - Use Charge

Authorize – authorize a Credit Card for a specific amount but doesn't charge it right away.
OPTIONAL
CCNumberCredit Card number, without spaces💳 REQUIRED FOR CREDIT CARD METHOD
ExpirationMonthExpiration Date (Month) – with preceding “0”, so May = “05”💳 REQUIRED FOR CREDIT CARD METHOD
ExpirationYearExpiration Date (Year) – in two digit format, so 2016 = “16”💳 REQUIRED FOR CREDIT CARD METHOD
CVVVerification Code on credit card

3 digit number for Visa or MC
4 digit number for AMEX
💳 REQUIRED FOR CREDIT CARD METHOD
AccountNumberFor ACH transitions, enter the bank account number for the customer.🏦 REQUIRED FOR ACH METHOD
RoutingNumberFor ACH transitions, enter the bank routing number for the customer's bank account.🏦 REQUIRED FOR ACH METHOD
AmountTotal amount to be processed – No “$” required. Example: 1.00REQUIRED
DescriptionDescription of the processed orderOPTIONAL
OrderNumberThis should be a unique value your application defines which is associated with the invoice that appears on the top of the customer facing invoice as "Invoice #" and throughout the Everyware portal.OPTIONAL
CreateTokenTrue : to tokenize Credit Card or ACH account as you run it

False : if you don't want to tokenize Credit Card or ACH account
OPTIONAL
CardTokenThe token of the Credit Card or ACH to be charged, as returned from the Create Payment API.OPTIONAL
IsEmailReceiptSend a receipt via automatic email to the email address provided above. Should be “true” or “false”. True is defaultOPTIONAL
IsSMSReceiptSend a receipt via SMS to the mobile phone number provided above. Should be “true” or “false”. True is defaultOPTIONAL

If IsSMSReceipt flag turned on, Mobile Number will be required.
TagsAdds existing tag or if unrecognized, automatically creates a new contact tag and adds to the contact's profile.

Separate tags by comma.

Ex: VIP, Customer
OPTIONAL
StatementDescriptorIn payment receipts and receipt text messages, the statement descriptor is what will show on the customer's bank statement.

Note: *Make sure this matches with what will actually show on your customer's bank statement to avoid confusion. Otherwise, set up custom descriptors for your sales site(s) with your Everyware rep
OPTIONAL
ExternalIDA unique identifier for the invoice you provide, which Everyware will store.OPTIONAL

Sample Use Case 1: Create Card Payment

Use a customer's card as the payment method.

{
    "FirstName": "Suzie",
    "LastName": "Sick",
    "Address1": "123 Testing",
    "Address2": "",
    "City": "Austin",
    "StateCode": "TX",
    "PostalCode": "78701",
    "CountryCode": "US",
    "Email": "[email protected]",
    "MobilePhone":"5125555555",
    "CCNumber": "111111111111111",
    "ExpirationMonth": "11",
    "ExpirationYear": "29",
    "CVV": "111",
    "Amount": "1",
    "Description": "New Patient Enrollment Fee",
    "OrderNumber": "111111",
    "ChargeType": "Charge",
    "IsEmailReceipt": false,
    "IsSMSReceipt": true,
    "StatementDescriptor": "HelloSunshine",
    "CreateToken": true
}
curl --location 'https://rest.everyware.com/api/Default/CreatePayment' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
    "FirstName": "Suzie",
    "LastName": "Sick",
    "Address1": "123 Testing",
    "Address2": "",
    "City": "Austin",
    "StateCode": "TX",
    "PostalCode": "78701",
    "CountryCode": "US",
    "Email": "[email protected]",
    "MobilePhone":"5125555555",
    "CCNumber": "111111111111111",
    "ExpirationMonth": "11",
    "ExpirationYear": "29",
    "CVV": "111",
    "Amount": "1",
    "Description": "New Patient Enrollment Fee",
    "OrderNumber": "111111",
    "ChargeType": "Charge",
    "IsEmailReceipt": false,
    "IsSMSReceipt": true,
    "StatementDescriptor": "HelloSunshine",
    "CreateToken": true
}
{
    "IsSuccess": true,
    "Message": "The credit card has been accepted.",
    "Data": {
        "TransactionStatus": true,
        "InvoiceNumber": "ew_3JN25fAawEMtODxF3OEtn7Q1",
        "InvoiceID": "ew_3JN25fAawEMtODxF3OEtn7Q1",
        "TokenStatus": true,
        "TokenResult": "card_ew12345678abc"
    },
    "OrderNumber": "111111"
}

Sample Use Case 2: Create Bank Account Payment

Use a customer's bank account as the payment method.

{
    "FirstName": "Suzie",
    "LastName": "Sick",
    "Address1": "123 Suzie St",
    "Address2": "",
    "City": "Boca",
    "StateCode": "FL",
    "PostalCode": "33472",
    "CountryCode": "US",
    "Email": "[email protected]",
    "MobilePhone": "5129474078",
    "AccountNumber": "1234536",
    "RoutingNumber": "031176110",
    "Amount": "1",
    "Description": "Name of Item Purchased",
    "ChargeType": "charge",
    "IsEmailReceipt": false,
    "IsSMSReceipt": true,
    "StatementDescriptor": "HelloSunshineMaster",
    "CreateToken": false
}
curl --location 'https://rest.everyware.com/api/Default/CreatePayment' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
    "FirstName": "Suzie",
    "LastName": "Sick",
    "Address1": "123 Suzie St",
    "Address2": "",
    "City": "Boca",
    "StateCode": "FL",
    "PostalCode": "33472",
    "CountryCode": "US",
    "Email": "[email protected]",
    "MobilePhone": "5129474078",
    "AccountNumber": "1234536",
    "RoutingNumber": "031176110",
    "Amount": "1",
    "Description": "Name of Item Purchased",
    "ChargeType": "charge",
    "IsEmailReceipt": false,
    "IsSMSReceipt": true,
    "StatementDescriptor": "HelloSunshineMaster",
    "CreateToken": false
}
{
    "IsSuccess": true,
    "Message": "\r\nThe credit card has been accepted.",
    "Data": {
        "TransactionStatus": true,
        "InvoiceNumber": "EWTest_141150e7-1cae-4236-be7a-6147098614fa",
        "InvoiceID": "EWTest_141150e7-1cae-4236-be7a-6147098614fa",
        "ReceiptNumber": "EWTest_141150e7-1cae-4236-be7a-6147098614fa",
        "TokenStatus": false,
        "TokenResult": null
    },
    "OrderNumber": "E366849224",
    "SMSID": null
}

Example Integrated Payment Webform

Integrated payment webform using the CreatePayment API to process online card payments.