API Reference

Callbacks

Os callbacks são usados para monitorar o status da ação realizada, podendo ser de uma transação ou saque.

transactionPix

Callback realizado na url cadastrada no webhook sempre que houver um pagamento ou uma devolução de um pagamento.

MétodoRota
POST{WEBHOOK_URL}/pix

Status de pagamento:

StatusIdentificador
PAGObccaee91-2d14-40e4-bd0b-0976ec694d6a
CANCELADOa1efc72c-a608-4c91-b816-0270d39b72b9
EXPIRADO6f9c3e97-c161-439b-a5c2-c423998141be
ESTORNADOfbcba001-e03c-4e97-b565-72d6b315860b

Retorno da requisição:

{
  "transactionId": "29eef544-2764-4e7d-8bfe-6a3fcd12bf85",
  "statusId": "bccaee91-2d14-40e4-bd0b-0976ec694d6a",
  "status": "PAGO",
  "endToEndId": "E31872495205502282310w42Nv7613X6",
  "value": 2.1,
  "cpfCnpj": "05745624190"
}



withdrawIntegration

Callback realizado na url cadastrada no webhook sempre que houver uma atualização do status de pagamento.

MétodoRota
POST{WEBHOOK_URL}/withdraw

Status de pagamento:

StatusIdentificador
EM ANÁLISEfbcba001-e03c-4e97-b565-72d6b315760a
APROVADO6f9c3e97-c161-439b-a5c2-c423998141bd
PAGObccaee91-2d14-40e4-bd0b-0976ec694d6a
CANCELADOa1efc72c-a608-4c91-b816-0270d39b72b9
ESTORNADOfbcba001-e03c-4e97-b565-72d6b315860b

Retorno da requisição:

{
  "withdrawId": "29eef544-2764-4e7d-8bfe-6a3fcd12bf85",
  "statusId": "bccaee91-2d14-40e4-bd0b-0976ec694d6a",
  "status": "PAGO",
  "value": 2.1,
  "endToEndId": "E31872495202402282310w42Nv7613X6",
  "description": "Pagamento realizado com sucesso.",// Caso seja cancelado ou estornado, neste campo contem o motivo.
  "keyPix": "12345678901",
  "customer": {
    "fullName": "Fulano de Tal",
    "document": "12345678901"
  },
  "identifier":"R1L5xfWfRc"
}