Queries

The Cashramp API provides read-only queries to fetch essential data like payment rails, exchange rates, and transaction status.

Geography & Payment Rails

Available Countries

query {
  availableCountries {
    id
    name # "Nigeria"
    code # "NG"
  }
}

Returns every country that Cashramp currently supports.

---

P2P Payment-Method Types

query {
  p2pPaymentMethodTypes(
    country: "VHlwZXM6OkNvdW50cnktN2FhZjdlYjEtODIwYi00YzA4LWIyM2ItODFlN2FjMTQyYmI0"
  ) {
    id
    identifier # "mtn_momo_gh"
    label # "MTN Mobile Money"
    fields {
      label # "Phone Number"
      identifier # "phone_number"
      required # true
    }
  }
}

Render the fields array as input controls when you save a customer’s payout rail.

---

Rates & Limits

Indicative Market Rate

query {
  marketRate(countryCode: "NG") {
    depositRate # Local-currency → USD
    withdrawalRate # USD → Local-currency
  }
}

These figures are indicative only. The final FX rate is locked when an agent picks up the payment request.

---

Ramp Limits

query {
  rampLimits {
    minimumDepositUsd
    minimumWithdrawalUsd
    maximumDepositUsd
    maximumWithdrawalUsd
    dailyLimitUsd
  }
}

---

Assets

Rampable Assets

query {
  rampableAssets {
    name # "USD Coin"
    symbol # "USDC"
    networks # ["CELO", "OP", "BASE"]
    contractAddress # "0x..."
  }
}

List of stablecoins and networks currently supported for on-chain ramps.

---

Transaction Status

Payment Request by Reference

query {
  merchantPaymentRequest(reference: "test_ref_1") {
    id
    paymentType # deposit | withdrawal
    hostedLink
    amount
    currency
    reference
    metadata
    status # created | picked_up | completed | canceled
  }
}

Poll or verify a webhook by cross-checking the status.

---

Onchain Withdrawal

query {
  onchainWithdrawal(
    id: "VHlwZXM6Ok9uY2hhaW5UeC0zOWNjMTgwZi1hOGM0LTRmNzYtYmVkZC01YjU3M2M2NjEwNTg="
  ) {
    quantity
    symbol # "USDC"
    network # "OP"
    address
    txhash
    txhashUrl
    fee
    status # pending | completed | failed
    createdAt
  }
}

---

Account Snapshot

query {
  account {
    id
    accountBalance # USD-denominated
    depositAddress # Your Cashramp onchain deposit address
  }
}