API Reference

Offramp

Process description

С2F order - is a crypto to fiat api tool, your clients can sell cryptocurrency from their account on your platform and receive payment to a Bank Card or SEPA transfer.


Limits and rates

  • Get fiat currency limits for the selected type of sale (CARD, SEPA) - limit
  • Calculate the rate of sale of cryptocurrency for fiat - rate

Sequence

Limit request example:

{  
  "account": "string",  
  "timestamp": 0,  
  "payload": {  
    "fiatCurrency": "ARS"  
  }  
}

Limit response example:

{
  "minLimit": 0,
  "maxLimit": 0,
  "limitCurrency": "ARS"
}

Rate request example:

{
  "account": "string",
  "timestamp": 0,
  "payload": {
    "fiatCurrency": "ARS",
    "currency": "string"
  }
}

Rate response example:

{
  "rateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rate": 0,
  "fiatCurrency": "ARS",
  "currency": "string",
  "expiredDate": "2025-03-07T16:20:46.242Z"
}

Sale crypto with Bank Card/SEPA

  • Create a request to sale of cryptocurrency with the Card/Sepa type - card / sepa
  • If the sale is successful, you will receive a webhook - FIAT_APPLIER_WITHDRAWAL_SUCCESS
  • If the sale is failed, you will receive a webhook - FIAT_APPLIER_WITHDRAWAL_FAILED
  • After receiving the webhook, we recommend checking the information about the sale by calling the request for information about the order - order

Sequence


Order states

StateDescription
INITCrypto to fiat order in processing.
COMPLETEDCrypto to fiat order successfully completed.
FAILEDCrypto to fiat order failed.

card request example

{
  "account": "string",
  "timestamp": 0,
  "payload": {
    "card": "string",
    "currency": "string",
    "fiatCurrency": "ARS",
    "fixedRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fiatAmount": 0,
    "cryptoAmount": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalId": "string",
    "type": "CARD",
    "bankCode": "string",
    "bankSystem": "string",
    "saveCard": true
  }
}

card response example

{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "INIT",
  "currency": {
    "name": "string",
    "feeCurrencyName": "string",
    "coinId": "string",
    "networkData": {
      "frontName": "string",
      "type": "string"
    },
    "scale": 0,
    "blockchainScale": 0,
    "garbageAmount": 0,
    "crypto": true,
    "blockchainName": "string",
    "contract": "string",
    "enabled": true,
    "active": true
  },
  "fiatCurrency": "ARS",
  "amountInCrypto": 0,
  "amountInFiat": 0,
  "externalId": "string"
}

sepa request example

{
  "account": "string",
  "timestamp": 0,
  "payload": {
    "currency": {
      "name": "string",
      "feeCurrencyName": "string",
      "coinId": "string",
      "networkData": {
        "frontName": "string",
        "type": "string"
      },
      "scale": 0,
      "blockchainScale": 0,
      "garbageAmount": 0,
      "crypto": true,
      "blockchainName": "string",
      "contract": "string",
      "enabled": true,
      "active": true
    },
    "fiatCurrency": "ARS",
    "fixedRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fiatAmount": 0,
    "cryptoAmount": 0,
    "idempotencyKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "externalId": "string",
    "accountNumber": "string",
    "accountName": "string",
    "accountEmail": "string",
    "type": "SEPA"
  }
}

sepa response example

{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "INIT",
  "currency": {
    "name": "string",
    "feeCurrencyName": "string",
    "coinId": "string",
    "networkData": {
      "frontName": "string",
      "type": "string"
    },
    "scale": 0,
    "blockchainScale": 0,
    "garbageAmount": 0,
    "crypto": true,
    "blockchainName": "string",
    "contract": "string",
    "enabled": true,
    "active": true
  },
  "fiatCurrency": "ARS",
  "amountInCrypto": 0,
  "amountInFiat": 0,
  "externalId": "string"
}

Get crypto to fiat order

order request example

{
  "account": "string",
  "timestamp": 0,
  "payload": {
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

order response example

{
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "INIT",
  "currency": {
    "name": "string",
    "feeCurrencyName": "string",
    "coinId": "string",
    "networkData": {
      "frontName": "string",
      "type": "string"
    },
    "scale": 0,
    "blockchainScale": 0,
    "garbageAmount": 0,
    "crypto": true,
    "blockchainName": "string",
    "contract": "string",
    "enabled": true,
    "active": true
  },
  "fiatCurrency": "ARS",
  "amountInCrypto": 0,
  "amountInFiat": 0,
  "externalId": "string"
}