Skip to content
innovorder
⌘K

Money movement

Payment Methods (Bulk Update)

Manage the payment methods available for a restaurant on a specific sales channel. Payment methods define how customers can pay (e.g. cash, credit card, e-wallet, luncheon voucher) and can be created, updated, or deleted in bulk for a given restaurant and channel combination.

PUT/payment_methodsBulk update payment methods

Create, update, and delete payment methods for a restaurant on a given channel in a single request. Each operation is provided as an array: "creates" for new methods, "updates" for modifications to existing ones, and "deletes" to remove methods. When channelId corresponds to POS, a posDeviceId is required.

Request Body

json
{
  "restaurantId": 101,
  "channelId": 1,
  "creates": [
    {
      "code": "EWallet",
      "label": "E-Wallet",
      "position": 5,
      "changeNotAllowed": false,
      "creditNoteAllowed": true,
      "directCollectionAllowed": false,
      "openCashDrawer": false,
      "ewalletReloadAllowed": true,
      "ewalletRefundAllowed": true,
      "defaultPayment": false,
      "consumptionMode": 1,
      "externalId": ""
    }
  ],
  "updates": [
    {
      "paymentMethodId": 312,
      "label": "Credit Card",
      "position": 1,
      "changeNotAllowed": true,
      "defaultPayment": true,
      "externalId": "ext_cc_001"
    }
  ],
  "deletes": [
    {
      "paymentMethodId": 315
    }
  ]
}
Request Body Properties

Every field in the example is listed below. Explicit requiredness is shown when the endpoint contract defines it.

PropertyTypeExampleDescription
restaurantIdinteger101Identifier of the restaurant.
channelIdinteger1Identifier of the associated channel.
createsarray[…]List of creates entries.
creates[]object{…}Object containing creates fields.
creates[].codestring"EWallet"Machine-readable application code for the result.
creates[].labelstring"E-Wallet"The label value.
creates[].positioninteger5The position value.
creates[].changeNotAllowedbooleanfalseThe change not allowed value.
creates[].creditNoteAllowedbooleantrueThe credit note allowed value.
creates[].directCollectionAllowedbooleanfalseThe direct collection allowed value.
creates[].openCashDrawerbooleanfalseThe open cash drawer value.
creates[].ewalletReloadAllowedbooleantrueThe ewallet reload allowed value.
creates[].ewalletRefundAllowedbooleantrueThe ewallet refund allowed value.
creates[].defaultPaymentbooleanfalseThe default payment value.
creates[].consumptionModeinteger1The consumption mode value.
creates[].externalIdstring""Identifier in the connected external system.
updatesarray[…]List of updates entries.
updates[]object{…}Object containing updates fields.
updates[].paymentMethodIdinteger312Identifier of the associated payment method.
updates[].labelstring"Credit Card"The label value.
updates[].positioninteger1The position value.
updates[].changeNotAllowedbooleantrueThe change not allowed value.
updates[].defaultPaymentbooleantrueThe default payment value.
updates[].externalIdstring"ext_cc_001"Identifier in the connected external system.
deletesarray[…]List of deletes entries.
deletes[]object{…}Object containing deletes fields.
deletes[].paymentMethodIdinteger315Identifier of the associated payment method.

Response

json
{
  "status": 200,
  "code": "payment_method_success",
  "message": "You have successfuly retrieved this payment method.",
  "data": [
    {
      "paymentMethodId": 316,
      "restaurantId": 101,
      "channelId": 1,
      "code": "EWallet",
      "label": "E-Wallet",
      "position": 5,
      "changeNotAllowed": false,
      "creditNoteAllowed": true,
      "directCollectionAllowed": false,
      "openCashDrawer": false,
      "ewalletReloadAllowed": true,
      "ewalletRefundAllowed": true,
      "defaultPayment": false,
      "consumptionMode": 1,
      "externalId": ""
    },
    {
      "paymentMethodId": 312,
      "restaurantId": 101,
      "channelId": 1,
      "code": "CreditCard",
      "label": "Credit Card",
      "position": 1,
      "changeNotAllowed": true,
      "creditNoteAllowed": false,
      "directCollectionAllowed": false,
      "openCashDrawer": false,
      "ewalletReloadAllowed": false,
      "ewalletRefundAllowed": false,
      "defaultPayment": true,
      "consumptionMode": 0,
      "externalId": "ext_cc_001"
    }
  ]
}
Response Properties

Every field in the example is listed below. Explicit requiredness is shown when the endpoint contract defines it.

PropertyTypeExampleDescription
statusinteger200HTTP status code returned by the API.
codestring"payment_method_success"Machine-readable application code for the result.
messagestring"You have successfuly retrieved this payment method."Human-readable result message. Do not use this value for program logic.
dataarray[…]Endpoint-specific response payload.
data[]object{…}Endpoint-specific response payload.
data[].paymentMethodIdinteger316Identifier of the associated payment method.
data[].restaurantIdinteger101Identifier of the restaurant.
data[].channelIdinteger1Identifier of the associated channel.
data[].codestring"EWallet"Machine-readable application code for the result.
data[].labelstring"E-Wallet"The label value.
data[].positioninteger5The position value.
data[].changeNotAllowedbooleanfalseThe change not allowed value.
data[].creditNoteAllowedbooleantrueThe credit note allowed value.
data[].directCollectionAllowedbooleanfalseThe direct collection allowed value.
data[].openCashDrawerbooleanfalseThe open cash drawer value.
data[].ewalletReloadAllowedbooleantrueThe ewallet reload allowed value.
data[].ewalletRefundAllowedbooleantrueThe ewallet refund allowed value.
data[].defaultPaymentbooleanfalseThe default payment value.
data[].consumptionModeinteger1The consumption mode value.
data[].externalIdstring""Identifier in the connected external system.
PreviousOrder PaymentsNext Coupons