OpenAPI Document
  1. Digital Custody
OpenAPI Document
  • 1. Overview
    • 1. Overview
  • 2. Authentication
    • 2.1 Introduction
      • 2.1 Introduction
      • Generating an RSA key pair
    • 2.2 Creating the Bearer Token
      • 2.2 Creating the Bearer Token
      • Creating the token
      • Signature Examples
      • JWT Token Specification
      • Signature Examples
  • 3. Requests & Responses
    • 3.1 Requests
    • 3.2 Responses
    • 3.2 Responses
      • 3.2.1 Succes Responses
      • 3.2.2 Retrying Requests
      • 3.2.3 HTTP Status Codes
      • 3.2.4 Error Responses
        • Error Response Format
  • 4. Getting Started
    • 4.1 Pagination
      • 4.1 Pagination
    • 4.2 Rate Limiting
      • Rate Limits
    • 4.3 Idempotency
      • Idempotency Fields
    • 4.4 External ID and Metadata
      • 4.4 External ID and Metadata
  • 5. API
    • Health
      • 5.1 Test connectivity
      • 5.2 Test connectivity
    • Accounts
      • 5.3 Get Accounts
      • 5.4 Get Accounts
      • 5.5 Get Balances
    • Transfer
      • 5.6 Create a Transfer
    • Transactions
      • 5.7 Get Account Transactions
    • Conversions
      • 5.8 Get a Quote
      • 5.9 Execute a trade
    • Payouts
      • 5.10 Get Payouts
      • 5.11 Create Payout
      • 5.12 Get Payout Quotation
    • Card Account
      • 5.13 Create Card Account
      • 5.14 Get Card Account Transactions
    • Cards
      • 5.15 Issue Card
      • 5.16 Get Cards
      • 5.17 Activate Card
      • 5.18 Suspend Card
      • 5.19 Unsuspend Card
      • 5.20 Lock Card
      • 5.21 Unlock Card
      • 5.22 Cancel a card
      • 5.23 Get Card Senstiive Info
      • 5.24 Change Card PIN
      • 5.25 Control Spending
    • Digital Custody
      • 5.26 Get Supported Digital Assets
        GET
      • 5.27 Get Supported Blockchains
        GET
      • 5.28 Create Withdrawal Request
        POST
      • 5.29 Get Deposit Addresses
        GET
      • 5.30 Generate Deposit Address
        POST
    • Countries
      • 5.31 Get Countries
    • Positions
      • 5.32 Get Positions
    • Occupations
      • 5.33 Get Occupations
  • 6. Screenshot Illustration（api+image）
    • 6. Screenshot Illustration（api+image）
  1. Digital Custody

5.30 Generate Deposit Address

POST
https://access.sandbox.orzcash.com/v1/digital-custody/deposit-addresses

Request

Query Params
asset
string 
required
chain
string 
required
accountId
string 
required
idempotencyKey
string 
required
xid
string 
required
xmetadata
integer 
required
Body Params application/json
asset
string 
required
chain
string 
required
accountId
string 
required
idempotencyKey
string 
required
xid
string 
required
xmetadata
object 
required
Example
{
    asset:"unlock",
    chain:"abc",
    accountId:"1003",
    idempotencyKey:"dec",
    xid:"14",
    xmetadata:{},
   
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://access.sandbox.orzcash.com/v1/digital-custody/deposit-addresses?asset&chain&accountId&idempotencyKey&xid&xmetadata' \
--header 'Content-Type: application/json' \
--data-raw '{
    asset:"unlock",
    chain:"abc",
    accountId:"1003",
    idempotencyKey:"dec",
    xid:"14",
    xmetadata:{},
   
}'

Responses

🟢200success
application/json
Body
id
string 
required
address
string 
required
asset
string 
required
chain
string 
required
addressTag
string 
required
created
string 
required
xid
string 
required
xmetadata
object 
required
Example
{
    "id": "c936a1ff-1d3c-45e1-af1f-ed497685a305",
    "address": "0x000000000dfde7deaf24138722987c9b6991e2d4",
    "asset": "USDC",
    "chain": "ETH",
    "addressTag": "string",
    "created": "2022-12-21T07:21:09.879Z",
    "xid": "string",
    "xmetadata": {}
}
Modified at 2023-01-03 11:03:40
Previous
5.29 Get Deposit Addresses
Next
5.31 Get Countries
Built with