Claim accounts, charger documents and recurrence charger sides for the calling engine

Each core claims every account it opens, when it opens it, and before its cutover loads the accounts it already holds the same way, in pages of up to 1000 keys. ACCOUNT takes account, plus branch for a current account. A PAYMENT ACCOUNT IS CLAIMED WITHOUT A BRANCH: omit branch or send it empty, never 0, because the Pix rail looks payment accounts up without one, and a payment account claimed with a branch is a key nothing reads. DOCUMENT takes keyValue, a Pix Automático charger’s CNPJ. PIX_RECURRENCE_ID_CHARGER takes keyValue, the idRecorrencia of a recurrence whose charger the caller holds: the charger’s side, which takes the schedule cancellations the payer’s PSP asked for; the payer’s side is claimed at PUT /v1/ownership/recurrences/. A key the map does not hold is still retained ACCOUNT_UNASSIGNED. 200 answers one result per key, in request order, never repeating the key: CLAIMED, the key is now the caller’s; ALREADY_OWNED, it already was and nothing changed; HELD_ELSEWHERE, the JDC-0102 fact: another engine holds the key, so report it to an operator, because only an operator moves a key; INVALID, the JDC-0104 fact: the key is not usable and nothing was written for it. One key’s outcome never fails another. 422 JDC-0002: no key, or more than 1000. 422 JDC-0104: a key carries bytes that are not valid UTF-8, and the whole call is refused. 503, a dropped connection or a timeout: the call may have stopped part-way and some keys may be recorded; send the same call again, it is idempotent. The owner is always the caller.

POST /v1/ownership/claims

Claim accounts, charger documents and recurrence charger sides for the calling engine

cURL

curl --request POST \
  --url https://api.example.com/v1/ownership/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keys": [
    {
      "account": "<string>",
      "branch": "<string>",
      "keyValue": "<string>"
    }
  ]
}
'

200

{
  "results": [
    {
      "outcome": "CLAIMED"
    }
  ]
}

Autorizaciones

Authorization · string · header · requerido

An Access Manager application token whose subject is bound to exactly one engine; an engine may hold several, one per calling product. It reaches only the operations its scopes name; the operator surface refuses it.

Scopes

ownership:write

Claim accounts, charger documents or a Pix Automático recurrence, or declare a Pix Automático payment leg, for the calling engine alone

Cuerpo

application/json

keys · object[] | null · requerido

Required array length: 1 - 1000 elements

Show child attributes

Respuesta

200

application/json

OK

results · object[] | null · requerido

Show child attributes