Documentation API Reference Ask AI Assistant

Process a Card Sale

PreviousCard Operations NextConsent Annual

Last updated 2 months ago

Was this helpful?

Process a card sale with card present

post

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

Header parameters

SessKeystringRequired

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-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

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

MerchIDintegerOptionalExample: 1

Responses

200

Successful response

application/json

post

POST /APIcardProcREST/v1.0.0/CardSale/CardPresent HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 924

{
  "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
}

200

Successful response

{
  "CreditCardSale_CardPresentResult": {
    "AVSresult": "Y",
    "AcquirerResponseEMV": null,
    "CVVresult": "",
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "IsPartialApproval": false,
    "RequiresVoiceAuth": false,
    "RespMsg": "APPROVED 092682",
    "ResponseApprovedAmount": "-1Pl",
    "ResponseAuthorizedAmount": -1,
    "ResponseBalanceAmount": -1,
    "TxApproved": true,
    "TxID": 44,
    "TxnCode": "092682"
  }
}

Process a manual card sale

post

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

Header parameters

SessKeystringRequired

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-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

MerchIDintegerOptionalExample: 1

Responses

200

Successful response

application/json

post

POST /APIcardProcREST/v1.0.0/CardSale/Manual HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 917

{
  "ccCardInfo": {
    "AccountNumber": "4111111111111111",
    "ExpMonth": 10,
    "ExpYear": 2028,
    "CSV": "122"
  },
  "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": "3d3424a6-c5f3-4c28-a294-490b6f674b41"
  },
  "MerchID": 1
}

200

Successful response

{
  "CreditCardSale_ManualResult": {
    "AVSresult": "Y",
    "AcquirerResponseEMV": null,
    "CVVresult": "",
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "IsPartialApproval": false,
    "RequiresVoiceAuth": false,
    "RespMsg": "APPROVED 099804                 ",
    "ResponseApprovedAmount": -1,
    "ResponseAuthorizedAmount": -1,
    "ResponseBalanceAmount": -1,
    "TxApproved": true,
    "TxID": 41,
    "TxnCode": "099804"
  }
}

Process a card sale with surcharge

post

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

Header parameters

SessKeystringRequired

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-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

MerchIDintegerOptionalExample: 1

Responses

200

Successful response

application/json

post

POST /APIcardProcREST/v1.0.0/CardSale/WithOptions HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 820

{
  "MerchID": 1,
  "ccCardInfo": {
    "AccountNumber": "4111111111111111",
    "ExpMonth": 10,
    "ExpYear": 2028,
    "CSV": "122"
  },
  "AcctHolder": {
    "Firstname": "Sean",
    "Lastname": "Testing",
    "Company": "",
    "Title": "",
    "Url": "",
    "BillingAddress": {
      "Address1": "123 Fake St.",
      "Address2": "",
      "City": "PORTLAND",
      "State": "ME",
      "ZIP": "04106",
      "Country": "USA"
    },
    "Email": "robert@easypaysolutions.com",
    "Phone": "8777248472"
  },
  "EndCustomer": {
    "Firstname": "Sean",
    "Lastname": "Testing",
    "Company": "",
    "Title": "",
    "Url": "",
    "BillingAddress": {
      "Address1": "123 Fake St.",
      "Address2": "",
      "City": "PORTLAND",
      "State": "ME",
      "ZIP": "04106",
      "Country": "USA"
    },
    "Email": "tester@easypaysolutions.com",
    "Phone": "8777248472"
  },
  "Amounts": {
    "BaseAmt": 52,
    "Surcharge": 1.04,
    "TotalAmt": 53.04
  },
  "PurchItems": {
    "ServiceDescrip": "FROM API TESTER",
    "ClientRefID": "1876345",
    "RPGUID": "3d3424a6-c5f3-4c28-a294-490b6f674b41"
  }
}

200

Successful response

{
  "CreditCardSale_WithOptionsResult": {
    "AVSresult": "Y",
    "AcquirerResponseEMV": null,
    "CVVresult": "",
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "IsPartialApproval": false,
    "RequiresVoiceAuth": false,
    "RespMsg": "APPROVED 099804                 ",
    "ResponseApprovedAmount": -1,
    "ResponseAuthorizedAmount": -1,
    "ResponseBalanceAmount": -1,
    "TxApproved": true,
    "TxID": 41,
    "TxnCode": "099804",
    "ApprovedAmounts": {
      "BaseAmt": 52,
      "Surcharge": 1.04,
      "TotalAmt": 53.04
    }
  }
}