C1c1st
PaymentTypes

Edit an exisiting payment type

put/paymenttypes/{id}

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/paymenttypes/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The PaymentType ID

Query parameters

allowDeletedinteger

Allows for settings deleted payment types when not 0

Request body

idinteger

A unique payment type id

titlestring

The name of a payment type

accountnostring nullable

The account number associated with the payment type

currencystring nullable

The currency associated with the payment type

exchangeratenumber nullable

The exchange rate of the given currency (if any) to the store's main currency.

cashinteger

Whether or not the payment type is physical cash

disabledinteger nullable

Included when deleted payment types are allowed

Example request

{
  "id": 1,
  "title": "Cash",
  "currency": "DKK",
  "exchangerate": 7.5
}

Response

Ok

idinteger

A unique payment type id

titlestring

The name of a payment type

accountnostring nullable

The account number associated with the payment type

currencystring nullable

The currency associated with the payment type

exchangeratenumber nullable

The exchange rate of the given currency (if any) to the store's main currency.

cashinteger

Whether or not the payment type is physical cash

disabledinteger nullable

Included when deleted payment types are allowed

Example response

{
  "id": 1,
  "title": "Cash",
  "currency": "DKK",
  "exchangerate": 7.5
}

Changes

No recorded changes to this operation across all 1 revision of this API.