AurellixPay API Documentation

This page shows the usage of some runtime APIs provided by AurellixPay.

API base URL - Please contact customer service to obtain it

Withdrawal Interface

Data type: JSON (content-type: application/json)
Request method: POST
Path: /v1/hexpay/withdraw/create
Authentication: Signature verification

Interface Description

This interface accepts withdrawal information passed by the merchant, performs data validation and balance checks, and creates a withdrawal application.

Request Parameters

Field Name	Type	Max Length	Required	Description
mchNo	String	30	Yes	Merchant number
appId	String	64	Yes	Application ID, assigned by the merchant platform
sign	String	512	Yes	Signature
signType	String	10	Yes	Signature type, default value RSA2
version	String	10	Yes	Version number, e.g., v1.0
currency	String	10	Yes	Withdrawal currency (refer to deposit currencies, please confirm support with customer service)
address	String	256	No	Withdrawal address (For USDC/USDT, it's a stablecoin address. For BRL, it can be: PIX code, CPF/CNPJ code, email address, phone number (e.g., +5511990028754), etc. Required for stablecoins and Brazil channels.)
amount	BigDecimal	-	Yes	Withdrawal amount
chain	String	30	No	Blockchain network, required when currency is (USDC/USDT). Optional values: Tron (Maintenance), Solana, Ethereum, Polygon, Arbitrum, Binance_smart_chain
mchWithdrawId	String	64	No	Merchant withdrawal record ID
bankCode	String	-	No	Bank code (Required for Malaysia, Thailand, Mexico, and other channels)
bankHolderName	String	-	No	Cardholder name (Required for Malaysia, Thailand, Mexico, and other channels)
bankAccount	String	-	No	Bank account (Required for Malaysia, Thailand, Mexico, and other channels)

Sample Request Data

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "currency": "USDC",
    "address": "DZwb72WbFsxLF332nF5mYHiMkXpLJMtYV6kv8RtbYRTQ",
    "amount": 3.21,
    "chain": "Solana",
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

Response Parameters

json

{
    "code": 0,
    "data": {
        "withdrawId": 20,
        "state": 1
    },
    "msg": "SUCCESS"
}

Withdrawal Status Query Interface

Data type: JSON (content-type: application/json)
Request method: POST
Path: /v1/hexpay/withdraw/query
Authentication: Signature verification

Interface Description

This interface queries the execution status of the withdrawal application based on the withdrawal record ID.

Request Parameters

Field Name	Type	Max Length	Required	Description
mchNo	String	30	Yes	Merchant number
appId	String	64	Yes	Application ID, assigned by the merchant platform
sign	String	512	Yes	Signature
signType	String	10	Yes	Signature type, default value RSA2
version	String	10	Yes	Version number, e.g., v1.0
withdrawId	Long		No	Withdrawal record ID (At least one of withdrawId or mchWithdrawId must be passed)
mchWithdrawId	String	64	No	Merchant withdrawal record ID (At least one of withdrawId or mchWithdrawId must be passed)

Sample Request Data

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "withrawId": 20,
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

Response Parameters

Field Name	Type	Required	Description
code	String	Yes	Response code
data	String	No	Response data
msg	String	No	Response message

data Data Format

Field Name	Type	Description
withdrawId	Long	Withdrawal record ID
currency	String	Currency
chain	String	Network
address	String	Withdrawal address
amount	BigDecimal	Withdrawal amount
state	Byte	Withdrawal status: 0-Pending, 1-Processing, 2-Success, 3-Failure, 4-Cancelled
failReason	String	Failure reason
gatewayResponse	String	Receipt information. Brazil channel return field descriptions: Channel record ID: transaction_id Amount: amount Receipt code: key Receiving account: recipient_account_id Receiving branch: recipient_branch_id Beneficiary CPF/CNPJ: recipient_legal_id Beneficiary name: recipient_name Receiving account type: recipient_account_type Operation record ID: operationUuid Error description 1: erro_descriptor Error description 2: new_erro_descriptor

data sample:

json

{
    "code": 0,
    "data": {
        "withdrawId": 20,
        "currency": "USDC",
        "chain": "Solana",
        "address": "DZwb72WbFsxLF332nF5mYHiMkXpLJMtYV6kv8RtbYRTQ",
        "amount": 3.21,
        "state": 0,
        "failReason": "Failure reason",
        "gatewayResponse": null
    },
    "msg": "SUCCESS"
}

Brazil channel gatewayResponse sample:

json

{
  "transaction_id": "111",
  "amount": 100,
  "key": "222",
  "recipient_account_id": "333",
  "recipient_branch_id": "1",
  "recipient_legal_id": "444",
  "recipient_name": "name abc",
  "recipient_account_type": "PAYMENT_ACCOUNT",
  "operationUuid": "123",
  "erro_descriptor": "",
  "new_erro_descriptor": ""
}

Batch Query Records Interface

Data type: JSON (content-type: application/json)
Request method: POST
Path: /v1/hexpay/withdraw/batch-query
Authentication: Signature verification

Interface Description

This interface queries withdrawal records in batches based on mchNo and appId.

Request Parameters

Field Name	Type	Max Length	Required	Description
appId	String	64	Yes	Application ID, assigned by the merchant platform
mchNo	String	30	Yes	Merchant number
version	String	10	Yes	Version: v1.0
signType	String	10	Yes	Signature type: Currently only supports RSA2
sign	String	256	Yes	Signature
startTime	Date		No	(Based on createdAt) Date format string (yyyy-MM-dd HH:mm:ss), time range query -- start time (inclusive)
endTime	Date		No	(Based on createdAt) Date format string (yyyy-MM-dd HH:mm:ss), time range query -- end time (inclusive)
currency	String	30	No	Currency, optional values: (USDC/USDT/BRL)
chain	String	10	No	Network, optional values: Tron (Maintenance), Solana, Ethereum, Polygon, Arbitrum, Binance_smart_chain
pageNum	Integer		No	Current page number, defaults to 1
pageSize	Integer		No	Page size, defaults to 10
state	Byte		No	Withdrawal status: 0-Pending, 1-Processing, 2-Success, 3-Failure, 4-Cancelled

Sample Request Data

json

{
    "appId": "68760330a2cf0af37c52a173",
    "mchNo": "M1752561528",
    "version": "v1.0",
    "signType": "RSA2",
    "state":0,
    "pageNum":1,
    "pageSize":5,
    "currency":"USDC",
    "chain":"ethereum",
    "startTime":"2025-08-28 00:00:00",
    "endTime":"2025-08-28 23:59:59",
    "sign": "g+NAXi68wJ8J9hnKbBEzf6gbF+acYSyn8eMQrQDE6ndzcma9dBVYIRTBaNaeE/aFDAdMB4ARbXpLit8QIaH7vn3ZF6iKqu7tGpax817C9Yz+c9zvLtbt6rvTpwuBCKVfQJNJ+JbWCjXqwfRMJBmDfnUCujdeLnXf2l7QW6azi0Q3CC18UKyRtHGiRZ8kdwP+s3YX7JXCD+N35aFUdf7vwP19nEhXpyjMrZKColFbarQdrPZ1MsrROcnAKPqfMgV0gQ39GizIUi0fSdBR3xD7YtG+pcmJ6iCUzNbpkpMyTYBg5J4sp2MT+ejhUXSp+hYellp20Lt22TE1yCUajAlJkQ=="
}

Response Parameters

data Data Format

Field Name	Type	Description
withdrawId	Long	Withdrawal record ID
currency	String	Currency
chain	BigDecimal	Network chain
address	String	Withdrawal address
amount	BigDecimal	Withdrawal amount
state	Byte	Withdrawal status: 0-Pending, 1-Processing, 2-Success, 3-Failure, 4-Cancelled
failReason	String	Failure reason
gatewayResponse	String	Receipt info (JSON)
mchWithdrawId	String	Merchant withdrawal ID

json

{
    "code": 0,
    "msg": "SUCCESS",
    "data": {
        "records": [
            {
                "withdrawId": 11,
                "currency": "USDC",
                "chain": "arbitrum",
                "address": "0xddc101d26c59d6b10c95e7b7b3928986741ea13f",
                "amount": "0.11",
                "state": 1
            },
            {
                "withdrawId": 10,
                "currency": "USDC",
                "chain": "arbitrum",
                "address": "0x4fd16e1c608f437f60d324ce1a96097ee85c8843",
                "amount": "0.11",
                "state": 2
            }
        ],
        "total": 2,
        "size": 5,
        "current": 1,
        "pages": 1
    }
}

Download Withdrawal Receipt Interface

Interface Information

Data type: JSON (content-type: application/json)
Request method: POST
Path: /v1/hexpay/withdraw/downloadWithdrawReceipt
Authentication: Signature verification

Interface Description

This interface downloads the withdrawal receipt PDF file based on the withdrawal record ID. Supports multilingual receipt file download.

Request Parameters

Field Name	Type	Max Length	Required	Description
mchNo	String	30	Yes	Merchant number
appId	String	64	Yes	Application ID, assigned by the merchant platform
sign	String	512	Yes	Signature
signType	String	10	Yes	Signature type, default value RSA2
version	String	10	Yes	Version number, e.g., v1.0
withdrawId	Long		No	Withdrawal record ID (At least one of withdrawId or mchWithdrawId must be passed)
mchWithdrawId	String	64	No	Merchant withdrawal record ID (At least one of withdrawId or mchWithdrawId must be passed)
lang	String	20	No	Receipt language, optional values: english (default), portuguese, chinese

Sample Request

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "withdrawId": 20,
    "lang": "english",
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

Response Parameters

Success Response

Content-Type: application/pdf
Content-Disposition: attachment; filename="WithdrawReceipt{mchWithdrawId}.pdf"
Response Body: PDF file stream

Failure Response

HTTP status code: 404 Not Found (when the withdrawal record does not exist)

Response Status Description

Situation	HTTP Status Code	Description
Success	200	Returns PDF file stream, browser will automatically download the file
Record does not exist	404	Withdrawal record does not exist or access denied
Parameter error	400	Request parameter validation failed
Signature error	401	Signature verification failed

AurellixPay API Documentation ​

Withdrawal Interface ​

Interface Description ​

Request Parameters ​

Response Parameters ​

Withdrawal Status Query Interface ​

Interface Description ​

Request Parameters ​

Response Parameters ​

Batch Query Records Interface ​

Interface Description ​

Request Parameters ​

Response Parameters ​

Download Withdrawal Receipt Interface ​

Interface Information ​

Interface Description ​

Request Parameters ​

Sample Request ​

Response Parameters ​

Success Response ​

Failure Response ​

Response Status Description ​

AurellixPay API Documentation

Withdrawal Interface

Interface Description

Request Parameters

Response Parameters

Withdrawal Status Query Interface

Interface Description

Request Parameters

Response Parameters

Batch Query Records Interface

Interface Description

Request Parameters

Response Parameters

Download Withdrawal Receipt Interface

Interface Information

Interface Description

Request Parameters

Sample Request

Response Parameters

Success Response

Failure Response

Response Status Description