Update STIP Balance - Field Descriptions

The following page details each of the fields that can be used in the request and received in the response when using the Update STIP Balance endpoint.

Request Fields

The following table describes fields that can be included in the body of the request when updating the STIP balance.

Field

Description

Minimum Length

Maximum Length

Mandatory

AvailableSTIPBalanceGPS

The new available to spend balance on the card:
Available Balance = Current Balance – Blocked Amount

1

20

Y

CurrentSTIPBalanceGPS

The new current balance on the card. Must not be less than the available balance.

1

20

Y

CurrenceyCode

The currency code of the adjustment. Must match the currency of the card account.

3

3

Y

BalanceSequenceIDExT

The external host balance sequence number.

1

18

Y

UpdatedBy

The name of the user that made the request.

1

30

ProcessingDate

The date the request was processed. Must be in YYYY-MM-DD format.

10

10

ProcessingTime

The time the request was processed. Must be in HHMMSS format.

6

6

RequestDate

The date the request was made. Must be in YYYY-MM-DD format.

10

10

RequestTime

The time the request was made. Must be in HHMMSS format.

6

6

TxnCode

The Transaction Code. See Transaction Codes. Default value 16.

1

2

Y

IssCode

Thredd Issuer (Program Manager) Code. Assigned by Thredd.

1

4

Y

ItemId

The unique item ID returned for the adjustment.

1

20

N

ActionCode

The action code for the response. See Action Codes.

3

3

N

Response Fields

The following table describes fields included in a successful response when updating the STIP balance.

Field

Description

BalanceSequenceID

The Thredd balance sequence returned in the response. This is updated each time Thredd updates the actual balance or blocked amount.

BalanceSequenceIDExT

The external host balance sequence number.

CurrenceyCode

The currency code of the balance returned. Will be the currency of the card account.

TxnCode

The Transaction Code. See Transaction Codes. Default value 16.

ItemId

The unique item ID returned for the adjustment.

IssCode

Thredd Issuer (Program Manager) Code. Assigned by Thredd.

ActionCode

The action code for the response. See Action Codes.

ProcessingDate

The date the request was processed. Must be in YYYY-MM-DD format.

ProcessingTime

The time the request was processed. Must be in HHMMSS format.