SellAuth

Payment Methods

Get Payment Methods

Retrieves the payment methods.

GET
/v1/shops/{shopId}/payment-methods

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger
curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/payment-methods" \
  -H "Authorization: Bearer <token>"

{
  "message": "No query results for model [App\\Models\\Shop] 1"
}

Create Payment Method

Creates a new payment method.

POST
/v1/shops/{shopId}/payment-methods

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
typeRequiredstring
Value in: "CUSTOMERBALANCE" | "STRIPE" | "SQUARE" | "SUMUP" | "MOLLIE" | "SKRILL" | "AUTHORIZENET" | "LEMONSQUEEZY" | "NMI" | "ADYEN" | "SHOPIFY" | "AMAZONPS" | "PAYPAL" | "PAYPALFF" | "CASHAPP" | "VENMO" | "BTC" | "LTC" | "MANUAL"
nameRequiredstring

Must not be greater than 100 characters.

icon_image_idinteger

The id of an existing record in the images table.

labelstring

Must not be greater than 100 characters.

fixed_feenumber

Must be at least -100. Must not be greater than 100.

percentage_feenumber

Must be at least -50. Must not be greater than 50.

min_amountnumber

Must be at least 0. Must not be greater than 999999.

max_amountnumber

Must be at least 0. Must not be greater than 999999.

currency_overridestring

Must not be greater than 3 characters.

hide_powered_byboolean
is_activeboolean

Path Parameters

shopIdRequiredinteger
curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/payment-methods" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "SHOPIFY",
    "name": "tsehecphxbjxldj",
    "icon_image_id": 20,
    "label": "flemmpdgr",
    "fixed_fee": 5,
    "percentage_fee": 3,
    "min_amount": 3,
    "max_amount": 21,
    "currency_override": "q",
    "hide_powered_by": true,
    "is_active": true
  }'

Get Payment Method

Retrieves a specific payment method.

GET
/v1/shops/{shopId}/payment-methods/{paymentMethodId}

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger
paymentMethodIdRequiredinteger
curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/payment-methods/{paymentMethodId}" \
  -H "Authorization: Bearer <token>"

{
  "message": "No query results for model [App\\Models\\Shop] 1"
}

Delete Payment Method

Deletes a payment method.

DELETE
/v1/shops/{shopId}/payment-methods/{paymentMethodId}

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger
paymentMethodIdRequiredinteger
curl -X DELETE "https://api.sellauth.com/v1/shops/{shopId}/payment-methods/{paymentMethodId}" \
  -H "Authorization: Bearer <token>"

Update Payment Method

Updates a payment method.

PUT
/v1/shops/{shopId}/payment-methods/{paymentMethodId}

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
typeRequiredstring
Value in: "CUSTOMERBALANCE" | "STRIPE" | "SQUARE" | "SUMUP" | "MOLLIE" | "SKRILL" | "AUTHORIZENET" | "LEMONSQUEEZY" | "NMI" | "ADYEN" | "SHOPIFY" | "AMAZONPS" | "PAYPAL" | "PAYPALFF" | "CASHAPP" | "VENMO" | "BTC" | "LTC" | "MANUAL"
nameRequiredstring

Must not be greater than 100 characters.

icon_image_idinteger

The id of an existing record in the images table.

labelstring

Must not be greater than 100 characters.

fixed_feenumber

Must be at least -100. Must not be greater than 100.

percentage_feenumber

Must be at least -50. Must not be greater than 50.

min_amountnumber

Must be at least 0. Must not be greater than 999999.

max_amountnumber

Must be at least 0. Must not be greater than 999999.

currency_overridestring

Must not be greater than 3 characters.

hide_powered_byboolean
is_activeboolean

Path Parameters

shopIdRequiredinteger
paymentMethodIdRequiredinteger
curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/payment-methods/{paymentMethodId}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "LEMONSQUEEZY",
    "name": "dcz",
    "icon_image_id": 1,
    "label": "qrccebxpzmvepzkcx",
    "fixed_fee": 6,
    "percentage_fee": 8,
    "min_amount": 6,
    "max_amount": 9,
    "currency_override": "q",
    "hide_powered_by": true,
    "is_active": true
  }'

Update Payment Method Order

Updates the order of payment methods.

PUT
/v1/shops/{shopId}/payment-methods/order

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
paymentMethodsRequiredarray<object>

Path Parameters

shopIdRequiredinteger
curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/payment-methods/order" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentMethods": [
      []
    ]
  }'

Toggle Payment Method

Toggles the active status of a payment method.

POST
/v1/shops/{shopId}/payment-methods/{paymentMethodId}/toggle

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger
paymentMethodIdRequiredinteger
curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/payment-methods/{paymentMethodId}/toggle" \
  -H "Authorization: Bearer <token>"

Notifications

Payment Processors