Skip to main content
PUT
/
v1
/
ramp-requests
/
{id}
/
amount
Edit the amount of a ramp request
curl --request PUT \
  --url https://api-fundflow.venly.io/v1/v1/ramp-requests/{id}/amount \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "amount": 1000.5
}
'
{
  "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.venlyfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth2 authentication via Venly Identity Platform

Path Parameters

​
id
string<uuid>
required

Unique identifier of the ramp request

Body

application/json

Request to update the incoming amount for an existing ramp request with optimistic locking

​
version
integer<int64>
required

Version number for optimistic locking. Must match the current version of the entity. If the version has changed since the client last fetched the resource, the request will fail with HTTP 409.

​
amount
number
required

The new incoming amount to set.

  • For ON_RAMP: This is the fiat amount (amount to be sent)
  • For OFF_RAMP: This is the crypto amount (amount to be sent)
Required range: x >= 1e-8
Example:

1000.5

Response

Amount successfully updated

​
success
boolean
default:true
​
result
object

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