Everything a payer needs to send money to this wallet. The same
instructions are embedded in every wallet response.
status says which way in the wallet has:
status | Payers send to | paymentReference |
|---|---|---|
SHARED | PayKeeper's escrow account, whose details are in wire and ach | Required, in the wire's originator-to-beneficiary information (the memo) or the ACH addenda. It is how PayKeeper knows which wallet the credit is for; without it the credit waits while PayKeeper works it out with you. |
DEDICATED | The wallet's own virtual account number | Optional. Anything credited to the number posts to this wallet on its own, with or without the reference. |
Which one a wallet has is set when it is opened, by its preset for
your organization (fundingAccount in GET /wallet-presets). A
DEDICATED wallet's paymentReference still works on the shared
route too.
What to hand a payer. wire and ach carry the complete details
for each rail, ready to copy into a payer's payment form. For a
DEDICATED wallet their accountNumber is the wallet's own, and
virtualAccount says which number it is and when it was assigned.
A wallet's number is its own for good. PayKeeper never gives a
wallet's account number to any other wallet, even after the wallet
closes, so a payer using old instructions can only ever reach the
wallet they were written for. Still identify wallets by id, not by
account number.
fundingLink is null in this version. If PayKeeper cannot read the
escrow account's bank details for a moment, wire and ach are
null (a DEDICATED wallet's virtualAccount is still there); try
again shortly. In the sandbox the account details come from our
banking provider's test environment and can show a real bank's name
and routing number, so never send real money to them; make a credit
arrive with POST /sandbox/deposits.
| Status | code | When |
|---|---|---|
| 404 | wallet_not_found | No wallet of yours has this id or ext: reference. |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||