Get off-ramp order detail

This endpoint is used to retrieve detailed information about an off-ramp order based on the specified order_id. The details include the transaction amount, payment method, status, and cryptocurrency purchased.

API end-point

POST /api/v2/orders/details

Headers

Name	Value
Content-Type	application/json
lang	The default will en if this param has been empty. Supported languages:en|cn|vi

Request Body

Name	Type	Condition	Description
partnerCode	string	required	Code of of the partner
signature	string	required	The signature created with SHA256 by using RSA created private key of partner The public key that has been provided to you during onboarding. The data shall be signed according to the structure: partnerCode|externalOrderId|secretKey
externalOrderId	string	required	This unique id for order created and managed in partner side. It will keep the update for transaction status after created it

Response

200

{
  "externalOrderId": "string",
  "type": "string",
  "fiatAmount": 0,
  "paidAmount": 0,
  "tokenTransfer": {
    "currency": "string",
    "network": "string",
    "price": 0,
    "amount": 0,
    "walletAddress": "string",
    "txHash": "string"
  },
  "bankTransfer": {
    "bankAccountName": "string",
    "bankAccountNumber": "string",
    "bankName": "string",
    "contentPayment": "string",
    "totalPayment": 0,
    "qrUrl": "string"
  },
  "fees": {
    "systemFee": 0,
    "processingFee": 0
  },
  "status": "string", // AWAITING_PAYMENT | PAYMENT_COMPLETED | PROCESSING_TOKEN_TRANSFER | SUCCESS | ERROR 
  "description": "string",
  "createdAt": "string",
  "expiresAt": "string",
  "signature": "string"
}

400

Signature

• Partner will digitally sign the transmitted data using SHA256 with RSA algorithm

• The private key that has been of yours

• Data shall be signed according to the structure externalOrderId|type|fiatAmount|status|secretKey

How to create and verify the signature

1. Creation

import * as crypto from 'crypto';

function create(data: string, privateKey: string): string 
{
  const signer = crypto.createSign('RSA-SHA256');
  signer.update(data);
  signer.end();

  return signer.sign(privateKey, 'base64');
}

2. Verification

function verify (data: string, signature: string, pubKey: string): boolean
{
        const verify = createVerify('RSA-SHA256');
        verify.update(data);
        verify.end();
        return verify.verify(pubKey, signature, 'base64');
}

Transaction status

Please refer the order status

Status name	Description
AWAITING_PAYMENT	The order created successfully. It is waiting (please wait IPN or manual check with operation)
PAYMENT_COMPLETED	When payment has transferred from AliX Pay to your customer bank account
PROCESSING_TOKEN_TRANSFER	When the token has deducted from your account wallet on AliX Pay
SUCCESS	When an transaction has completed
ERROR	When an transaction has error with any reasons