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 Name | Description | Required/Not |
|---|---|---|
| FirstName | First Name of customer | REQUIRED |
| LastName | Last Name of customer | REQUIRED |
| Address1 | First line of customer’s billing street address | REQUIRED (May not always be required. Depends on your gateway) |
| Address2 | Second line of customer’s billing street address | Optional |
| City | Customer’s billing address city | REQUIRED |
| StateCode | Customer’s billing state code, in two letter format, so “Florida” = “FL” | REQUIRED |
| PostalCode | Customer’s billing zipcode | REQUIRED |
| CountryCode | Customer’s billing country code, in two letter format, so “United States” = “US” (default) | REQUIRED |
| Customer’s email, standard format ([email protected]) | REQUIRED | |
| MobilePhone | Mobile phone number of customer, provided in 10 digit format: 3055551212. Must be a valid mobile number or the transaction will be declined | OPTIONAL |
| ChargeType | Charge – 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 |
| CCNumber | Credit Card number, without spaces | 💳 REQUIRED FOR CREDIT CARD METHOD |
| ExpirationMonth | Expiration Date (Month) – with preceding “0”, so May = “05” | 💳 REQUIRED FOR CREDIT CARD METHOD |
| ExpirationYear | Expiration Date (Year) – in two digit format, so 2016 = “16” | 💳 REQUIRED FOR CREDIT CARD METHOD |
| CVV | Verification Code on credit card 3 digit number for Visa or MC 4 digit number for AMEX | 💳 REQUIRED FOR CREDIT CARD METHOD |
| AccountNumber | For ACH transitions, enter the bank account number for the customer. | 🏦 REQUIRED FOR ACH METHOD |
| RoutingNumber | For ACH transitions, enter the bank routing number for the customer's bank account. | 🏦 REQUIRED FOR ACH METHOD |
| Amount | Total amount to be processed – No “$” required. Example: 1.00 | REQUIRED |
| Description | Description of the processed order | OPTIONAL |
| OrderNumber | This 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 |
| CreateToken | True : 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 |
| CardToken | The token of the Credit Card or ACH to be charged, as returned from the Create Payment API. | OPTIONAL |
| IsEmailReceipt | Send a receipt via automatic email to the email address provided above. Should be “true” or “false”. True is default | OPTIONAL |
| IsSMSReceipt | Send a receipt via SMS to the mobile phone number provided above. Should be “true” or “false”. True is default | OPTIONAL If IsSMSReceipt flag turned on, Mobile Number will be required. |
| Tags | Adds 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 |
| StatementDescriptor | In 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 |
| ExternalID | A 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.
Updated 5 days ago