Payment request payouts
A payout is a separate outbound transfer that sends funds from a completed payment to a beneficiary. A payment's completed event confirms Hubpay wallet credit; it does not confirm that an automatic payout reached its beneficiary.
Payout flow
- Add the beneficiary and store its identifier
- Create the payment request with the required payout details
- Track the customer payment until Hubpay credits the wallet
- Hubpay creates the payout after payment completion
- Track the payout through approval and processing
- Confirm the final payout state from a webhook or API lookup
Payout states
| State | Meaning |
|---|---|
pending_approval | A checker must approve the payout before processing |
initiated | Hubpay has started processing the payout |
paid | Funds have been paid to the beneficiary |
failed | The payout was rejected or failed during processing |
Maker-checker approval
If maker-checker is enabled for the account, a checker must approve the payout in the Hubpay corporate portal. Approval is not available through the API.
Accounts without maker-checker move directly to initiated after creation.
Track a payout
Subscribe to these webhook events:
v1.collection.payment_request.payment.payout.pending_approvalv1.collection.payment_request.payment.payout.initiatedv1.collection.payment_request.payment.payout.paidv1.collection.payment_request.payment.payout.failed
See Payout events for payload fields. You can also fetch the current payment and payout state with Get payment for payment request.
