Webhook de teste

Envia uma notificacao de teste para o Webhook URL. O metodo permite verificar a disponibilidade do seu endpoint, o processamento dos dados recebidos e o recebimento de notificacoes sem criar um pagamento real.

URL

Autorizacao obrigatoria

POST

https://api.fps.pro/invoices/webhook/test

Formato da requisicaoapplication/json

id

uuid

Identificador de um pagamento inexistente

Padrao: generated

webhook_link

required

url

URL para onde o status do pagamento sera enviado

status

string

Status do pagamento

Padrao: paid

Formato da respostadata object

status

number

Status HTTP do envio do webhook ao seu endpoint

response_body

json

Corpo da resposta recebido apos enviar dados ao seu endpoint

Exemplos de requisição

curl --request POST 'https://api.fps.pro/invoices/webhook/test' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: YOUR_CLIENT_ID' \
  --header 'X-Timestamp: 1720000000' \
  --header 'X-Signature: YOUR_HMAC_SHA256_SIGNATURE' \
  --data '{
  "id": "0a718b02-131d-495a-9641-39ca52139c07",
  "webhook_link": "https://merchant.example.com/webhooks/fps",
  "status": "paid"
}'

Resposta bem-sucedida

{
  "status": 200,
  "message": "success",
  "data": {
    "status": 200,
    "response_body": "Webhook receive"
  }
}

Erros

A lista detalhada de erros de autorizacao esta em Autorizacao - Erros

{
  "status": 403,
  "message": "Forbidden"
}
{
  "status": 422,
  "message": "Validation Error",
  "data": {
    "field": "name",
    "message": "field validation error"
  }
}
{
  "status": 500,
  "message": "Internal Server Error"
}