Payment Methods

Get or create crypto wallet payment method

Retrieves an existing crypto wallet or creates a new one for the specified crypto asset. Important: This endpoint is only active in production and does not work in sandbox. Supports idempotency to prevent duplicate wallet creation: a call made while another crypto-wallet call from your business is still being processed returns 400 BAD_REQUEST_ERROR, so retry it once the first has finished. Currently supports USDT and USDC assets (USD is accepted as an alias for USDC). Send a GET request with the required asset parameter (and optional customerId). The system will either return existing wallet addresses or automatically create and return new ones if none exist for that asset/customer (or business if no customerId is provided).

get/api/v1/payment-method/crypto-wallet

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-method/crypto-wallet/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

asset'USDT' | 'USDC' | 'USD' required

The crypto asset symbol for the wallet. USD is accepted as an alias for USDC.

customerIdstring

Optional customer ID. If not provided, the wallet will be created for the business.

Response

Crypto wallet addresses retrieved or created successfully.

Example response

{
  "data": {
    "id": "695271a3ba52c13b669fad2b",
    "addresses": [
      {
        "address": "0x1234567890abcdef1234567890abcdef12345678",
        "network": "ETHEREUM_MAINNET"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.