Webhooks

Enviar webhook de teste

Envia para a URL configurada do status informado em data.status um POST igual ao de um evento real, assinado quando há secret. Use-o para validar seu endpoint antes de operar. Nenhuma transação é criada. Se não houver URL configurada para o status, nada é enviado.

POSThttps://api.monkeypay.app/api/v2/webhook/resource/test-sendBearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    PUTConfigurar eventos

    /webhook/resource/events

    URL cadastrada para o estado testado

Esta chamada

POSTEnviar evento de teste

/webhook/resource/test-send

Respostas possíveis

Depois do sucesso

  1. Você

    Valide a assinatura e responda 2xx

    Quando houver secret

  2. Chamada

    GETHistórico de entregas

    /webhook/resource/send-events

    Confira o registro da entrega

Autorização

BearerRequer autenticação Bearer

Parâmetros

x-customer-idstringcabeçalhoopcional

Opcional. A versão atual da API não lê nem grava este header: a organização é sempre deduzida do token bearer. Enviá-lo não altera o resultado da chamada.

<x-customer-id>

Body

organizationIdstringobrigatório
org_01J9Z8K3M4N5P6Q7R8S9T0V1W2
dataobjectobrigatório
<data>
statusstringobrigatório
Tamanho1 ≤ tamanho
<status>
typestringobrigatório

valores: pix_inpix_out

<type>
payloadobjectobrigatório
<payload>
transactionIdstring (uuid)obrigatório
<transactionId>
externalIdstringopcional
<externalId>
statusstringobrigatório
Tamanho1 ≤ tamanho
<status>

Respostas

1{
2 "error": null,
3 "success": true,
4 "message": "Webhook test sent successfully"
5}

Campos da resposta

errorobjectopcional

`null` no sucesso; mensagem de falha quando `success` é `false`.

<error>
successbooleanopcional
<success>
messagestringopcional
<message>
Credenciais

Requisição

1curl --request POST \
2 --url 'https://api.monkeypay.app/api/v2/webhook/resource/test-send' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>' \
5 --data '{
6 "organizationId": "org_01J9Z8K3M4N5P6Q7R8S9T0V1W2",
7 "data": {
8 "type": "pix_in",
9 "status": "completed",
10 "payload": {
11 "transactionId": "00000000-0000-4000-8000-000000000000",
12 "externalId": "teste-webhook",
13 "status": "completed"
14 }
15 }
16 }'

Resposta

1{
2 "error": null,
3 "success": true,
4 "message": "Webhook test sent successfully"
5}