Step 1: set up budget webhooks

Before we start creating payments, we’re going to subscribe to the three budget-related webhook event types. The first event type to subscribe to is BoxDebited. This event is triggered when a budget is debited in production, whether that’s due to an internal transfer of funds or an external payment. In sandbox, you’ll receive it when you make budget-to-budget transfers and when generating test credits.

Production

curl -i -X POST 'https://api.equalsmoney.com/v2/webhooks' \
-H 'Authorization: ApiKey {apiKey}' \ # Your API key
-H 'Content-Type: application/json' \
-d '{
  "webhookEventTypeName": "BoxDebited",
  "accountId": "{accountId}",
  "url": "{webhookUrl}",
  "enabled": true
}'

The second event type to subscribe to is BoxCredited. This event is triggered when a budget is credited in production, whether that’s due to an internal transfer of funds or an external inbound payment. In sandbox, you’ll receive it when you make budget-to-budget transfers and when generating test credits.

Production

curl -i -X POST 'https://api.equalsmoney.com/v2/webhooks' \
-H 'Authorization: ApiKey {apiKey}' \ # Your API key
-H 'Content-Type: application/json' \
-d '{
  "webhookEventTypeName": "BoxCredited",
  "accountId": "{accountId}",
  "url": "{webhookUrl}",
  "enabled": true
}'

The third type to subscribe to is FeeCreated. This event is triggered when certain fees are raised, such as a fee for receiving an inbound credit. Not every fee sends it: the standard fee on an outbound payment is reported only as a BoxDebited whose orderId ends in -Fee. To see which fees send FeeCreated, see the FeeCreated event. Every fee, whether or not it sends FeeCreated, also appears in the account’s transaction activity with a type of fee.

Production

curl -i -X POST 'https://api.equalsmoney.com/v2/webhooks' \
-H 'Authorization: ApiKey {apiKey}' \ # Your API key
-H 'Content-Type: application/json' \
-d '{
  "webhookEventTypeName": "FeeCreated",
  "accountId": "{accountId}",
  "url": "{webhookUrl}",
  "enabled": true
}'

For more information about webhooks and webhook event type structures, see the webhooks guide.

Get started

Accounts & onboarding

Budgets

Payments

Cards

Transactions

Reports

People

Webhooks

Roqqett

Set up budget webhooks

Step 1: set up budget webhooks

​Step 1: set up budget webhooks

Step 1: set up budget webhooks