Payouts

Atlas for Platform — Payouts

This guide covers making payouts from a sub-account to an external beneficiary.


Key differences from Global Clearing

Global ClearingAtlas for Platform
AuthenticationParent account JWTSub-account JWT
Sender objectRequired for POBO flowsNot required — all flows originate at sub-account level
Fund sourceParent walletSub-account wallet only

Payout flow

Step 1 — Validate the beneficiary account (optional, NGN only)

Optionally validate the destination account using the Get Account Name endpoint before creating the beneficiary.


Step 2 — Create a beneficiary

Create a beneficiary using the Create Beneficiary endpoint. Only beneficiaries with a status of approved can receive payments.

See the Bank codes & market requirements guide for country-specific requirements.


Step 3 — Check wallet balance

Confirm the sub-account wallet has sufficient funds using the Get Wallet endpoint before initiating the payout.


Step 4 — Request a payout

Submit the payout using the Create Payment Request endpoint.

{
  "beneficiaryId": 278,
  "purposeId": 12,
  "amount": 100,
  "walletId": 1,
  "clientReference": "your-reference",
  "paymentId": "a7600e0e-a973-4d26-b15c-89de5836e900"
}
FieldDescriptionMandatory
beneficiaryIdID of the approved beneficiaryYes
purposeIdPurpose of payment codeYes
amountAmount to sendYes
walletIdSub-account wallet ID to debitYes
clientReferenceYour own reference for the paymentNo
paymentIdUnique UUID for idempotencyYes
📘

Sender object not required

All flows on Atlas for Platform originate at sub-account level. Sender identity is established through the sub-account's KYB data and director consent — no sender object is needed in the payout request.


Step 5 — Track payment status

We recommend subscribing to webhooks to receive real-time status updates rather than polling. See the Webhooks guide for setup instructions.

API response states

StateDescription
requestedPayment created and queued. Sub-account wallet debited.
completedFunds sent successfully. Note this does not confirm the beneficiary has received the funds.
archivedPayment cancelled or failed. Funds returned to sub-account wallet.
refundedPayment refunded. Funds returned to sub-account wallet.

Webhook states

StateDescription
requestedSub-account wallet debited and funds sent.
completedFunds sent to the beneficiary. Note this does not confirm the beneficiary has received the funds.
archivedPayment archived and funds returned to sub-account wallet.
📘

Compliance holds

On rare occasions payments may be held for compliance review. Verto will reach out with an RFI if this occurs. Check payment status at any time using the paymentId via the Get Payment endpoint.


Did this page help you?