Company
List payment methods
GET
Returns the payment methods set up on the till, such as Cash and Card. Needs branches:read. Methods are
sorted by branch, then in the order staff see them on the till.
bearerAuthheader
AuthorizationBearer <api_key>branchId?stringString. One branch id from List branches. A branch outside the key's branch list returns 403 branch_forbidden; an id that is not in your company returns 404. Left out: every branch the key can read.
Match
^[A-Za-z0-9_-]{1,128}$Payment methods
application/json- response
data*array<>meta*curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/payment-methods?branchId=YOUR_BRANCH_ID'Example Response
{ "data": [ { "id": "pm_cash", "branchId": "YOUR_BRANCH_ID", "name": "Cash", "type": "cash", "isActive": true, "order": 1 }, { "id": "pm_card", "branchId": "YOUR_BRANCH_ID", "name": "Card", "type": "card", "isActive": true, "order": 2 } ], "meta": { "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f" }}