Create order

Creates an order for a provided user details.

POSThttps://sandbox-api.fonbnk.com/api/offramp/create-order

Authorization

Body

offerId*string

ID of the offer returned from get best offer endpoint

requiredFields*object

Object with user required fields

paymentType*OfframpPaymentType (enum)

CRYPTO_WALLET: User will pay with a crypto wallet
VIRTUAL_WALLET: Order will be paid from a merchant's virtual wallet

CRYPTO_WALLETVIRTUAL_WALLET

network*OfframpNetwork (enum)

AVALANCHEPOLYGONCELOETHEREUM

asset*OfframpAsset (enum)

USDCUSDTCUSDCKES

address*string

Address of the wallet from which funds will be sent

currency*OfframpAmountCurrency (enum)

localusd

amount*number

Amount of usd user wants to pay or amount of local currency user wants to receive depending on the currency param value

ipstring

IP address of a user

orderParamsstring

OrderParams that need to be associated with an order

Response

Order created successfully

Body

_idstring

offerIdstring

paymentTypeOfframpPaymentType (enum)

CRYPTO_WALLET: User will pay with a crypto wallet
VIRTUAL_WALLET: Order will be paid from a merchant's virtual wallet

CRYPTO_WALLETVIRTUAL_WALLET

networkOfframpNetwork (enum)

AVALANCHEPOLYGONCELOETHEREUM

assetOfframpAsset (enum)

USDCUSDTCUSDCKES

exchangeRatenumber

cashoutobject

fromAddressstring

toAddressstring

statusOfframpOrderStatus (enum)

initiated: The offramp order has been initiated
awaiting_transaction_confirmation: User sent the transaction hash and system is awaiting confirmation
transaction_confirmed: User transaction has been confirmed
transaction_failed: User transaction has failed
offramp_success: The offramp transaction has been successful
offramp_pending: The offramp transaction is pending
offramp_failed: The offramp transaction has failed
offramp_retry: The offramp transaction is being retried
refunding: The offramp transaction is being refunded
refunded: The offramp transaction has been refunded
refund_failed: The offramp transaction refund has failed
expired: The offramp order has expired
cancelled: The offramp order has been cancelled by the user

initiatedawaiting_transaction_confirmationtransaction_confirmedtransaction_failedofframp_successofframp_pendingofframp_failedofframp_retryrefundingrefundedrefund_failedexpiredcancelled

createdAtstring (date-time)

expiresAtstring (date-time)

hashstring

statusHistoryarray of object

requiredFieldsobject

Fields that was required to be filled by the user

countryIsoCodestring

currencyIsoCodestring

offerRequiredFieldsarray of object

orderParamsstring

Request

const response = await fetch('https://sandbox-api.fonbnk.com/api/offramp/create-order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "offerId": "65b8c4b8b188250081f30165",
      "network": "CELO",
      "asset": "CUSD",
      "amount": 1.02,
      "address": "0x5b7ae3c3c87F4A3F94b35c77233b13191eBFAD20",
      "requiredFields": {
        "bankCode": "011:02",
        "buyerBankAccountNumber": "3134586782"
      },
      "currency": "usd",
      "ip": "192.168.1.1",
      "orderParams": "someParams"
    }),
});
const data = await response.json();

Response

{
  "_id": "text",
  "offerId": "text",
  "paymentType": "CRYPTO_WALLET",
  "network": "AVALANCHE",
  "asset": "USDC",
  "exchangeRate": 0,
  "cashout": {
    "localCurrencyAmount": 0,
    "usdAmount": 0,
    "feeAmountUsd": 0,
    "feeAmountUsdFonbnk": 0,
    "feeAmountUsdPartner": 0,
    "feeAmountLocalCurrency": 0,
    "feeAmountLocalCurrencyFonbnk": 0,
    "feeAmountLocalCurrencyPartner": 0,
    "cryptoAmount": 0,
    "feeAmountCrypto": 0,
    "feeAmountCryptoFonbnk": 0,
    "feeAmountCryptoPartner": 0
  },
  "fromAddress": "text",
  "toAddress": "text",
  "status": "initiated",
  "createdAt": "2024-12-21T12:29:38.276Z",
  "expiresAt": "2024-12-21T12:29:38.276Z",
  "hash": "text",
  "statusHistory": [
    {
      "status": "initiated",
      "changedAt": "2024-12-21T12:29:38.276Z"
    }
  ],
  "countryIsoCode": "text",
  "currencyIsoCode": "text",
  "offerRequiredFields": [
    {
      "label": "text",
      "type": "text",
      "value": "text"
    }
  ],
  "orderParams": "text"
}

PreviousValidate fields NextConfirm order

const response = await fetch('https://sandbox-api.fonbnk.com/api/offramp/create-order', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "offerId": "65b8c4b8b188250081f30165", "network": "CELO", "asset": "CUSD", "amount": 1.02, "address": "0x5b7ae3c3c87F4A3F94b35c77233b13191eBFAD20", "requiredFields": { "bankCode": "011:02", "buyerBankAccountNumber": "3134586782" }, "currency": "usd", "ip": "192.168.1.1", "orderParams": "someParams" }), }); const data = await response.json();

{ "_id": "text", "offerId": "text", "paymentType": "CRYPTO_WALLET", "network": "AVALANCHE", "asset": "USDC", "exchangeRate": 0, "cashout": { "localCurrencyAmount": 0, "usdAmount": 0, "feeAmountUsd": 0, "feeAmountUsdFonbnk": 0, "feeAmountUsdPartner": 0, "feeAmountLocalCurrency": 0, "feeAmountLocalCurrencyFonbnk": 0, "feeAmountLocalCurrencyPartner": 0, "cryptoAmount": 0, "feeAmountCrypto": 0, "feeAmountCryptoFonbnk": 0, "feeAmountCryptoPartner": 0 }, "fromAddress": "text", "toAddress": "text", "status": "initiated", "createdAt": "2024-12-21T12:29:38.276Z", "expiresAt": "2024-12-21T12:29:38.276Z", "hash": "text", "statusHistory": [ { "status": "initiated", "changedAt": "2024-12-21T12:29:38.276Z" } ], "countryIsoCode": "text", "currencyIsoCode": "text", "offerRequiredFields": [ { "label": "text", "type": "text", "value": "text" } ], "orderParams": "text" }