Consent Recurring

Cancel a recurring consent

post

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

ConsentIDintegeroptional

ID of the consent to be cancelled

Example: 23

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

Recurring consent successfully cancelled

Modify a recurring consent

post

For values which should not be altered use value 1 or “1”

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

ConsentIDintegeroptional

ID of the consent to be modified

Example: 42

ConsentModsobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentRecurring/Modify' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "ConsentID": 42,
    "ConsentMods": {
      "ExpMonth": 10,
      "ExpYear": 2028,
      "Email": "[e-mail]",
      "Zip": "04101",
      "CustomerRefID": "A123456",
      "ServiceDescrip": "Test",
      "RPGUID": ""
    }
  }'

200

200

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

Recurring consent successfully modified