POST:: Iniciar pagamento Pix

Essa API permite que seja realizada a iniciação de um pagamento Pix a partir das regras populadas em seu payload.

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

TRANSFER: 'vlcpAmount', 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' não devem ser preenchido. WITHDRAWAL: 'vlcpAmount' não deve ser preenchido, 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' devem ser preenchido. CHANGE: 'vlcpAmount', 'vldnAmount', 'withdrawalAgentMode' e 'withdrawalServiceProvider' devem ser preenchido.

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

MANUAL: 'transactionIdentification' deve ser nulo, 'creditParty.key' deve ser nulo. DICT:'transactionIdentification' deve ser nulo, 'creditParty.key' deve ser preenchido. STATIC_QRCODE: 'transactionIdentification' deve ser preenchido com o identificador do QR Code contendo até 25 caracteres, 'creditParty.key' deve ser preenchido. DYNAMIC_QRCODE: 'transactionIdentification' deve ser preenchido com o identificador do QR Code contendo de 26 até 35 caracteres, 'creditParty.key' deve ser preenchido. PAYMENT_INITIATOR: 'taxIdPaymentInitiator' deve ser preenchido com um CNPJ (14 caracteres). - PAYMENT_INITIATOR: 'creditParty.key' deve ser preenchido caso exista uma consulta DICT pré pagamento. PAYMENT_INITIATOR: 'transactionIdentification' deve ser preenchido de acordo com a regra de pagamento de STATIC_QRCODE.

Endpoint de request

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

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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"amount\":25.55,\"initiationType\":\"DICT\",\"transactionType\":\"TRANSFER\"}",
  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/payment \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
     "amount": 25.55,
     "initiationType": "DICT",
     "transactionType": "TRANSFER"
}
'

NodeJs Axios

const axios = require('axios');

const options = {
  method: 'POST',
  url: 'https://sandbox.agilspotpay.financehub.com.br/pix/v1/payment',
  headers: {accept: 'application/json', 'content-type': 'application/json'},
  data: {amount: 25.55, initiationType: 'DICT', transactionType: 'TRANSFER'}
};

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

Modelo de retorno 200 OK

{
  "transactionId": 45854857,
  "code": "",
  "slip": "COMPROVANTE TRANSFERENCIA PIX...",
  "slipAuth": "5C.A3.DA.5E.C2.00.27.0B.79.5F.B3.57.F2.0F.02.15",
  "endToEndId": "E3030629420200808185300887639654"
}

Modelo de retorno 400 Error

400 - General Reject Operation
{
  "code": "PBE150",
  "description": "General reject operation."
}

Modelo de retorno 504 GatewayTimeout

{
  "errorCode": "CLP010",
  "description": "Transação em processamento. Favor consultar o status da transação ou aguardar o webhook."
}