Create Annual Consent
For PCI compliant merchants only (AOC on file with Number required)
Header parameters
SessKeystringRequiredExample:
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.
A1842D663E9A4A72XXXXXXXX303541303234373138
Content-TypestringRequiredExample:
application/json
AcceptstringRequiredExample:
application/json
Body
TrackstringOptionalExample:
%B4788250000028291^VISA TEST/GOOD^231010100733000000?;4895390000000013=151210100000733?
Responses
200
Successful response
application/json
post
POST /APIcardProcREST/v1.0.0/ConsentAnnual/Create_CP HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 860
{
"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": "[email protected]",
"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": "[email protected]",
"Phone": "8777248472"
}
}
200
Successful response
{
"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"
}
}
For PCI compliant merchants only (AOC on file with Number required)
Header parameters
SessKeystringRequiredExample:
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.
A1842D663E9A4A72XXXXXXXX303541303234373138
Content-TypestringRequiredExample:
application/json
AcceptstringRequiredExample:
application/json
Body
Responses
200
Successful response
application/json
post
POST /APIcardProcREST/v1.0.0/ConsentAnnual/Create_MAN HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 853
{
"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": "[email protected]",
"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": "[email protected]",
"Phone": "8777248472"
}
}
200
Successful response
{
"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"
}
}
Last updated
Was this helpful?