GET:: Busca de dados de uma cobrança imediata

Essa API possibilita a busca de uma cobrança imediata a partir de alguns parâmetros.

Endpoint de request

https://sandbox.agilspotpay.financehub.com.br/pix/v1/collection/pi/immediate

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/collection/pi/immediate",
  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/collection/pi/immediate \
     --header 'accept: application/json'

NodeJs Axios

const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://sandbox.agilspotpay.financehub.com.br/pix/v1/collection/pi/immediate',
  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": 12345345,
  "status": "ACTIVE",
  "lastUpdate": "2021-04-29",
  "payerQuestion": "Esta cobrança é referente a...",
  "additionalInformation": [
    {
      "value": "Assinatura de serviço",
      "key": "Produto 1"
    }
  ],
  "debtor": {
    "name": "Fulano de Tal",
    "cpf": "11122233366",
    "cnpj": "1112223300100",
    "city": "Barueri",
    "publicArea": "Avenida Brasil",
    "state": "SP",
    "postalCode": "01202003",
    "email": "[e-mail]"
  },
  "amount": {
    "original": 15.63,
    "discount": {
      "discountDateFixed": [
        {
          "date": "2021-04-29",
          "amountPerc": "1.00"
        }
      ],
      "modality": "string"
    },
    "abatement": {
      "amountPerc": "1.00",
      "modality": "FIXED_VALUE"
    },
    "fine": {
      "amountPerc": "1.00",
      "modality": "string"
    },
    "interest": {
      "amountPerc": "1.00",
      "modality": "string"
    }
  },
  "key": "5d000ece-b3f0-47b3-8bdd-c183e8875862",
  "receiver": {
    "name": "João da Silva",
    "cpf": "11122233366",
    "cnpj": "1112223300100",
    "postalCode": "01202003",
    "city": "Barueri",
    "publicArea": "Avenida Brasil",
    "state": "SP",
    "fantasyName": "Nome de Comercial"
  },
  "calendar": {
    "expirationAfterPayment": "10",
    "createdAt": "2021-04-29",
    "dueDate": "2021-05-10"
  },
  "createAt": "2021-04-29",
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk479195205",
  "transactionIdPayment": 45854857
}

Modelo de retorno 400

400 - Não Foi Possível Localizar A Cobrança
{
  "message": "Não foi possível localizar a cobrança associada ao parâmetro informado.",
  "errorCode": "VL002"
}