Sign in

v1

latestOpenAPI 3.0.02026-07-263118119.8 KB
Webhooks

webhook

Create a webhook.

Specify a topic and a url. Use this call to either create or update a webhook for a topic.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP009401Unauthorized
AP101401No authenticated user
AP1000200Invalid API
AP1102400Topic required to create webhook
AP1103400URL is invalid or missing
AP1104400Unrecognized topic
AP1105200Error creating webhook
AP1107400Merchant is required
</details>
post/v2/webhook

Headers

Content-Typestring required
authorizationstring required

A merchant scoped token.

Request body

topic'transaction_completed' | 'transaction_refunded' | 'transaction_voided' | 'preauthorized_transaction_created' | 'transaction_declined' | 'transaction_resolved' | 'user_active' | 'user_suspended' | 'merchant_reputation_updated' required

Webhook topic to subscribe to

urlstring required

Callback URL where webhook payloads will be sent.

Response

Success - Webhook Subscribed

OR

Example response

{
  "webhooks": {
    "payloadVersion": "2.0"
  }
}