Invites one person into your wallet program and creates their wallet.
Use it to enroll a holder before you credit or charge them. Your account must have the wallet program enabled.
Permission. Every Wallets and Wallet Disputes endpoint requires the Wallet Management permission; see
/docs/authentication#wallets-wallet-disputes-and-payment-requests. Without it, the call returns
403 FORBIDDEN_INSUFFICIENT_TAGS.
What one call does:
- Finds or creates the payee for
emailunder your account. The holder'sholderIdis that payee's user ID. - Finds or creates the buyer profile the holder pays card loads through.
- Creates an empty wallet in the chosen currency. One holder has at most one wallet per currency.
- Gives the holder access to the wallet in the payee app.
- Sends an invitation email, but only when the payee is new to your account.
No money moves. Choose the ledger account the wallet belongs to with currency, or with ledgerAccountId when you have
more than one ledger account in that currency.
The call is safe to repeat. Inviting someone who already has a wallet in that currency returns 200 with the existing
wallet, and created.payee and created.wallet false.
Errors
400 VALIDATION_ERROR: a field is invalid. Detail codes:REQUIREDonemail, or oncurrencywhen neithercurrency
norledgerAccountIdis sent;INVALID_EMAIL;INVALID_LEDGER_ACCOUNT(the account is not one of your active ledger
accounts in that currency) orMORE_THAN_ONE_LEDGER_ACCOUNT(name one withledgerAccountId) onledgerAccountId,
both with the usable accounts inconstraints.validAccounts; or a field that is not part of the request403 WALLET_NOT_ENABLED: the wallet program is not enabled on your account409 WALLET_LEDGER_ACCOUNT_MISMATCH: the holder already has a wallet in this currency under another of your ledger accounts
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
