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

AcceptstringRequiredExample: application/json

Body

ConsentIDintegerOptional

ID of the consent to be cancelled

Example: 23

Responses

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/ConsentRecurring/Cancel HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 16

{
  "ConsentID": 23
}

200

Recurring consent successfully cancelled

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

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

AcceptstringRequiredExample: application/json

Body

ConsentIDintegerOptional

ID of the consent to be modified

Example: 42

Responses

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/ConsentRecurring/Modify HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 173

{
  "ConsentID": 42,
  "ConsentMods": {
    "ExpMonth": 10,
    "ExpYear": 2028,
    "Email": "[e-mail]",
    "Zip": "04101",
    "CustomerRefID": "A123456",
    "ServiceDescrip": "Test",
    "RPGUID": ""
  }
}

200

Recurring consent successfully modified

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