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
}
Campo | Tipo | Descrição |
---|---|---|
accountId | String | ID da conta do cliente. |
pixKey | String | Chave do PIX. |
pixMessage | String | Mensagem padrão PIX. |
additionalInformation | Array | container das informações dos serviço/produto do parceiro. |
fieldName | String | Nome do Produto/serviço da compra. |
fieldValue | String | Valor da compra |
amount | Decimal | Valor 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
}
Campo | Tipo | Descrição |
---|---|---|
calendar | Array | container da data geração do QR code. |
expiration | int | Tempo de expiração do Qr code (Tempo em segundos). |
createdIn | String | Data da geração da transação. |
transactionId | String | ID único. ID que se encontra no response da solicitação da criação do QR code |
amount | Decimal | Valor do Qr code. |
createdIn | String | Data da geração da transação. |
qrCodeContent | String | Formato para utilizar cópia e cola do PIX. |
qrCodeImage | String | Criação da imagem do Qrcode. |
responseCode | String | Código do retorno da chamada. "0000"= Aprovado. |
responseReason | String | Mensagem do respose code. |
wasSuccessfull | bool | True= QR code gerado. False = Falha ao gerar QR code. |