Process a Card Sale

The methods below are for PCI Level 1 compliant merchants only. These operations involve sensitive credit card data. Additionally, they require a secured header. If you are not PCI compliant, use our PayForm widget instead.

Process a card sale with card present

<style>h4{color:red;}</style> <h4>For PCI compliant merchants only</h4>

post

/APIcardProcREST/v1.0.0/CardSale/CardPresent

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-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

Trackstring

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

AcctHolderobject

EndCustomerobject

Amountsobject

PurchItemsobject

MerchIDinteger

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/CardSale/CardPresent' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"Track":"%B4788250000028291^VISA TEST/GOOD^231010100733000000?;4895390000000013=151210100000733?","MerchID":1,"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"},"AcctHolder":{"Firstname":"Sean","Lastname":"Wood","Company":"","Title":"","Url":"","Email":"[e-mail]","Phone":"8777248472","BillIngAdress":{"Address1":"123 Fake St.","Address2":"","City":"PORTLAND","State":"ME","ZIP":"04106","Country":"USA"}},"EndCustomer":{"Firstname":"Sean","Lastname":"Wood","Company":"","Title":"","Url":"","Email":"[e-mail]","Phone":"8777248472","BillIngAdress":{"Address1":"123 Fake St.","Address2":"","City":"PORTLAND","State":"ME","ZIP":"04106","Country":"USA"}}}'

200

200

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

Successful response

Process a manual card sale

<style>h4{color:red;}</style> <h4>For PCI compliant merchants only</h4>

post

/APIcardProcREST/v1.0.0/CardSale/Manual

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-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

ccCardInfoobject

AcctHolderobject

EndCustomerobject

AmountsFullobject

Itemsobject

MerchIDinteger

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/CardSale/Manual' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"MerchID":1,"ccCardInfo":{"AccountNumber":"4111111111111111","ExpMonth":10,"ExpYear":2028,"CSV":"122"},"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"},"AcctHolder":{"Firstname":"Sean","Lastname":"Wood","Company":"","Title":"","Url":"","Email":"[e-mail]","Phone":"8777248472","BillIngAdress":{"Address1":"123 Fake St.","Address2":"","City":"PORTLAND","State":"ME","ZIP":"04106","Country":"USA"}},"EndCustomer":{"Firstname":"Sean","Lastname":"Wood","Company":"","Title":"","Url":"","Email":"[e-mail]","Phone":"8777248472","BillIngAdress":{"Address1":"123 Fake St.","Address2":"","City":"PORTLAND","State":"ME","ZIP":"04106","Country":"USA"}}}'

200

200

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

Successful response

Process a card sale with surcharge

<style>h4{color:red;}</style> <h4>For PCI compliant merchants only</h4>

post

/APIcardProcREST/v1.0.0/CardSale/Surcharge

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-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

MerchIDinteger

Example: 1

ccCardInfoobject

AcctHolderobject

EndCustomerobject

Amountsobject

PurchItemsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/CardSale/Surcharge' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"MerchID":1,"ccCardInfo":{"AccountNumber":"4111111111111111","ExpMonth":10,"ExpYear":2028,"CSV":"122"},"Amounts":{"BaseAmt":52,"Surcharge":1.04,"TotalAmt":53.04},"PurchItems":{"ServiceDescrip":"FROM API TESTER","ClientRefID":"1876345","RPGUID":"3d3424a6-c5f3-4c28-a294-490b6f674b41"},"AcctHolder":{"Firstname":"Sean","Lastname":"Wood","Company":"","Title":"","Url":"","Email":"[e-mail]","Phone":"8777248472","BillIngAdress":{"Address1":"123 Fake St.","Address2":"","City":"PORTLAND","State":"ME","ZIP":"04106","Country":"USA"}},"EndCustomer":{"Firstname":"Sean","Lastname":"Wood","Company":"","Title":"","Url":"","Email":"[e-mail]","Phone":"8777248472","BillIngAdress":{"Address1":"123 Fake St.","Address2":"","City":"PORTLAND","State":"ME","ZIP":"04106","Country":"USA"}}}'

200

200

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

Successful response