XendBridge
  • Get Started
  • 🛠️API Method Calls
    • Third Party Order Operations
      • Rate
      • Buy Order
      • Sell Order
      • Swap Order
      • Pending Order
      • Pay For Order
      • Cancel Order
    • LP Simulation
      • Pay For Order (Buy Order)
      • Pay For Order (Sell Order)
    • Dispute
      • Raise Third Party Dispute
      • Get All Disputes
      • XendBridge Chat SDK
    • Payment Inquiry
    • WebHooks
      • Order Payment Confirmation
      • Order Matched Notification
      • Order Canceled Notification
      • Checksum Verification
  • 📄XENDBRIDGE PORTAL
    • Checkout URL
      • Buy Order
      • Sell Order
      • Swap Order
      • Rate
      • Rate Bounds
      • Initiate Order Created With Deferred Payment Method
      • Supported Currencies
      • Payment Methods
    • Inline Html Snippet
    • DeFi Checkout
  • 📦XENDBRIDGE SDKS
    • XendBridge NodeJs SDK
    • XendBridge .NET SDK
      • Rate
      • Buy Order
      • Sell Order
      • Swap Order
      • Pending Order
      • Pay For Order Confirmation
      • Cancel Order
      • Raise A Dispute
  • Errors
  • 🔖REFERENCE
    • API Reference
Powered by GitBook
On this page

Was this helpful?

  1. API Method Calls
  2. Third Party Order Operations

Rate

Get Order Rate

The Get Order Rate GETendpoint gets the lowest possible exchange rate for an order placed by a consumer from a provider. This requires your publickey in the environment variables while the query params passed will be the payInCurrencyCode , payInCurrencyNetwork ,recieveInCurrencyCode , recieveInCurrencyNetwork & orderAmount.

The returned result will have a rateValidityInSeconds, providerRateAmount& providerRateReference. To get a response for a sell or swap order, switch to desired networks and currency inputs on request and make the call. See the example below;

.../Rate?payInCurrencyCode=NGN&payInCurrencyNetwork=LOCAL&receiveInCurrencyCode=BUSD&receiveInCurrencyNetwork=BEP20&orderAmount=500

GET https://canary.xendbridge.com/api/PeerToPeerOrder...

Query Parameters

Name
Type
Description

payInCurrencyCode*

string

NGN

payInCurrencyNetwork*

string

LOCAL

recieveInCurrencyCode*

string

BUSD

recieveInCurrencyNetwork*

string

BEP-20

orderAmount*

decimal

500

Headers

Name
Type
Description

publicKey

string

{your_publicKey}

{
    "data": {
        "exchangeRate": 559.00,
        "maximumAmount": 10000.000000000,
        "minimumAmount": 5.000000000,
        "providerRateReference": "1382CB3D300346E6A183B720181E0D2B",
        "rateValidityInSeconds": 20
    },
    "status": "OK",
    "message": ""
}

Parameters
Type
Definitions

payInCurrencyCode

string

Required The currency to be paid in.

payInCurrencyNetwork

string

Required The network of the currency to be paid in.

receiveInCurrencyCode

string

Required The currency to be received in.

receiveInCurrencyNetwork

string

Required The network of the currency to be receieved in.

orderAmount

string

Required The amount of the order.

Parameters
Type
Definitions

exchangeRate

decimal

This is the exchange rate at which an order could be exchanged for

maximumAmount

decimal

This is the maximum amount a customer can order.

minimumAmount

decimal

This is the minimum amount a customer can order.

providerRateReference

string

This is the reference of the rates of a provider.

rateValidityInSeconds

int

This is the validity of an order rate of a provider in seconds.

PreviousThird Party Order OperationsNextBuy Order

Last updated 2 years ago

Was this helpful?

🛠️