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

Batch Payout Upload Interface

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

Interface Description

This interface accepts batch payout records passed by the merchant, performs data validation and balance checks, and creates a batch payout 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
records	Array	-	Yes	Batch payout records list
purpose	String	256	No	Payout purpose

Record Type

Field Name	Type	Required	Description
recipientAddress	String	Yes	Recipient address
paymentAmount	BigDecimal	Yes	Payout amount
paymentCurrency	String	Yes	Payout currency, optional values: USDT, USDC
networkType	String	Yes	Network type, optional values: Tron (Maintenance), Solana, Ethereum, Polygon, Arbitrum, Binance_smart_chain
remarks	String	No	Remarks
addressTag	String	No	Address tag

Sample Request Data

json

{
    "mchNo": "M1752564528",
    "appId": "68760330a2cf0af37c52a073",
    "signType": "RSA2",
    "version": "v1.0",
    "purpose": "Batch payout test",
    "records": [
        {
            "recipientAddress": "TUEZSdKsoDHQMeZwihtdoBiN46zP8ulvDE",
            "paymentAmount": 10.50,
            "paymentCurrency": "USDT",
            "networkType": "Binance_smart_chain",
            "remarks": "Payout remark 1",
            "addressTag": "tag1"
        },
        {
            "recipientAddress": "TSNEZdKsoDHQMeZwihtdoBiN46zP8ulvDE",
            "paymentAmount": 20.30,
            "paymentCurrency": "USDC",
            "networkType": "Binance_smart_chain",
            "remarks": "Payout remark 2",
            "addressTag": "tag2"
        }
    ],
    "sign": "VaKMVivLXtqJw6kp7PyNaI6P7qoLM9kOXms5Tll8TsX0eubZ0F+bbxGpfaTR2zpCZkVr/iygD4QyuueMt+pMOAOXZ2yayFGloyKL1mMfNHzb5PDPMhU3cKm6cb+BCHkfk5S602rCBFrQSEhVgQiwpd5ezI6NAdw4+EdPwVmzXH6pVZ9YXNSp9n1O8caS5dL0bjhWxO5EFWrxhbfFNLgWy1OXRs9e02wHZXbzukAkbuJl6UZDpPKKluy2m1BbgxYYYHlx4sunBsE8vP5vj50UHg8KK4v1K/XXzx+oIpZQ85895ZFAISLO9V7ugdlXx/+jrpzg2xnEOK9ss/oSSbdDoQ=="
}

Response Parameters

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

data Data Format

Field Name	Type	Description
batchNo	String	Batch number
totalCount	Integer	Total number of records
totalAmount	Array	Total amount statistics by currency
applyTime	Date	Application time
checkErrorList	Array	Data validation error list
checkBalanceList	Array	Balance check results (only returns insufficient balance)

totalAmount Data Format

Field Name	Type	Description
currency	String	Currency
amount	BigDecimal	Amount

checkBalanceList Data Format

Field Name	Type	Description
paymentCurrency	String	Currency
paymentAmount	BigDecimal	Payout amount
freeAmount	BigDecimal	Transaction fee
totalAmount	BigDecimal	Total amount (Payout + Fee)
availableAmount	BigDecimal	Current account available balance
isSatisfy	Integer	Whether conditions are met (0=insufficient, 1=sufficient)
validCount	Integer	Valid records count
errorCount	Integer	Error records count

Response Sample

json

{
    "code": 0,
    "data": {
        "batchNo": "BP20250905123456789",
        "totalCount": 2,
        "totalAmount": [
            {
                "currency": "USDT",
                "amount": 10.50
            },
            {
                "currency": "USDC",
                "amount": 20.30
            }
        ],
        "applyTime": "2025-09-05 14:30:25",
        "checkErrorList": [],
        "checkBalanceList": [
            {
                "paymentCurrency": "USDT",
                "paymentAmount": 10.50,
                "freeAmount": 0.50,
                "totalAmount": 11.00,
                "availableAmount": 5.00,
                "isSatisfy": 0,
                "validCount": 1,
                "errorCount": 0
            }
        ]
    },
    "msg": "SUCCESS"
}

Batch Payout Query Interface

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

Interface Description

This interface queries the detailed information of a batch payout application according to the batch number, including the audit status and the execution status of each record.

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
batchNo	String	64	Yes	Batch number

Sample Request Data

json

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

Response Parameters

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

data Data Format

Field Name	Type	Description
batchNo	String	Batch number
mchNo	String	Merchant number
mchName	String	Merchant name
auditStatus	Byte	Audit status: 0-Pending, 1-Executing, 2-Rejected, 3-Completed, 4-Failed, 5-Cancelled
totalCount	Integer	Total records count
successCount	Integer	Successful count
failCount	Integer	Failed count
processingCount	Integer	Processing count
waitCount	Integer	Pending count
totalAmount	BigDecimal	Total amount
applyTime	Date	Application time
auditTime	Date	Audit time
executeTime	String	Execution time
purpose	String	Payout purpose
rejectReason	String	Rejection reason
auditOpinion	String	Audit opinion
records	Array	Detailed records list

RecordDetail Data Format

Field Name	Type	Description
id	Long	Record ID
recipientAddress	String	Recipient address
paymentAmount	BigDecimal	Payout amount
paymentCurrency	String	Payout currency
networkType	String	Network type
feeAmount	BigDecimal	Fee amount
remarks	String	Remarks
addressTag	String	Address tag
status	Byte	Record status: 0-Pending, 1-Processing, 2-Payout successful, 3-Payout failed, 4-Cancelled
failReason	String	Failure reason
txHash	String	Transaction hash
processedAt	Date	Processed time
createdAt	Date	Creation time

Response Sample

json

{
    "code": 0,
    "data": {
        "batchNo": "BP20250905123456789",
        "mchNo": "M1752564528",
        "mchName": "Test Merchant",
        "auditStatus": 1,
        "totalCount": 2,
        "successCount": 1,
        "failCount": 0,
        "processingCount": 1,
        "waitCount": 0,
        "totalAmount": 30.80,
        "applyTime": "2025-09-05 14:30:25",
        "auditTime": "2025-09-05 14:35:10",
        "executeTime": "2025-09-05 14:35:15",
        "purpose": "Batch payout test",
        "rejectReason": null,
        "auditOpinion": "Approved",
        "records": [
            {
                "id": 1001,
                "recipientAddress": "TUEZSdKsoDHQMeZwihtdoBiN46zP8ulvDE",
                "paymentAmount": 10.50,
                "paymentCurrency": "USDT",
                "networkType": "",
                "feeAmount": 0.50,
                "remarks": "Payout remark 1",
                "addressTag": "tag1",
                "status": 2,
                "failReason": null,
                "txHash": "0x1234567890abcdef1234567890abcdef12345678",
                "processedAt": "2025-09-05 14:40:20",
                "createdAt": "2025-09-05 14:30:25"
            },
            {
                "id": 1002,
                "recipientAddress": "TSNEZdKsoDHQMeZwihtdoBiN46zP8ulvDE",
                "paymentAmount": 20.30,
                "paymentCurrency": "USDC",
                "networkType": "Binance_smart_chain",
                "feeAmount": 1.00,
                "remarks": "Payout remark 2",
                "addressTag": "tag2",
                "status": 1,
                "failReason": null,
                "txHash": null,
                "processedAt": null,
                "createdAt": "2025-09-05 14:30:25"
            }
        ]
    },
    "msg": "SUCCESS"
}

Batch Payout Cancellation Interface

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

Interface Description

This interface is used to cancel a batch payout application in "Pending review" status. After cancellation, the frozen balance will be rolled back.

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
batchNo	String	64	Yes	Batch number

Sample Request Data

json

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

Response Parameters

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

data Data Format

Field Name	Type	Description
id	Long	Primary ID
batchNo	String	Batch number
mchNo	String	Merchant number
mchName	String	Merchant name
totalCount	Integer	Total records count
totalAmount	BigDecimal	Total amount
status	Byte	Audit status: 0-Pending, 1-Executing, 2-Rejected, 3-Completed, 4-Failed, 5-Cancelled
auditUserId	Long	auditor ID
auditUserName	String	Auditor nickname
auditTime	Date	Audit time
remarks	String	Remarks
purpose	String	Payout purpose
rejectReason	String	Rejection reason
auditOpinion	String	Audit opinion
executeTime	String	Execution time
successCount	Integer	Successful count
failCount	Integer	Failed count
executingCount	Integer	Executing count
createdAt	Date	Creation time
updatedAt	Date	Updated time

Response Sample

json

{
    "code": 0,
    "data": {
        "id": 1001,
        "batchNo": "BP20250905123456789",
        "mchNo": "M1752564528",
        "mchName": "Test Merchant",
        "totalCount": 2,
        "totalAmount": 30.80,
        "status": 5,
        "auditUserId": null,
        "auditUserName": null,
        "auditTime": null,
        "remarks": null,
        "purpose": "Batch payout test",
        "rejectReason": null,
        "auditOpinion": null,
        "executeTime": null,
        "successCount": 0,
        "failCount": 0,
        "executingCount": 0,
        "createdAt": "2025-09-05 14:30:25",
        "updatedAt": "2025-09-05 15:20:15"
    },
    "msg": "SUCCESS"
}

AurellixPay API Documentation ​

Batch Payout Upload Interface ​

Interface Description ​

Request Parameters ​

Response Parameters ​

Batch Payout Query Interface ​

Interface Description ​

Request Parameters ​

Response Parameters ​

Batch Payout Cancellation Interface ​

Interface Description ​

Request Parameters ​

Response Parameters ​

AurellixPay API Documentation

Batch Payout Upload Interface

Interface Description

Request Parameters

Response Parameters

Batch Payout Query Interface

Interface Description

Request Parameters

Response Parameters

Batch Payout Cancellation Interface

Interface Description

Request Parameters

Response Parameters