STIP Balance Update - Field Descriptions
The following tables describe the fields that can be included in the request and the response for the STIP Balance Update 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 | N |
| TxnCode | The Transaction Code. See Transaction Codes. Default value is 16 (Balance adjustment used for STIP). | AN | 1 | 1 | Yes |
| PAN | Card Number. Required in request if PublicToken not present. | AN | 14 | 19 | Conditional |
| PublicToken | The card’s public token. Mandatory in request if PAN is not present. | AN | 1 | 9 | Conditional |
| CurrCode | The currency code of the adjustment. Must match the currency of the card account. | AN | 3 | 3 | Yes |
| AvlBalance_GPS_STIP | The new available to spend balance on the card: Available Balance = Current Balance – Blocked Amount | D | 1 | 20 | Yes |
| CurBalance_GPS_STIP | The new current balance on the card. Must not be less than the available balance. | D | 1 | 20 | Yes |
| Balance_Sequence_Exthost | External host balance sequence number. Sets the new balances only if this sequence number is higher than the existing balance sequence number currently held in Thredd. This is to ensure that an out-of-date balance is not set due to race conditions. | N | 1 | 18 | Yes |
| LoadedBy | Name of person or cashier making the adjustment. | AN | 1 | 30 | No |
| IssCode | Thredd Issuer (Program Manager) Code. Assigned by Thredd. | AN | 1 | 4 | Yes |
| LocDate | The local current date in year-month-date format. | YYYY-MM-DD | 10 | 10 | Yes |
| LocTime | The local current time, in hour-minute-second format. | HHMMSS | 6 | 6 | Yes |
Response
The following table describes the fields that are included in the response.
| Field | Description |
|---|---|
| CurrCode | The currency code of the balance returned. Will be the currency of the card account. |
| Balance_Sequence_Exthost | The external host balance sequence number in Thredd after this update. (This will be Balance_Sequence_Exthost in the request message if set, or the current value on Thredd if not set.) |
| Balance_Sequence | The Thredd balance sequence returned in the response. This is updated each time Thredd updates the actual balance or blocked amount. |
| ItemID | The unique item ID returned for the adjustment. |
| ActionCode | The action code for the response. See Action Codes. |