Pix Saque/Troco

Para realizar transações do tipo pix saque ou pix troco, a API a ser utilizada é a mesma de pix-payment, o que vai mudar é o corpo da requisição. Link da API Abaixo os campos obrigatórios para cada tipo de fluxo:



Pix Saque (WITHDRAWAL)

Utilizado para retiradas de dinheiro em espécie. O valor total da transação é o valor sacado.

Campodescrição
clientCodeIdentificador único do cliente.
transactionTypeDeve ser preenchido como WITHDRAWAL.
urgencyNível de prioridade da transação.
paymentTypeModalidade do pagamento.
initiationTypeForma como a transação foi iniciada.
debitPartyDados do pagador (quem está sacando).
creditPartyDados do recebedor (estabelecimento/agente).
creditParty.keyChave Pix do recebedor.
amountValor do recurso em espécie disponibilizado.
vldnAmountValor do recurso em espécie disponibilizado.
endToEndIdIdentificador fim-a-fim da transação Pix.
transactionIdentificationID da transação (TxID).
withdrawalAgentModeModo do agente de saque (ex: AGTEC).
withdrawalServiceProviderISPB do provedor do serviço de saque.


Pix Troco (CHANGE)

Utilizado para compras onde o cliente deseja receber uma parte do valor em espécie.

Regra de Valor (amount): Nesta modalidade, o campo totalizador deve somar o valor da compra ao valor do saque:

amount = vlcpAmount (compra) + vldnAmount (espécie)


Campodescrição
clientCodeIdentificador único do cliente.
transactionTypeDeve ser preenchido como WITHDRAWAL.
urgencyNível de prioridade da transação.
paymentTypeModalidade do pagamento.
initiationTypeForma como a transação foi iniciada.
debitPartyDados do pagador (quem está sacando).
creditPartyDados do recebedor (estabelecimento/agente).
creditParty.keyChave Pix do recebedor.
amountSomatória do valor da compra + valor em espécie.
vlcpAmountValor do recurso referente à compra.
vldnAmountValor do recurso referente ao saque em espécie.
endToEndIdIdentificador fim-a-fim da transação Pix.
transactionIdentificationID da transação (TxID).
withdrawalAgentModeModo do agente de saque (ex: AGTEC).
withdrawalServiceProviderISPB do provedor do serviço de saque.