Get Consumer Information – Certegy Developer

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 or by SSN. If searching with consumerToken, then idCode and idValue are not required search elements.

Get requests are a URL generated request with the proper data elements included.

Search by one of the following:

consumerToken
idCode and idValue
ssn

GET  https://cce.cashline.certegy.com/v1/customer/

REQUIRED

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)
`attributes`	`all` or `all_plus_transactions`	Must be one of two values: `all` or `all_plus_transactions`

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 Alphanumeric and dash
`ssn`	999999999	9 digits/Numeric only. No dashes or spaces.
`idCode`	FL	2 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.

URL when consumer token is the search term:

https://cce.cashline.certegy.com/v1/customer?consumerToken={consumerToken}&attributes=all&trxID={trxID}

URL when ID is the search term:

https://cce.cashline.certegy.com/v1/customer?idCode={idCode}&idValue={idValue}&attributes=all&trxID={trxID}

URL when SSN is the search term:

https://cce.cashline.certegy.com/v1/customer?ssn={SSN}&attributes=all&trxID={trxID}

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
`trxRefID`	5604490000014	4 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
`trxID`	123456	4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash) (Must be Unique for 2 years)
`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`	firstname	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	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	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	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	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: 25
`state`	FL	2 / 2 Alpha only
`zip`	12345	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`	2020-06-22 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 / 2 See State Code List
`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	1/30 Alphanumeric and spl chars except \ and "
`accountToken`	e893b724-48fa-11ea-962c-9177b3415f70	Max 60 Alphanumeric and dash
`accountLast4`	2058	4 / 4 All numeric
`accountLastUsed`	false	(boolean) true/false (lowercase only)
`SSNPresent`	false	(boolean) true/false (lowercase only)
`phoneMasked`	7890	4 digits Numeric only
`emailAddress`	iam@home.com	50 All Allowed. (All emails must be unique and cannot be shared with another consumer)

{
  "trxID": "123456",
  "trxRefID": "5604490000014",
  "consumerToken": "99da5722-83f9-11ea-b9c5-f9a750265efe",
  "termsAcceptedInd": "Y",
  "activeInd": "Y",
  "name": {
    "firstName": "Johnny",
    "lastName": "Rocket"
  },
  "address": {
    "address1": "12355 Rose Blvd",
    "address2": "suite 3",
    "city": "St Pete",
    "state": "FL",
    "zip": "12345"
  },
  "limit": {
    "cashLineLimit": "500",
    "cashLineAvailable": "500",
    "cashLineRefillAmount": "250",
    "cashLineRefillDate": "2020-06-22 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",
      "accountLastUsed": true
    },
    {
      "accountNickname": "My Bank 2",
      "accountToken": "f904c835-59gb-22fb-073d-0288c4526g81",
      "accountLast4": "2058",
      "accountLastUsed": "false"
    }
  ],
  "SSNPresent": false,
  "phoneMasked": "7890",
  "emailAddress": "iam@home.com"
}

Get Consumer Plus Transactions

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.

Field Parameter	Value	Field Values or Constraints
`trxRefID`	5604490000014	4 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
`consumerToken`	99da5722-83f9-11ea-b9c5-f9a750265efe	36 / 36 Alphanumeric and dash
`transactions`		Object = May respond with multiple transaction history
`trxDate`	2024/11/05 16:13:13	4 / 20 Alphanumeric a-z, A-Z, 0-9 - (dash)
`trxAmt`	1.00	No Min/(Max) 9999999.99 Numeric and decimal - No commas
`trxID`	123456	4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash)
`trxRefID`	5604490000014	4 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
`checkStatus`	APPROVE or DECLINE	Max 20 Alpha a-z, A-Z
`settlementDate`	2024-11-07	Numeric - (dash)
`delayedSettlementDays`	0	Numeric
`cashLineTransactionRefillDate`	2024/11/12 11:38:19	Timestamp

{ 
  "trxID": "123456",
  "trxRefID": "5604490000014",
  "consumerToken": "99da5722-83f9-11ea-b9c5-f9a750265efe",
  ...
  "transactions":[
    {
      "trxID": "316663",
      "trxRefID": "1747100002929",
      "trxDate": "2024/11/05 16:13:13",
      "trxAmt": "3.00",
      "checkStatus": "APPROVE",
      "settlementDate": "2024-11-06",
      "delayedSettlementDays": "0",
      "cashLineTransactionRefillDate": "2024/11/11 16:13:13"
    },
    {
      "trxID": "81368985",
      "trxRefID": "5605730000009",
      "trxDate": "2020/06/22 11:49:53",
      "trxAmt": "3000.00",
      "checkStatus": "DECLINE",
      "settlementDate": null,
      "delayedSettlementDays": null,
      "cashLineTransactionRefillDate": null
    }
  ],
  ...
}

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
`trxID`	123456	4 / 20 Alphanumeric, a-z, A-Z, 0-9 - (dash)
`trxRefID`	5604490000014	4 / 36 Alphanumeric, a-z, A-Z, 0-9 - (dash)
`errorPath`	/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 Customer Care at xxx-xxx-xxxx	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
`responseCode`	0314	See 4 digit response codes page for gaming
`adverseAction`	false	(boolean) true/false (lowercase only)
`stationNum`	1070000000	10 Max Numeric only

{
  "errors": [
    {
      "trxID": "123456",
      "trxRefID": "5604490000014",
      "errorPath": "/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 Customer Care at xxx-xxx-xxxx",
      "errorType": "system_error",
      "errorDate": "06-25-2020 03:18:19",
      "responseCode": "0314",
      "adverseAction": false,
      "stationNum": "1070000000"
    }
  ]
}

CashLine