API Reference

Será enviada a notificação de pagamento para todas as transações criadas. Enviaremos tais informações de retorno para o endereço informado no callbackAddress , das transações.

transaction_type irá conter uma das opções abaixo:

  • BankSlip -> Boleto
  • CreditCard -> Cartão de Crédito
  • InstantPayment -> PIX

Header de autenticação

Por questão de segurança e validação dos eventos, enviamos no header de autenticação o Seller Id convertido em base64, como C2P-Hash.

Notificação de Pagamento Recebido

Assim que o pagamento for recebido, enviaremos a notificação contendo os dados da transação. Segue abaixo um exemplo de notificação que enviaremos.

{
   "type":"PAYMENT_RECEIVED",
   "date":"2024-09-12 09:09:53",
   "proccess_id":"5a806b392de12342a20cb392ff7f99e6",
   "tid":"e3c5d8f5-qwer-4052-9047-01619022c0fe",
   "external_identifier":"123",
   "status":"paid",
   "status_reason":null,
   "transaction_type":"CreditCard",
   "customer":{
      "name":"JOHN DOE",
      "taxid":"*******",
      "email":"*******",
      "phone":"*******"
   },
   "payment":{
      "sender":{
         "name":"JOHN DOE",
         "taxid":"***.000.000-**"
      },
      "amount":"150.00",
      "paid_amount":"150.00",
      "date":"2024-09-15 09:10:05",
      "psp":"Elo"
   }
}
{
   "type":"PAYMENT_RECEIVED",
   "date":"2024-09-15 09:56:24",
   "proccess_id":"A6505163-ABCD-DAE3-EFG5-BB63E15D3C1A",
   "tid":"5500c29e-xxxx-aaaa-b8ea-fb183c091628",
   "external_identifier":"123",
   "status":"paid",
   "status_reason":null,
   "transaction_type":"InstantPayment",
   "customer":{
      "name":"JOHN DOE",
      "taxid":"*******",
      "email":"*******",
      "phone":"*******"
   },
   "payment":{
      "sender":{
         "name":"JOHN DOE",
         "taxid":"***.000.000-**"
      },
      "amount":"100.35",
      "paid_amount":100.35,
      "date":"2024-09-12 09:56:53",
      "psp":"BANCO INTER",
      "endToEndId":"E00000000001111111122lCZT7NTu000",
      "reference":"QRS2TXW5I2Q8R1GIBGUSSB8FZBQW60OPDXV"
   }
}
{
   "type":"PAYMENT_RECEIVED",
   "date":"2024-08-06 17:42:27",
   "proccess_id":"5336addf97xxx78e8a7154b0f557096c",
   "tid":"0165093e-xxxx-4c90-97f1-180735065314",
   "external_identifier":"123",
   "status":"paid",
   "status_reason":null,
   "transaction_type":"BankSlip",
   "customer":{
      "name":"JOHN DOE",
      "taxid":"*******",
      "email":"*******",
      "phone":"*******"
   },
   "payment":{
      "sender":{
         "name":"JOHN DOE",
         "taxid":"***.000.000-**"
      },
      "amount":"100.00",
      "paid_amount":"100.00",
      "date":"2024-08-20 02:44:45",
      "psp":"BRADESCO"
   }
}

Notificação de Pagamento Cancelado / Estornado

Ao solicitar um estorno ou cancelamento, da transação, poderá ocorrer do PSP (Provedor de Serviços de Pagamento) se encontrar indisponível, fazendo com que, retornemos o código 202, no momento da solicitação.

Nesse caso, assim que tivermos a confirmação do PSP, de que a transação foi cancelada ou estornada, iremos notificar, conforme o exemplo abaixo.

{
    "type": "PAYMENT_REFUNDED",
    "date": "2021-12-16 14:39:35",
    "proccess_id": "9999999-AA99-99A9-9999-AA9999AAAAAA",
    "tid": "a99999a-0abc-999a-9a9a-aa99a999a99a",
    "external_identifier": "123456",
    "status": "cancelled",
    "status_reason": "refunded",
    "transaction_type": "InstantPayment",
    "customer": {
        "name": "Nome do pagador",
        "taxid": "*******",
        "email": "*******",
        "phone": "*******"
    },
    "refund": {
        "amount": "19.90",
        "psp": "CAIXA ECONOMICA FEDERAL"
    }
}
{
    "type": "PAYMENT_REFUNDED",
    "date": "20241-05-16 14:39:35",
    "proccess_id": "9999999-AA99-99A9-9999-AA9999AAAAAA",
    "tid": "a99999a-0abc-999a-9a9a-aa99a999a99a",
    "external_identifier": "123456",
    "status": "cancelled",
    "status_reason": "refunded",
    "transaction_type": "InstantPayment",
    "customer": {
        "name": "Nome do pagador",
        "taxid": "*******",
        "email": "*******",
        "phone": "*******"
    },
    "refund": {
      	"recipient":{
          "name":"NOME PAGADOR",
          "taxid":"***.000.000-**"
        },
        "amount": "19.90",
        "psp": "CAIXA ECONOMICA FEDERAL",
        "endToEndId":"D00000000001111111122lCZT7NTu000"
    }
}