binance-merchant-pay-api

v1.8.2

Published

a year ago

For Binance Merchant Pay Integration

0High
0Medium
0Low

nawingngan

Binance Merchant Pay Binance Pay Binance Api

Binance Merchant Pay API

If you have any questions, always refer back to the API documentation
https://developers.binance.com/docs/binance-pay/introduction

Installation

npm install binance-merchant-pay-api

Basic Operations

1. Creating Instance

const BinanceMerchantPayAPI = require("binance-merchant-pay-api");
const BINANCE_API_KEY = "";
const BINANCE_SECRET_KEY = "";
const BINANCE_MERCHANT_ID = "";
const BinancePay = new BinanceMerchantPayAPI(
  BINANCE_API_KEY,
  BINANCE_SECRET_KEY,
  BINANCE_MERCHANT_ID,
)

2. Creating Order

// https://developers.binance.com/docs/binance-pay/api-order-create-v3
BinanceMerchantPayAPI
    .createOrder({
        'terminalType': opts.terminalType,
        'merchantId': this.merchantId,
        'merchantTradeNo': opts.merchantTradeNo,
        'orderAmount': opts.orderAmount,
        'currency': opts.currency,
        "description": opts.description,
        "goodsDetails": opts.goodsDetails,
        "returnUrl": opts.returnUrl,
        "cancelUrl": opts.cancelUrl,
        "webhookUrl": opts.webhookUrl
    }).then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

Buyer

Shipping

Merchant

Good Details

3. Query Order

// https://developers.binance.com/docs/binance-pay/api-order-query-v2
BinanceMerchantPayAPI
    .queryOrder({
        'merchantTradeNo': opts.merchantTradeNo,
        'prepayId': opts.prepayId,
    }).then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

4. Close Order

// https://developers.binance.com/docs/binance-pay/api-order-close
BinanceMerchantPayAPI
    .closeOrder({
        'merchantTradeNo': opts.merchantTradeNo,
        'prepayId': opts.prepayId,  
    })
    .then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

Fund Transfer Operations

1. Transfer Fund

// https://developers.binance.com/docs/binance-pay/api-wallet-transfer
BinanceMerchantPayAPI
    .createTransfer({
        'requestId': opts.requestId,
        'currency': opts.currency,  
        'amount': opts.amount,  
        'transferType': opts.transferType,  
    })
    .then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

2. Query Fund

// https://developers.binance.com/docs/binance-pay/api-wallet-transfer-query
BinanceMerchantPayAPI
    .queryTransfer({
        'tranId': opts.tranId,
    })
    .then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

Refund Operations

1. Create Refund

// https://developers.binance.com/docs/binance-pay/api-order-refund
BinanceMerchantPayAPI
    .createRefund({
        'refundRequestId': opts.refundRequestId,
        'prepayId': opts.prepayId,
        'refundAmount': opts.refundAmount,
        'refundReason': opts.refundReason,
        'webhookUrl': opts.webhookUrl,
    })
    .then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

2. Query Refund

// https://developers.binance.com/docs/binance-pay/api-order-refund-query
BinanceMerchantPayAPI
    .queryRefund({
        'refundRequestId': opts.refundRequestId,
    })
    .then((response) => {
        console.log(response)
    }).catch((error) => {
        console.log(error)
    })

Payout Operations

1. Create Payout

// https://developers.binance.com/docs/binance-pay/api-payout
BinanceMerchantPayAPI
    .createPayOut({
        'requestId': opts.requestId,
        'batchName': opts.batchName,
        'currency': opts.currency,
        'totalAmount': opts.totalAmount,
        'totalNumber': opts.totalNumber,
        'bizScene': opts.bizScene,
        'transferDetailList': opts.transferDetailList
    });

Transfer Detail

2. Query Payout

// https://developers.binance.com/docs/binance-pay/api-payout-query
BinanceMerchantPayAPI
    .queryPayOut({
        'requestId': opts.requestId,
    });

3. Validate Payout User

// https://developers.binance.com/docs/binance-pay/api-payout-validate-receiver
BinanceMerchantPayAPI
    .validatePayOutReceiver({
        'receiveType': opts.receiveType,
        'receiverId': opts.receiverId,
        'registrationEmail': opts.registrationEmail,
        'registrationMobileNumber': opts.registrationMobileNumber,
        'registrationMobileCode': opts.registrationMobileCode,
        'openUserId': opts.openUserId,
    });

Wallet Balance

1. Query Balance V1

// https://developers.binance.com/docs/binance-pay/api-balance-query
BinanceMerchantPayAPI
    .queryWalletBalance({
        'wallet': opts.wallet,
        'currency': opts.currency,
    });

2. Query Balance V2

// https://developers.binance.com/docs/binance-pay/api-balance-query-v2
BinanceMerchantPayAPI
    .queryV2WalletBalance({
        'wallet': opts.wallet,
        'currency': opts.currency,
    });

Profit Sharing

1. Add Profit Sharing Receiver

// https://developers.binance.com/docs/binance-pay/api-profitshare-add-receiver
BinanceMerchantPayAPI
    .addProfitSharingReceiver({
        'account': opts.account,
    });

2. Add Profit Sharing Receiver

// https://developers.binance.com/docs/binance-pay/api-profitshare-query-receiver
BinanceMerchantPayAPI
    .queryProfitSharingReceiver({
        'pageNum': opts.pageNum,
        'pageSize': opts.pageSize,
    });

3. Delete Profit Sharing Receiver

// https://developers.binance.com/docs/binance-pay/api-profitshare-delete-receiver
BinanceMerchantPayAPI
    .deleteProfitSharingReceiver({
        'account': opts.account,
    });

4. Create A Profit Split

// https://developers.binance.com/docs/binance-pay/api-profitshare-submit-split
BinanceMerchantPayAPI
    .createSplit({
        'merchantRequestId': opts.merchantRequestId,
        'prepayOrderId': opts.prepayOrderId,
        'receiverList': opts.receiverList,
    });

5. Query A Profit Split

// https://developers.binance.com/docs/binance-pay/api-profitshare-query-split
BinanceMerchantPayAPI
    .querySplit({
        'merchantRequestId': opts.merchantRequestId,
        'prepayOrderId': opts.prepayOrderId,
    });

6. Query A Profit Split

// https://developers.binance.com/docs/binance-pay/api-profitshare-split-return
BinanceMerchantPayAPI
    .returnSplit({
        'prepayOrderId': opts.prepayOrderId,
        'splitOrderNo': opts.splitOrderNo,
        'originMerchantRequestId': opts.originMerchantRequestId,
        'merchantReturnNo': opts.merchantReturnNo,
        'transferOutAccount': opts.transferOutAccount,
        'returnAmount': opts.returnAmount,
        'description': opts.description,
        'webhookUrl': opts.webhookUrl,
    });

Callback Handling

const express = require("express");
const bodyParser = require("body-parser");
const crypto = require("crypto");
const app = express();
const PORT = process.env.PORT || 3000;
const BinanceMerchantPayAPI = require("binance-merchant-pay-api");
const BINANCE_API_KEY = "";
const BINANCE_SECRET_KEY = "";
const BINANCE_MERCHANT_ID = "";
const BinancePay = new BinanceMerchantPayAPI(
  BINANCE_API_KEY,
  BINANCE_SECRET_KEY,
  BINANCE_MERCHANT_ID,
)

app.use(bodyParser.json()); 
// Binance Merchant API callback endpoint

app.post("/binance-webhook", (req, res) => {
    const secretKey = "your_binance_api_secret"; 
    const payload = JSON.stringify(req.body); 
    const signature = req.headers["binancepay-signature"]; 
    const timestamp = req.headers["binancepay-timestamp"];
    const nonce = req.headers["binancepay-nonce"];
    // Generate HMAC SHA-512 signature
    BinancePay.verifyCallbackSignature((verified) => {
        if (!verified) {
            res.status(403).json({ message: "Unauthorized" });
        }
        if (verified) {
            // Process the callback data
            const { bizType, data, bizStatus } = req.body;
            if (bizType === "PAY") { 
                if (bizStatus === "PAY_SUCCESS") {
                    // Do your success operations
                }
            }
            if (bizType === "PAYOUT") {  

            }
            if (bizType === "PAY_REFUND") {  

            }
            res.status(200).json({ message: "Success" });
        }
    })
});
app.listen(PORT, () => console.log(`Server is running on port ${PORT}`));

Summary

If there are any issue, please feel free to contribute and contact me [email protected]
If you find this package useful, please buy me a coffee.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Binance Merchant Pay API

Installation

Basic Operations

1. Creating Instance

2. Creating Order

Buyer

Shipping

Merchant

Good Details

3. Query Order

4. Close Order

Fund Transfer Operations

1. Transfer Fund

2. Query Fund

Refund Operations

1. Create Refund

2. Query Refund

Payout Operations

1. Create Payout

Transfer Detail

2. Query Payout

3. Validate Payout User

Wallet Balance

1. Query Balance V1

2. Query Balance V2

Profit Sharing

1. Add Profit Sharing Receiver

2. Add Profit Sharing Receiver

3. Delete Profit Sharing Receiver

4. Create A Profit Split

5. Query A Profit Split

6. Query A Profit Split

Callback Handling

Summary