Cadastro de contato - Transação Pix-out

Durante uma operação de Pix-out, o cliente poderá optar por cadastrar o destinatário como contato e solicitar sua habilitação como favorito, diretamente na requisição da transação.

Para isso, foi adicionado ao request o parâmetro isSaveToFavorite, que determina se o destinatário deverá ser cadastrado como contato e submetido ao processo de habilitação como favorito.

A habilitação do favorito seguirá a mesma regra de carência de 24 horas aplicada ao cadastro de favoritos.


Parâmetros da requisição

CampoTipoDescriçãoObrigatórioValor padrão
isSaveToFavoriteBooleanndica se o destinatário deve ser cadastrado como contato e submetido à habilitação como favorito.Nãofalse

Regras gerais


  • Quando isSaveToFavorite = false ou o parâmetro não for informado: a transação Pix-out seguirá o fluxo normal, sem realizar o cadastro automático do destinatário como contato por meio desse parâmetro.
  • Quando isSaveToFavorite = true: o destinatário será cadastrado como contato e será iniciada a solicitação para habilitá-lo como favorito.
  • Durante o período de carência: o contato poderá ser consultado normalmente pelo endpoint de Consulta de Contatos (GET /accounts/{account}/contacts), porém o campo isFavorite retornará false.
  • Após 24 horas: concluído o período de carência e efetivada a habilitação, o campo isFavorite retornará true na consulta do contato.
  • Aplicação dos limites: enquanto o contato não estiver efetivamente habilitado como favorito, não deverá ser considerado favorito para fins de aplicação do limite específico para favorecidos. Nesse período, aplicam-se as regras de limite correspondentes à classificação vigente do destinatário.

Exemplo de requisição

O exemplo abaixo demonstra o envio do parâmetro isSaveToFavorite com valor true na requisição Pix-out.

{
  "amount": 1.00,
  "clientCode": "{{clientCode}}",
  "initiationType": "DICT",
  "paymentType": "IMMEDIATE",
  "urgency": "HIGH",
  "transactionType": "TRANSFER",
  "endToEndId": "{{pixapi_e2e}}",
  "debitParty": {
    "account": "41025180"
  },
  "creditParty": {
    "bank": "{{pixapi_participantcredit}}",
    "account": "{{pixapi_accountredit}}",
    "branch": "{{pixapi_branchcredit}}",
    "taxId": "{{pixapi_taxidcredit}}",
    "name": "{{pixapi_namecredit}}",
    "accountType": "****",
    "key": "{{pixapi_key}}"
  },
  "isSaveToFavorite": true,
  "remittanceInformation": "Texto pix assincrono"
}


Did this page help you?