Skip to main content
Disbursements are batch payouts that send funds to multiple recipients in a single operation. They’re ideal for payroll, vendor payments, customer refunds at scale, and any scenario requiring bulk fund distribution.

Overview

A disbursement:
  • Sends funds to multiple recipients in one batch
  • Uses CSV upload to define recipients and amounts
  • Includes validation to catch errors before execution
  • Requires approval before funds are sent

Creating a Disbursement

Step 1: Navigate to Disbursements

Click Disbursements in the sidebar, then click Create Disbursement.

Step 2: Enter Disbursement Details

FieldRequiredDescription
NameYesDescriptive name (e.g., “January Payroll”)
DescriptionNoAdditional details
CurrencyYesHTG or USD

Step 3: Upload CSV

Upload a CSV file with recipient information:
bousol_uid,asset_amount
CUST001,500.00
CUST002,750.00
GABC...XYZ,1000.00

CSV Columns

ColumnRequiredDescription
bousol_uidYesClient external ID or Stellar wallet address
asset_amountYesAmount to send

Identifying Recipients

The bousol_uid column accepts:
FormatExampleResolution
External IDCUST001Looks up client by external ID, uses their wallet
Wallet AddressGABC...XYZUses the address directly

Step 4: Review Validation

After upload, the system validates each row:
StatusDescriptionAction Needed
ValidReady to payNone
InvalidError foundFix and re-upload
Common validation errors:
ErrorCauseSolution
Client not foundExternal ID doesn’t existAdd client or use wallet address
Invalid walletWallet address format incorrectVerify the address
Invalid amountAmount not a valid numberCheck CSV formatting
Missing walletClient has no wallet addressAdd wallet to client record

Step 5: Submit for Approval

Once all rows are valid (or you’ve acknowledged invalid rows will be skipped):
  1. Review the summary:
    • Total recipients
    • Total amount
    • Valid vs. invalid rows
  2. Click Submit for Approval

Disbursement Status

StatusDescription
ProcessingCSV is being validated
Pending SubmitValidation complete, ready to submit
Pending ApprovalSubmitted, awaiting approval
ExecutingApproved, payments being sent
CompletedAll payments sent
FailedExecution failed
RejectedApproval denied

Status Flow

Created → Processing → Pending Submit → Pending Approval → Executing → Completed
                ↓                              ↓                ↓
              Failed                        Rejected         Failed

Approval Workflow

Disbursements typically require approval due to their batch nature:
  1. Creator uploads CSV and submits
  2. Approver reviews recipient list and total amount
  3. Approver approves or rejects with comments
  4. System executes approved disbursements

Reviewing as Approver

When reviewing a disbursement:
  1. Check the total amount matches expectations
  2. Review the recipient list for accuracy
  3. Verify the funding source has sufficient balance
  4. Approve or reject with a comment

Managing Disbursements

Viewing Disbursements

The list shows all disbursements with status filters:
FilterDescription
AllAll disbursements
PendingAwaiting action
CompletedSuccessfully executed
FailedExecution failed

Disbursement Actions

ActionWhen AvailableDescription
View DetailsAny statusSee full disbursement info
View ItemsAny statusSee individual recipients
Re-upload CSVPending SubmitUpload corrected CSV
SubmitPending SubmitSubmit for approval
ApprovePending ApprovalApprove execution
RejectPending ApprovalDeny execution
RetryFailedRetry failed payments
CancelBefore executionCancel the disbursement

Viewing Disbursement Items

Click on a disbursement, then View Items to see each recipient:
ColumnDescription
Row #CSV row number
RecipientClient name or wallet address
AmountPayment amount
StatusValid, Invalid, Sent, Failed
ErrorValidation or execution error message

Filtering Items

  • All — All recipients
  • Valid — Ready for payment
  • Invalid — Has validation errors
  • Sent — Successfully paid
  • Failed — Payment failed

Validation Summary

The validation summary shows:
MetricDescription
Total RowsNumber of recipients in CSV
ValidRows ready for payment
InvalidRows with errors
Total AmountSum of valid payments

Execution

When a disbursement executes:
  1. System processes each valid recipient
  2. Payments are sent in batches for efficiency
  3. Each payment is recorded with transaction hash
  4. Failed payments can be retried

Partial Success

If some payments fail:
  • Successful payments are recorded as Sent
  • Failed payments are marked for retry
  • You can retry failed items without re-creating the disbursement

Best Practices

CSV Preparation

  • Validate data before upload — Check for duplicates, invalid amounts
  • Use consistent identifiers — Stick to external IDs or wallet addresses
  • Keep backups — Save your CSV files for records

Amounts

  • Double-check totals — Ensure the sum matches your expected disbursement
  • Account for fees — Ensure sufficient balance including any fees
  • Test first — For new processes, do a small test disbursement

Approval

  • Clear descriptions — Name disbursements clearly (e.g., “January 2026 Payroll”)
  • Document purpose — Use the description field
  • Separate duties — Different people create and approve

Monitoring

  • Track execution — Watch the status during execution
  • Review failures — Investigate and retry failed payments promptly
  • Keep records — Export completed disbursements for accounting

Example Use Cases

Payroll

bousol_uid,asset_amount
EMP001,25000.00
EMP002,30000.00
EMP003,28000.00

Customer Refunds

bousol_uid,asset_amount
CUST-A123,150.00
CUST-B456,75.50
CUST-C789,200.00

Vendor Payments

bousol_uid,asset_amount
GABCDEF...123,5000.00
GXYZ123...456,3500.00

API Integration

For programmatic disbursement management, see Disbursements API.

Next Steps

  • Payouts — Single recipient payments
  • Clients — Manage recipient database
  • Reports — Track disbursement history