Wallet lookup

Resolves a user's wallet and returns the wallet's identifier, the associated user reference, and the wallet currency.

Endpoint

GET /api/v1/user/wallet/lookup

Headers

Header	Description	Required
`x-merchant-ref`	Unique reference identifying the merchant	Yes

Query Parameters

Parameter	Description	Required
`user_ref`	Unique reference identifying the user whose wallet is being looked up	Yes
`wallet_id`	Unique identifier of the wallet to resolve	Yes

Request

curl --location -g '{{base_url}}/api/v1/user/wallet/lookup?user_ref={{vault%3AMerchant-user-ref}}&wallet_id={{vault%3Angn-wallet}}' \
--header 'x-merchant-ref: {{vault\:x-merchant-ref}}'

Response

{
  "status": "success",
  "message": "Wallet resolved",
  "data": {
    "wallet_id": "LBWNGN81C4801EE29D43F8A0B2231E367B74550063J",
    "user_ref": "UREF52EAF03D45714E47A65BF451969A22FB00CHN",
    "currency": "NGN"
  }
}

Response Fields

Field	Description
`status`	Indicates whether the request was successful.
`message`	Describes the result of the wallet lookup.
`data.wallet_id`	Unique identifier of the wallet.
`data.user_ref`	Unique reference of the user associated with the wallet.
`data.currency`	Currency of the wallet.

Use Cases

The Wallet Lookup endpoint can be used to:

Resolve a wallet using the user's reference and wallet ID.
Confirm that a wallet belongs to a specific user.
Retrieve the currency associated with a wallet.
Validate wallet details before performing wallet-related operations.