Create a wallet for a user

This POST endpoint creates a new wallet for the user with the specified user_token, in the requested currency.
To use this endpoint, you need to provide the user_token as a required parameter in the URL Path and the currency_code as a JSON parameter in the Request Body. The currency_code must be an ISO 4217 currency code, such as USD, EUR or MXN. The user must belong to the authenticated client.
Optionally, fee_wallet_token nominates one of your client wallets, in the same currency, as the wallet that pays the fees of payouts funded from the new wallet, so the payee receives the full amount.
A user can hold at most one wallet per currency, so the operation is idempotent: if the user already has a wallet in the requested currency, that existing wallet is returned unchanged with a 200 status code instead of 201, and its balance reflects the current balance. If the existing wallet has a different fee-paying configuration than the requested fee_wallet_token, the request is rejected with a 409 status code and nothing is changed.
Newly created wallets start with a zero balance and can be funded through loads, pay-ins or wallet transfers. The response has the same shape as the wallets returned by the GET operation on this resource.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Token representing the user who owns the wallet

Body Params

User wallet creation request parameters

Request body for creating a wallet for a user. The wallet may nominate one of your client wallets to pay the fees of payouts funded from it.

string
required
length between 3 and 3

Currency the wallet is denominated in, using the ISO 4217 format. Case-insensitive.

string

Optional. Token of one of your client wallets (clnt_wlt_ prefix) that will pay the fees of payouts funded from the new user wallet, so the payee receives the full amount. The client wallet must be owned by the authenticated client and denominated in the same currency_code as the new wallet. When omitted, the payee pays the fees from the wallet balance.

Headers
string

Unique key to prevent duplicate processing

Responses

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