API Guide

Create and manage offloader wallets for automated stablecoin-to-fiat conversion.

New to Offloader Wallets?

See the Off-Ramp Overview for how the product works before diving into the API.

Requirements

To successfully set up and use an Offloader Wallet, each customer must:

Be registered via the Create Customer API
Have accepted the Terms of Service (TOS)
Have signed the Customer's Agreement (for business customers only)
Have completed KYC/KYB verification
Have an active customer status of approved

Offloader Wallet APIs

Create Offloader Wallet

POST https://api.spherepay.co/v2/offloader-wallet

For full request/response details, see the Create Offloader Wallet API Reference.

Request Example

{
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "currency": "usdc",
  "network": "ethereum",
  "destination": {
    "bankAccountId": "bankAccount_6221e8d4299f4a889bd882255e92f581",
    "currency": "usd",
    "network": "ach",
    "achReference": "REF123"
  }
}

Response Example

{
  "id": "wallet_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "customerId": "customer_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "address": "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
  "currency": "usdc",
  "network": "ethereum",
  "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"
}

Retrieve Offloader Wallet

GET https://api.spherepay.co/v2/offloader-wallet/{offloader_wallet_id}

For full request/response details, see the Get an Offloader Wallet API Reference.

Update Offloader Wallet

PATCH https://api.spherepay.co/v2/offloader-wallet/{offloader_wallet_id}

For full request/response details, see the Update Offloader Wallet API Reference.

List Offloader Wallets

GET https://api.spherepay.co/v2/offloader-wallet

For full request/response details, see the List Offloader Wallets API Reference.

Tracking Transfers

Transfer history for Offloader Wallets is available through the standard Transfer API — not a wallet-specific endpoint.

Get a Transfer — retrieve a single transfer by ID
List Transfers — list all transfers, filterable by offloader wallet

Additional Notes

Webhook notifications are not currently supported for Offloader Wallets.

Fees and Limits

For information on applicable fees and transaction limits, contact your SpherePay sales representative.

On this page