Fonbnk Docs
  • Intro
  • Integration Guide
  • On-ramp
    • How it works
    • URL Parameters
    • Webhook
  • Off-ramp
    • How it works
    • URL Parameters
    • Webhook
  • Reference
    • Servers
    • Signing requests
    • Endpoints
      • On-ramp
        • Assets
        • Order
        • Orders
        • Price
        • Providers
        • Limits
      • Off-ramp
        • Order
        • Orders
        • Best offer
        • Limits
        • Countries
        • Wallets
        • Validate fields
        • Create order
        • Confirm order
      • Util
        • Check address
        • Assets
      • Kyc
        • State
        • Submit
    • Specification
Powered by GitBook
On this page
  1. Reference
  2. Endpoints
  3. On-ramp

Providers

PreviousPriceNextLimits

Get providers

get

Returns a list of providers. Optionally includes limitations data.

Authorizations
Query parameters
includeLimitsbooleanOptional

Should limitations data be included in the response. Defaults to true. If limitations are not included the request will be much faster.

Default: true
Responses
200
Successful response
application/json
get
GET /api/pay-widget-merchant/providers HTTP/1.1
Host: sandbox-api.fonbnk.com
x-client-id: YOUR_API_KEY
Accept: */*
200

Successful response

[
  {
    "countryIsoCode": "NG",
    "currencyIsoCode": "NGN",
    "providers": [
      {
        "name": "bank_transfer",
        "description": "Bank transfer",
        "requiresCarrier": false,
        "carriers": [],
        "limits": {
          "POLYGON": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1714,
              "max": 348047,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0,
              "minFee": 0.01
            }
          },
          "STELLAR": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1730,
              "max": 348064,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0.01,
              "minFee": 0.01
            }
          },
          "AVALANCHE": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1797,
              "max": 348132,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0.05,
              "minFee": 0.01
            }
          },
          "SOLANA": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1714,
              "max": 348047,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0,
              "minFee": 0.01
            }
          },
          "BASE": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1714,
              "max": 348047,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0,
              "minFee": 0.01
            }
          },
          "TON": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1747,
              "max": 348081,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0.02,
              "minFee": 0.01
            }
          },
          "CELO": {
            "cryptoLimits": {
              "min": 1,
              "max": 200
            },
            "localCurrencyLimits": {
              "type": "open_range",
              "min": 1714,
              "max": 348047,
              "step": 1,
              "withCents": false
            },
            "fees": {
              "feePercent": 2.5,
              "fonbnkFeePercent": 2.5,
              "partnerFeePercent": 0,
              "gasAmount": 0,
              "minFee": 0.01
            }
          }
        }
      }
    ]
  },
  {
    "countryIsoCode": "KE",
    "currencyIsoCode": "KES",
    "providers": [
      {
        "name": "carrier",
        "description": "Airtime",
        "requiresCarrier": true,
        "carriers": [
          {
            "id": "618e43914f57e07d255ff353",
            "name": "Safaricom Kenya",
            "limits": {
              "POLYGON": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.47
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 157,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "STELLAR": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.46
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 158,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0.01,
                  "minFee": 0.01
                }
              },
              "AVALANCHE": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.42
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 164,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0.05,
                  "minFee": 0.01
                }
              },
              "SOLANA": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.47
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 157,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "CELO": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.47
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 157,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "BASE": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.47
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 157,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "TON": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 1.45
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 160,
                  "max": 230,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0.02,
                  "minFee": 0.01
                }
              }
            }
          }
        ]
      },
      {
        "name": "mpesa",
        "description": "M-PESA",
        "requiresCarrier": true,
        "carriers": [
          {
            "id": "618e43914f57e07d255ff353",
            "name": "Safaricom Kenya",
            "limits": {
              "POLYGON": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 153,
                  "max": 30506,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "AVALANCHE": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 161,
                  "max": 30513,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0.05,
                  "minFee": 0.01
                }
              },
              "STELLAR": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 155,
                  "max": 30508,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0.01,
                  "minFee": 0.01
                }
              },
              "SOLANA": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 153,
                  "max": 30506,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "CELO": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 153,
                  "max": 30506,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "BASE": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 153,
                  "max": 30506,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0,
                  "minFee": 0.01
                }
              },
              "TON": {
                "cryptoLimits": {
                  "min": 1,
                  "max": 200
                },
                "localCurrencyLimits": {
                  "type": "open_range",
                  "min": 156,
                  "max": 30509,
                  "step": 1,
                  "withCents": false
                },
                "fees": {
                  "feePercent": 2.5,
                  "fonbnkFeePercent": 2.5,
                  "partnerFeePercent": 0,
                  "gasAmount": 0.02,
                  "minFee": 0.01
                }
              }
            }
          }
        ]
      }
    ]
  }
]