Deposit & Withdrawal API

User withdrawal request (get requestId)

post

Body

application/json

currencyIdinteger · int64Optional

amountnumberOptional

addressstringOptional

Responses

200

OK

*/*

post

/v1/wallet/withdraws/requestId

HTTPcURLJavaScriptPython

POST /v1/wallet/withdraws/requestId HTTP/1.1
Host: dex-api.benpay.com/
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "currencyId": 1,
  "amount": 1,
  "address": "text"
}

200

OK

{
  "success": true,
  "data": {
    "bfcAddress": "text",
    "action": "SIGNIN",
    "withdrawId": 1,
    "coinType": "text",
    "amount": "text",
    "chainId": 1,
    "expires": 1,
    "hash": "text",
    "payload": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

User withdrawal signature

post

Body

application/json

bfcAddressstringOptional

BFC address

actionstring · enumOptional

Action

Possible values:

withdrawIdinteger · int64Optional

Withdrawal id

coinTypestringOptional

amountstringOptional

chainIdinteger · int64Optional

expiresinteger · int64Optional

hashstringOptional

signaturestringOptional

Responses

200

OK

*/*

post

/v1/wallet/withdraw/sign

HTTPcURLJavaScriptPython

POST /v1/wallet/withdraw/sign HTTP/1.1
Host: dex-api.benpay.com/
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "bfcAddress": "text",
  "action": "SIGNIN",
  "withdrawId": 1,
  "coinType": "text",
  "amount": "text",
  "chainId": 1,
  "expires": 1,
  "hash": "text",
  "signature": "text"
}

200

OK

{
  "success": true,
  "data": true,
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query user withdrawal request list records

get

Query parameters

offsetIdinteger · int64OptionalDefault: 0

maxResultsinteger · int32OptionalDefault: 100

Responses

200

OK

*/*

get

/v1/wallet/withdraws

HTTPcURLJavaScriptPython

GET /v1/wallet/withdraws HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "id": 1,
        "createdAt": 1,
        "updatedAt": 1,
        "withdrawId": 1,
        "userId": 1,
        "currency": "text",
        "chainId": 1,
        "token": "text",
        "tokenDecimals": 1,
        "amount": 1,
        "status": "INIT",
        "txHash": "text",
        "expiresAt": 1,
        "operator": "text",
        "withdrawFor": "text",
        "approvedCount": 1,
        "requiredCount": 1,
        "validators": "text",
        "approvalStatus": "text",
        "userSig": "text",
        "usdQuotedAmount": 1,
        "usdQuotedPrice": 1
      }
    ]
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query user withdrawal request list records

get

Query parameters

requestIdinteger · int64OptionalDefault: 0

Responses

200

OK

*/*

get

/v1/wallet/queryWithdrawById

HTTPcURLJavaScriptPython

GET /v1/wallet/queryWithdrawById HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "id": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "withdrawId": 1,
    "userId": 1,
    "currency": "text",
    "chainId": 1,
    "token": "text",
    "tokenDecimals": 1,
    "amount": 1,
    "status": "INIT",
    "txHash": "text",
    "expiresAt": 1,
    "operator": "text",
    "withdrawFor": "text",
    "approvedCount": 1,
    "requiredCount": 1,
    "validators": "text",
    "approvalStatus": "text",
    "userSig": "text",
    "usdQuotedAmount": 1,
    "usdQuotedPrice": 1
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query user deposit log list records

get

Query parameters

offsetIdinteger · int64OptionalDefault: 0

maxResultsinteger · int32OptionalDefault: 100

Responses

200

OK

*/*

get

/v1/wallet/deposits

HTTPcURLJavaScriptPython

GET /v1/wallet/deposits HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "id": 1,
        "txHash": "text",
        "currency": "text",
        "blockHash": "text",
        "blockNumber": 1,
        "blockTimestamp": 1,
        "operator": "text",
        "depositFor": "text",
        "token": "text",
        "amount": 1,
        "removed": true
      }
    ]
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query user wallet account inflow and outflow list information

get

Query parameters

rangestringOptionalDefault: ""

currencystringOptionalDefault: ""

offsetIdinteger · int64OptionalDefault: 0

limitinteger · int32OptionalDefault: 100

Responses

200

OK

*/*

get

/v1/wallet/flows

HTTPcURLJavaScriptPython

GET /v1/wallet/flows HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "id": 1,
        "currency": "text",
        "flowType": "DEPOSIT",
        "sign": true,
        "amount": 1,
        "createdAt": 1
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}