Skip to content

Update a store

PATCH
/v1/stores/{store_id}
curl --request PATCH \
--url https://api.feitpay.com/v1/stores/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "website_url": "https://example.com", "default_currency": "EUR", "status": "active" }'
store_id
required
string
FeitPay-Organization
string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Media typeapplication/json
object
name
string
>= 1 characters <= 120 characters
website_url
string format: uri
default_currency
string
Allowed values: EUR USD BRL GBP
status
string
Allowed values: active disabled

Updated.

Media typeapplication/json
object
id
required
string
object
required
string
Allowed value: store
organization_id
required
string
name
required
string
website_url
required
string | null
default_currency
required
string
status
required
string
Allowed values: active disabled
sandbox_fixture
required
boolean
branding
required
object
display_name
required
string
logo_url
required
string | null
accent_color
required
string | null
support_email
required
string | null
support_url
required
string | null
website_domain
required
string | null
domain_verified
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example

{
"object": "store",
"status": "active"
}

Missing or invalid credentials.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}

Authenticated but not permitted.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}

Resource not found (or not visible to this tenant).

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}

Validation failed.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}

Too many requests. See Retry-After.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example

{
"error": {
"type": "invalid_request_error"
}
}
Retry-After
integer