Pular para o conteúdo principal

Solicitar um limite Pix temporário

Solicita, para uma conta de titularidade do solicitante, o limite Pix temporário do dia: o volume total de Pix que se pretende transacionar pela trilha temporária.

Request​

ENDPOINT
/baas/pix/exceptional_pix_request
MÉTODO
POST
cuidado

Disponível somente entre 06:00 e 17:00 (horário de Brasília). Fora dessa janela a resposta é PXT000200.

Request Body
{
  "account_key": "0f2a1e4c-1111-2222-3333-444455556666",
  "total_amount": 1200000.00,
  "request_reason": "folha de pagamento do cliente Alfa Ltda"
}

Body Params​

CampoTipoDescriçãoCaracteres
account_key *uuidv4Chave única de identificação da conta, de titularidade do solicitante, à qual o limite se aplica.36
total_amount *numberVolume total do limite Pix temporário para hoje a partir desta conta. Não pode ser inferior ao volume já transacionado no dia.—
request_reason *stringMotivo pelo qual o volume temporário é necessário. Usado pela QI Tech na análise manual, quando houver.3 a 255

Response​

Duas respostas de sucesso são possíveis, e a diferença entre elas é o que determina se o limite já pode ser usado:

Código HTTPstatusSignificado
201approvedDentro do teto de aprovação automática da integração. O limite já pode ser utilizado para transferências hoje.
202pending_approvalAcima do teto de aprovação automática. Segue para análise manual da QI Tech, que pode aprovar ou recusar; não utilizável enquanto pendente.
202 não é aprovação

Com 202 e pending_approval, a solicitação foi registrada mas não libera transferências. Tentar uma transferência nesse estado responde PXT000201. O resultado da análise chega pelos webhooks baas.pix.exceptional.approved ou baas.pix.exceptional.rejected, e também pode ser acompanhado por Consultar solicitações de limite.

informação

Ao criar uma solicitação para uma conta que já possui outra em aberto, os volumes não se somam. Se a anterior estava approved e o novo total_amount é menor ou igual ao dela, a nova é aprovada na hora e a anterior passa a cancelled. Se o novo total_amount é maior, a nova nasce pending_approval e a anterior continua aprovada e utilizável até a QI Tech resolver — aprovando a nova, a anterior passa a cancelled; recusando, a anterior segue valendo. Veja Observações.

Response Body: 201 Created
{
  "pix_request_key": "9c3b7d21-8f4a-4c2b-9e1d-7a6b5c4d3e2f",
  "account_key": "0f2a1e4c-1111-2222-3333-444455556666",
  "total_amount": 1200000.00,
  "request_reason": "folha de pagamento do cliente Alfa Ltda",
  "status": "approved",
  "message": "Request approved and available for use today until 20:00."
}
Response Body: 202 Accepted
{
  "pix_request_key": "9c3b7d21-8f4a-4c2b-9e1d-7a6b5c4d3e2f",
  "account_key": "0f2a1e4c-1111-2222-3333-444455556666",
  "total_amount": 1200000.00,
  "request_reason": "folha de pagamento do cliente Alfa Ltda",
  "status": "pending_approval",
  "message": "Request received and forwarded to manual analysis. The result will be sent by webhook."
}

Response Body Params​

CampoTipoDescrição
pix_request_keyuuidv4Chave única de identificação da solicitação de limite Pix temporário.
account_keyuuidv4Conta à qual a solicitação se aplica.
total_amountnumberVolume total declarado para o dia.
request_reasonstringMotivo informado na solicitação.
statusenumeratorStatus da solicitação. Ver Temporary Pix Request Status.
messagestringTexto descritivo do status, em inglês.

Erros​

Os erros específicos de Pix temporário estão em Erros de Pix temporário. Nesta operação podem ocorrer PXT000206, PXT000200 e PXT000202.