POST
/
createTransactionRequest
curl --request POST \
  --url https://doc-api.oppipayment.com/api/v3/createTransactionRequest \
  --header 'signatureToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Content-Type: application/json' \
  --data '{
    "currency": "6698aec7f188ae24c673da1c",
    "amount": "0.01",
    "orderId": "ORDER_1",
    "isCheckBalance": true
  }'
{
  "address": "0x6648C29C6FD8........eD9Eb964c6F838bF",
  "amount": "0.0001",
  "tag": "2165464",
  "transactionId": "0866f8-4a53-4579-9274-351ec868a627"
}

Authentication

signatureToken
string
required
A JWT token required for API authentication. Generate JWT token as explained in section Generate JWT Token using empty string.

Headers

Content-Type
string
required
Must be set to application/json.

Request Body

currency
string
required
Assets Currency id.
amount
string
required
Provide amount for transaction.
orderId
string
required
Pass orderId for your reference.
isCheckBalance
boolean
If true, the request will be accepted only if the sent amount equals the entered amount. If false, the request will be accepted even if the amount exceeds the available balance.Note: Transactions below the minimum payment won’t be reflected in your account. See Fees Chart.
curl --request POST \
  --url https://doc-api.oppipayment.com/api/v3/createTransactionRequest \
  --header 'signatureToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Content-Type: application/json' \
  --data '{
    "currency": "6698aec7f188ae24c673da1c",
    "amount": "0.01",
    "orderId": "ORDER_1",
    "isCheckBalance": true
  }'

Response

Returns the transaction details upon successful request.
address
string
required
The address for the deposit.
amount
string
required
The amount that was deposited.
tag
string
required
The tag associated with the transaction.
transactionId
string
required
Unique identifier for the transaction.
{
  "address": "0x6648C29C6FD8........eD9Eb964c6F838bF",
  "amount": "0.0001",
  "tag": "2165464",
  "transactionId": "0866f8-4a53-4579-9274-351ec868a627"
}