Envio de webhook das transações

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

Este é o Webhook de notificação de transações que aconteceram. Com os formatos que será enviado para os parceiros.

É importante que os parceiros respondam com HTTP código 200.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. necessario apenas cadastrar na nossa API o webhook de cada tipo que irá receber as notificações

Requisição de exemplo

Webhook de transacoes

post

Webhook de PIXs

Authorizations

Body

idstringOptional

ID da requisição da transação.

txIdstringOptional

ID de conciliação do recebedor.

endToEndstringOptional

ID único para a transação entre os sistemas.

dtHrTransactionstring · date-timeOptional

Data e hora da efetivação da transação.

initializationTypestring · enumOptional

Tipo de inicialização da transação.

Possible values:

paymentPrioritystring · enumOptional

Prioridade de pagamento.

Possible values:

tpPaymentPrioritystring · enumOptional

Tipo de prioridade de pagamento.

Possible values:

purposestring · enumOptional

Finalidade do pagamento.

Possible values:

amountnumberOptional

Valor da transação.

detailsstringOptional

Detalhes da transação.

descriptionstringOptional

Descrição adicional da transação.

messagestringOptional

Mensagem associada à transação.

keystringOptional

Chave PIX associada à transação.

statusstring · enumOptional

Status da transação.

Possible values:

notifystring · enumOptional

Tipo de notificação do webhook.

Possible values:

endToEndOriginstringOptional

ID de origem da transação.

Responses

200

successful

401

authorization failed

422

validation failed

500

unknown server error

post

HTTPcURLJavaScriptPython

POST /internal/api/v1/webhooks/pixs HTTP/1.1
Host: sandbox.globalscm.app.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 993

{
  "id": "ee90b15f-f9cb-4163-bc11-1003c94dbfd6",
  "txId": "ee90b15f-f9cb-4163-bc11-1003c94dBDd6",
  "endToEnd": "E18236120202412231857s06fxxxxe23F",
  "dtHrTransaction": "2024-12-23T15:30:00.000Z",
  "initializationType": "DICT",
  "payer": {
    "ispb": "12345678",
    "personType": "FISICA",
    "cpfCnpj": "12345678901",
    "name": "JOÃO DA SILVA",
    "agency": "1234",
    "accountType": "CONTA_CORRENTE",
    "accountNumber": "1234567890"
  },
  "receiver": {
    "ispb": "87654321",
    "personType": "JURIDICA",
    "cpfCnpj": "98765432000199",
    "name": "EMPRESA X LTDA",
    "agency": "4321",
    "accountType": "CONTA_POUPANCA",
    "accountNumber": "0987654321",
    "key": "98765432000199"
  },
  "paymentPriority": "LIQUIDACAO_PRIORITARIA",
  "tpPaymentPriority": "PAGAMENTO_PRIORITARIO",
  "purpose": "COMPRA_TRANSFERENCIA",
  "amount": 100.5,
  "details": "Pagamento por transferência de serviços.",
  "description": "Transação de pagamento de serviços.",
  "message": "Pagamento realizado com sucesso.",
  "key": "98765432000199",
  "status": "SUCCESS",
  "notify": "pix_in",
  "endToEndOrigin": "D18236120202412231857s06fxxxxe23F"
}

No content

JSON Retorno Sucesso