OpenAPI Document
  1. Transfer
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
        POST
    • 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
      • 5.27 Get Supported Blockchains
      • 5.28 Create Withdrawal Request
      • 5.29 Get Deposit Addresses
      • 5.30 Generate Deposit Address
    • 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. Transfer

5.6 Create a Transfer

Developing
POST
https://access.sandbox.orzcash.com/v1/accounts/transfers

Request

Query Params
asset
string 
optional
amount
number 
optional
source
string 
optional
destination
string 
optional
description
string 
optional
xid
string 
optional
xmetadata
string 
optional
Body Params application/json
amount
number 
required
asset
string 
required
source
string 
required
destination
string 
required
description
string 
required
xmetadata
object 
required
Example
{
    amount:1,
    asset:"abc",
    source:"count",
    destination:"dec",
    description:"des",
    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/accounts/transfers?asset&amount&source&destination&description&xid&xmetadata' \
--header 'Content-Type: application/json' \
--data-raw '{
    amount:1,
    asset:"abc",
    source:"count",
    destination:"dec",
    description:"des",
    xid:"14",
    xmetadata:{},
   
}'

Responses

🟢200success
application/json
Body
id
string 
required
amount
string 
required
asset
string 
required
description
string 
required
refId
string 
required
source
string 
required
destination
string 
required
sourceTransactionId
string 
required
destinationTransactionId
string 
required
createdAt
string 
required
xid
string 
required
xmetadata
object 
required
Example
{
    "id": "string",
    "amount": 0,
    "asset": "string",
    "description": "string",
    "refId": "string",
    "source": "string",
    "destination": "string",
    "sourceTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "destinationTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2022-12-21T04:58:56.119Z",
    "xid": "string",
    "xmetadata": {}
}
Modified at 2023-01-03 10:35:59
Previous
5.5 Get Balances
Next
5.7 Get Account Transactions
Built with