Skip to main content
POST
/
api
/
v1
/
webhooks
/
{gateway}
Receive gateway webhook
curl --request POST \
  --url http://localhost:7701/api/v1/webhooks/{gateway} \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "order.paid",
  "data": {
    "id": "or_abc123",
    "status": "paid"
  }
}
'
{
  "received": true
}

Path Parameters

​
gateway
enum<string>
required

Gateway slug (pagarme, stripe, picpay, safe2pay)

Available options:
pagarme,
stripe,
picpay,
safe2pay
Example:

"pagarme"

Body

application/json

Raw gateway event payload (structure varies per gateway)

The body is of type object.

Response

200 - application/json

Acknowledged

​
received
boolean
Example:

true