public.onramps

Create Onramp

Creates either a temporary or permanent onramp configuration. Include developer_fee.percentage to keep 0% to 50% of each received deposit; deposit responses and webhooks show the developer fee and customer amount separately from Daya fees. Requires an idempotency key in the X-Idempotency-Key header.

post/v1/onramps

Headers

X-Idempotency-Keystring required

Idempotency key for request deduplication

Request body

amountinteger

rate_idstring

type'TEMPORARY' | 'PERMANENT' required

Example request

{
  "amount": 50000,
  "customer": {
    "customer_id": "650e8400-e29b-41d4-a716-446655440000",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "verification": {
      "bank_account": {
        "account_number": "0123456789",
        "bank_code": "058"
      },
      "bvn": "22345678901",
      "image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...",
      "phone_number": "+2348012345678"
    }
  },
  "developer_fee": {
    "percentage": "1.5"
  },
  "rate_id": "550e8400-e29b-41d4-a716-446655440000",
  "settlement": {
    "asset": "USDC",
    "chain": "BASE",
    "destination_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "mode": "ONCHAIN"
  },
  "type": "PERMANENT"
}

Response

Created

amountstring

currencystring

customer_idstring

onramp_idstring

rate_expires_atstring

rate_idstring

type'TEMPORARY' | 'PERMANENT'

Example response

{
  "amount": "50000.50",
  "currency": "NGN",
  "customer_id": "650e8400-e29b-41d4-a716-446655440000",
  "developer_fee": {
    "percentage": "1.5"
  },
  "onramp_id": "750e8400-e29b-41d4-a716-446655440000",
  "rate_expires_at": "2025-01-05T15:04:05Z",
  "rate_id": "550e8400-e29b-41d4-a716-446655440000",
  "settlement": {
    "asset": "USDC",
    "chain": "BASE",
    "destination_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "mode": "ONCHAIN"
  },
  "type": "PERMANENT",
  "virtual_account": {
    "account_name": "Daya-John Doe",
    "account_number": "1234567890",
    "bank_name": "Wema Bank",
    "expires_at": "2025-01-05T16:04:05Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.