Skip to main content

Funds flow

Payscribe integrations should model money movement as a reconciled lifecycle, not a single HTTP response.

Engineering flowBuild, verify, then reconcile
Test this flow in sandbox
  1. 01InitiateCreate one requested payment or money movement with a stable ref.
  2. 02ProcessPayscribe and its provider process the operation asynchronously.
  3. 03ConfirmVerify the signed event or status for the original reference.
  4. 04ReconcileUpdate wallet, ledger, and business state exactly once.

Use a dashboard-issued sandbox API key on your server. Do not enter credentials into this documentation site.

Engineering flow

Request or inbound payment → provider processing → signed event → transaction/wallet reconciliation → business-state update

FlowStartFinal confirmation
CollectionCustomer pays a virtual account, invoice, or linkVerified payment event and wallet/transaction record
PayoutYour server creates a transfer with refVerification endpoint and signed event
Card actionCreate, fund, withdraw, or control a cardConfirmed provider/card state and event
FXCreate quote then execute before expiryConversion record and destination wallet state

Build the reconciliation loop

  1. Generate and persist a unique ref before making a write request.
  2. Keep the returned identifier and the original request state; a successful HTTP response is not always the final money state.
  3. Verify signed webhook events, deduplicate their event IDs, and update your business record exactly once.
  4. When an outcome is uncertain, query the relevant transaction or account history endpoint before retrying.

For a fresh Sandbox business, /my-account/balances can return 404 until wallets are provisioned. Treat that as a setup state, never as a wallet with a zero balance. See Wallet Funding and My Account for the exact response shapes.

Was this page helpful?

Report a docs issue →