Retrieve Wallet

Endpoint

GET /wallets/{id}

Description

Use this endpoint to fetch the current state of a wallet. The response includes balance information, associated customer and account IDs, payment methods, wallet status, and lifecycle events.

Path Parameters

Parameter	Type	Required	Description
`id`	string (UUID)	Yes	Unique identifier of the wallet

Response

Success Response (200 OK)

{
  "data": {
    "account_id": "f55ca88c-71aa-4dab-a10a-4d818c11e8e6",
    "balance": {
      "amount": 0,
      "currency": "USD"
    },
    "customer_id": "a08bf5a3-8459-4e65-a5bb-34a1feef94cf",
    "events": [
      {
        "action": "create",
        "id": "6a2a5833-609d-4dff-a4e6-0eaf452d7826",
        "inserted_at": "2025-07-24T08:08:07Z",
        "reason": null,
        "wallet_id": "55a76a42-ed3a-4d0b-b74c-2887d64612f6"
      }
    ],
    "id": "3d2e3f3e-3b3c-4907-a4fd-e241203440d7",
    "payment_methods": [
      {
        "account_name": "Prosacco Erdman",
        "account_number": "3515200757",
        "account_type": "savings",
        "address": null,
        "bank_address": "9896 Bulah Roads, Suite 256, North Carolina, Kansas, 09819, US",
        "bank_code": "035",
        "bank_name": "Wema Bank"
      }
    ],
    "status": "active"
  }
}

Response Fields

Wallet Information

Field	Type	Description
`id`	string	Wallet ID
`status`	string	Current wallet status
`customer_id`	string	Customer associated with the wallet
`account_id`	string	Internal account identifier

Balance

Field	Type	Description
`balance.amount`	number	Current wallet balance
`balance.currency`	string	Wallet currency

Payment Methods

Field	Type	Description
`payment_methods`	array	List of payment methods linked to the wallet
`account_name`	string	Name on the bank account
`account_number`	string	Bank account number
`account_type`	string	Type of bank account (e.g., savings, current)
`bank_name`	string	Name of the bank
`bank_code`	string	Bank routing or institution code
`bank_address`	string	Bank branch address

Sensitive fields may be partially masked depending on environment and permissions.

Events

Field	Type	Description
`events`	array	Historical actions performed on the wallet
`action`	string	Event type (e.g., `create`, `freeze`, `delete`)
`inserted_at`	string (ISO 8601)	Timestamp of the event
`reason`	string	Reason for the action, if provided

Example cURL Request

curl -X GET https://api.yourdomain.com/wallets/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Common Errors

Status Code	Description
`401`	Unauthorized
`404`	Wallet not found
`403`	Access denied

Use Cases

Display wallet details in a dashboard
Check wallet balance and status before transactions
Review linked payment methods
Audit wallet activity and lifecycle events

Notes & Best Practices

Always confirm wallet status before initiating funding or payouts.
Cache wallet responses carefully to avoid stale balance data.
Use wallet events for audit logs and compliance reviews.

Home

Customers

Payments

Payment Transactions

Transfers

Exchange

Wallet As A Service

Endpoint

Description

Path Parameters

Response

Success Response (200 OK)

Response Fields

Wallet Information

Balance

Payment Methods

Events

Example cURL Request

Common Errors

Use Cases

Notes & Best Practices

​Endpoint

​Description

​Path Parameters

​Response

​Success Response (200 OK)

​Response Fields

​Wallet Information

​Balance

​Payment Methods

​Events

​Example cURL Request

​Common Errors

​Use Cases

​Notes & Best Practices

Endpoint

Description

Path Parameters

Response

Success Response (200 OK)

Response Fields

Wallet Information

Balance

Payment Methods

Events

Example cURL Request

Common Errors

Use Cases

Notes & Best Practices