GET:: Verificar o status de um pagamento Pix

Endpoint destinado a consulta de status posterior ao recebimento de webhook, ou em caso de muita demora para o recebimento da confirmação.

A consulta receberá o parâmetro gerado na requisição de pagamento, como parâmetro de entrada para realizar a consulta.

No resultado, serão apresentado até 3 tipos de status diferentes:

PROCESSING: Transação ainda em processamento;

CONFIRMED: Transação confirmada com sucesso;

ERROR: Transação com erro. Vide nó 'error' do payload de response para detalhes sobre o erro;

As consultas de status realizadas neste endpoint, só terão um status válido a partir de 2 minutos após o recebimento da resposta de sucesso da requisição de pagamento.

Endpoint de request

https://sandbox.agilspotpay.financehub.com.br/pix/v1/payment/pi/status

Exemplo com as principais linguagem

Retorno em JSON com os dados do cadastro.

cPHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.agilspotpay.financehub.com.br/pix/v1/payment/pi/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

cURL

curl --request GET \
     --url https://sandbox.agilspotpay.financehub.com.br/pix/v1/payment/pi/status \
     --header 'accept: application/json'

NodeJs Axios

const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://sandbox.agilspotpay.financehub.com.br/pix/v1/payment/pi/status',
  headers: {accept: 'application/json'}
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });

Modelo de retorno 200 OK

{
  "transactionId": 9193070,
  "clientCode": "312312312",
  "endToEndId": "E1393589320220322182401415343541",
  "status": "ERROR",
  "error": {
    "code": "PBE343",
    "description": "Settlement of the transaction has failed."
  }
}

Modelo de retorno 400 - General Reject Operation

{
  "code": "PBE150",
  "description": "General reject operation."
}