Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Deposits

View inbound crypto and fiat deposits to deposit accounts

List deposit accounts

get
/api/v1/deposits/accounts

Lists your deposit accounts.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Query parameters
pagenumber · min: 1Optional

Page number (1-based)

Default: 1Example: 1
sizenumber · min: 1 · max: 100Optional

Number of items per page

Default: 10Example: 10
statusstring · enumOptional

Filter by account status

Example: activePossible values:
Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit accounts retrieved successfully
get/api/v1/deposits/accounts
GET /api/v1/deposits/accounts HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*
200Success
{
  "success": true,
  "message": "Deposit accounts retrieved successfully",
  "data": [
    {
      "id": "da_123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "isParent": false,
      "settlementCurrency": "USDT",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "customer@example.com",
        "phone": "+1234567890",
        "telegramId": "123456789",
        "metadata": {
          "source": "website",
          "referrer": "google"
        },
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z"
      },
      "staticDepositAddresses": [
        {
          "chain": "ethereum",
          "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "ngnVirtualAccounts": [
        {
          "currency": "NGN",
          "accountNumber": "0123456789",
          "accountName": "COINCIRCUIT/JANE DOE",
          "bankName": "Nomba Bank",
          "bankCode": "090645",
          "accountReference": "CCVBA-7f3a9c12",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "size": 10,
    "total": 42,
    "totalPages": 5
  }
}

Create a deposit account

post
/api/v1/deposits/accounts

Creates a deposit account. Omit customerId to create a parent account. A holder has one deposit account, so repeat calls return the existing account.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Body
customerIdstringOptional

Existing customer to scope the account to. Omit to create the merchant parent account.

Example: 123e4567-e89b-12d3-a456-426614174000
settlementCurrencystring · enumOptional

Currency deposits into this account settle into. On default, a USDT, USDC or NGN deposit credits that balance directly and every other asset converts to USDT. Any other value converts every deposit into that currency. The merchant parent account is always default.

Default: defaultExample: USDTPossible values:
Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit account ready
post/api/v1/deposits/accounts
POST /api/v1/deposits/accounts HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "settlementCurrency": "USDT"
}
{
  "success": true,
  "message": "Deposit account ready",
  "data": {
    "id": "da_123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "isParent": false,
    "settlementCurrency": "USDT",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "staticDepositAddresses": [
      {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "ngnVirtualAccounts": [
      {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
}

Retrieve a deposit account

get
/api/v1/deposits/accounts/{id}

Retrieves a deposit account and its identities.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters
idstringRequired

Deposit account ID

Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit account retrieved successfully
get/api/v1/deposits/accounts/{id}
GET /api/v1/deposits/accounts/{id} HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Deposit account retrieved successfully",
  "data": {
    "id": "da_123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "isParent": false,
    "settlementCurrency": "USDT",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "staticDepositAddresses": [
      {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "ngnVirtualAccounts": [
      {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
}

Update a deposit account

patch
/api/v1/deposits/accounts/{id}

Changes the settlement currency of a customer-scoped deposit account. Deposits already in flight keep the currency they were credited in. The merchant parent account is always default.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters
idstringRequired

Deposit account ID

Body
settlementCurrencystring · enumRequired

Currency deposits into this account settle into. On default, a USDT, USDC or NGN deposit credits that balance directly and every other asset converts to USDT. Any other value converts every deposit into that currency.

Example: USDCPossible values:
Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit account retrieved successfully
patch/api/v1/deposits/accounts/{id}
PATCH /api/v1/deposits/accounts/{id} HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "settlementCurrency": "USDC"
}
{
  "success": true,
  "message": "Deposit account retrieved successfully",
  "data": {
    "id": "da_123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "isParent": false,
    "settlementCurrency": "USDT",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "staticDepositAddresses": [
      {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "ngnVirtualAccounts": [
      {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
}

Issue a deposit identity

post
/api/v1/deposits/accounts/{id}/identities

Issues a pay-in identity into a deposit account: a static crypto deposit address or an NGN virtual account.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters
idstringRequired

Deposit account ID

Body
typestring · enumRequired

Which identity to issue

Example: static_deposit_addressPossible values:
chainstring · enumOptional

Blockchain. Required when type is static_deposit_address.

Example: ethereumPossible values:
bvnstringOptional

BVN of the account holder (11 digits). Required when type is ngn_virtual_account.

Example: 12345678901
currencystring · enumOptional

Currency for a virtual account.

Example: NGNPossible values:
Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit account retrieved successfully
post/api/v1/deposits/accounts/{id}/identities
POST /api/v1/deposits/accounts/{id}/identities HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "type": "static_deposit_address",
  "chain": "ethereum",
  "bvn": "12345678901",
  "currency": "NGN"
}
{
  "success": true,
  "message": "Deposit account retrieved successfully",
  "data": {
    "id": "da_123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "isParent": false,
    "settlementCurrency": "USDT",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "staticDepositAddresses": [
      {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "ngnVirtualAccounts": [
      {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
}

Retrieve parent deposit account

get
/api/v1/deposits/accounts/parent

Retrieves the merchant parent deposit account.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit account retrieved successfully
get/api/v1/deposits/accounts/parent
GET /api/v1/deposits/accounts/parent HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*
200Success
{
  "success": true,
  "message": "Deposit account retrieved successfully",
  "data": {
    "id": "da_123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "isParent": true,
    "settlementCurrency": "default",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "staticDepositAddresses": [
      {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "ngnVirtualAccounts": [
      {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
}

Retrieve a customer's deposit account

get
/api/v1/deposits/accounts/customer/{customerId}

Retrieves the deposit account for a customer.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters
customerIdstringRequired

Customer ID

Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Deposit account retrieved successfully
get/api/v1/deposits/accounts/customer/{customerId}
GET /api/v1/deposits/accounts/customer/{customerId} HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Deposit account retrieved successfully",
  "data": {
    "id": "da_123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "isParent": false,
    "settlementCurrency": "USDT",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "staticDepositAddresses": [
      {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ],
    "ngnVirtualAccounts": [
      {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
}

List deposits

get
/api/v1/deposits

Lists your inbound deposits (crypto and fiat).

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Query parameters
customerIdstringOptional

Filter by customer id

depositAccountIdstringOptional

Filter by deposit account id

typestring · enumOptional

Filter by type

Possible values:
statusstring · enumOptional

Filter by status

Possible values:
chainstringOptional

Filter by crypto chain

Example: ethereum
currencystringOptional

Filter by currency

Example: USDT
txHashstringOptional

Filter by crypto deposit transaction hash (exact)

startDatestringOptional

Start date (ISO string)

Example: 2026-01-01T00:00:00Z
endDatestringOptional

End date (ISO string)

Example: 2026-12-31T23:59:59Z
pagenumber · min: 1Optional

Page number (1-based)

Default: 1Example: 1
sizenumber · min: 1 · max: 100Optional

Number of items per page

Default: 20Example: 20
Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Direct deposits retrieved successfully
get/api/v1/deposits
GET /api/v1/deposits HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*
200Success
{
  "success": true,
  "message": "Direct deposits retrieved successfully",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "crypto",
      "status": "completed",
      "amount": "100.00",
      "currency": "USDT",
      "fee": "0.50",
      "netAmount": "99.50",
      "conversion": {
        "fromCurrency": "USDT",
        "toCurrency": "NGN",
        "sourceAmount": "100.00",
        "targetAmount": "149000.00",
        "rate": "1490.00"
      },
      "depositAccountId": "da_123e4567-e89b-12d3-a456-426614174000",
      "balanceReference": "BAL-9f1c4a2b7de3",
      "customer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "customer@example.com",
        "phone": "+1234567890",
        "telegramId": "123456789",
        "metadata": {
          "source": "website",
          "referrer": "google"
        },
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z"
      },
      "crypto": {
        "txHash": "0xabc...",
        "chain": "ethereum",
        "asset": "USDT",
        "amount": "12.5",
        "fromAddress": "0xfrom...",
        "toAddress": "0xto...",
        "amlCheck": "passed",
        "staticDepositAddress": {
          "chain": "ethereum",
          "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      },
      "fiat": {
        "reference": "NMB-12345",
        "method": "bank_transfer",
        "payer": {
          "accountName": "Jane Doe",
          "accountNumber": "0123456789",
          "bankName": "Nomba Bank",
          "bankCode": "090645"
        },
        "payee": {
          "accountName": "Jane Doe",
          "accountNumber": "0123456789",
          "bankName": "Nomba Bank",
          "bankCode": "090645"
        },
        "ngnVirtualAccount": {
          "currency": "NGN",
          "accountNumber": "0123456789",
          "accountName": "COINCIRCUIT/JANE DOE",
          "bankName": "Nomba Bank",
          "bankCode": "090645",
          "accountReference": "CCVBA-7f3a9c12",
          "createdAt": "2026-01-01T00:00:00.000Z"
        }
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "completedAt": "2026-01-01T00:05:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "size": 10,
    "total": 42,
    "totalPages": 5
  }
}

Retrieve a deposit

get
/api/v1/deposits/{id}

Retrieves a single deposit.

Authorizations
x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters
idstringRequired

Deposit ID

Responses
200Success
application/json
successbooleanRequiredExample: true
messagestringRequiredExample: Direct deposit retrieved successfully
get/api/v1/deposits/{id}
GET /api/v1/deposits/{id} HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Direct deposit retrieved successfully",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "crypto",
    "status": "completed",
    "amount": "100.00",
    "currency": "USDT",
    "fee": "0.50",
    "netAmount": "99.50",
    "conversion": {
      "fromCurrency": "USDT",
      "toCurrency": "NGN",
      "sourceAmount": "100.00",
      "targetAmount": "149000.00",
      "rate": "1490.00"
    },
    "depositAccountId": "da_123e4567-e89b-12d3-a456-426614174000",
    "balanceReference": "BAL-9f1c4a2b7de3",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Doe",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "telegramId": "123456789",
      "metadata": {
        "source": "website",
        "referrer": "google"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    "crypto": {
      "txHash": "0xabc...",
      "chain": "ethereum",
      "asset": "USDT",
      "amount": "12.5",
      "fromAddress": "0xfrom...",
      "toAddress": "0xto...",
      "amlCheck": "passed",
      "staticDepositAddress": {
        "chain": "ethereum",
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    },
    "fiat": {
      "reference": "NMB-12345",
      "method": "bank_transfer",
      "payer": {
        "accountName": "Jane Doe",
        "accountNumber": "0123456789",
        "bankName": "Nomba Bank",
        "bankCode": "090645"
      },
      "payee": {
        "accountName": "Jane Doe",
        "accountNumber": "0123456789",
        "bankName": "Nomba Bank",
        "bankCode": "090645"
      },
      "ngnVirtualAccount": {
        "currency": "NGN",
        "accountNumber": "0123456789",
        "accountName": "COINCIRCUIT/JANE DOE",
        "bankName": "Nomba Bank",
        "bankCode": "090645",
        "accountReference": "CCVBA-7f3a9c12",
        "createdAt": "2026-01-01T00:00:00.000Z"
      }
    },
    "createdAt": "2026-01-01T00:00:00.000Z",
    "completedAt": "2026-01-01T00:05:00.000Z"
  }
}
PreviousTransactions
NextPayouts

Last updated

Was this helpful?