v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cadastra nova portabilidade ou reivindicação DICT

Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude.

post/dict/claim

Request body

type'PORTABILITY' | 'OWNERSHIP' required

Deveá ser preenchido como PORTABILITY para portabilidade e OWNERSHIP para reivindicação

branchstring required

Número de agência do reivindicador

accountType'CACC' | 'SLRY' | 'SVGS' | 'TRAN' required

Tipo de conta

accountNumberstring required

Número da Conta. Mínimo 1 e máximo 20 caracteres

taxIdstring required

CPF ou CNPJ do Reivindicador

namestring required

Razão Social/Nome Completo do Reivindicador

keystring required

Chave de Endereçamento Reivindicada.

reasonstring required

Motivo da reivindicação ou portabilidade da chave

tradeNamestring

Nome Fantasia do Reivindicador Obs.: Informar apenas quando CNPJ é preenchido no campo TaxId }

Response

201

versionstring

statusinteger

Example response

{
  "version": "string",
  "body": {
    "type": "PORTABILITY",
    "key": "string",
    "keyType": "string",
    "donorParticipant": "string",
    "id": "string",
    "status": "string",
    "completionPeriodEnd": "2024-05-29T13:39:05.129Z",
    "resolutionPeriodEnd": "2024-05-29T13:39:05.129Z",
    "lastModified": "2024-05-29T13:39:05.129Z",
    "confirmReason": "string",
    "cancelReason": "string",
    "cancelledBy": "string",
    "correlationId": "string",
    "responseTime": "2024-05-29T13:39:05.129Z",
    "merchantCustomerId": "string",
    "claimerAccount": {
      "participant": "string",
      "branch": "string",
      "accountNumber": "string",
      "tipoConta": "CACC",
      "accountType": "string",
      "openingDate": "2024-05-29T13:39:05.129Z"
    },
    "claimer": {
      "type": "string",
      "taxIdNumber": "string",
      "name": "string"
    }
  }
}