GET
/
api
/
partner
/
v1
/
wallets
/
{userId}
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v1/wallets/{userId} \
  --header 'partner-api-key: <partner-api-key>' \
  --header 'x-supported-country: <x-supported-country>'
{
  "status": "ok",
  "data": {
    "walletAddress": "<string>"
  }
}
Get User Wallet for Off Ramp

​
Headers

x-supported-country - Country code of the flow (MX or DO) PartnerApiKey (string) - API key associated with the partner.
Partner API Key RequiredRequires partner-api-key for authentication to ensure only authorized partners can access this data.See 🔑 API Key Generation Guide for getting your API key

​
Parameters

  • chainId (string) - Refers to the blockchain id used for the off-ramp transaction. See Blockchain to Token docs for more information on how to retrieve the chainId.
  • userId (string) - Id of the user who corresponds the wallet and transaction to be created

​
Response Body

  • walletAddress(string) - Wallet address the user must send the amount of token wanted to be off ramped

​
Example

{
  "walletAddress": "0x4d2f3d8f83b6f2f8e0f3f4f3f3f3f3f3f3f3f3f3"
}

​
Use Cases

  • Get User’s Wallet: Be able to show the wallet address the user must transfer the crypto to so the Off Ramp can be completed successfully

Headers

​
x-supported-country
string
required

Country code of the flow (MX or DO)

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Path Parameters

​
userId
string
required

The userId from the user

Query Parameters

​
chainId
enum<number>
required

The chain id for the blockchain for the wallet address.

Available options:
137,
56,
10,
42161,
8453,
5000,
1116,
900,
480,
1,
23448594291968336
Example:

10

​
transactionFlow
enum<string>
required
Available options:
OTC,
PAYMENT,
REGULAR

Response

200 - application/json

Retrieves the wallet address belonging to the partner user for off ramp.

​
status
string
Example:

"ok"

​
data
object