Balances and Payouts
Reference pages: Withdrawals, Platform Fees, List Sellers, Withdraw Balance, List Past Withdrawals, List Future Withdrawals, Reporting Across Your Sellers.
Reading a balance
There's no balance endpoint. get-sellers returns seller_wallets, by currency, in minor units.
| Field | Meaning |
|---|---|
wallet_total |
Everything PayMe holds for the seller |
wallet_releasable |
The part past its release date |
| The difference | Recent sales still before their release date |
Show the seller all three. "Why can I only withdraw part of it?" is the first question they ask.
In the sandbox, seller_wallets stayed at 0 after several completed sales. Why is unconfirmed, so ask PayMe. Until then, test the display with a fake answer and report the real figures as not proven.
Withdrawing
| Refusal | Cause | What to do |
|---|---|---|
| Error 109 | The seller isn't validated | Show approval state and signup link, and disable the action with an explanation |
Error 907 |
The seller is on an automatic withdrawal plan, so manual withdrawals aren't allowed. Seen in the sandbox | Nothing to do. PayMe pays out on the plan's schedule |
PayMe checks the plan first, so an unapproved seller on an automatic plan gets 907, not 109. Don't rely on seeing 109: check seller_approved yourself. A new seller takes the partner's default plan, and every one created in the sandbox came back with seller_withdrawal_plan 2, which is automatic. No API field changes it, so PayMe must set up a test seller before a payout can succeed: ask them.
If a withdrawal's outcome is unknown, don't start another in that currency until a person has checked get-withdrawals (TRN-04).
The completion callback
withdrawal-complete has no signature, and it fires when the withdrawal is committed, before the bank transfer happens. So it doesn't prove the money arrived, and its body proves nothing at all (CB-04). Re-read with get-withdrawals, and tell sellers the money is on its way rather than received.
Your own fee
market_fee isn't part of a seller's wallet, and it isn't withdrawn with withdraw-balance. By default it's transferred to you monthly. See Platform Fees.