Skip to main content
POST
Move a key to another engine

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

Idempotency key; a retry with the same key and body replays the first answer.

Parámetros de ruta

assignmentId
string<uuid>
requerido

Surrogate identifier of the assignment. Find one by keyKind + keyValue on the collection.

Cuerpo

application/json
reason
string
requerido

Required. This is a human decision about where money lands.

Required string length: 1 - 512
toEngineId
string
requerido
Pattern: ^[a-z0-9-]{1,32}$

Respuesta

OK

assignmentId
string<uuid>
requerido
engineId
string
requerido
Pattern: ^[a-z0-9-]{1,32}$
keyKind
enum<string>
requerido
Opciones disponibles:
ACCOUNT,
DOCUMENT,
PIX_KEY_EMAIL,
PIX_KEY_PHONE,
PIX_KEY_RANDOM,
PAYMENT_ID,
PIX_RECURRENCE_ID
keyValue
string
requerido

Normalized form. This is what the rails resolve against. ACCOUNT is :, and : for a payment account.

Maximum string length: 256
updatedAt
string<date-time>
requerido
keyValueRaw
string

Exactly what the operator typed.

Maximum string length: 256
previousEngineId
string | null

Present after a move.

updatedBy
string
Maximum string length: 128