Prerequisites
{{aggregator_id}}and{{secret_key}}- Validated beneficiary account details (IBAN or alias)
- Webhook endpoint for status updates
Flow overview
1
Validate beneficiary
Run
GET /title-fetch or GET /account-info before submitting the payout.2
Initiate payout
Call
POST /v1/aggregators/{{aggregator_id}}/payout with an idempotent request_id, the beneficiary details, and the amount.3
Await webhook
Safepay pushes status updates to your webhook endpoint. Polling is optional but recommended as a safety net.
4
Reconcile and notify
Update internal ledgers, emit beneficiary notifications, and archive the payload for audit.
Webhook events to expect
Use the webhooks delivery guide for the full event catalog and signature verification. Settlement-related events are emitted as batch processing progresses.Status reference
Operational best practices
- Webhook reliability: Implement exponential backoff retries if your webhook endpoint experiences downtime.
- Dual controls: Require two-person review for high-value payouts before calling the API.
- Ledger reconciliation: Store the
trace_referenceandrequest_idto match Safepay webhooks with internal ledger entries. - Incident response: Alert operators automatically when a payout remains in
P_RECEIVEDbeyond your SLA or entersP_FAILED.