v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB

Machines

Create Payment Methods for Machine

Creates new payment methods for a specific machine, identified by MachineID. This operation allows users to add new payment options to the machine.

post/v1/machines/{MachineID}/paymentMethods

Path parameters

MachineIDinteger required

The unique identifier of the machine.

Request body

MachineIDinteger

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

PaymentMethodIDinteger

The unique identifier of the payment method.

ConvenienceFeePercentageBitboolean nullable

Indicates whether a convenience fee is applied as a percentage.

ConvenienceFeeValuenumber double

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

LastUpdatedstring date-time

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

ExternalPaymentProviderUsernamestring nullable

The username used to authenticate with an external payment provider.

ExternalPaymentProviderPasswordstring nullable

The password used to authenticate with an external payment provider.

ExternalPaymentProviderTerminalIDstring nullable

The terminal ID provided by the external payment provider.

ExternalPaymentProviderLocationIdentifierstring nullable

The location identifier used by the external payment provider.

PaymentMethodCustomDatastring nullable

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

ConvenienceFeeBackupValuenumber double

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

PaymentMethodQRStringstring nullable

A QR code string associated with the payment method.

Response

The newly created payment methods for the specified machine.