Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Transfers

Transfer Completed

Sent when a transfer is completed

Required permissions:

  • webhook_receive:transfers
postWebhooktransfer.completed

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

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

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

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

type'transfer.completed' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "amount": 25,
    "created_at": "2026-01-01T12:00:00.000Z",
    "created_by_user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Marcus Webb",
      "username": "marcuswebb"
    },
    "currency": "usd",
    "destination": {
      "id": "biz_xxxxxxxxxxxxxx",
      "route": "biz_xxxxxxxxxxxxxx",
      "title": "Shine Time Auto Detailing",
      "typename": "Company"
    },
    "destination_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
    "fee_amount": 0.5,
    "id": "ctt_xxxxxxxxxxxxxx",
    "metadata": {
      "order_id": "SHINE-1042"
    },
    "notes": "Refund for the rescheduled interior detail",
    "object": "transfer",
    "origin": {
      "id": "biz_xxxxxxxxxxxxxx",
      "route": "biz_xxxxxxxxxxxxxx",
      "title": "Shine Time Auto Detailing",
      "typename": "Company"
    },
    "origin_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
    "status": "succeeded"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "transfer.completed"
}

Response

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