Skip to main content
WEBHOOK
payout_method.created
{
  "api_version": "v1",
  "data": {
    "account_reference": "****1234",
    "company": {
      "id": "biz_xxxxxxxxxxxxxx"
    },
    "created_at": "2023-12-01T05:00:00.401Z",
    "currency": "USD",
    "destination": {
      "country_code": "<string>",
      "name": "<string>"
    },
    "id": "potk_xxxxxxxxxxxxx",
    "institution_name": "Chase Bank",
    "is_default": true,
    "nickname": "My Business Account"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "payout_method.created",
  "company_id": "biz_xxxxxxxxxxxxxx"
}

Headers

​
webhook-id
string
required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
webhook-signature
string
required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

​
webhook-timestamp
string
required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json
​
api_version
string
required

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
data
object
required

A configured payout destination where a user receives earned funds, such as a bank account or digital wallet.

​
id
string
required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
timestamp
string<date-time>
required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

​
type
string
required

The webhook event type

Allowed value: "payout_method.created"
Example:

"payout_method.created"

​
company_id
string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

Return a 200 status to indicate that the data was received successfully