Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidocs.hopnow.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Event Structure

All webhook events follow this structure: 
{
  "id": "evt_1234567890abcdef",
  "type": "payout.completed",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    // Event-specific data
  }
}

​
Account Events

​
account.created

Triggered when a new account is created. 
{
  "id": "evt_abc100",
  "type": "account.created",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "id": "acc_1234567890abcdef",
    "customer_id": "cus_1234567890abcdef",
    "name": "Primary Account",
    "status": "active",
    "created": "2024-01-15T10:00:00Z"
  }
}

​
account.updated

Triggered when account details are updated. 
{
  "id": "evt_abc101",
  "type": "account.updated",
  "created": "2024-01-15T11:00:00Z",
  "data": {
    "id": "acc_1234567890abcdef",
    "customer_id": "cus_1234567890abcdef",
    "name": "Updated Account Name",
    "status": "active",
    "created": "2024-01-15T10:00:00Z"
  }
}

​
account.deleted

Triggered when an account is deactivated. 
{
  "id": "evt_abc102",
  "type": "account.deleted",
  "created": "2024-01-16T09:00:00Z",
  "data": {
    "id": "acc_1234567890abcdef",
    "customer_id": "cus_1234567890abcdef",
    "status": "inactive",
    "deleted_at": "2024-01-16T09:00:00Z"
  }
}

​
Payout Events

​
payout.created

Triggered when a payout is initiated. 
{
  "id": "evt_pout100",
  "type": "payout.created",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "id": "pout_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "beneficiary_id": "ben_1234567890abcdef",
    "amount": "100.00",
    "currency": "USD",
    "status": "pending",
    "created": "2024-01-15T10:00:00Z"
  }
}

​
payout.processing

Triggered when a payout begins processing. 
{
  "id": "evt_pout101",
  "type": "payout.processing",
  "created": "2024-01-15T10:01:00Z",
  "data": {
    "id": "pout_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "100.00",
    "currency": "USD",
    "status": "processing"
  }
}

​
payout.completed

Triggered when a payout is successfully delivered. 
{
  "id": "evt_pout102",
  "type": "payout.completed",
  "created": "2024-01-17T09:30:00Z",
  "data": {
    "id": "pout_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "100.00",
    "currency": "USD",
    "status": "completed",
    "completed_at": "2024-01-17T09:30:00Z"
  }
}

​
payout.failed

Triggered when a payout fails. 
{
  "id": "evt_pout103",
  "type": "payout.failed",
  "created": "2024-01-17T10:00:00Z",
  "data": {
    "id": "pout_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "100.00",
    "currency": "USD",
    "status": "failed",
    "failed_at": "2024-01-17T10:00:00Z",
    "error": {
      "code": "insufficient_funds",
      "message": "Insufficient balance"
    }
  }
}

​
Payin Events

​
payin.created

Triggered when an incoming payment is initiated. 
{
  "id": "evt_pin100",
  "type": "payin.created",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "id": "pin_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "1000.00",
    "currency": "USD",
    "status": "pending",
    "created": "2024-01-15T10:00:00Z"
  }
}

​
payin.processing

Triggered when a payin begins processing. 
{
  "id": "evt_pin101",
  "type": "payin.processing",
  "created": "2024-01-15T10:01:00Z",
  "data": {
    "id": "pin_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "1000.00",
    "currency": "USD",
    "status": "processing"
  }
}

​
payin.completed

Triggered when funds are credited to the account. 
{
  "id": "evt_pin102",
  "type": "payin.completed",
  "created": "2024-01-15T10:05:00Z",
  "data": {
    "id": "pin_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "1000.00",
    "currency": "USD",
    "status": "completed",
    "completed_at": "2024-01-15T10:05:00Z"
  }
}

​
payin.failed

Triggered when a payin fails. 
{
  "id": "evt_pin103",
  "type": "payin.failed",
  "created": "2024-01-15T10:05:00Z",
  "data": {
    "id": "pin_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "amount": "1000.00",
    "currency": "USD",
    "status": "failed",
    "failed_at": "2024-01-15T10:05:00Z",
    "error": {
      "code": "payment_rejected",
      "message": "Payment was rejected by the bank"
    }
  }
}

​
Beneficiary Events

​
beneficiary.created

Triggered when a beneficiary is added. 
{
  "id": "evt_ben100",
  "type": "beneficiary.created",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "id": "ben_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "name": "Jane Smith",
    "type": "individual",
    "status": "active",
    "created": "2024-01-15T10:00:00Z"
  }
}

​
beneficiary.updated

Triggered when beneficiary details are updated. 
{
  "id": "evt_ben101",
  "type": "beneficiary.updated",
  "created": "2024-01-15T11:00:00Z",
  "data": {
    "id": "ben_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "name": "Jane Smith-Jones",
    "type": "individual",
    "status": "active"
  }
}

​
beneficiary.deleted

Triggered when a beneficiary is removed. 
{
  "id": "evt_ben102",
  "type": "beneficiary.deleted",
  "created": "2024-01-16T09:00:00Z",
  "data": {
    "id": "ben_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "status": "inactive",
    "deleted_at": "2024-01-16T09:00:00Z"
  }
}

​
beneficiary.disabled

Triggered when a beneficiary is disabled. 
{
  "id": "evt_ben103",
  "type": "beneficiary.disabled",
  "created": "2024-01-16T09:00:00Z",
  "data": {
    "id": "ben_1234567890abcdef",
    "account_id": "acc_1234567890abcdef",
    "status": "disabled"
  }
}