For the complete documentation index, see llms.txt. This page is also available as Markdown.

Process a Card Sale

Process a card sale with card present

post: https://easypay5.com/APIcardProcNumber/v1.0.0/CardSale/CardPresent

For PCI compliant merchants only (AOC on file with Number required)

{
  "Track": "%B4788250000028291^VISA TEST/GOOD^231010100733000000?;4895390000000013=151210100000733?",
  "AcctHolder": {
    "Firstname": "Sean",
    "Lastname": "Wood",
    "Company": "",
    "Title": "",
    "Url": "",
    "BillIngAdress": {
      "Address1": "123 Fake St.",
      "Address2": "",
      "City": "PORTLAND",
      "State": "ME",
      "ZIP": "04106",
      "Country": "USA"
    },
    "Email": "robert@easypaysolutions.com",
    "Phone": "8777248472"
  },
  "EndCustomer": {
    "Firstname": "Sean",
    "Lastname": "Wood",
    "Company": "",
    "Title": "",
    "Url": "",
    "BillIngAdress": {
      "Address1": "123 Fake St.",
      "Address2": "",
      "City": "PORTLAND",
      "State": "ME",
      "ZIP": "04106",
      "Country": "USA"
    },
    "Email": "robert@easypaysolutions.com",
    "Phone": "8777248472"
  },
  "Amounts": {
    "TotalAmt": 10,
    "SalesTax": 0,
    "Surcharge": 0,
    "Tip": 0,
    "CashBack": 0,
    "ClinicAmount": 0,
    "VisionAmount": 0,
    "PrescriptionAmount": 0,
    "DentalAmount": 0,
    "TotalMedicalAmount": 0
  },
  "PurchItems": {
    "ServiceDescrip": "FROM API TESTER",
    "ClientRefID": "",
    "RPGUID": "a8e2bbfc-e423-4a84-a9e9-2a6e08153368"
  },
  "MerchID": 1
}

SessKey string required

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138


Content-Type string required

Example: application/json


Accept string required

Example: application/json

Track string optional

Example: %B4788250000028291^VISA TEST/GOOD^231010100733000000?;4895390000000013=151210100000733?


AcctHolder object optional

AccountNum string optional

The unique account number associated with the account holder.

Example: wj8HlAYlMJI=jvje9l7qZuEFiDDeEDDym6ZdlL0DX8HX


AcctMask string optional

The masked version of the account number for security purposes.

Example: 4111XXXXXXXX1111


Address1 string optional

The primary address line of the account holder.

Example: 123 Fake St


Address2 string optional

The secondary address line of the account holder, if applicable.


CardType string optional

The type of card associated with the account (e.g., Visa, MasterCard).

Example: VI


City string optional

The city where the account holder resides.

Example: PORTLAND


Company string optional

The name of the company associated with the account holder, if applicable.


CreatedOn string optional

Date and time in Microsoft JSON date format (Unix timestamp and timezone offset).

Example: 2024-12-01T11:19:01.000Z


Email string optional

The email address of the account holder.

Example: robert@easypaysolutions.com


ExpDate string optional

The expiration date of the card in MMYY format.

Example: 1023


Firstname string optional

The first name of the account holder.

Example: Sean


ID integer optional

The unique identifier for the account holder in the system.

Example: 1


LastChanged string optional

Date and time in Microsoft JSON date format (Unix timestamp and timezone offset).

Example: 2024-12-01T11:19:01.000Z


LastName string optional

The last name of the account holder.

Example: Wood


MerchID integer optional

The unique identifier for the merchant associated with the account.

Example: 1


Phone string optional

The phone number of the account holder.

Example: 8777248472


State string optional

The state where the account holder resides.

Example: ME


Zip string optional

The postal code for the account holder's address.

Example: 04106

EndCustomer object optional

AccountNum string optional

The unique account number associated with the account holder.

Example: wj8HlAYlMJI=jvje9l7qZuEFiDDeEDDym6ZdlL0DX8HX


AcctMask string optional

The masked version of the account number for security purposes.

Example: 4111XXXXXXXX1111


Address1 string optional

The primary address line of the account holder.

Example: 123 Fake St


Address2 string optional

The secondary address line of the account holder, if applicable.


CardType string optional

The type of card associated with the account (e.g., Visa, MasterCard).

Example: VI


City string optional

The city where the account holder resides.

Example: PORTLAND


Company string optional

The name of the company associated with the account holder, if applicable.


CreatedOn string optional

Date and time in Microsoft JSON date format (Unix timestamp and timezone offset).

Example: 2024-12-01T11:19:01.000Z


Email string optional

The email address of the account holder.

Example: robert@easypaysolutions.com


ExpDate string optional

The expiration date of the card in MMYY format.

Example: 1023


Firstname string optional

The first name of the account holder.

Example: Sean


ID integer optional

The unique identifier for the account holder in the system.

Example: 1


LastChanged string optional

Date and time in Microsoft JSON date format (Unix timestamp and timezone offset).

Example: 2024-12-01T11:19:01.000Z


LastName string optional

The last name of the account holder.

Example: Wood


MerchID integer optional

The unique identifier for the merchant associated with the account.

Example: 1


Phone string optional

The phone number of the account holder.

Example: 8777248472


State string optional

The state where the account holder resides.

Example: ME


Zip string optional

The postal code for the account holder's address.

Example: 04106

Amounts object optional

TotalAmt number optional

The total $ amount to be charged.

Example: 10


SalesTax number optional

Example: 0


Surcharge number optional

The surcharge $ amount added to the base amount, if applicable.

Example: 0


Tip number optional

Example: 0


CashBack number optional

Example: 0


ClinicAmount number optional

Example: 0


VisionAmount number optional

Example: 0


PrescriptionAmount number optional

Example: 0


DentalAmount number optional

Example: 0


TotalMedicalAmount number optional

Example: 0

PurchItems object optional

ServiceDescrip string optional

A description of the service or item.

Example: FROM API TESTER


ClientRefID string optional

A reference ID provided by the client for tracking purposes.

Example: 12456AA


RPGUID string optional

A custom, user-defined reference ID or value.

Example: adf98580-b4ab-42fc-bb99-01c89964afe9

MerchID integer optional

Example: 1

Last updated

Was this helpful?