Skip to main content
Every money movement maps to a Platform API object: money in is a Deposit (api_) credited to a virtual account when funds settle; money out is a Payment (apo_) from a virtual account to a Beneficiary’s bank-account Payment Destination; internal moves are same-account, same-currency Transfers (atx_) between virtual accounts.
Funding rail
↳ Prerequisite: the account is already approved and any required agreements have been accepted — see the onboarding flow. Funds movement begins once onboarding has completed.
POSTwriteGETreadwebhookevent you receiveBank railexternal railapi_resource created— Platform— Hop— End customer
Platformyou
1Provision a virtual account (one per currency)POST/accounts/{id}/virtual-accountsvirtual_account.createdva_›
2Wait for activation, then surface deposit instructionsvirtual_account.updatedGET/virtual-accounts/{id}›
5Read the updated balance on the virtual accountGET/virtual-accounts/{id}›
6Move funds between this account’s virtual accounts (optional)POST/accounts/{account_id}/transfersatx_›
7Create the recipient as a beneficiaryPOST/accounts/{account_id}/beneficiariesbene_›
8Add a bank-account payment destinationPOST…/payment-destinationsdest_›
9Send the payment — hold funds, review, process, settlePOST/accounts/{account_id}/paymentspayment.created → payment.completedapo_›
HopAPI · funds processing
4Hop creates a deposit and credits the virtual accountdeposit.receivedGET…/deposits/{deposit_id}api_›
End customer& counterparties
3Payer sends funds over a supported bank railACH · Fedwire · SWIFT · SEPA · SPEI · PIX · Faster Payments›
10Customer sees the receipt and updated balancepayment.completed · payment.returnedGET/virtual-accounts/{id}

Tip: select any card to open the related API reference. Scroll down to follow the flow ↓

Money in: Deposit (api_) credited to a virtual account. Money out: Payment (apo_) from a virtual account to a Beneficiary’s bank-account Payment Destination. Internal moves: same-account, same-currency Transfer (atx_) between virtual accounts.