Skip to main content
POST
Rotate an API key (developer)

Authorizations

Authorization
string
header
required

SimplePay customer session bearer. Never a tenant API credential.

Headers

x-sp-step-up-token
string
required

Short-lived, single-use SimplePay recent-auth proof bound to this mutation and Idempotency-Key.

Required string length: 32 - 4096
Idempotency-Key
string
required
Required string length: 8 - 255

Path Parameters

id
string<uuid>
required

Body

application/json
tenant_environment
enum<string>
required
Available options:
sandbox,
live
tenant_id
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$

Response

200 - application/json

Replacement API key created. one_time_value is returned once.

key
object
required
object
any
required
one_time_value
string
required

One-time plaintext credential. Never returned by list or replay and never persisted by SimplePay.

Minimum string length: 16
Last modified on September 1, 2026