/v2/webhook

post https://example.com/v2/webhook

Query Params

external_account_id

string

required

Your business/store ID that maps to the merchant.

Body Params

webhook_id

number

Our unique identifier for the webhook

callback_url

uri

required

secret_key

string

required

length ≥ 1

types

array of strings

required

length ≥ 1

Webhooks

account.updated - Account has been created or updated
dispute.created - Dispute created
dispute.updated - Dispute updated
dispute.lost - Dispute has been lost - dispute can no longer be defended
dispute.won - Dispute has been won - payment will be changed to success
payment.updated - A payment has been created or updated
pay_by_link.completed - A pay-by-link payment has been completed by the customer

types*

request_id

number

Unique identifier for the request which can be used to lookup the request in our logs

Responses

Language

Credentials

Bearer

JWT


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://example.com/v2/webhook \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "types": [
8
    "account.updated"
9
  ]
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Webhook

400invalid input, object invalid

401Unauthorized