Rota que gera transação de pagamento por PIX.

curl --request POST '/api/Pix/pay'

Rota que gera transação de pagamento por PIX.

📘

Quando encaminhamos essa requisição a API de banking, essa solicitação gera um pedido de criação do QR code para pagamento.

Exemplo de request:


{
"accountId": "*******" ,
"pixKey": "*****",
"pixMessage":"Mensagem padrão PIX",
"additionalInformation" : 
    {
        "fieldName" : "Nome",
        "fieldValue" : "Valor"
    },
"amount" : 1
}
CampoTipoDescrição
accountIdStringID da conta do cliente.
pixKeyStringChave do PIX.
pixMessageStringMensagem padrão PIX.
additionalInformationArraycontainer das informações dos serviço/produto do parceiro.
fieldNameStringNome do Produto/serviço da compra.
fieldValueStringValor da compra
amountDecimalValor da solicitação

🚧

Como descobrir o AccounID:

Após o fluxo de consentimento ter dado certo. A API irá retorna o response dos dados necessários, via retorno criptografado. Com isso basta segui com a chave privada para descriptografar o webhook recebido. Segue link para esclarecer maiores dúvidas.
Como descriptografar webhook.

Exemplo de response:

  {
      calendar: {
          expiration: 900,
          createdIn: "08/11/2023 16:20:45"
      },
      transactionId: "",
      amount: 1,
      createdIn: "2023-11-08T16:20:45",
      qrCodeContent: "",
      qrCodeImage: "",
      responseCode: "",
      responseReason: "",
      wasSuccessfull: false
  }
CampoTipoDescrição
calendarArraycontainer da data geração do QR code.
expirationintTempo de expiração do Qr code (Tempo em segundos).
createdInStringData da geração da transação.
transactionIdStringID único. ID que se encontra no response da solicitação da criação do QR code
amountDecimalValor do Qr code.
createdInStringData da geração da transação.
qrCodeContentStringFormato para utilizar cópia e cola do PIX.
qrCodeImageStringCriação da imagem do Qrcode.
responseCodeStringCódigo do retorno da chamada.
"0000"= Aprovado.
responseReasonStringMensagem do respose code.
wasSuccessfullboolTrue= QR code gerado.
False = Falha ao gerar QR code.