Create Annual Consent

Create an annual consent with card present

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

Trackstringoptional

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

ConsentCreatorobjectoptional

AcctHolderobjectoptional

EndCustomerobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ConsentAnnual/Create_CP' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "Track": "%B4788250000028291^VISA TEST/GOOD^231010100733000000?;4895390000000013=151210100000733?",
    "ConsentCreator": {
      "MerchID": 1,
      "CustomerRefID": "A1523644",
      "ServiceDescrip": "REST Test",
      "RPGUID": "ad8c349f-a301-4fc8-956c-54b59a3f6440",
      "StartDate": "/Date(1566406242284-0400)/",
      "NumDays": 365,
      "LimitPerCharge": 1000,
      "LimitLifeTime": 100000
    },
    "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

{
  "ConsentAnnual_Create_CPResult": {
    "ConsentID": 28,
    "CreationSuccess": true,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "PreConsentAuthMessage": "APPROVED 095710                 ",
    "PreConsentAuthSuccess": true,
    "PreConsentAuthTxID": 84,
    "RespMsg": "Success : Created Consent ID : 000028"
  }
}

Successful response

Create an annual 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/ConsentAnnual/Create_MAN' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "ccCardInfo": {
      "AccountNumber": "4111111111111111",
      "ExpMonth": 10,
      "ExpYear": 2022,
      "CSV": "122"
    },
    "ConsentCreator": {
      "MerchID": 1,
      "CustomerRefID": "A1523644",
      "ServiceDescrip": "REST Test",
      "RPGUID": "4c269391-a698-4e10-a1a8-0353ee80d1a6",
      "StartDate": "/Date(1563800567934-0400)/",
      "NumDays": 365,
      "LimitPerCharge": 1000,
      "LimitLifeTime": 100000
    },
    "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

{
  "ConsentAnnual_Create_MANResult": {
    "ConsentID": 18,
    "CreationSuccess": true,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "PreConsentAuthMessage": "APPROVED 297311                 ",
    "PreConsentAuthSuccess": true,
    "PreConsentAuthTxID": 61,
    "RespMsg": "Success : Created Consent ID : 000018"
  }
}

Successful response