POST:: Criar nova cobrança imediata

Essa API possibilita que seja realizado o vinculo de um QR Code a uma cobrança imediata.

Regras de preenchimento e validação do campo Amount:

Para cobranças: os objetos 'withdrawal' e 'change' não devem ser preenchidos.

Endpoint de request

https://sandbox.agilspotpay.financehub.com.br/pix/v1/collection/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/immediate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"clientRequestId\":\"9b26edb7cf254db09f5449c94bf13abc\",\"key\":\"[e-mail]\",\"amount\":{\"original\":15.01,\"changeType\":0},\"calendar\":{\"expiration\":\"86400\"}}",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "content-type: 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 POST \
     --url https://sandbox.agilspotpay.financehub.com.br/pix/v1/collection/immediate \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
     "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
     "key": "[e-mail]",
     "amount": {
          "original": 15.01,
          "changeType": 0
     },
     "calendar": {
          "expiration": "86400"
     }
}
'

NodeJs Axios

const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://sandbox.agilspotpay.financehub.com.br/pix/v1/collection/immediate',
  headers: {accept: 'application/json', 'content-type': 'application/json'},
  data: {
    clientRequestId: '9b26edb7cf254db09f5449c94bf13abc',
    key: '[e-mail]',
    amount: {original: 15.01, changeType: 0},
    calendar: {expiration: '86400'}
  }
};

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

Modelo de retorno 200 OK

{
  "revision": 0,
  "transactionId": 9190596,
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "status": "ACTIVE",
  "lastUpdate": "2022-03-21T19:45:32.7719371+00:00",
  "payerQuestion": null,
  "additionalInformation": null,
  "debtor": {
    "name": "valdir",
    "cpf": "35914746817",
    "cnpj": null
  },
  "amount": {
    "original": 15.01,
    "changeType": 0,
    "withdrawal": null,
    "change": null
  },
  "location": {
    "merchant": {
      "postalCode": "01201005",
      "city": "Barueri",
      "merchantCategoryCode": "0000",
      "name": "AgilSpot Pay Pagamentos"
    },
    "url": "api-h.developer.btgpactual.com/v1/p/v2/de69b65990834cfaa88ec7c6754b9a87",
    "emv": "00020101021226930014br.gov.bcb.pix2571api-h.developer.btgpactual.com/v1/p/v2/de69b65990834cfaa88ec7c6754b9a875204000053039865802BR5918Celcoin Pagamentos6007Barueri61080120100562070503***6304DEFF",
    "type": "COB",
    "locationId": "12731028",
    "id": null
  },
  "key": "[e-mail]",
  "calendar": {
    "expiration": 86400
  },
  "createAt": "2022-03-21T19:45:32.7719371+00:00",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk9190596"
}

Modelo de retorno 400 Error

400 - Location Já Está Em Uso
{
  "message": "Can't create a new Pix Collection when there is another Pix Collection active with the same location.",
  "errorCode": "PBE318"
}
400 - Não Foi Retornado BRCode Location
{
  "message": "Não foi retornado BRCode Location.",
  "errorCode": "CI002"
}
400 - Chave Informada Não Cadastrada
{
  "message": "Chave informada não cadastrada",
  "errorCode": "CI003"
}
400 - O Valor Original É Obrigatório Neste Tipo De Transação
{
  "message": "O valor original é obrigatório neste tipo de transação",
  "errorCode": "VLI001"
}
400 - Não É Permitido Preencher Os Objetos 'Change' E 'Withdrawal'
{
  "message": "Não é permitido preencher os objetos 'change' e 'withdrawal' simultaneamente",
  "errorCode": "VLI002"
}
400 - Valor Em Dinheiro Disponibilizado É Obrigatório
{
  "message": " Valor em dinheiro disponibilizado é obrigatório neste tipo de transação",
  "errorCode": "VLI010"
}