latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

4b45df3039ef

Accounts API4

Balance Transfers API3

Balances API5

Capabilities API1

Captures API3

Chargebacks API3

Clients API2

Customers API7

Delayed Routing API3

Invoices API2

Mandates API4

Methods API7

OAuth API2

Onboarding API2

Orders API11

Organizations API3

Payment Links API6

Payments API6

Payouts API4

Permissions API2

Profiles API6

Refunds API5

Sales Invoices API5

Sessions API2

Settlements API8

Shipments API4

Subscriptions API7

Terminals API6

Transfers API2

Unmatched Credit Transfers API4

Verify Payee API1

Wallets API1

Webhook Events API1

Webhooks API6

Webhooks API

Test a webhook

Sends a test event to the webhook to verify the endpoint is working as expected.

🔑 Access with

Advanced access token with webhooks.write

OAuth access with webhooks.write

post/v2/webhooks/{webhookId}/ping

testmodeboolean

You can enable test mode by setting testmode to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Accepted.