v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Altera uma chave Pix

Essa API possibilita a realização do de uma chave Pix

put/dict/entry/{key}

Path parameters

keystring required

Chave Pix a ser alterada

Request body

reason'FEDERAL_REVENUE_VALIDATION' | 'USER_REQUESTED' | 'RECONCILIATION' | 'BRANCH_TRANSFER' required

Razão para alteração da chave. Para chaves pix do tipo EVP, a reason não poderá ser "USER_REQUESTED"

branchstring

Agência associada a conta.

accountTypestring

Tipo de conta. CACC: Conta corrente ou digital; SLRY: Conta salário; SVGS: Conta poupança; TRAN: Conta de pagamentos;

accountNumberstring

Número da conta transacional

openingDatestring

Data que a Chave foi criada

merchantCustomerIdstring

O id único que identifica o cliente.

namestring

Nome do dono da chave.

tradeNamestring

Nome Fantasia do dono da conta. (Apenas para chave vinculada de pessoa jurídica)

ispbstring

Código bancário de 8 dígitos

Response

200

versionstring

statusinteger

Example response

{
  "version": "string",
  "body": {
    "key": "exemplo@exemplo.com",
    "keyType": "EMAIL",
    "account": {
      "branch": "0002",
      "accountNumber": "105156485",
      "accountType": "TRAN",
      "participant": "30306294",
      "openingDate": "2023-04-05T15:13:00"
    },
    "owner": {
      "type": "NATURAL_PERSON",
      "taxIdNumber": "12345678901",
      "name": "Fulano de Tal",
      "tradeName": "Empreiteira S/A"
    },
    "creationDate": "2023-01-01T01:01:01Z",
    "keyOwnershipDate": "2022-01-01T01:01:01Z",
    "openClaimCreationDate": "2022-02-02T01:01:01Z"
  }
}