Asset Transfer API

Request user asset transfer Wallet->Spots

post
Body
currencystringOptional
amountnumberOptional
Responses
200

OK

*/*
post
/v1/transfer/request/wallet/to/spots
POST /v1/transfer/request/wallet/to/spots HTTP/1.1
Host: dex-api.benpay.com/
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "currency": "text",
  "amount": 1
}
200

OK

{
  "success": true,
  "data": {
    "transferId": "text",
    "success1": true,
    "success2": true,
    "done1": true,
    "done2": true,
    "transferFrom": "WALLET",
    "transferTo": "WALLET",
    "fromUserId": 1,
    "toUserId": 1,
    "amount": 1,
    "errorCode": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "status": "PROCESSING",
    "currency": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Request user asset transfer Wallet->Contracts

post
Body
currencystringOptional
amountnumberOptional
Responses
200

OK

*/*
post
/v1/transfer/request/wallet/to/contracts
POST /v1/transfer/request/wallet/to/contracts HTTP/1.1
Host: dex-api.benpay.com/
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "currency": "text",
  "amount": 1
}
200

OK

{
  "success": true,
  "data": {
    "transferId": "text",
    "success1": true,
    "success2": true,
    "done1": true,
    "done2": true,
    "transferFrom": "WALLET",
    "transferTo": "WALLET",
    "fromUserId": 1,
    "toUserId": 1,
    "amount": 1,
    "errorCode": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "status": "PROCESSING",
    "currency": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Request user asset transfer Spots->Wallet

post
Body
currencystringOptional
amountnumberOptional
Responses
200

OK

*/*
post
/v1/transfer/request/spots/to/wallet
POST /v1/transfer/request/spots/to/wallet HTTP/1.1
Host: dex-api.benpay.com/
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "currency": "text",
  "amount": 1
}
200

OK

{
  "success": true,
  "data": {
    "transferId": "text",
    "success1": true,
    "success2": true,
    "done1": true,
    "done2": true,
    "transferFrom": "WALLET",
    "transferTo": "WALLET",
    "fromUserId": 1,
    "toUserId": 1,
    "amount": 1,
    "errorCode": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "status": "PROCESSING",
    "currency": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Request user asset transfer Contracts->Wallet

post
Body
currencystringOptional
amountnumberOptional
Responses
200

OK

*/*
post
/v1/transfer/request/contracts/to/wallet
POST /v1/transfer/request/contracts/to/wallet HTTP/1.1
Host: dex-api.benpay.com/
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "currency": "text",
  "amount": 1
}
200

OK

{
  "success": true,
  "data": {
    "transferId": "text",
    "success1": true,
    "success2": true,
    "done1": true,
    "done2": true,
    "transferFrom": "WALLET",
    "transferTo": "WALLET",
    "fromUserId": 1,
    "toUserId": 1,
    "amount": 1,
    "errorCode": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "status": "PROCESSING",
    "currency": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Get currencyMappings related information

get
Responses
200

OK

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

OK

{
  "success": true,
  "data": [
    {
      "currencyId": 1,
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "iconUrl": "text"
    }
  ],
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query user wallet asset balance information

get
Responses
200

OK

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

OK

{
  "success": true,
  "data": {
    "ANY_ADDITIONAL_PROPERTY": [
      1
    ]
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query transfer request information by transferId

get
Path parameters
transferIdstringRequired
Responses
200

OK

*/*
get
/v1/transfer/{transferId}/request
GET /v1/transfer/{transferId}/request HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "transferId": "text",
    "success1": true,
    "success2": true,
    "done1": true,
    "done2": true,
    "transferFrom": "WALLET",
    "transferTo": "WALLET",
    "fromUserId": 1,
    "toUserId": 1,
    "amount": 1,
    "errorCode": "text",
    "createdAt": 1,
    "updatedAt": 1,
    "status": "PROCESSING",
    "currency": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Query transfer log list information by transferId

get
Path parameters
transferIdstringRequired
Responses
200

OK

*/*
get
/v1/transfer/{transferId}/log
GET /v1/transfer/{transferId}/log HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*
200

OK

{
  "success": true,
  "data": [
    {
      "id": 1,
      "transferId": "text",
      "receiver": true,
      "done": true,
      "success": true,
      "userId": 1,
      "accountId": 1,
      "transferFrom": "WALLET",
      "transferTo": "WALLET",
      "amount": 1,
      "createdAt": 1,
      "updatedAt": 1,
      "currency": "text"
    }
  ],
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Paginated query of transfer log list information

get
Query parameters
offsetIdinteger · int64OptionalDefault: 0
maxResultsinteger · int32OptionalDefault: 100
Responses
200

OK

*/*
get
/v1/transfer/transfer/logs
GET /v1/transfer/transfer/logs HTTP/1.1
Host: dex-api.benpay.com/
Accept: */*
200

OK

{
  "hasMore": true,
  "nextOffsetId": 1,
  "results": [
    {
      "id": 1,
      "transferId": "text",
      "receiver": true,
      "done": true,
      "success": true,
      "userId": 1,
      "accountId": 1,
      "transferFrom": "WALLET",
      "transferTo": "WALLET",
      "amount": 1,
      "createdAt": 1,
      "updatedAt": 1,
      "currency": "text"
    }
  ]
}
PreviousDeposit & Withdrawal API

Last updated