Customer Enquiry - Field Descriptions
The following tables describe the fields in the request and the response for the Customer Enquiry endpoint.
Request
The following table describes the fields that can be included in the request.
| Field | Description | Type | Min Length | Max Length | Mandatory |
|---|---|---|---|---|---|
| wsid | The web service ID. This must be unique for every request sent. You can set your own wsid, for example by using the current date and time (20250213145006), or you can leave the field blank and Thredd generates the wsid for you. | N | 0 | 19 | No |
| IssCode | Thredd Issuer (Program Manager) Code. Assigned by Thredd. | AN | 1 | 4 | Yes |
| PAN | Card Number. Mandatory if CustAccount or PublicToken are not provided. | AN | 14 | 19 | Conditional |
| PublicToken | The card’s public token. Mandatory in request if PAN and CustAccount are not present. | AN | 14 | 19 | Conditional |
| CustAccount | Cardholder account number or reference number. You can use this reference to find the cards linked to a cardholder. Mandatory in request if PAN and PublicToken are not present. | AN | 1 | 25 | Conditional |
| CurrCode | 3-letter ISO currency code for the currency (e.g. EUR). | AN | 3 | 3 | No |
| ItemSrc | Source field to define alternate fees. Legacy field for information purposes only. Suggest using 0. | N | 1 | 2 | Yes |
Response
The following table describes the fields that are included in the response.
| Field | Description |
|---|---|
| issCode | Thredd Issuer (Program Manager) Code. Assigned by Thredd. |
| TxnCode | The Transaction Code. See Transaction Codes. Default value 4. |
| PublicToken | The card’s public token, |
| CustAccount | Cardholder account number or reference number. |
| CurCode | 3-letter ISO currency code for the currency (e.g. EUR). This is the primary currency code associated with the customer. |
| ActionCode | The action code for the response. See Action Codes. |
| Primary | Indicates if the card is the Primary card. |
| Cards | Object that contains the cards associated with the PublicToken, CustAccount, or PAN included in the request. |
| CardList2 | Object that contains the details of the card. |
| PAN | Card Number. Unique card identifier. |
| ExpDate | Expiry date of the card in YYYY-MM-DD format. |
| CurCode | 3-letter ISO currency code for the currency (e.g. EUR). This is the currency code associated with the card. |
| StatCode | The status code of the card. See Card Status Codes. |
| CrdProduct | The identifier of the card product, or Product ID, within Thredd. For details, check with your Implementation Manager. |
| Program | The ID of the Program this card belongs to. |
| DesignRef | Predefined design reference code associated with the card, also known as PRODUCT_REF. |
| EmbossName | Name embossed on the card. |
| AvlBal | The current balance on the card account. This includes all financial transactions and outstanding authorisations. The balance amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). |
| BlkAmt | Amount of funds blocked on the card account as a result of all outstanding authorisations. The balance amount can include up to four decimal places, depending on the currency exponent (e.g., 10.99 for EUR which has a currency exponent of 2). |
| FirstName | Cardholder’s first name. |
| LastName | Cardholder’s last name. |
| CustType | Identifies the owner of the card. |
| PublicToken | Thredd 9-digit public token of the card. |
| Primary | Indicates if the card is the Primary card. |
| IsLive | Specifies whether the card is active or not. 1 or True = Active; 0 or False = Not Active. |
| Scheme | The card’s scheme. |
| Product | The name you give to your Thredd card product. This is stored in Smart Client. |
| MCCGroup | Group code of the MCC Group. |
| LimitGroup | Group code of the Limit Group. |
| PERMSGroup | Group code of the Usage Group. |
| FeeGroup | Group code of the Fee Group. |
| SchedFeeGroup | Group code of the Scheduled Fee Group. |
| WsFeeGroup | Group code of the Web Service Fee Group. |
| LinkageGroup | Group code of the Card Linkage Group. |
| PrimaryToken | The primary card’s public token. This field populates where the card enquired on is a child card. |
| MaskedPAN | Card Number displayed as masked. |
| ProductId | Thredd Product ID. |
| ProductRef | The physical card design reference as used by the Card Manufacturer. Identifies the PRODUCT_REF field in the XML file sent to the card manufacturer. |
| AuthCalendarGroup | Group code of the Auth Calendar Group. |
| FXGroup | Group code of the FX Group. |
| PaymentTokenUsageGroup | Payment token usage group code. For details, check with your Implementation Manager. |
| StartDate | Start date printed on the card in the format MM/YY. |
| EndDate | Physical end date printed on the card in the format MM/YY. |
Updated 8 days ago