Invite Wallet Holder

post

https://api-sandbox.paymentlabs.io/wallets/invites

Invites a holder into the payor's wallet program.

One call creates the payee and an empty wallet for them. No money is moved.
Inviting a holder who is already provisioned returns their existing wallet with 200.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for POST /wallets/invites — bring a holder into the customer's wallet program.

One call provisions the payee, the buyer and the wallet, the way creating a payment for a payee
already provisions the payee. There is no separate "create wallet": a holder and their wallet
come into existence together.

email is the identity anchor. service-payee and service-buyer both resolve their user from
it through service-auth, so both land on the same user — and that user, scoped to this
customer, is the wallet's holder.

referenceId

string

required

The customer's own durable handle for this person, carried onto both the payee and the buyer.
How the customer addresses the holder in its own system.

string

required

The holder's email. Resolves the platform user that the payee and the buyer share.

currency

string

The wallet's currency, as an uppercase ISO 4217 code.

Names the FBO indirectly: the customer's accounts are filtered to this currency and, when
exactly one remains, it is used without the caller naming it. Optional only when
{@link ledgerAccountId} is supplied — one of the two must be present.

ledgerAccountId

string

The customer FBO ledger account the wallet hangs under.

Required only when currency alone is ambiguous — a customer owns one FBO per partner,
country and currency, and internal accounts multiply as treasury needs them, so several
candidates in one currency is normal rather than exceptional. When several match, the request
is rejected with the candidates listed and the customer picks.

taxJurisdiction

string

enum

Tax jurisdiction for the payee record this provisions.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The holder was already provisioned, nothing was created

201The holder and their wallet have been created

401Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.

403 Forbidden response, when the user is authenticated but does not have the necessary permissions.