Payment Methods
Get Payment Methods
Retrieves the payment methods.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
Create Payment Method
Creates a new payment method.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredtypeRequiredstring"CUSTOMERBALANCE" | "STRIPE" | "SQUARE" | "SUMUP" | "MOLLIE" | "SKRILL" | "AUTHORIZENET" | "REVOLUTBUSINESS" | "LEMONSQUEEZY" | "NMI" | "OVERPAY" | "SWIFTPAY" | "WHOP" | "ADYEN" | "SHOPIFY" | "AMAZONPS" | "PAYPAL" | "PAYPALFF" | "CASHAPP" | "VENMO" | "BTC" | "LTC" | "MANUAL"nameRequiredstringMust not be greater than 100 characters.
icon_image_idintegerlabelstringMust not be greater than 100 characters.
fixed_feenumberMust be at least -100. Must not be greater than 100.
percentage_feenumberMust be at least -50. Must not be greater than 50.
min_amountnumberMust be at least 0. Must not be greater than 999999.
max_amountnumberMust be at least 0. Must not be greater than 999999.
currency_overridestringMust not be greater than 3 characters.
hide_powered_bybooleanis_activebooleanpasswordstringMust not be greater than 255 characters.
otpstringMust not be greater than 6 characters.
tfa_codestringMust not be greater than 8 characters.
remember_mfabooleanPath Parameters
shopIdRequiredintegerThe shop ID.
Get Payment Method
Retrieves a specific payment method.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
paymentMethodIdRequiredintegerThe payment method ID.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
paymentMethodIdRequiredintegerThe payment method ID.
Update Payment Method
Updates a payment method.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredtypeRequiredstring"CUSTOMERBALANCE" | "STRIPE" | "SQUARE" | "SUMUP" | "MOLLIE" | "SKRILL" | "AUTHORIZENET" | "REVOLUTBUSINESS" | "LEMONSQUEEZY" | "NMI" | "OVERPAY" | "SWIFTPAY" | "WHOP" | "ADYEN" | "SHOPIFY" | "AMAZONPS" | "PAYPAL" | "PAYPALFF" | "CASHAPP" | "VENMO" | "BTC" | "LTC" | "MANUAL"nameRequiredstringMust not be greater than 100 characters.
icon_image_idintegerlabelstringMust not be greater than 100 characters.
fixed_feenumberMust be at least -100. Must not be greater than 100.
percentage_feenumberMust be at least -50. Must not be greater than 50.
min_amountnumberMust be at least 0. Must not be greater than 999999.
max_amountnumberMust be at least 0. Must not be greater than 999999.
currency_overridestringMust not be greater than 3 characters.
hide_powered_bybooleanis_activebooleanpasswordstringMust not be greater than 255 characters.
otpstringMust not be greater than 6 characters.
tfa_codestringMust not be greater than 8 characters.
remember_mfabooleanPath Parameters
shopIdRequiredintegerThe shop ID.
paymentMethodIdRequiredintegerThe payment method ID.
Update Payment Method Order
Updates the order of payment methods.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredpaymentMethodsRequiredarray<integer>Path Parameters
shopIdRequiredintegerThe shop ID.
Toggle Payment Method
Toggles the active status of a payment method.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
paymentMethodIdRequiredintegerThe payment method ID.