v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cadastrar uma nova chave Pix

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

post/dict/entry

Request body

keystring required

Chave Pix a ser cadastrada. Caso seja EVP, deve ser informada o tipo de chave e este campo deve estar vazio ou nulo. (exemplo: 12345678901)

branchstring required

Agencia da conta (exemplo: 0002)

accountNumberstring required

Numero da conta (exemplo: 105156485)

accountTypestring required

Tipo da Conta: CACC SLRY SVGS TRAN

openingDatestring required

Data de abertura da Conta (exemplo: 2023-04-05T15:10:00)

taxIdstring required

Número de documento do dono da conta (exemplo:12345678901)

namestring required

Nome do dono da Conta. (exemplo: Anderson Garcia

tradeNamestring

Nome Fantasia do dono da conta. (exemplo: Empreitera S/A)

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

Razão para criação da chave.

Response

201

versionstring

statusinteger

Example response

{
  "version": "string",
  "body": {
    "requestId": "9bbb7b37-2f3a-4ff0-97b8-e377aab70cbe",
    "key": "exemplo@exemplo.com",
    "creationDate": "string",
    "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"
    }
  }
}