Update Payment Methods for Machine

curl --request PUT \
  --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/paymentMethods \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "MachineID": 123,
    "PaymentMethodID": 123,
    "ConvenienceFeePercentageBit": true,
    "ConvenienceFeeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderTerminalID": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ConvenienceFeeBackupValue": 123,
    "PaymentMethodQRString": "<string>"
  }
]
'

[
  {
    "MachineID": 123,
    "PaymentMethodID": 123,
    "ConvenienceFeePercentageBit": true,
    "ConvenienceFeeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderTerminalID": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ConvenienceFeeBackupValue": 123,
    "PaymentMethodQRString": "<string>"
  }
]

PUT

machines

{MachineID}

paymentMethods

Update Payment Methods for Machine

curl --request PUT \
  --url https://qa-lynx.nayax.com/operational/v1/machines/{MachineID}/paymentMethods \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "MachineID": 123,
    "PaymentMethodID": 123,
    "ConvenienceFeePercentageBit": true,
    "ConvenienceFeeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderTerminalID": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ConvenienceFeeBackupValue": 123,
    "PaymentMethodQRString": "<string>"
  }
]
'

[
  {
    "MachineID": 123,
    "PaymentMethodID": 123,
    "ConvenienceFeePercentageBit": true,
    "ConvenienceFeeValue": 123,
    "LastUpdated": "2023-11-07T05:31:56Z",
    "ExternalPaymentProviderUsername": "<string>",
    "ExternalPaymentProviderPassword": "<string>",
    "ExternalPaymentProviderTerminalID": "<string>",
    "ExternalPaymentProviderLocationIdentifier": "<string>",
    "PaymentMethodWorkingDays": [
      {
        "name": "<string>",
        "week_day": 123,
        "start_time": "<string>",
        "end_time": "<string>",
        "work_hour_lut_id": 123
      }
    ],
    "PaymentMethodCustomData": "<string>",
    "ConvenienceFeeBackupValue": 123,
    "PaymentMethodQRString": "<string>"
  }
]

Authorizations

Authorization

string

header

required

Enter your API key. It's required to authenticate API requests.

Path Parameters

MachineID

integer<int64>

required

The unique identifier of the machine.

Body

application/json

The payment methods to update for the machine.

MachineID

integer<int64>

The unique identifier of the machine associated with the payment method.

PaymentMethodID

integer<int32>

The unique identifier of the payment method.

ConvenienceFeePercentageBit

boolean | null

Indicates whether a convenience fee is applied as a percentage.

ConvenienceFeeValue

number<double>

The value of the convenience fee applied to the payment method.

LastUpdated

string<date-time>

The date and time when the payment method was last updated.

ExternalPaymentProviderUsername

string | null

The username used to authenticate with an external payment provider.

ExternalPaymentProviderPassword

string | null

The password used to authenticate with an external payment provider.

ExternalPaymentProviderTerminalID

string | null

The terminal ID provided by the external payment provider.

ExternalPaymentProviderLocationIdentifier

string | null

The location identifier used by the external payment provider.

PaymentMethodWorkingDays

object[] | null

The working days during which the payment method is active.

Show child attributes

PaymentMethodCustomData

string | null

Custom data related to the payment method, provided as a string.

ConvenienceFeeBackupValue

number<double>

A backup value for the convenience fee in case the primary value is unavailable.

PaymentMethodQRString

string | null

A QR code string associated with the payment method.

Response

200 - application/json

The updated list of payment methods for the specified machine.

MachineID

integer<int64>

The unique identifier of the machine associated with the payment method.

PaymentMethodID

integer<int32>

The unique identifier of the payment method.

ConvenienceFeePercentageBit

boolean | null

Indicates whether a convenience fee is applied as a percentage.

ConvenienceFeeValue

number<double>

The value of the convenience fee applied to the payment method.

LastUpdated

string<date-time>

The date and time when the payment method was last updated.

ExternalPaymentProviderUsername

string | null

The username used to authenticate with an external payment provider.

ExternalPaymentProviderPassword

string | null

The password used to authenticate with an external payment provider.

ExternalPaymentProviderTerminalID

string | null

The terminal ID provided by the external payment provider.

ExternalPaymentProviderLocationIdentifier

string | null

The location identifier used by the external payment provider.

PaymentMethodWorkingDays

object[] | null

The working days during which the payment method is active.

Show child attributes

PaymentMethodCustomData

string | null

Custom data related to the payment method, provided as a string.

ConvenienceFeeBackupValue

number<double>

A backup value for the convenience fee in case the primary value is unavailable.

PaymentMethodQRString

string | null

A QR code string associated with the payment method.

Get Payment Methods for Machine Create Payment Methods for Machine

⌘I

Guides

API Reference

Update Payment Methods for Machine

Authorizations

Path Parameters

Body

Response