Integration guide

Reconcile payouts

Run a periodic job so your records match every transfer, even when webhooks are missed.

Payout webhooks notify; GET /v1/payouts/{payoutId} is the source of truth. A misconfigured or disabled endpoint drops events without telling you, so run a periodic job over the payouts your records show as not final:

  1. List payouts that aren't final. Call GET /v1/payouts?status=requires_action&status=processing, following nextCursor until it is null.

    curl "https://api.merchant.pay.walletconnect.com/v1/payouts?status=requires_action&status=processing" \
      -H "Api-Key: YOUR_PAYOUT_API_KEY"
  2. Update your records. For each payout your records show as not final, call GET /v1/payouts/{payoutId} and apply the result if its payoutStateVersion is higher than yours.

  3. Fund what is waiting. Compare each balance's shortfall in GET /v1/payout-accounts with what you have already sent. See Balances.

List filters

GET /v1/payouts accepts these query parameters:

ParameterMeaning
statusRepeat for several: ?status=processing&status=succeeded.
referenceIdPayouts with this reference.
startTs, endTsCreated at or after startTs, and before endTs (RFC 3339).
limit50 by default, 200 at most.
cursornextCursor from the previous page.

Results are newest first, in data.

On this page