Application ProvidersRotate merchant application payment provider API key

Rotate merchant application payment provider API key

Replaces the stored API key credentials for the configured payment provider on the given application. The application must belong to the authenticated merchant.

curl -X PATCH "https://api.example.com/api/v1/applications/example_string/providers/stripe/api-key" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -d '{
  "apiKey": "sk_live_..."
}'
{}
PATCH
/api/v1/applications/{applicationId}/providers/{providerName}/api-key
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

Bearer token (JWT) - just enter the token, "Bearer" prefix will be added automatically

path
applicationIdstring
Required

ID of the application that owns the provider configuration.

path
providerNamestring
Required

Name identifier of the payment provider whose API key is rotated.

Content-Typestring
Required

The media type of the request body

Options: application/json
apiKeystring
Required

New provider API key.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). Authentication token required.

Path Parameters

applicationIdstring
Required

ID of the application that owns the provider configuration.

providerNamestring
Required

Name identifier of the payment provider whose API key is rotated.

Example:
stripe

Body

application/json
apiKeystring
Required

New provider API key.

Example:
sk_live_...

Responses