Skip to main content
PUT
/
api
/
dashboard
/
payment-methods
/
{method}
Upsert Payment Method
curl --request PUT \
  --url https://api.example.com/api/dashboard/payment-methods/{method} \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "display_name": "<string>",
  "display_order": 100,
  "config": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "method": "stripe",
  "enabled": true,
  "display_order": 123,
  "config": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null
​
X-API-Key
string | null
​
X-Stella-Merchant-Id
string | null

Path Parameters

​
method
string
required

Body

application/json

Body for PUT /api/dashboard/payment-methods/{method}.

The handler dispatches on method (path param) to validate the config field against the matching per-method schema above.

​
enabled
boolean
required
​
display_name
string | null
​
display_order
integer
default:100
​
config
Config · object

Response

Successful Response

Single config row in dashboard responses.

​
id
string<uuid>
required
​
merchant_id
string<uuid>
required
​
method
enum<string>
required
Available options:
stripe,
cod,
bank_transfer
​
enabled
boolean
required
​
display_order
integer
required
​
config
Config · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
display_name
string | null