Set Partner Webhook URL

{
  "webhook_url": "https://yourapp.com/api/webhooks/fund-balance"
}

{
  "webhook_url": ""
}

{
  "message": "success",
  "data": {
    "webhook_url": "https://yourapp.com/api/webhooks/fund-balance"
  }
}

{
  "error": "invalid request",
  "error_code": "BAD_REQUEST",
  "message": "webhook_url must be a valid HTTPS URL"
}

POST

partners

webhook-url

{
  "webhook_url": "https://yourapp.com/api/webhooks/fund-balance"
}

{
  "webhook_url": ""
}

{
  "message": "success",
  "data": {
    "webhook_url": "https://yourapp.com/api/webhooks/fund-balance"
  }
}

{
  "error": "invalid request",
  "error_code": "BAD_REQUEST",
  "message": "webhook_url must be a valid HTTPS URL"
}

Set or clear the partner-level webhook URL that receives pay.partner.fund-balance-changed events. Whenever the partner’s prefund balance changes due to a deposit, withdrawal, or compensation, Holdstation Pay sends a POST request to this URL. Pass an empty string "" as webhook_url to disable notifications.

This endpoint configures the destination for the Balance Change Webhook only. Order events (pay.order.status-updated) are delivered to the per-order callback field set when the order is created — see Orders Webhook.

Authentication

Partner-App-Key

string

required

Your partner app key.

X-HSPay-Signature

string

required

Base64-encoded Ed25519 signature of the sign data.

X-HSPay-Timestamp

string

required

Unix timestamp (seconds) of the request. Must be within 60 seconds of server time.

Body Parameters

webhook_url

string

required

HTTPS URL to receive fund balance change events. Pass an empty string "" to clear the webhook.

{
  "webhook_url": "https://yourapp.com/api/webhooks/fund-balance"
}

{
  "webhook_url": ""
}

{
  "message": "success",
  "data": {
    "webhook_url": "https://yourapp.com/api/webhooks/fund-balance"
  }
}

{
  "error": "invalid request",
  "error_code": "BAD_REQUEST",
  "message": "webhook_url must be a valid HTTPS URL"
}

Event Delivery

See Balance Change Webhook for the headers, payload schema, change_type values, and signature verification.

Create Crypto Payout Create Customer KYC

Overview

Banks

Tokens

Exchange

Orders

Configurations

Prefunding

Merchant Virtual Account

Partners

Partner Customer KYC

Authentication

Body Parameters

Event Delivery

​Authentication

​Body Parameters

​Event Delivery

Authentication

Body Parameters

Event Delivery