STIP Balance Update

The STIP Balance Update endpoint enables you to update the available and current balance for EHI (External Host Interface) Mode 4 and 5 Cards.

You can update the card balance by making a POST request to the STIP Balance Update endpoint. For example:

{{base-url}}/ws/api/v1/Ws_BalanceUpdate

The request body must include the transaction code which should be 16, which is used for adjusting the balance of the card.

See the following example of an STIP Balance Update request where the transaction code is set to balance adjustment (TxnCode is set to 16).

{
    "wsid": "20250213165006",
    "TxnCode": "16",
    "PublicToken": "123456789",
    "CurrCode": "GBP",
    "AvlBalance_GPS_STIP": "100",
    "CurBalance_GPS_STIP": "110",
    "Balance_Sequence_Exthost": "1",
    "LoadedBy": "John Bloggs",
    "IssCode": "PMT",
    "LocDate": "2025-02-13",
    "LocTime": "120000"
}

If successful, a 200 response is returned. See the below example:

{
    "CurrCode": "GBP",
    "Balance_Sequence_Exthost": "1",
    "Balance_Sequence": "1",
    "ItemID": "23290",
    "ActionCode": "000"
}

📘

More Information

• For detailed field descriptions for the fields in the request and response, see STIP Balance Update - Field Descriptions.
• To view the endpoint in the API Explorer, see STIP Balance Update.