Manage payment methods
Create or update the manual cash or card payment methods available at Harbor Soho, and optionally restrict a method to selected TPV terminals. This controls which active payment options appear when staff take payments from a terminal.
In this article
Use this guide when a Harbor Soho manager needs to control which manual cash or card methods are available in TPV payment flows.
Payment method management is location-scoped. It changes the methods staff can select at checkout, but it does not delete methods, process payments, open a cash drawer or test hardware connectivity.
Before you start
- You are signed in to Harbor Demo Group with Harbor Soho selected.
- You have location permission tpv:manage to create, edit and save payment methods. Users with tpv:view can open the TPV settings list but cannot manage methods.
- The active location context includes ORG_ID and LOCATION_ID.
- For editing in the GB demo runtime, use TPV_PAYMENT_METHOD_ID=579125b5-91ac-4133-96f9-e4ca5b398bff.
- For terminal-restricted examples, use a terminal from the same location, such as TPV_TERMINAL_ID=a17b518e-f065-4d58-a5c4-8d56e00f7e9f.
Instructions
- 1.
Open Payment methods
Go to TPV settings for Harbor Soho and select the Payment methods tab. Review the configured methods, including the method name, code, integration type, terminal availability and active status.
- 2.
Start a new method or edit an existing one
Select New method to create a payment method, or use Edit on an existing row. When creating from a terminal context, the terminal can be preselected so the new method starts restricted to that terminal.
- 3.
Complete the visible fields
Enter the method name and optional code, choose a supported manual cash or card type, choose which terminals can use the method, and set whether the method is active. Leave the terminal list empty when the method should be available from every terminal at Harbor Soho.
- 4.
Save or leave the form
Save the form to create or update the TPV payment method. After a successful save, Antylogic refreshes payment methods and TPV settings, shows the saved confirmation and returns to the previous screen. Use Back or Cancel to leave without creating or updating a method.
Validations and limits
- The TPV settings screen loads for users with tpv:view or tpv:manage, but New method, row Edit actions and Save require tpv:manage.
- Name is required before saving.
- Save is disabled when there are no form changes, while saving is in progress or when the user lacks tpv:manage.
- If code is omitted on create, the backend derives it from the name; payment method codes must be unique within Harbor Soho.
- Terminal restrictions must reference TPV terminals from the same Harbor Soho location.
- If no terminal restriction is set, the method is available from every terminal in the location.
- The current UI supports the implemented manual cash/card management path. Older fields such as separate execution mode, sort order, drawer behaviour, channel availability and authorised users are not exposed on this screen.
- If an existing method cannot be loaded, the item screen shows the API error state instead of the form.
- Validation errors are mapped back onto the form where possible, focus moves to the first failing field and an error toast is shown.
- Cross-location payment method or terminal ids are treated as not found or invalid.
- This action does not delete payment methods, run payments, create payment operations, open a cash drawer or test terminal hardware.
Expected result
Harbor Soho has an updated TPV payment method configuration. Active methods appear in payment flows only where the current terminal is allowed to use them.