Skip to main content

​
Changed

​
Customer Guides Rewrite

The following guides under guides/customers/ have been completely rewritten to improve clarity and align with current API behavior:
PageSummary of Changes
Create businessExpanded KYB (Know Your Business) workflow documentation, added field-by-field explanations for required business registration data, and included sample request/response payloads that match the live API.
Create individualOverhauled KYC (Know Your Customer) instructions with step-by-step guidance, clearer document-upload requirements, and updated example payloads reflecting actual field names and validation rules.
Verify identityClarified the verification lifecycle (from inactive → in_review → active or rejected), documented each possible status transition, and explained how to interpret verification outcomes programmatically.

​
New Customer Verification Webhook Events

Added comprehensive webhook coverage in guides/webhooks/webhook-events. The following four events are now documented with full sample payloads, trigger conditions, and recommended handling patterns:
EventTriggerKey Payload Fields
customer.verification.in_reviewCustomer submits verification documents and review begins.status: "in_review", level: "0", updated_at
customer.verification.activeReview succeeds; customer is fully verified.status: "active", level: "1", updated_at
customer.verification.rejectedReview fails due to invalid or incomplete documents.status: "rejected", rejection_reason, level: "0", updated_at
customer.verification.inactiveVerification reverted (compliance issue, suspension, etc.).status: "inactive", level: "0", updated_at
Each event follows the standard webhook envelope (business_id, event, data) and can be used to automate customer onboarding workflows, surface rejection reasons to end-users, or trigger compliance alerts.

​
New Transfer Webhook Event: transfer.funds_refunded

Added the transfer.funds_refunded event in guides/webhooks/webhook-events. This event fires when funds are returned to the sender’s balance after a transfer fails (for example, an invalid payout destination or network delivery issue).
EventTriggerKey Payload Fields
transfer.funds_refundedFunds are refunded to the balance following a failed transfer.status: "funds_refunded", fees (array with refund-related fees), pay_out (original destination details), updated_at
Use this event to automatically reconcile balances, notify users that their funds have been returned, or trigger retry logic.

​
Transfers Overview Update

  • File: overview/transfers
  • Added funds_refunded to the list of possible transfer statuses so integrators know this terminal state exists.

​
Sandbox Setup Guide

  • File: guides/getting-started/setup-sandbox
  • Updated the sandbox account registration link to point to the current developer console URL.
  • Refreshed the onboarding steps so new integrators land on the correct dashboard and can generate API keys without confusion.

​
Delegated Transactions Guide

  • File: guides/customers/transactions-on-behalf
  • Adjusted usage scenarios and parameter descriptions to stay accurate for delegated (on-behalf-of) transaction flows.
  • Ensured code samples reflect the latest required headers and request body shape.

​
Removed

​
Obsolete Recipient Code Snippets

  • File: guides/recipients/create-and-manage
  • Deleted legacy code examples that no longer match the current API surface.
  • Removed the deprecated X-BU-VERSION header from sample requests so developers copying the guide use headers the API actually accepts.