Update a payment method
patch
https://api.flactrum.com/v1/payment-methods/{method}
| Required scope | payment_methods.write |
| Success status | 200 |
| Returns | One PaymentMethod object |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| method * | path | string | ULID of the record. |
Request body
| Field | Type | Description |
|---|---|---|
| name * | string | Unique within the brand. |
| type * | string | — |
| is_active | boolean | — |
| show_on_kiosk | boolean | — |
| translations | object | Language code → {name}. Only languages configured for the brand are accepted; an empty value removes that translation. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| name | string | — |
| type | string | Cash methods are counted in the day-end drawer reconciliation. |
| is_active | boolean | — |
| show_on_kiosk | boolean | Listed on the kiosk and selectable by customers. The till uses every active method regardless. |
| translations | object | Translations of name keyed by language code, e.g. {"en": {"name": "Credit card"}}. The kiosk shows the name in the language the customer picked. `name` itself follows Accept-Language. |
Examples
No recorded example yet.