Update a Pix key entry

Updates an existing Pix entry (RFC 7386 JSON Merge Patch). Only account information, name, and trade name can be changed. A branch or account number change resolves the new account in the CRM before BACEN is called: no CRM account refuses the update with PIX-0116 (or PIX-0140 when the CRM is unavailable) and BACEN is not called. Moving the key onto a salary account (SLRY), by stating that account type or by a branch or account number change to an account the CRM records as SLRY, is refused with 422 PIX-0176 before BACEN is called; a key already on a salary account stays updatable. BACEN’s refusals come back as PIX-0120 (the directory does not hold the key), PIX-0100 (it refused the change) and PIX-0106 (the key is not active).

PATCH /entries/{entry_id}

Update a Pix key entry

cURL

curl --request PATCH \
  --url https://api.example.com/dict-hub/v1/entries/{entry_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "account": {
    "branch": "0001",
    "number": "0007654321",
    "openingDate": "2010-01-10",
    "participant": "12345678",
    "type": "CACC"
  },
  "metadata": {
    "source": "mobile"
  },
  "owner": {
    "name": "João Silva",
    "tradeName": "Silva ME"
  }
}
'

200

Example

{
  "account": {
    "branch": "0001",
    "number": "0007654321",
    "participant": "12345678",
    "type": "CACC",
    "openingDate": "2010-01-10T03:00:00Z"
  },
  "createdAt": "2019-11-18T03:00:00Z",
  "id": "019606c3-5d6e-7f80-1b23-456789012cde",
  "keyCreationDate": "2019-11-18T03:00:00Z",
  "keyOwnershipDate": "2019-11-18T03:00:00Z",
  "keyType": "CPF",
  "keyValue": "52998224725",
  "organizationId": "019606d4-6e7f-8091-2c34-567890123def",
  "owner": {
    "document": "52998224725",
    "name": "João Silva",
    "personType": "NATURAL",
    "tradeName": "Silva ME"
  },
  "requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d",
  "status": "ACTIVE",
  "updatedAt": "2019-11-18T03:00:00Z",
  "holderId": "019606e5-7f80-9102-3d45-678901234ef0",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string · required

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

X-Account-Id · string · required

Account ID (UUID format)

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

X-Reason · string · required

Reason for the update. For an EVP key it MUST be BRANCH_TRANSFER, RECONCILIATION or RFB_VALIDATION; for every other key type any non-empty value is accepted and recorded as the audit reason.

Example:

"USER_REQUESTED"

Path Parameters

entry_id · string · required

Entry ID (UUID format)

Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

Body

application/json

account · object

Show child attributes

metadata · object

Free-form, single-level key/value pairs persisted with the entry. Keys up to 100 characters, values up to 2000 characters, at most 25 entries; nested objects are rejected.

Show child attributes

Example:

{ "source": "mobile" }

owner · object

Show child attributes

Response

200

application/json

OK

account · object · required

Show child attributes

createdAt · string<date-time> · required

Example:

"2019-11-18T03:00:00Z"

id · string · required

Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

keyCreationDate · string<date-time> · required

Example:

"2019-11-18T03:00:00Z"

keyOwnershipDate · string<date-time> · required

Example:

"2019-11-18T03:00:00Z"

keyType · string · required

Example:

"CPF"

keyValue · string · required

Example:

"52998224725"

organizationId · string · required

Example:

"019606d4-6e7f-8091-2c34-567890123def"

owner · object · required

Show child attributes

requestId · string · required

Example:

"a946d533-7f22-42a5-9a9b-e87cd55c0f4d"

status · string · required

Example:

"ACTIVE"

updatedAt · string<date-time> · required

Example:

"2019-11-18T03:00:00Z"

holderId · string

CRM holder of the key's account. Absent while a key VSync synchronized from the directory waits for its owner's CRM account.

Example:

"019606e5-7f80-9102-3d45-678901234ef0"

metadata · object

Show child attributes