Invite Wallet Holder

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 email under your account. The holder's holderId is 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: REQUIRED on email, or on currency when neither currency
    nor ledgerAccountId is sent; INVALID_EMAIL; INVALID_LEDGER_ACCOUNT (the account is not one of your active ledger
    accounts in that currency) or MORE_THAN_ONE_LEDGER_ACCOUNT (name one with ledgerAccountId) on ledgerAccountId,
    both with the usable accounts in constraints.validAccounts; or a field that is not part of the request
  • 403 WALLET_NOT_ENABLED: the wallet program is not enabled on your account
  • 409 WALLET_LEDGER_ACCOUNT_MISMATCH: the holder already has a wallet in this currency under another of your ledger accounts
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

One person to invite into your wallet program. Send currency, ledgerAccountId, or both.

string

Your own reference for the holder, 1–128 characters. Set on the payee created for them, so you can find them by it later. Optional.

string
required

The holder's email. Identifies the person: an existing payee with this email is reused.

string

ISO 4217 currency code of the wallet, in upper case, for example USD. Selects your ledger account in that currency. Required unless you send ledgerAccountId.

string

ID of your ledger account the wallet belongs to. Required when you have more than one active ledger account in currency; the error lists them.

string
enum

Tax jurisdiction of the payee created for the holder.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json