Cashramp
  • Introduction
    • Getting Started
    • API Endpoints
    • Authentication
    • Webhooks
    • Integration Guide
    • SDKs
  • Hosted payments
    • Deposits
    • Withdrawals
    • Cancel Payment
  • Onchain Payments
    • On-Off Ramp
  • Cashramp API
    • Queries
    • Customers
    • Payment Methods
    • Withdraw Onchain
Powered by GitBook
On this page
  • Countries
  • Market Rate
  • Banks
  • Payment Method Types
  • Rampable Assets
  • Limits
  • Payment Request
  • Your Account
  1. Cashramp API

Queries

Countries

countries.gql
query {
    availableCountries {
        id
        name
        code
    }
}

Market Rate

This query allows you to fetch the market rate for any Cashramp country.

marketRate.gql
query {
    marketRate(countryCode: "NG") {
        depositRate
        withdrawalRate
    }
}

This market rate should not be considered as the final rate. The final rate is provided when a user is assigned to an agent and proceeds to initiate a payment.

Banks

countries.gql
query {
    banks(countryCode: "NG") {
        id
        name
        code
    }
}

Payment Method Types

p2pPaymentMethodTypes.gql
query {
    p2pPaymentMethodTypes(country: "VHlwZXM6OkNvdW50cnktN2FhZjdlYjEtODIwYi00YzA4LWIyM2ItODFlN2FjMTQyYmI0") {
        id
        identifier
        label
        fields {
            label
            identifier
            required
        }
    }
}

Rampable Assets

rampableAssets.gql
query {
    rampableAssets {
        name
        symbol
        networks
        contractAddress
    }
}

Limits

rampLimits.gql
query {
    rampLimits {
        minimumDepositUsd
        minimumWithdrawalUsd
        maximumDepositUsd
        maximumWithdrawalUsd
        dailyLimitUsd
    }
}

Payment Request

getPaymentRequest.gql
query {
    merchantPaymentRequest(reference: "test_ref_1") {
        id
        paymentType
        hostedLink
        amount
        currency
        reference
        metadata
        status
    }
}

Your Account

account.gql
query {
    account {
        id
        accountBalance
        depositAddress
    }
}
PreviousOn-Off RampNextCustomers

Last updated 6 months ago