Giters

xup6m6fu04 / bitwin-sdk-go

Bitwin API version.3 SDK for Go

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This project is no longer available！

Bitwin SDK for Go (v3)

🌍 English ∙ 繁體中文 ∙ 简体中文

Build Status FOSSA Status codecov GoDoc Go Report Card

Introduction

The BITWIN SDK for Go makes it easy to develop bots using BITWIN merchant api, and you can create a sample client within minutes.

Documentation

See the official API documentation for more information.

Requirements

This library requires Go 1.13 or later.

Installation

$ go get -u github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin

Configuration

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    ...
}

Example

Create Crypto Pay Order

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    // true will be production environment, default is false (test environment)
    client.CreateCryptoPayOrder.SetIsProdEnvironment(false)
    client.CreateCryptoPayOrder.SetMerchantUserID("YOZERO_USER_0000001")
    client.CreateCryptoPayOrder.SetMerchantOrderID("YOZERO_ORDER_0000001")
    client.CreateCryptoPayOrder.SetOrderDescription("YOZERO_DESC_0000001")
    client.CreateCryptoPayOrder.SetAmount("700000000") // 7 USDT
    client.CreateCryptoPayOrder.SetMerchantRMB("45.38")
    client.CreateCryptoPayOrder.SetSymbol("USDT_ERC20")
    client.CreateCryptoPayOrder.SetCallBackURL("https://yourdomain/api/callback")
    client.CreateCryptoPayOrder.SetTimeStamp(strconv.Itoa(int(time.Now().Unix())))
    // You can use variable "execute" to check server result
    execute, err := client.CreateCryptoPayOrder.Execute()
    if err != nil {
        fmt.Print(err)
        return
    }
    empJSON, err := json.MarshalIndent(execute, "", "    ")
    if err != nil {
        fmt.Print(err)
        return
    }
    fmt.Printf("CreateCryptoPayOrder Response\n%s\n", string(empJSON))
}

If Success Printf result will be like

CreateCryptoPayOrder Response
{
    "OrderId": "53190266162719072",
    "Qrcode": "https://stage-api.bitwin.ai/order/53190266162719072",
    "Amount": "700000000",
    "RealAmount": "700000000",
    "CryptoWallet": "0x54420B5AB4a26Aa294C4F039052Ca3A7069E2C99",
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "474A8E4E3A8FF8FDC5D392BDCB4672D9"
}

Query Crypto Pay Order

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    // true will be production environment, default is false (test environment)
    client.QueryCryptoPayOrder.SetIsProdEnvironment(false)
    // SetMerchantOrderID or SetOrderID just choose one (or both)
    client.QueryCryptoPayOrder.SetMerchantOrderID("YOZERO_ORDER_0000001")
    client.QueryCryptoPayOrder.SetOrderID("53190266162719072")
    client.QueryCryptoPayOrder.SetTimeStamp(strconv.Itoa(int(time.Now().Unix())))
    // You can use variable "execute" to check server result
    execute, err := client.QueryCryptoPayOrder.Execute()
    if err != nil {
        fmt.Print(err)
        return
    }
    empJSON, err := json.MarshalIndent(execute, "", "    ")
    if err != nil {
        fmt.Print(err)
        return
    }
    fmt.Printf("QueryCryptoPayOrder Response\n%s\n", string(empJSON))
}

If user not paid yet, Printf result will be like

QueryCryptoPayOrder Response
{
    "OrderId": "53190266162719072",
    "MerchantOrderId": "YOZERO_ORDER_0000001",
    "MerchantUserId": "YOZERO_USER_0000001",
    "OrderDescription": "YOZERO_DESC_0000001",
    "Symbol": "USDT_ERC20",
    "Amount": "700000000",
    "RealAmount": "700000000",
    "MerchantRMB": "45.38",
    "ExchangeRMB": "45.85",
    "OrderStatus": "PENDING",
    "CallBackUrl": "https://yourdomain/api/callback",
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "8B7FA6A133EB46FEBBEA21870FE36C4E"
}

If user paid, Printf result will be like

QueryCryptoPayOrder Response
{
    "OrderId": "53190266162719072",
    "MerchantOrderId": "YOZERO_ORDER_0000001",
    "MerchantUserId": "YOZERO_USER_0000001",
    "OrderDescription": "YOZERO_DESC_0000001",
    "Symbol": "USDT_ERC20",
    "Amount": "700000000",
    "RealAmount": "700000000",
    "MerchantRMB": "45.38",
    "ExchangeRMB": "45.85",
    "OrderStatus": "SUCCESS",
    "CallBackUrl": "https://yourdomain/api/callback",
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "1227B59B65769CC8E497228638A54D40"
}

If user paid, your callback server will receive JSON like

{
  "MerchantId": "<Merchant ID>",
  "MerchantOrderId": "YOZERO_ORDER_0000001",
  "OrderId": "53190266162719072",
  "Symbol": "USDT_ERC20",
  "Amount": "700000000",
  "PayAmount": "700000000",
  "MerchantRMB": "45.38",
  "ExchangeRMB": "45.85",
  "PayUnixTimestamp": 1628563840,
  "Sign": "78AEA2AEA64681F2CE96AE537CDDFADA"
}

Please see the official API documentation for more information.

Merchant Withdraw

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    // true will be production environment, default is false (test environment)
    client.MerchantWithdraw.SetIsProdEnvironment(false)
    client.MerchantWithdraw.SetMerchantUserID("YOZERO_USER_0000001")
    client.MerchantWithdraw.SetMerchantWithdrawID("YOZERO_WITHDRAW_0000001")
    client.MerchantWithdraw.SetUserWallet("0x875EDa094F03Ed4c93adb3dbb77913F860dC888f")
    client.MerchantWithdraw.SetAmount("1000000000") // 10 USDT
    client.MerchantWithdraw.SetMerchantRMB("64.81")
    client.MerchantWithdraw.SetSymbol("USDT_ERC20")
    client.MerchantWithdraw.SetCallBackURL("https://yourdomain/api/callback")
    client.MerchantWithdraw.SetTimeStamp(strconv.Itoa(int(time.Now().Unix())))
    // You can use variable "execute" to check server result
    execute, err := client.MerchantWithdraw.Execute()
    if err != nil {
        fmt.Print(err)
        return
    }
    empJSON, err := json.MarshalIndent(execute, "", "    ")
    if err != nil {
        fmt.Print(err)
        return
    }
    fmt.Printf("MerchantWithdraw Response\n%s\n", string(empJSON))
}

If success, Printf result will be like

MerchantWithdraw Response
{
    "WithdrawId": "53192080311396704",
    "MerchantWithdrawId": "YOZERO_WITHDRAW_0000001",
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "878DCEE083E966D661DD2070B968850D"
}

Query Merchant Withdraw

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    // true will be production environment, default is false (test environment)
    client.QueryMerchantWithdraw.SetIsProdEnvironment(false)
    // SetMerchantWithdrawID or SetWithdrawID just choose one (or both)
    client.QueryMerchantWithdraw.SetMerchantWithdrawID("YOZERO_WITHDRAW_0000001")
    client.QueryMerchantWithdraw.SetWithdrawID("53192080311396704")
    client.QueryMerchantWithdraw.SetTimeStamp(strconv.Itoa(int(time.Now().Unix())))
    // You can use variable "execute" to check server result
    execute, err := client.QueryMerchantWithdraw.Execute()
    if err != nil {
        fmt.Print(err)
        return
    }
    empJSON, err := json.MarshalIndent(execute, "", "    ")
    if err != nil {
        fmt.Print(err)
        return
    }
    fmt.Printf("QueryMerchantWithdraw Response\n%s\n", string(empJSON))
}

If withdraw pending, Printf result will be like

QueryMerchantWithdraw Response
{
    "MerchantUserId": "YOZERO_USER_0000001",
    "UserWallet": "0x875EDa094F03Ed4c93adb3dbb77913F860dC888f",
    "MerchantWithdrawId": "YOZERO_WITHDRAW_0000001",
    "WithdrawId": "53192080311396704",
    "Symbol": "USDT_ERC20",
    "Amount": "1000000000",
    "MerchantRMB": "64.81",
    "ExchangeRMB": "68.00",
    "Status": "PENDING",
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "0D7827A91A2DFEC4A37930B7B63CB3D7"
}

If withdraw success, Printf result will be like

QueryMerchantWithdraw Response
{
    "MerchantUserId": "YOZERO_USER_0000001",
    "UserWallet": "0x875EDa094F03Ed4c93adb3dbb77913F860dC888f",
    "MerchantWithdrawId": "YOZERO_WITHDRAW_0000001",
    "WithdrawId": "53192080311396704",
    "Symbol": "USDT_ERC20",
    "Amount": "1000000000",
    "MerchantRMB": "64.81",
    "ExchangeRMB": "68.00",
    "Status": "SUCCESS",
    "WithdrawDateTime": 1628565087,
    "ApprovedDateTime": 1628564721,
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "0031A5895817164033D39618C4C687B1"
}

If withdraw success, your callback server will receive JSON like

{
  "MerchantId": "<Merchant ID>",
  "MerchantUserId": "YOZERO_USER_0000001",
  "MerchantWithdrawId": "YOZERO_WITHDRAW_0000001",
  "UserWallet": "0x875EDa094F03Ed4c93adb3dbb77913F860dC888f",
  "WithdrawId": "53192080311396704",
  "WithdrawAmount": "1000000000",
  "MerchantRMB": "64.81",
  "ExchangeRMB": "68.00",
  "Symbol": "USDT_ERC20",
  "ReplyDateTime": 1628565087,
  "Sign": "AA367497C3BC87FC4E544D669C58DDAF"
}

Please see the official API documentation for more information.

Exchange Rate

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    // true will be production environment, default is false (test environment)
    client.ExchangeRate.SetIsProdEnvironment(false)
    client.ExchangeRate.SetSymbol("USDT_ERC20")
    // You can use variable "execute" to check server result
    execute, err := client.ExchangeRate.Execute()
    if err != nil {
        fmt.Print(err)
        return
    }
    empJSON, err := json.MarshalIndent(execute, "", "    ")
    if err != nil {
        fmt.Print(err)
        return
    }
    fmt.Printf("ExchangeRate Response\n%s\n", string(empJSON))
}

Printf result will be like

ExchangeRate Response
{
    "RMBRate": "6.55",
    "RMBBuyRate": "6.80",
    "ReturnCode": "200",
    "ReturnMessage": ""
}

Build Relation User

import (
    "github.com/xup6m6fu04/bitwin-sdk-go/v3/bitwin"
)

func main() {
    client := bitwin.New("<Merchant ID>", "<Merchant Sign key>", "<Access key>")
    // true will be production environment, default is false (test environment)
    client.BuildRelationUser.SetIsProdEnvironment(false)
    client.BuildRelationUser.SetMerchantUserID("YOZERO_USER_0000001")
    client.BuildRelationUser.SetCallBackURL("https://yourdomain/api/callback")
    client.BuildRelationUser.SetTimeStamp(strconv.Itoa(int(time.Now().Unix())))
    // You can use variable "execute" to check server result
    execute, err := client.BuildRelationUser.Execute()
    if err != nil {
        fmt.Print(err)
        return
    }
    empJSON, err := json.MarshalIndent(execute, "", "    ")
    if err != nil {
        fmt.Print(err)
        return
    }
    fmt.Printf("BuildRelationUser Response\n%s\n", string(empJSON))
}

Printf result will be like

BuildRelationUser Response
{
    "QrcodeData": "BITWIN$eyJhY3Rpb24iOiJtb2JpbGUvdjMvdXNlci9iaW5kIiwiZGF0YSI6eyJuYW1lIjoiOTkwODg1MzBEMDkzQzRDRkY0MzEyRjAyRUY3RkI1RjYiLCJjb2RlIjoiRUhrSWoiLCJtZXJjaGFudF9uYW1lIjoieW96ZXJvIn19",
    "QrcodeImageUrl": "https://stage-api.bitwin.ai/web/v3/bind/user/99088530D093C4CFF4312F02EF7FB5F6",
    "ReturnCode": "200",
    "ReturnMessage": "",
    "Sign": "414E783ECC46DB9403916694741DF275"
}

After user scan, your callback server will receive JSON like

{
  "MerchantId": "<Merchant ID>",
  "MerchantUserId": "YOZERO_USER_0000001",
  "UserName": "48847933077253904",
  "BTC": "2My4ttAncyVKbAQWwAMLsG7JCMif3KkpHBC",
  "ETH": "0xe4f3Ad1005ac2FbD22f7F22871A8Ea1d688866a0",
  "USDT_ERC20": "0x7F8FAe2d400cD767d4184638eD296DBc44F218Bb",
  "USDT_TRC20": "TYGzJX3tyDy81eQGGw92US821LiykuHPFi",
  "USDT_BEP20": "0x84e6B02d0223c004bc350F481038371Cfd7e4512",
  "Sign": "9C516FBC1513EB54CC628C7AB5C105AF"
}

Versioning

This project respects semantic versioning.

See http://semver.org/

License

FOSSA Status

About

Bitwin API version.3 SDK for Go

License:MIT License

Languages

Language:Go 99.1%Language:Shell 0.9%