Skip to main content
POST
Move a key to another engine

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

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

Path Parameters

assignmentId
string<uuid>
required

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

Body

application/json
reason
string
required

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

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

Response

OK

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

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

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

Exactly what the operator typed.

Maximum string length: 256
previousEngineId
string | null

Present after a move.

updatedBy
string
Maximum string length: 128