Create Recurring Consent

Create a recurring consent with manual card entry

post

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

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

ccCardInfoobjectoptional

ConsentCreatorobjectoptional

AcctHolderobjectoptional

EndCustomerobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentRecurring/Create' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "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"
    }
  }'

200

200

{
  "ConsentRecurring_CreateResult": {
    "ConsentID": 22,
    "CreationSuccess": true,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "MySched": [
      {
        "Remaining": 9000,
        "SchedID": 41,
        "paymentAmt": 1000,
        "paymentDate": "/Date(1549947600000-0500)/",
        "paymentNo": 1
      }
    ],
    "PreConsentAuthMessage": "APPROVED 298734                 ",
    "PreConsentAuthSuccess": true,
    "PreConsentAuthTxID": 66,
    "RespMsg": "Success : Created Recurring Consent ID : 000022"
  }
}

Successful response