Consent Annual

Calculate surcharging or convenience fees

post

/APIcardProcREST/v1.0.0/ConsentAnnual/CalcFees

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

ConsentIDinteger

ID for consent associated with the merchant account

Example: 7849

Amountnumber · float

Base $ amount for which fees are to be calculated

Example: 52

AlternateMerchIDinteger

ID of the merchant to collect the payment funds. Use 0 for the merchant on consent.

Example: 0

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/CalcFees' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"ConsentID":7849,"Amount":52,"AlternateMerchID":0}'

200

200

{
  "ConsentAnnual_CalcFeesResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Fees calculated for CREDIT Card 4663XXXXXXXX2741",
    "Amounts": {
      "BaseAmt": 52,
      "Surcharge": 1.04,
      "TotalAmt": 53.04
    }
  }
}

Successful calculation of fees

Cancel a consent (Card On File)

post

/APIcardProcREST/v1.0.0/ConsentAnnual/Cancel

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

ConsentIDinteger

ID of the consent to be canceled

Example: 20

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/Cancel' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"ConsentID":20}'

200

200

{
  "ConsentAnnual_CancelResult": {
    "CancelSuccess": true,
    "CancelledConsentID": 20,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successfully DISBALED ConsentID 20 : Card Number Removed"
  }
}

Successful cancellation of consent

Charge a stored card

post

/APIcardProcREST/v1.0.0/ConsentAnnual/ChargeStoredCard

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

ConsentIDinteger

ID of the consent (or stored card data)

Example: 8

Amountsobject

purchDetailsobject

AlternateMerchIDinteger

Use 0 for the original merchant record or a positive integer for a different merchant record

Example: 0

Userstring

The user initiating the sale. Used for reporting.

Example: Samuel

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/ChargeStoredCard' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"ConsentID":8,"AlternateMerchID":0,"User":"Samuel","Amounts":{"BaseAmt":52,"Surcharge":1.04,"TotalAmt":53.04},"purchDetails":{"ServiceDescrip":"Annual Checkup","ClientRefID":"174356","RPGUID":"99438332"}}'

200

200

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

Successful charge of the stored card

Modify an annual consent

post

/APIcardProcREST/v1.0.0/ConsentAnnual/Modify

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

ConsentIDinteger

ID of the consent to be modified

Example: 10

ConsentModsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/Modify' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"ConsentID":10,"ConsentMods":{"ExpMonth":10,"ExpYear":22,"Email":"[e-mail]","Zip":"04106","CustomerRefID":"A1235456","ServiceDescrip":"REST API Testor","RPGUID":"adf98580-b4ab-42fc-bb99-01c89964afe9","NumDays":365,"LimitPerCharge":10000,"LimitLifeTime":100000}}'

200

200

{
  "ConsentAnnual_ModifyResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "ModifySuccess": true,
    "RespMsg": "Success : Modified Consent ID : 10"
  }
}

Successful modification of annual consent

Process a payment using a stored card consent

post

/APIcardProcREST/v1.0.0/ConsentAnnual/ProcPayment

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

ConsentIDinteger

ID of the consent to be used for payment

Example: 21

ProcessAmountnumber · float

Amount to be processed

Example: 5

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/ProcPayment' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"ConsentID":21,"ProcessAmount":5}'

200

200

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

Successful processing of consent payment

Process a payment using a stored card consent with an alternate merchant

post

/APIcardProcREST/v1.0.0/ConsentAnnual/ProcPayment_Alt

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

ConsentIDinteger

ID of the consent to be used for payment

Example: 542

ProcessAmountnumber · float

Amount to be processed

Example: 1

AlternateMerchIDinteger

ID of the alternate merchant

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/ProcPayment_Alt' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"ConsentID":542,"ProcessAmount":1,"AlternateMerchID":1}'

200

200

{
  "ConsentAnnual_ProcPayment_AltResult": {
    "AVSresult": "Y",
    "AcquirerResponseEMV": null,
    "CVVresult": "",
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "IsPartialApproval": false,
    "RequiresVoiceAuth": false,
    "RespMsg": "APPROVAL",
    "ResponseApprovedAmount": 0,
    "ResponseAuthorizedAmount": 0,
    "ResponseBalanceAmount": 0,
    "TxApproved": true,
    "TxID": 2875,
    "TxnCode": "TAS018"
  }
}

Successful processing of consent payment with alternate merchant

Retrieve statistics for a specific consent

post

/APIcardProcREST/v1.0.0/ConsentAnnual/Stats

Body

ConsentIDinteger

ID of the consent for which to retrieve statistics

Example: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/Stats' \
  --header 'Content-Type: application/json' \
  --data '{"ConsentID":10}'

200

parameters

200

{
  "ConsentAnnual_StatsResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successfully Returned Stats For Consent ID : 10",
    "Stats": {
      "FirstChargeAttempt": "/Date(1549947600000-0500)/",
      "ID": 10,
      "IsEnabled": false,
      "LastChargeAmount": 0,
      "LastChargeAttempt": "/Date(1549947600000-0500)/",
      "LastSettledAmount": 0,
      "LimitLifeTime": 100000,
      "NumChargeAttempts": 0,
      "NumFailed": 0,
      "NumFailedAttempts": 0,
      "NumOpen": 0,
      "NumSettled": 0,
      "NumTx": 0,
      "RemainingInConsent": 100000,
      "TotalDollarsOpen": 0,
      "TotalDollarsSettled": 0
    }
  }
}

Successfully retrieved consent statistics