Update Consumer – Required Fields and Parameters
CashLine API has the ability to update or add to the consumer’s information on file such as the consumer’s SSN or Drivers License number and address (if moved or moved out of state or to a new address), add the ability to add a new bank account. All the fields do not need the operation field (add, delete, inquiry), these are accepted as updated if they are sent in the request and do not need the operation field.
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
| Field Parameter | Required or Optional | Field Values or Constraints |
|---|---|---|
| merchantID 123456 | REQUIRED | 6 / 6 All Numeric, 0-9 (no special characters or alpha allowed) |
| trxID 1234567890 | REQUIRED | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| integratorID xYzAbC123 | REQUIRED | 4 / 30 Alphanumeric, space and dash |
| termsAcceptedInd Y=yes | REQUIRED | 1 byte Y=yes the consumer has been provided the terms and conditions and they have approved them. |
| ssn 999999999 | OPTIONAL | 999999999 |
| email { | OPTIONAL | Object |
| operation add or delete | OPTIONAL | add or delete |
| emailAddress iam2home.com } | OPTIONAL | 50 All Characters Allowed |
| phoneNumber 7275551212 | OPTIONAL | 10 digits/Numeric only. No dashes or spaces. |
| name { | REQUIRED | Object |
| firstName firstname | REQUIRED | 2 / 25- 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| lastName lastname } | REQUIRED | 2 / 25- 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| address { | REQUIRED | Object - US Only - *Canadian Addresses not permitted |
| address1 7512 Parkway Road | REQUIRED | 2 / 25 Alphanumeric characters, "-", ".", ",", "&"," " ' ", and spaces only |
| address2 suite 7512 | REQUIRED | 2 / 14 Alphanumeric characters, "-", ".", ",", "&"," " ' ", and spaces only |
| city New York City | REQUIRED | 30 Max 30 characters Alphanumeric characters, "-", ".", ",", "&"," " ' ", and spaces only |
| state FL | REQUIRED | 2 characters alpha - US states only |
| zip 12345 } | REQUIRED | 5 or 9 Numeric characters only |
| account { | REQUIRED | Object |
| operation add or delete or inquiry | OPTIONAL | add or delete or inquiry |
| accountNickname Wells Fargo Gaming 2212 | OPTIONAL | Max 30 Alpha only a-z, A-Z |
| accountToken 1b68bd74-a0e7-11ea-9630-9750481e0769 | OPTIONAL | Max 60 Alphanumeric and dash |
| micrData TOAD | REQUIRED | TOAD 1 / 75 Alphanumeric and spaces only. lower Case letters |
| d { | REQUIRED | Object |
| operation add or inquiry | OPTIONAL | add or inquiry only |
| idCode FL | REQUIRED | 2 characters alpha, A-Z US only |
| idValue 123458 | REQUIRED | Alphanumeric and Asterisks (*) Only. Dashes or spaces, if entered, will be stripped out. Max Length - 24 Alphabetic characters. This variable-size field contains the Driver's License number. Asterisks are acceptable characters. However, other special characters such as dashes and spaces appearing on the face of the license should not be manually entered or transmitted. |
| idToken 1b68bd74-a0e7-11ea-9630-9750481e0769 } | OPTIONAL | Max 60 Alphanumeric and dash |
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
{
"merchantID":"123456",
"trxID":"1234567890",
"integratorID":"xYzAbC123",
"termsAcceptedInd":"Y",
"ssn":"999999999",
"email": {
"operation":"add or delete",
"emailAddress":"iam@home.com"
},
"phoneNumber":"7275551212",
"name": {
"firstName":"Johnny",
"lastName":"Rocket"
},
"address": {
"address1":"7512 Parkway Road",
"address2":"suite 7512 xxxxx",
"city":"Marietta",
"state":"GA",
"zip":"30006"
},
"account": {
"operation":"add or delete or inquiry",
"accountNickname":"WellsFargo1",
"accountToken":"99da5722-83f9-11ea-b9c5-f9a750265efe",
"micrData":"t123456789t o1234o 123",
},
"id": {
"operation":"add or inquiry",
"idCode":"GA",
"idValue":"123458",
"idToken":"1b68bd74-a0e7-11ea-9630-9750481e0769"
},
}
just add and email example.
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
{
"merchantID":"123456",
"trxID":"1234567890",
"integratorID":"xYzAbC123",
"termsAcceptedInd":"Y",
"ssn":"999999999",
"email": {
"operation":"add or delete",
"emailAddress":"iam@home.com"
},
}
Change phone number, name and or address just by reentering the new values example change 7275551212 by just entering 8135551313
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
{
"merchantID":"123456",
"trxID":"1234567890",
"integratorID":"xYzAbC123",
"termsAcceptedInd":"Y",
"ssn":"999999999",
"phoneNumber":"7275551212",
"name": {
"firstName":"Johnny",
"lastName":"Rocket"
},
"address": {
"address1":"7512 Parkway Road",
"address2":"suite 7512 xxxxx",
"city":"Marietta",
"state":"GA",
"zip":"30006"
},
}
Singularly change by Add, delete or inquiry the account information. Singularly change just the ID by add or query the ID with the query operations.
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
{
"merchantID":"123456",
"trxID":"1234567890",
"integratorID":"xYzAbC123",
"termsAcceptedInd":"Y",
"account": {
"operation":"add or delete or inquiry",
"accountNickname":"WellsFargo1",
"accountToken":"99da5722-83f9-11ea-b9c5-f9a750265efe",
"micrData":"t123456789t o1234o 123",
},
"id": {
"operation":"add or inquiry",
"idCode":"GA",
"idValue":"123458",
"idToken":"1b68bd74-a0e7-11ea-9630-9750481e0769"
},
}
Update Consumer Response
| Field Parameter | Field Values or Constraints |
|---|---|
| trxID 1234567890 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| consumerToken 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| termsAcceptedInd Y=yes or N=No | 1 Byte N=yes or N=No 1 byte Y=yes the consumer has been provided the terms and conditions and they have approved them. |
| activeInd Y=yes or N=No | 1 Byte N=yes or N=No |
| name { | Object |
| firstName Jack | 2 / 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| lastName Kelley } | 2 / 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| address { | Object - US Only - *Canadian address not allowed |
| address1 12355 Rose Blvd | 2 / 25 Alphanumeric characters, "'", &, "-", ".", ",", and spaces only |
| Address2 | 2 / 25 Alphanumeric characters, "'", &, "-", ".", ",", and spaces only |
| city St Pete | 2 / 25 Alphanumeric characters, "'", "-", ".", ",", and spaces only |
| state FL | 2 characters alpha - US states only |
| zip 33716 } | 5 or 9 Numeric only |
| Limit { | Object |
| cashLineLimit 500 | No Min/(Max) 9999999.99 Only Digits - No commas |
| cashLineAvailable 500 | No Min/(Max) 9999999.99 Only Digits - No commas |
| cashLineRefillAmount | No Min/(Max) 9999999.99 Only Digits - No commas |
| cashLineRefillDate } | DATE/TIME |
| ids [ { | Object Possible for multiple ID's if the consumer has had a change of address |
| idCode FL | 2 characters alpha, A-Z US only |
| idToken e8a71815-48fa-11ea-962c-49d8ac5f6bfd | Max 60 Alphanumeric and dash |
| idPrimaryInd Y } | 1 Alpha only |
| idCode { GA | 2 characters alpha, A-Z US only |
| idToken e8a71815-48fa-11ea-962c-49d8ac5f6bfd | Max 60 Alphanumeric and dash |
| idPrimaryInd N } ] | 1 Alpha only |
| accounts [ { | Object |
| accountNickname Bank of America | Max 30 Alpha only a-z, A-Z |
| accountToken f993a543-99fa-11ea-962c-9177b3498g66 | Max 60 Alphanumeric and dash |
| accountLast4 3169 | 4 / 4 All numeric |
| isLastUsed true } | (boolean) true/false (lowercase only) |
| accountNickname { Wells Fargo | Max 30 Alpha only a-z, A-Z |
| accountToken e893b724-48fa-11ea-962c-9177b3415f70 | Max 60 Alphanumeric and dash |
| accountLast4 2058 | 4 / 4 All numeric |
| isLastUsed false } ] | (boolean) true/false (lowercase only) |
| SSNPresent false | (boolean) true/false (lowercase only) |
| phoneMasked 1176 | 4 digits Numeric only |
| emailAddress junk1@certegy.com } | 50 All Characters Allowed |
{
"trxID":"1234567890",
"consumerToken":"99da5722-83f9-11ea-b9c5-f9a750265efe",
"termsAcceptedInd":"Y",
"activeInd":"Y",
"name":{
"firstName":"Jack",
"lastName":"Kelley"
},
"address":{
"address1":"12355 Rose Blvd",
"address2":"suite 3",
"city":"St Pete",
"state":"FL",
"zip":"33716"
},
"limit":{
"cashLineLimit":"500",
"cashLineAvailable":"500"
},
"ids":[
{
"idCode:":"FL",
"idToken":"e8a71815-48fa-11ea-962c-49d8ac5f6bfd",
"idPrimaryInd":"Y"
},
(if multiple IDs on file list continues)
{
"idCode:":"GA",
"idToken":"e8a71815-48fa-11ea-962c-49d8ac5f6bfd",
"idPrimaryInd":"N"
}
],
"account":[
{
"accountNickname":"Bank of America",
"accountToken":"e893b724-48fa-11ea-962c-9177b3415f70",
"accountLast4":"2058",
"isLastUsed":"true"
},
(if multiple accounts on file list continues)
{
"accountNickname":"Wells Fargo",
"accountToken":"e893b724-48fa-11ea-962c-9177b3415f70",
"accountLast4":"2058",
"isLastUsed":"false"
}
],
"SSNPresent":"false",
"phoneMasked":"1176",
"emailAddress":"junk1@certegy.com"
}
Get Consumer Response Decline/Error – HTTPS 400 and HTTPS 500
If the customer is not enrolled in CashLine you will receive a “Customer is not Enrolled” response.
| Field Parameter | Field Values or Constraints |
|---|---|
| errors [ { | object |
| errorPath /customer/customer | Max 200 Alpha only a-z, A-Z |
| errorMessage Invalid or inactive setup | Max 200 Alpha only a-z, A-Z |
| errorDetails The client's account information does not exist or has been deactivated in Certegy's system. Reattempt the transaction. If the issue persists, contact Certegy Client Relations at 833-293-3131 | Max 260 Alpha only a-z, A-Z |
| errorType system_error | Max 20 Alpha only a-z, A-Z |
| errorDate 06-25-2020 03:18:19 | DATE/TIME |
| trxID 100235245 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| responseCode 0314 | Min/Max 4 bytes Numeric only |
| adverseAction false | (boolean) true/false (lowercase only) |
| stationNum 1070000000 } ] } | 10 Max Numeric only |
{
"errors": [
{
"errorPath":"/customer",
"errorMessage":"Customer is not Enrolled",
"errorDetails":"The client's account information does not exist or has been deactivated in Certegy's system. Reattempt the transaction. If the issue persists, contact Certegy Client Relations at 833-293-3131",
"errorType":"system_error",
"errorDate":"06-25-2020 03:18:19",
"trxID":"12345678954",
"responseCode":"0390",
"adverseAction":"false",
"stationNum":"1070000000"
}
]
}