v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Deposit Fiat

Child Address Create Payment Order

post/v1/wallets/{walletId}/addresses/{addressId}/deposit/fiat/orders

Path parameters

walletIdstring uuid required

Wallet identifier.

addressIdstring uuid required

Child address identifier.

Request body

currencystring required

ISO 4217 fiat currency paid by the customer.

assetIdstring uuid required

Stablecoin asset to settle.

amountstring required

Stablecoin amount to receive, encoded as a decimal string.

rail'one_time_virtual_account' | 'payment_link' | 'qr_code' required

Supported fiat collection rail.

referencestring

Unique client reference used for reconciliation and safe retries.

validityTimeMinutesnumber

Time before the payment instructions expire.

codestring

passkeyResponseobject

customerIdstring uuid

Existing Blockradar customer identifier.

additionalDataobject

Values collected from the quote requirements schema.

metadataobject

Your application metadata returned with the order.

providerstring

Optional provider slug. Omit for automatic routing.

Example request

{
  "currency": "NGN",
  "assetId": "ae455f23-3824-4125-baab-d158315cbcbd",
  "amount": "100.00",
  "reference": "dep_20260719_001",
  "validityTimeMinutes": 30,
  "customerId": "18d2f159-e0cd-4a45-b735-e9dfe0f7520a",
  "customer": {
    "name": "Ada Okafor",
    "email": "ada@example.com",
    "phone": "+2348012345678"
  },
  "additionalData": {
    "beneficiaryType": "individual"
  },
  "metadata": {
    "checkoutId": "checkout_123"
  },
  "provider": "example-provider"
}

Response

Created successfully.

statusCodeinteger required

messagestring required

Human-readable result.

Example response

{
  "statusCode": 200,
  "message": "Payment order created successfully",
  "data": {
    "id": "80ea45ab-38b9-4506-b213-52da8bc7e825",
    "type": "deposit",
    "reference": "dep_20260719_001",
    "providerReference": "provider_order_839201",
    "currency": "NGN",
    "amount": "100.00",
    "amountFiat": "155000.00",
    "feeFiat": "1500.00",
    "amountFiatPayable": "156500.00",
    "expiresAt": "2026-07-19T13:00:00.000Z",
    "paymentInstructions": {
      "bank": {
        "name": "Example Bank",
        "code": "999",
        "accountName": "Blockradar / Acme Ltd",
        "accountNumber": "0123456789"
      },
      "paymentLink": {
        "url": "https://pay.example.com/order/839201"
      },
      "qrCode": {
        "payload": "000201010212...",
        "imageUrl": "https://pay.example.com/qr/839201.png"
      },
      "expiresAt": "2026-07-19T13:00:00.000Z"
    },
    "provider": {
      "id": "1128dd40-2c94-4c16-a6bf-fbbc6afee52c",
      "slug": "example-provider",
      "name": "Example Provider"
    },
    "wallet": {
      "id": "4465468a-3c36-4536-918a-91d689e18a74",
      "address": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a"
    },
    "address": {
      "id": "a2746f77-56b1-4b34-b0f3-53ad99bf53e2",
      "address": "0x8Fcb...f12"
    },
    "asset": {
      "id": "ae455f23-3824-4125-baab-d158315cbcbd",
      "symbol": "USDC",
      "name": "USD Coin"
    },
    "customer": {
      "id": "18d2f159-e0cd-4a45-b735-e9dfe0f7520a"
    },
    "createdAt": "2026-07-19T12:30:00.000Z",
    "updatedAt": "2026-07-19T12:30:00.000Z"
  }
}