Skip to content

Create Refund Order

Unreleased: This endpoint is available only in the test environment for early integration. Production is not yet available.

Request

POST https://api.mycactus.dev/custody/v1/api/projects/{b_id}/refund-order/create

Call this endpoint only when the deposit status is frozen_refund_waiting_address. Identical requests are idempotent and do not create duplicate refund orders.

Parameters

Path Parameters

FieldTypeDescription
b_id
Required
StringBusiness line ID

Request Body

FieldTypeDescription
wallet_detail_id
Required
LongDeposit transaction detail ID
order_no
Required
StringAPI order ID, up to 50 characters
same_way
Optional
BooleanReturn to the original sender. Defaults to false. When true, the destination must be an original sender address.
dest_address
Required
StringRefund destination address; it must not be a Cactus internal address
desc
Optional
StringOrder description
memo_type
Optional
StringMemo type for chains that require it
memo
Optional
StringMemo value

Request Example

{
  "wallet_detail_id": 1000123456,
  "order_no": "RF202609220001",
  "same_way": true,
  "dest_address": "0xabc...",
  "desc": "KYT refund"
}

ETH/TRON cold-contract token wallets do not currently support refund orders. Address review depends on the deposit status; a successful response does not mean the refund has arrived.

Response

Response Body

FieldTypeDescription
codeIntegerResponse code; 0 indicates success
messageStringResponse message
successfulBooleanWhether the request was successful
dataObjectRefund order information

data (object)

FieldTypeDescription
OrderNoStringRefund order ID

Response Example

{
  "code": 0,
  "message": "Success",
  "successful": true,
  "data": {
    "OrderNo": "PO202607310001"
  }
}