Modify a consent subscription

Modify an existing subscription consent

post: https://easypay5.com/APIcardProcNumber/v1.0.0/ConsentSubscription/Modify

Sample Request

{
  "ConsentID": 12,
  "ConsentMods": {
    "ExpMonth": 10,
    "ExpYear": 2022,
    "Email": "[e-mail]",
    "Zip": "04106",
    "RPGUID": "",
    "CustomerRefID": "A123456",
    "ServiceDescrip": "Test",
    "PaymentAmt": 10,
    "PaymentAdjustDate": "2019-04-29T11:26:11.093Z",
    "OnHold": false
  }
}

Sample Response

{
  "ErrCode": 0,
  "ErrMsg": "",
  "FunctionOk": true,
  "RespMsg": "Consent successfully modified"
}

Header Parameters

SessKey string required

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-Type string required

Example: application/json

---

Accept string required

Example: application/json

Body

ConsentID integer optional

ID of the consent to be modified

Example: 12

---

ConsentMods object optional

ExpMonth integer optional

Expiration month of the card

Example: 10

---

ExpYear integer optional

Expiration year of the card

Example: 2022

---

Email string · email optional

Email associated with the consent

Example: [e-mail]

---

Zip string optional

ZIP code associated with the consent

Example: 04106

---

RPGUID string optional

A custom, user-defined reference ID or value.

Example: adf98580-b4ab-42fc-bb99-01c89964afe9

---

CustomerRefID string optional

Customer reference ID

Example: A123456

---

ServiceDescrip string optional

Description of the service

Example: Test

---

PaymentAmt number · float optional

Payment $ amount

Example: 10

---

PaymentAdjustDate string · date-time optional

Date and time for payment adjustment

Example: 2019-04-29T11:26:11.093Z

---

OnHold boolean optional

Whether the consent is on hold

Example: false

Notes

In most cases you may only want to modify a single parameter such as PaymentAdjustDate or OnHold. You can supply a value of -1 or "-1" to any value which you do not want us to alter. The following example shows how to simply remove the hold from ConsentID 21:

{
"ConsentID": 21,
"ConsentMods": {
    "ExpMonth": -1,
    "ExpYear": -1,
    "Email": "-1",
    "Zip": "-1",
    "RPGUID": "-1",
    "CustomerRefID": "-1",
    "ServiceDescrip": "-1",
    "PaymentAmt": -1,
    "PaymentAdjustDate": "-1",
    "OnHold": false
   }
}