Create a recurring consent with manual card entry

post: https://easypay5.com/APIcardProcNumber/v1.0.0/ConsentRecurring/Create

For PCI compliant merchants only (AOC on file with Number required)

Sample Request

{
  "ccCardInfo": {
    "AccountNumber": "4111111111111111",
    "ExpMonth": 10,
    "ExpYear": 23,
    "CSV": "123",
    "Track": "%B4788250000028291^VISA TEST/GOOD^231010100733000000?;4895390000000013=151210100000733?"
  },
  "ConsentCreator": {
    "MerchID": 1,
    "CustomerRefID": "A123456",
    "ServiceDescrip": "",
    "RPGUID": "",
    "StartDate": "/Date(1564409121413-0400)/",
    "NumPayments": 10,
    "TotalAmount": 10000,
    "Period": 2
  },
  "AcctHolder": {
    "Firstname": "Sean",
    "Lastname": "Wood",
    "Company": "",
    "Title": "",
    "Url": "",
    "BillIngAdress": {
      "Address1": "123 Fake St",
      "Address2": "",
      "City": "PORTLAND",
      "State": "ME",
      "ZIP": "04106",
      "Country": "USA"
    },
    "Email": "[e-mail]",
    "Phone": "8777248472"
  },
  "EndCustomer": {
    "Firstname": "Sean",
    "Lastname": "Wood",
    "Company": "",
    "Title": "",
    "Url": "",
    "BillIngAdress": {
      "Address1": "123 Fake St.",
      "Address2": "",
      "City": "PORTLAND",
      "State": "ME",
      "ZIP": "04106",
      "Country": "USA"
    },
    "Email": "[e-mail]",
    "Phone": "8777248472"
  }
}

Sample Response

{
  "ConsentRecurring_CreateResult": {
    "ConsentID": 22,
    "CreationSuccess": true,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "MySched": [
      {
        "Remaining": 9000,
        "SchedID": 41,
        "paymentAmt": 1000,
        "paymentDate": "2024-12-01T11:19:01.000Z",
        "paymentNo": 1
      }
    ],
    "PreConsentAuthMessage": "APPROVED 298734                 ",
    "PreConsentAuthSuccess": true,
    "PreConsentAuthTxID": 66,
    "RespMsg": "Success : Created Recurring Consent ID : 000022"
  }
}

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

ccCardInfo object optional

AccountNumber string optional

Example: 4111111111111111

---

ExpMonth integer optional

Example: 10

---

ExpYear integer optional

Example: 2028

---

CSV string optional

Example: 122

---

Track string | nullable optional

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

ConsentCreator object optional

MerchID integer optional

Example: 1

---

CustomerRefID string optional

Example: A123456

---

ServiceDescrip string optional

---

RPGUID string optional

A custom, user-defined reference ID or value.

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

---

StartDate string optional

Date and time in Microsoft JSON date format (Unix timestamp and timezone offset).

Example: 2024-12-01T11:19:01.000Z

---

NumPayments integer optional

Example: 10

---

TotalAmount number · float optional

Example: 10000

---

Period integer optional

Example: 2

AcctHolder object optional

Firstname string optional

Example: Sally

---

Lastname string optional

Example: APIACH

---

Company string optional

---

Title string optional

---

Url string optional

---

BillIngAddress object optional

---

Email string optional

Example: [e-mail]

---

Phone string optional

Example: 8775558472

EndCustomer object optional

Firstname string optional

Example: Sally

---

Lastname string optional

Example: APIACH

---

Company string optional

---

Title string optional

---

Url string optional

---

BillIngAddress object optional

---

Email string optional

Example: [e-mail]

---

Phone string optional

Example: 8775558472