Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Wallet

Retrieve all available wallets for a user

This GET endpoint is used to retrieve all available wallets for a provided user token. <br> You can use this endpoint to obtain information about the wallets associated with the provided user token. <br> To use this endpoint, you need to provide the user_token as a required parameter in the URL Path. <br> The response will include a JSON array containing details for each wallet including user_token, balance, currency_code.

get/wallet/{user_token}

Path parameters

user_tokenstring required

Token representing the user who owns the wallet

Query parameters

client_onlyboolean

When set to true, the response will include only the wallet balances funded by the client making the API call. Use this to restrict results to balances that were loaded or managed by your client credentials. Default is false, which returns all balances associated with the user, regardless of funding source.

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Successful operation.

user_tokenstring required

Token representing the user

tokenstring uuid required

Token representing the wallet

balancenumber required

The wallet's current balance in USD

currency_codestring required

The currency wallet balance is stored in. Using ISO 4217 format. In most cases this value will be USD

type'MASSPAY_CARD' | 'USER_FUNDS' required

Type of wallet

card_type'MASTERCARD' | 'VISA' | 'AMEX' | 'DISCOVER' | 'UNIONPAY'

In case type of wallet is MASSPAY_CARD, card_type would be provided with the type of card it is

last_4string

In case type of wallet is MASSPAY_CARD, last_4 would be provided with the last four digits of the card

activeboolean required

An indicator whether the wallet is active. If inactive, can still retrieve historical transactions history

client_paying_feesboolean

An indicator whether the fees for payouts using this wallet are paid by the client. If false, the user pays the fees

Example response

[
  {
    "user_token": "usr_ba4275f2-bae1-488d-9d6f-20af1cd83574",
    "token": "123e4567-e89b-12d3-a456-426614174000",
    "balance": 100.5,
    "currency_code": "USD",
    "type": "USER_FUNDS",
    "card_type": "VISA",
    "last_4": "1234"
  }
]