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); 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 |
|---|---|---|---|
| trxID | 123456 | REQUIRED | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (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 | 9 digits/Numeric only. No dashes or spaces. |
| operation | add or delete | OPTIONAL | add or delete |
| emailAddress | iam@home.com | OPTIONAL | 50 All Allowed. (All emails must be unique and cannot be shared with another consumer) |
| phoneNumber | 23456778901 | OPTIONAL | 10 digits/Numeric only. No dashes or spaces. Cannot begin with a 0 or a 1. |
| firstName | firstname | OPTIONAL | First name. Allowable characters: a to z (lowercase alphabet) A to Z (uppercase alphabet) 0 to 9 (numeric digits) hyphen (-) dot (.) comma (,) space character ( ) tab character Minimum Characters: 2 Maximum Characters: 25 |
| lastName | lastname | OPTIONAL | Last name. Allowable characters: a to z (lowercase alphabet) A to Z (uppercase alphabet) 0 to 9 (numeric digits) hyphen (-) dot (.) comma (,) space character ( ) tab character Minimum Characters: 2 Maximum Characters: 25 |
| address1 | 12355 Rose Blvd | OPTIONAL | Street number and street name. Allowable characters: a to z (lowercase alphabet) A to Z (uppercase alphabet) 0 to 9 (numeric digits) single quotation mark ( ' ) ampersand ( & ) hyphen ( - ) dot ( . ) comma ( , ) hash symbol (#) forward slash ( / ) parenthesis ( () ) space character ( ) tab character Minimum Characters: 2 Maximum Characters: 50 |
| address2 | suite 3 | OPTIONAL | Additional addressing components. Allowable characters: a to z (lowercase alphabet) A to Z (uppercase alphabet) 0 to 9 (numeric digits) single quotation mark ( ' ) ampersand ( & ) hyphen ( - ) dot ( . ) comma ( , ) hash symbol (#) forward slash ( / ) parenthesis ( () ) space character ( ) tab character Minimum Characters: 2 Maximum Characters: 50 |
| city | St Pete | OPTIONAL | City. Allowable characters: a to z (lowercase alphabet) A to Z (uppercase alphabet) 0 to 9 (numeric digits) single quotation mark ( ' ) hyphen ( - ) dot ( . ) comma ( , ) space character ( ) tab character Minimum Characters: 2 Maximum Characters: 30 |
| state | FL | OPTIONAL | 2 / 2 Alpha only |
| zip | 12345 | OPTIONAL | 5 or 9 Numeric only |
| operation | OPTIONAL | add or delete | |
| accountNickname | Wells Fargo | OPTIONAL | 1/30 Alphanumeric and spl chars except \ and " (If adding new bank account, account nickname is required) |
| accountToken | 1b68bd74-a0e7-11ea-9630-9750481e0769 | OPTIONAL | Max 60 Alphanumeric and dash |
| micrData | OPTIONAL | 1 / 75 Alphanumeric and spaces only. lower Case letters See TOAD | |
| operation | OPTIONAL | add or delete only | |
| idCode | FL | OPTIONAL | 2 / 2 See State Code List |
| idValue | 123458 | OPTIONAL | 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. |
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}{
"trxID": "123456",
"termsAcceptedInd": "Y",
"ssn": "999999999",
"email": {
"operation": "add or delete",
"emailAddress": "iam@home.com"
},
"phoneNumber": "2345678901",
"name": {
"firstName": "Johnny",
"lastName": "Rocket"
},
"address": {
"address1": "12355 Rose Blvd",
"address2": "suite 3",
"city": "St Pete",
"state": "FL",
"zip": "12345"
},
"account": {
"operation": "add or delete or inquiry",
"accountNickname": "Wells Fargo",
"accountToken": "99da5722-83f9-11ea-b9c5-f9a750265efe",
"micrData": "t123456789t o1234o 123",
},
"id": {
"operation": "add or inquiry",
"idCode": "FL",
"idValue": "123458"
},
}
just add and email example.
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
{
"trxID": "123456",
"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}
{
"trxID": "123456",
"termsAcceptedInd": "Y",
"ssn": "999999999",
"phoneNumber": "2345678901",
"name": {
"firstName": "Johnny",
"lastName": "Rocket"
},
"address": {
"address1": "12355 Rose Blvd",
"address2": "suite 3",
"city": "St Pete",
"state": "FL",
"zip": "12345"
},
}
Singularly change by adding or deleting the account information.
PUT https://cce.cashline.certegy.com/v1/customer/{ConsumerToken}
{
"trxID": "123456",
"termsAcceptedInd": "Y",
"account": {
"operation": "add or delete or inquiry",
"accountNickname": "WellsvFargo",
"accountToken": "99da5722-83f9-11ea-b9c5-f9a750265efe",
"micrData": "t123456789t o1234o 123",
},
"id": {
"operation": "add or inquiry",
"idCode": "FL",
"idValue": "123458",
"idToken": "1b68bd74-a0e7-11ea-9630-9750481e0769"
},
}
Update Consumer Response Success
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| trxID | 123456 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) (Must be Unique for 2 years) |
| trxRefID | 5604490000014 | 4 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| status | Success |
{
"trxID": "123456",
"trxRefID": "5604490000014",
"consumerToken": "99da5722-83f9-11ea-b9c5-f9a750265efe",
"status": "Success",
}
Update 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 | 123456 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) (Must be Unique for 2 years) |
| trxRefID | 5604490000014 | 4 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| responseCode | 0397 | 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": "123456",
"trxRefID": "5604490000014",
"consumerToken": "token value",
"responseCode": "0397",
"responseMsg": "SSN Error"
"responseDetails": "The SSN provided is already associated with a different consumer, etc...."
}