Skip to main content
POST
Create an API key using a SimplePay customer session

Autorizaciones

Authorization
string
header
requerido

SimplePay customer session bearer. Never a tenant API credential.

Encabezados

x-sp-step-up-token
string
requerido

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

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

Cuerpo

application/json
tenant_environment
enum<string>
requerido
Opciones disponibles:
sandbox,
live
tenant_id
string
requerido
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
scopes
enum<string>[]
requerido
Required array length: 1 - 64 elements
Opciones disponibles:
bookable_payments:read,
bookable_payments:write,
admission_control:manage,
admission_control:redeem,
customer_hub.contacts:write,
customer_hub.notes:write,
customer_hub.provider_sync:write,
customer_hub.segments:read,
customer_hub.segments:write,
customer_hub:read,
customer_hub:write,
digital_catalog.inventory:read,
digital_catalog.inventory:write,
digital_catalog:read,
digital_catalog:write,
hosted_checkout:read,
hosted_checkout:write,
intelligence:read,
payment_links:read,
payment_links:write,
physical_checkout:read,
physical_checkout:write,
table_pay:read,
table_pay:write,
policies:read,
refunds:read,
refunds:write,
reporting:read,
tap_to_pay:read,
tap_to_pay:write,
terminal:read,
terminal:write,
ticketing:read,
ticketing:write,
transfers:read,
transfers:write,
webhooks:read,
webhooks:write,
workspace:read,
workspace:write
Required string length: 3 - 96
description
string
Maximum string length: 120

Respuesta

201 - application/json

API key created. one_time_value is returned once and is never persisted by SimplePay.

key
object
requerido
object
any
requerido
one_time_value
string
requerido

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

Minimum string length: 16
Última modificación el 1 de septiembre de 2026