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 | Value | 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 |
| operation | add or delete | OPTIONAL | add or delete |
| emailAddress | iam@home.com | OPTIONAL | 50 All Characters Allowed. (All emails must be unique and cannot be shared with another consumer) |
| phoneNumber | 7275551212 | OPTIONAL | 10 digits/Numeric only. No dashes or spaces. |
| firstName | firstname | REQUIRED | 2 / 25- 25 digits - Alphanumeric, "-", ".", ",", and spaces only |
| lastName | lastname | REQUIRED | 2 / 25- 25 digits - Alphanumeric, "-", ".", ",", and spaces only |
| address1 | 7512 Parkway Road | REQUIRED | 2 / 50 Alphanumeric, "'", &, "-", ".", “#”, “/ ", “( )”, tab and spaces only |
| address2 | suite 7512 | OPTIONAL | 2 / 50 Alphanumeric, "'", &, "-", ".", “#”, “/ ", “( )”, tab and spaces only |
| city | New York City | REQUIRED | 2 / 30 Alphanumeric, "-", ".", ",", " " ' ", and spaces only |
| state | FL | REQUIRED | 2 Alpha, A-Z US only allowed |
| zip | 12345 | REQUIRED | 5 or 9 Numeric only |
| operation | 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 | REQUIRED | 1 / 75 Alphanumeric and spaces only. lower Case letters See TOAD | |
| operation | OPTIONAL | add or inquiry only | |
| idCode | FL | REQUIRED | 2 Alpha, A-Z US only allowed |
| 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 Success
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| trxID | 1234567890 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| trxRefID | 5604490000014 | Max 15 Numeric |
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| status | Success |
{
"trxID": "1234567890",
"trxRefID": "5604490000014",
"consumerToken": "99da5722-83f9-11ea-b9c5-f9a750265efe",
"status": "Success",
}
Get Consumer Response Fail
If the customer is not enrolled in CashLine you will receive a “Customer is not Enrolled” response.
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| trxID | 100235245 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| trxRefID | 5604490000014 | Max 15 Numeric |
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| responseCode | 03 | Min/Max 4 bytes Numeric only |
| responseMsg | SSN Error | Max 200 Alpha only a-z, A-Z |
| responseDetails | The SSN provided is already associated with a different consumer, etc.... | Max 260 Alpha only a-z, A-Z |
{
"trxID": "1234567890",
"trxRefID": "1534512345623",
"consumerToken": "token value",
"responseCode": "03",
"responseMsg": "SSN Error"
"responseDetails": "The SSN provided is already associated with a different consumer, etc...."
}