Sign in

v1

latestOpenAPI 3.0.02026-07-224537337.5 KB

Update an offloader wallet

Update an offloader wallet by id

patch/v2/offloader-wallet/{id}

Path parameters

idstring required

Request body

integratorBpsFeeRatestring

Integrator fee override in basis points (0-1000). Send "0" to remove the integrator fee.

returnAddressstring

Crypto address where funds are returned on failed transactions. Must be valid for the wallet network.

Example request

{
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "achReference": "REF456"
  },
  "integratorBpsFeeRate": "75",
  "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"
}

Response

idstring required

Unique identifier for the offloader wallet.

customerIdstring required

The customer who owns the offloader wallet.

addressstring required

The on-chain deposit address for the offloader wallet. Send crypto to this address to trigger automatic conversion.

currency'usdc' | 'usdt' | 'eurc' required

The crypto currency the offloader wallet accepts for deposits. See Supported Rails & Currencies.

network'sol' | 'ethereum' | 'arbitrum' | 'polygon' | 'base' | 'avalanche' | 'tron' required

The blockchain network the offloader wallet is on. See Supported Rails & Currencies.

status'active' | 'deactivated' required

Lifecycle status of the offloader wallet. active accepts deposits and settles; deactivated no longer settles.

returnAddressstring

Crypto address where funds are returned on failed transactions. Must be valid for the wallet network. Null if not configured.

createdstring required

Timestamp when the offloader wallet was created (ISO 8601).

updatedstring required

Timestamp when the offloader wallet was last updated (ISO 8601).

Example response

{
  "id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
  "currency": "usdc",
  "network": "ethereum",
  "status": "active",
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "currency": "usd",
    "network": "ach",
    "achReference": "REF123"
  },
  "fees": {
    "integratorFee": {
      "bpsRate": "100",
      "currency": "usdc"
    },
    "platformFee": {
      "bpsRate": "30",
      "currency": "usdc"
    }
  },
  "returnAddress": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
  "created": "2024-06-15T10:30:00.000Z",
  "updated": "2024-06-15T12:00:00.000Z"
}