Skip to main content
POST
/
v1
/
ramp-requests
Create a new ramp request
curl --request POST \
  --url https://api-fundflow-qa.venly.io/v1/ramp-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rampType": "ON_RAMP",
  "amount": 1000,
  "fiatCurrencyId": "123e4567-e89b-12d3-a456-426614174002",
  "cryptoCurrencyId": "123e4567-e89b-12d3-a456-426614174003",
  "companyBankAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "companyWalletId": "123e4567-e89b-12d3-a456-426614174001"
}
'
{
  "success": true,
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyName": "<string>",
    "rampType": "ON_RAMP",
    "status": "AWAITING_APPROVAL",
    "amount": 123,
    "netAmount": 123,
    "fiatAmount": 1000,
    "fiatNetAmount": 990,
    "cryptoAmount": 0.5,
    "fiatFeeAmount": 10,
    "exchangeRate": 2000,
    "feePercentage": 1,
    "paymentReference": "PAY-2024-001234",
    "paymentReceived": true,
    "blockchainTransactionHash": "0x1234...",
    "createdAt": "2023-11-07T05:31:56Z",
    "companyBankAccount": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "bankName": "<string>",
      "companyName": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "bankCountry": "<string>",
      "beneficiaryAddressLine1": "<string>",
      "beneficiaryAddressLine2": "<string>",
      "beneficiaryCity": "<string>",
      "beneficiaryState": "<string>",
      "beneficiaryPostalCode": "<string>",
      "beneficiaryCountry": "<string>",
      "bankAccountType": "EUR_SEPA",
      "supportedRampType": "ON_RAMP",
      "verificationStatus": "PENDING",
      "verifiedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "version": 123,
      "iban": "<string>",
      "bic": "<string>",
      "intermediaryBic": "<string>"
    },
    "companyWallet": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "address": "<string>",
      "chain": "ETHEREUM",
      "verificationStatus": "PENDING",
      "verifiedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "version": 123
    },
    "depositBankAccount": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bankName": "<string>",
      "beneficiary": "<string>",
      "fiatCurrency": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currency": "EUR",
        "label": "Euro",
        "enabled": true,
        "version": 123
      },
      "label": "<string>",
      "isActive": true,
      "isDefault": true,
      "bankAccountType": "EUR_SEPA",
      "version": 123,
      "bic": "<string>",
      "intermediaryBic": "<string>",
      "iban": "<string>"
    },
    "depositWallet": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "address": "<string>",
      "chain": "ETHEREUM",
      "label": "<string>",
      "isDefault": true,
      "isActive": true,
      "version": 123
    },
    "fiatCurrency": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currency": "EUR",
      "label": "Euro",
      "enabled": true,
      "version": 123
    },
    "cryptoCurrency": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currency": "USDC",
      "chain": "ETHEREUM",
      "label": "USD Coin",
      "enabled": true,
      "version": 123,
      "coingeckoId": "<string>"
    },
    "events": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventType": "CREATED",
        "userId": "<string>",
        "username": "<string>",
        "email": "<string>",
        "role": "COMPANY_ADMIN",
        "createdAt": "2023-11-07T05:31:56Z",
        "version": 123,
        "metadata": {}
      }
    ],
    "version": 123,
    "amountReceived": 123
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 authentication via Venly Identity Platform

Body

application/json

Request to create a new on-ramp or off-ramp transaction with specified currencies and amounts

​
rampType
enum<string>
required

Type of ramp operation

Available options:
ON_RAMP,
OFF_RAMP
Example:

"ON_RAMP"

​
amount
number
required

The amount for the ramp request.

  • For ON_RAMP: Fiat amount to be sent
  • For OFF_RAMP: Crypto amount to be sent
Required range: x >= 1e-8
Example:

1000

​
fiatCurrencyId
string<uuid>
required

The fiat currency ID for the transaction

Example:

"123e4567-e89b-12d3-a456-426614174002"

​
cryptoCurrencyId
string<uuid>
required

The crypto currency ID for the transaction

Example:

"123e4567-e89b-12d3-a456-426614174003"

​
companyBankAccountId
string<uuid>

Required for OFF_RAMP requests. The company bank account where fiat will be received.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
companyWalletId
string<uuid>

Required for ON_RAMP requests. The company wallet where crypto will be received.

Example:

"123e4567-e89b-12d3-a456-426614174001"

Response

Ramp request successfully created

​
success
boolean
default:true
​
result
object

Complete ramp request details including status, amounts, and event history