MAmasspay
Wallet

Retrieve all available wallets for a user

Changed on

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}

Request

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' | 'CLIENT_FUNDS' | 'SUBLEDGER_FUNDS' required

Type of wallet. USER_FUNDS and MASSPAY_CARD are user wallets (user_token present); CLIENT_FUNDS and SUBLEDGER_FUNDS are the client's own wallets

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

fee_wallet_tokenstring

GET /wallets/{wallet_token} only: your own CLIENT_FUNDS wallet that pays this wallet's fees, when there is one

wiring_instructionsobject

Deposit (wire / ACH) instructions of the bank account that funds this wallet, present only when they are available: when the wallet's provider - or, for a USER_FUNDS wallet without a provider of its own, your CLIENT_FUNDS wallet in the same currency - is a deposit bank with a known account. The object is the bank's own record, passed through as the bank returns it, so its keys and vocabulary depend on the bank and its casing may differ from the rest of this response. <br><br> Cross River Bank (routing 021214891): accountNumber, routingNumber, accountType, title (the account title, normally your business name), currency (lowercase ISO 4217, for example usd) and status. Cross River's status values are Active, Inactive, Dormant, Escheat and Closed; an account in normal use is Active, contact support if you see anything else. Its accountType values are Deposit, GeneralLedger, CreditCard, StoredValue, Wallet and Unknown; a MassPay funding account is Deposit. <br><br> Other banks return wire details only: Fortress accountNumber, routingNumber, receiverName, receiverAddress, receiverBankName, receiverBankAddress, swiftCode; Braid AccountNumber, RoutingNumber; Zenus AccountNumber; Stride Bank and Metropolitan Commercial Bank account_number, routing_number, bank_name, address, city, state, zip; My EU Pay viban, swift, bank_name, address, city, country, zip. <br><br> Treat every value as display text for your payer. Do not branch on status or accountType beyond checking Cross River's Active.

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",
    "fee_wallet_token": "clnt_wlt_0f4b7d3e-1234-4c8a-9c1e-0a1b2c3d4e5f",
    "wiring_instructions": {
      "accountNumber": "2010001234",
      "routingNumber": "021214891",
      "accountType": "Deposit",
      "title": "Acme Corp",
      "currency": "usd",
      "status": "Active"
    }
  }
]

Changes

  • f9fa41b7c45cRevision changes
    • warning

      added the new CLIENT_FUNDS enum value to the / response property for the response status

    • warning

      added the new SUBLEDGER_FUNDS enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status