Documentation

CashLine

CashLine

  2. Home
  4. CashLine
  6. Private: Kiosk eCheck
  8. Kiosk Get Consumer Information

Kiosk Get Consumer Information

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 ParameterValueField Values or Constraints
trxID123456 4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) (Must be Unique for 2 years)
attributesall or all_plus_transactionsOnly two possible attributes; 1. all or 2. all_plus_transactions

OPTIONAL

Field ParameterValueField Values or Constraints
operatorIDxxx1232 / 30 Alphanumeric, Spaces and dash (a-z, A-Z, 0-9 $#@._ )
terminalIDTerminal3212 / 30 Alphanumeric, Spaces and dash (a-z, A-Z, 0-9 $#@._ )
consumerToken99da5722-83f9-11ea-b9c5-f9a750265efe36 Alphanumeric and dash
ssn9999999999 digits/Numeric only. No dashes or spaces.
idCodeFL2 alpha, A-Z US only
idValue123458Alphanumeric 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.

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 ParameterValueField Values or Constraints
trxRefID56044900000144 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
trxID1234564 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) (Must be Unique for 2 years)
consumerToken99da5722-83f9-11ea-b9c5-f9a750265efe36 / 36 Alphanumeric and dash
termsAcceptedIndY=yes or N=no1 byte Y=yes or N=no IF no, provided the terms and conditions and use update consumer endpoint
activeIndY=yes or N=no1 byte Y=yes or N=no IF no, Consumer should enroll and make their private account active
firstNamefirstnameFirst 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
lastNamelastnameLast 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
address112355 Rose BlvdStreet 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
address2suite 3Additional 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
citySt PeteCity.
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: 25
stateFL2 / 2 Alpha only
zip123455 or 9 Numeric only
cashLineLimit500No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars.
cashLineAvailable500No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars.
cashLineRefillAmount250No Min/(Max) 9999999.99 Numeric only - No commas. If the decimal point is omitted, the amount is considered to be in whole dollars.
cashLineRefillDate06-22-2020 11:49:53DATE/TIME
idsObject - 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
idCodeFL2 / 2 See State Code List
idTokene8a71815-48fa-11ea-962c-49d8ac5f6bfdMax 60 Alphanumeric and dash
idPrimaryIndY 1 Alpha only
accountsObject - Get Consumer may have multiple bank accounts on file with us, any returned accountToken can be chosen to have an ACH draft request
accountNicknameWells Fargo1/30 Alphanumeric and spl chars except \ and "
accountTokene893b724-48fa-11ea-962c-9177b3415f70Max 60 Alphanumeric and dash
accountLast420584 / 4 All numeric
accountLastUsedfalse(boolean) true/false (lowercase only)
SSNPresentfalse(boolean) true/false (lowercase only)
phoneMasked78904 digits Numeric only
emailAddressiam@home.com50 All Allowed. (All emails must be unique and cannot be shared with another consumer) 

{
	"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 ParameterValueField Values or Constraints
trxRefID56044900000144 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
consumerToken99da5722-83f9-11ea-b9c5-f9a750265efe36 / 36 Alphanumeric and dash
transactionsObject = May respond with multiple transaction history
trxDate06-25-2020 03:18:194 / 20 Alphanumeric a-z, A-Z, 0-9 - (dash)
trxAmt1.00No Min/(Max) 9999999.99 Numeric and decimal - No commas
trxID1234564 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash)
trxRefID56044900000144 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
checkStatusAPPROVE or DECLINEMax 20 Alpha a-z, A-Z
settlementDate2024-11-07Numeric - (dash)
delayedSettlementDays0Numeric
cashLineTransactionRefillDate2024/11/12 11:38:19Timestamp 

{
	"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 ParameterValueField Values or Constraints
errorPath   /kiosk/customerMax 200 Alpha only a-z, A-Z
errorMessage   Invalid or inactive setupMax 200 Alpha only a-z, A-Z
errorDetailsThe 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-3131Max 260 Alpha only a-z, A-Z
errorType   system_errorMax 20 Alpha only a-z, A-Z
errorDate   06-25-2020 03:18:19DATE/TIME
trxID   1002352454 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash)
responseCode   0314See 4 digit response codes page for gaming
adverseAction  false(boolean) true/false (lowercase only)
stationNum  107000000010 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 ParameterValueField Values or Constraints
errorPath   /kiosk/customerMax 200 Alpha only a-z, A-Z
errorMessage   Agreement RequiredMax 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   declineMax 20 Alpha only a-z, A-Z
errorDate   06-25-2020 03:18:19DATE/TIME
trxID   1002352454 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash)
responseCode   0389See 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"
	}]
}

Back to Top

Was this article helpful to you? Yes No

How can we help?