CashLine API has the ability to search for the previously enrolled consumer by one or a combination set of these fields consumerToken, or idCode, idValue and dob or by (SSN and dob). If searching with consumerToken, then idCode, idValue and dob are not required search elements.
Get requests are a URL generated request with the proper data elements included.
Search by:
- consumerToken
- idCode and idValue and dob
- ssn and dob
GET https://cce.cashline.certegy.com/v1/kiosk/customer
REQUIRED
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| merchantID | 123456 | 6 / 6 All Numeric, 0-9 (no special characters or alpha allowed) |
| trxID | 123456 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| integratorID | xYzAbC123 | 4 / 30 Alphanumeric, space and dash |
OPTIONAL
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| operatorID | xxx123 | 2 / 30 Alphanumeric, Spaces and dash (a-z, A-Z, 0-9 $#@._ ) |
| terminalID | Terminal321 | 2 / 30 Alphanumeric, Spaces and dash (a-z, A-Z, 0-9 $#@._ ) |
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 Characters Alphanumeric and dash |
| ssn | 999999999 | 999999999 |
| dob | yyyy-mm-dd | DATE (YYYY-MM-DD) |
| idCode | FL | 2 characters alpha, A-Z US only |
| idValue | 123458 | 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. |
| attributes | all or all_plus_transactions | Only two possible attributes; 1. all or 2. all_plus_transactions |
URL using the attribute “all” for when consumer token is used:
https://cce.cashline.certegy.com/v1/kiosk/customer?{merchantID}{trxID}{integratorID}{consumerToken}{attributes}
URL using the attribute “all” for when ID & DOB is used:
https://cce.cashline.certegy.com/v1/kiosk/customer?{merchantID}{trxID}{integratorID}{idCode}{idValue}{dob}{attributes}
URL using the attribute “all” for when SSN & DOB is used:
https://cce.cashline.certegy.com/v1/kiosk/customer?{merchantID}{trxID}{integratorID}{ssn}{dob}{attributes}
Get Consumer Response using All attribute
Response fields for get consumer when the “all” attribute is used only the consumer information is returned (no transactions). If the consumer is enrolled, we will return the consumerToken, idToken and the accountToken these three values are required to make a request to ACH, (debit) the consumer’s checking account. Multiple accountTokens with defined accountNicknames allows the consumer to choose which bank account to use for the ACH transaction. The chosen accountToken would debit that specific consumer’s account.
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| termsAcceptedInd | Y=yes or N=no | 1 byte Y=yes or N=no IF no, provided the terms and conditions and use update consumer endpoint |
| activeInd | Y=yes or N=no | 1 byte Y=yes or N=no IF no, Consumer should enroll and make their private account active |
| firstName | Jack | 2 / 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| lastName | Kelley | 2 / 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| address1 | 12355 Rose Blvd | 2 / 50 Alphanumeric characters, "'", &, "-", ".", ",", and spaces only |
| Address2 | suite 3 | 2 / 50 Alphanumeric characters, "'", &, "-", ".", ",", and spaces only |
| city | St Pete | 2 / 25 Alphanumeric characters, "'", "-", ".", ",", and spaces only |
| state | FL | 2 / 2 Alpha characters only |
| zip | 33716 | 5 or 9 Numeric only |
| cashLineLimit | 500 | No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars. |
| cashLineAvailable | 500 | No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars. |
| cashLineRefillAmount | No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars. | |
| cashLineRefillDate | DATE/TIME | |
| ids | Object - Get Consumer may respond with multiple ID's if the consumer has had changes to their driver's license. If the driver's license does not match, then an update consumer request would be sent to update the IDs being presented. This causes the last correct DL to be primary and the older DLs being returned with "N" defined by the idPrimaryInd field | |
| 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 |
| accounts | Object - Get Consumer may have multiple bank accounts on file with us, any returned accountToken can be chosen to have an ACH draft request | |
| 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 |
{
"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",
"cashLineRefillAmount": "250",
"cashLineRefillDate": "06-22-2020 11:49:53"
},
"ids": [{
"idCode": "FL",
"idToken": "e8a71815-48fa-11ea-962c-49d8ac5f6bfd",
"idPrimaryInd": "Y"
},
{
"idCode": "GA",
"idToken": "e9b82926-59gb-22fb-073d-49d8ac5f6bfd",
"idPrimaryInd": "N"
}
],
"accounts": [{
"accountNickname": "Wells Fargo",
"accountToken": "e893b724-48fa-11ea-962c-9177b3415f70",
"accountLast4": "2058",
"isLastUsed": "true"
},
{
"accountNickname": "My Bank 2",
"accountToken": "f904c835-59gb-22fb-073d-0288c4526g81",
"accountLast4": "2058",
"isLastUsed": "false"
}
],
"SSNPresent": "false",
"phoneMasked": "1176",
"emailAddress": "junk1@certegy.com"
}
Get Consumer Response using all_plus_transactions attribute
Response fields for get consumer when the “all_plus_transactions” attribute is used the consumer information along with check cashing activity is returned. If the consumer is enrolled, we will return the consumerToken, idToken and the accountToken these three values are required to make a request to ACH, (debit) the consumer’s checking account. Multiple accountTokens with defined accountNicknames allows the consumer to choose which bank account to use for the ACH transaction. The chosen accountToken would debit that specific consumer’s account.
URL using the attribute “all_plus_transactions” for when consumer token is used:
https://cce.cashline.certegy.com/v1/kiosk/customer?{merchantID}{trxID}{integratorID}{consumerToken}{attributes}
URL using the attribute “all_plus_transactions” for when ID & DOB is used:
https://cce.cashline.certegy.com/v1/kiosk/customer?{merchantID}{trxID}{integratorID|{idCode}{idValue}{dob}{attributes}
URL using the attribute “all_plus_transactions” for when SSN & DOB is used:
https://cce.cashline.certegy.com/v1/kiosk/customer?{merchantID}{trxID}{integratorID}{ssn}{dob}{attributes}
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| consumerToken | 99da5722-83f9-11ea-b9c5-f9a750265efe | 36 / 36 Alphanumeric and dash |
| termsAcceptedInd | Y=yes or N=no | 1 byte Y=yes or N=no IF no, provided the terms and conditions and use update consumer endpoint |
| activeInd | Y=yes or N=no | 1 byte Y=yes or N=no IF no, Consumer should enroll and make their private account active |
| firstName | Jack | 2 / 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| lastName | Kelley | 2 / 25 digits - Alphanumeric characters, "-", ".", ",", and spaces only |
| address1 | 12355 Rose Blvd | 2 / 50 Alphanumeric characters, "'", &, "-", ".", ",", and spaces only |
| Address2 | suite 3 | 2 / 50 Alphanumeric characters, "'", &, "-", ".", ",", and spaces only |
| city | St Pete | 2 / 25 Alphanumeric characters, "'", "-", ".", ",", and spaces only |
| state | FL | 2 / 2 Alpha characters only |
| zip | 33716 | 5 or 9 Numeric only |
| cashLineLimit | 500 | No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars. |
| cashLineAvailable | 500 | No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars. |
| cashLineRefillAmount | 250 | No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars. |
| cashLineRefillDate | 06-22-2020 11:49:53 | DATE/TIME |
| ids | Object - Get Consumer may respond with multiple ID's if the consumer has had changes to their driver's license. If the driver's license does not match, then an update consumer request would be sent to update the IDs being presented. This causes the last correct DL to be primary and the older DLs being returned with "N" defined by the idPrimaryInd field | |
| 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 |
| accounts | Object - Get Consumer may have multiple bank accounts on file with us, any returned accountToken can be chosen to have an ACH draft request | |
| 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) |
| transactions | Object = May respond with multiple transaction history | |
| trxDate | 06-25-2020 03:18:19 | 4 / 20 Alphanumeric a-z, A-Z, 0-9 - (dash) |
| trxAmt | 1.00 | No Min/(Max) 9999999.99 Numeric and deximal - No commas |
| trxID | 1234567890 | 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) |
| trxRefID | 5604490000014 | Max 15 Numeric |
| checkStatus | Max 20 Alpha a-z, A-Z | |
| achRefID | 371867197 | Max 15 Numeric |
| merchantID | 123456 | 6 / 6 All Numeric, 0-9 (no special characters or alpha allowed) |
| integratorID | xYzAbC123 | 4 / 30 Alphanumeric, space and dash |
| operatorID | xxx123 | 2 / 30 Alphanumeric, Spaces and dash (a-z, A-Z, 0-9 $#@._ ) |
| terminalID | Terminal321 | 2 / 30 Alphanumeric, Spaces and dash (a-z, A-Z, 0-9 $#@._ ) |
| terminalGrpID | grp321 | Optional - 2 / 30 Alphanumeric, a-z, A-Z, 0-9 $#@._ (-) Dash |
| SSNPresent | false | (boolean) true/false (lowercase only) |
| phoneMasked | 1176 | 4 digits Numeric only |
| emailAddress | junk1@certegy.com | 50 All Characters Allowed |
{
"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",
"cashLineRefillAmount": "250",
"cashLineRefillDate": "06-22-2020 11:49:53"
},
"ids": [{
"idCode": "FL",
"idToken": "e8a71815-48fa-11ea-962c-49d8ac5f6bfd",
"idPrimaryInd": "Y"
},
{
"idCode": "GA",
"idToken": "e9b82926-59gb-22fb-073d-49d8ac5f6bfd",
"idPrimaryInd": "N"
}
],
"accounts": [{
"accountNickname": "Wells Fargo",
"accountToken": "e893b724-48fa-11ea-962c-9177b3415f70",
"accountLast4": "2058",
"isLastUsed": "true"
},
{
"accountNickname": "My Bank 2",
"accountToken": "f904c835-59gb-22fb-073d-0288c4526g81",
"accountLast4": "2058",
"isLastUsed": "false"
}
],
"transactions": [{
"trcDate": "06-30-2020 18:49:53",
"trxAmt": "3002",
"trxID": "81368985",
"trxRefID": "5605730000009",
"checkStatus": "APPROVE",
"achRefID": "372056437",
"merchantID": "123456",
"integratorID": "xYzAbC123",
"operatorID": "xxx123",
"terminalID": "terminal321",
"terminalGrpID": "grp321"
},
{
"trcDate": "06-22-2020 11:49:53",
"trxAmt": "3002",
"trxID": "81368985",
"trxRefID": "5605730000009",
"checkStatus": "APPROVE",
"achRefID": "372056437",
"merchantID": "123456",
"integratorID": "xYzAbC123",
"operatorID": "xxx123",
"terminalID": "terminal321",
"terminalGrpID": "grp321"
}
],
"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 | Value | Field Values or Constraints |
|---|---|---|
| errorPath | /kiosk/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 | See 4 digit response codes page for gaming |
| adverseAction | false | (boolean) true/false (lowercase only) |
| stationNum | 1070000000 | 10 Max Numeric only |
{
"errors": [{
"errorPath": "/kiosk/customer",
"errorMessage": "Consumer Account Inactive",
"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",
"responseCode": "0390",
"adverseAction": "false",
"stationNum": "1070000000"
}]
}
Get Consumer Response Agreement Required, the consumer must accept the Terms and Conditions before continuing – HTTPS 400 and HTTPS 500
This is the response if the Terms and Conditions have not been accepted by the consumer
| Field Parameter | Value | Field Values or Constraints |
|---|---|---|
| errorPath | /kiosk/customer | Max 200 Alpha only a-z, A-Z |
| errorMessage | Agreement Required | Max 200 Alpha only a-z, A-Z |
| errorDetails | Enrollment cannot proceed withour agreeing to the Terms and Conditions. | Max 260 Alpha only a-z, A-Z |
| errorType | decline | 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 | 0389 | See 4 digit response codes page for gaming |
| adverseAction | false | (boolean) true/false (lowercase only) |
| stationNum | 1070000000 | 10 Max Numeric only |
{
"errors": [{
"errorPath": "/kiosk/customer",
"errorMessage": "Agreement Required",
"errorDetails": "Enrollment cannot proceed without agreeing to the Terms and Conditions.",
"errorType": "decline",
"errorDate": "06-25-2020 03:18:19",
"responseCode": "0390",
"consumerToken": "e8f37d52-d296-11ea-adb9-1b536cf4193f",
"adverseAction": "false",
"stationNum": "1070000000"
}]
}