Rotate an API key
Webhooks and account administration
Rotate an API key
Replaces an API key’s secret while retaining its identity and supported access settings.
POST
Rotate an API key
What this endpoint does
Replaces an API key’s secret while retaining its identity and supported access settings.When to use it
Rotate routinely and immediately after suspected exposure.Before you call
Use API-key administration access and pass a key ID owned by the same tenant account. Prepare to update the consuming service.Money and balance effect
This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.States and completion
The new secret is returned once. The old secret stops working according to the rotation response and policy.Safe retries
Send a uniqueIdempotency-Key for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.
Read API keys for the complete workflow.Authorizations
Send the same Wayex API key as Authorization: Bearer <key>.
Headers
A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.
Required string length:
8 - 255Path Parameters
Body
application/json
Required array length:
1 - 19 elementsAvailable options:
customers:read, customers:write, routes:read, routes:write, transfers:read, transfers:write, treasury:read, treasury:write, rates:read, webhooks:read, webhooks:write, fees:read, fees:write, keys:read, keys:write, settings:read, settings:write, admin:read, admin:write Required array length:
1 - 50 elementsRequired string length:
1 - 49Pattern:
^[0-9a-fA-F:.]+(\/\d{1,3})?$Response
The replacement key, including the new plaintext secret (shown once).
Minimum string length:
1Minimum string length:
1Available options:
secret, publishable Minimum string length:
1Minimum string length:
1Available options:
active, revoked Minimum string length:
1Minimum string length:
1Available options:
customers:read, customers:write, routes:read, routes:write, transfers:read, transfers:write, treasury:read, treasury:write, rates:read, webhooks:read, webhooks:write, fees:read, fees:write, keys:read, keys:write, settings:read, settings:write, admin:read, admin:write Required string length:
1 - 49Pattern:
^[0-9a-fA-F:.]+(\/\d{1,3})?$
