Rest API

Rest API

General API Information
HTTP Return Codes
  • HTTP 4XX return codes are used for malformed requests; the issue is on the sender's side.
  • HTTP 403 return code is used when the WAF Limit (Web Application Firewall) has been violated.
  • HTTP 429 return code is used when breaking a request rate limit.
  • HTTP 418 return code is used when an IP has been auto-banned for continuing to send requests after receiving 429 codes.
  • HTTP 5XX return codes are used for internal errors; the issue is on Binance's side. It is important to NOT treat this as a failure operation; the execution status is UNKNOWN and could have been a success.
General Information on Endpoints
  • For GET endpoints, parameters must be sent as a query string.
  • For POST, PUT, and DELETE endpoints, the parameters may be sent as a json object or array or in the request body with content type application/json.
  • Parameters may be sent in any order.
  • If a parameter sent in both the query string and request body, the query string parameter will be used.
Terminology
  • These terms will be used throughout the documentation, so it is recommended especially for new users to read to help their understanding of the API.

Sign Up Endpoints

Entity Information

End points : https://api.paycircle.io:8443/Api/custody

Return an entity information details.

HTTP REQUEST : POST

/addCustodyEntityInfo

Request Body:

brokerEntityInfo:{

"name":"TarunBibar",

"registrationType":"custody",

"dba":"TarunBibar",

"orgType":"Orgi",

"regDate":"12/22/2020",

"corpIdNo":"123444",

"entityActivity":"qeqwewe",

"entityGroupDesc":"qeqwewe"

}

corpArticlesDoc: (binary)

corpTaxIdDoc: (binary)

Response Body:

{

"Code":0,

"entityId":201,

"message":"Entity info has been successfully saved !"

}

Office Information

End points : https://api.paycircle.io:8443/Api/custody

Return an entity office information details.

HTTP REQUEST : POST

/addCustodyOfficeInfo

Request Body:

{

"entityId":"201",

"directorName":"eqwqewr",

"directorDesignation":"zxczxczc",

"directorEmail":"rupam.hashcash@gmail.com",

"directorFaxNo":"12344",

"directorMobileNo":"12123123",

"directorPassportNo":"`123`123",

"directorTelephoneNo":"+919903480303",

"complianceDesignation":"eqwrwqe",

"complianceEmail":"rupam.hashcash@gmail.com",

"complianceFaxNo":"1232`13",

"complianceMobileNo":"123",

"complianceName":"Hahscash",

"compliancePassportNo":"`2131`3",

"complianceTelephoneNo":"+919903480303"

}

Response Body:

{

"Code":0,

"message":"Personnel Information successfully saved"

}

Personal Information

End points : https://api.paycircle.io:8443/Api/custody

Return an entity personal information details.

HTTP REQUEST : POST

/addCustodyPersonalInfo

Request Body:

{

"entityId":"201",

"directorName":"eqwqewr",

"directorDesignation":"zxczxczc",

"directorEmail":"rupam.hashcash@gmail.com",

"directorFaxNo":"12344",

"directorMobileNo":"12123123",

"directorPassportNo":"123123",

"directorTelephoneNo":"+919903480303",

"complianceDesignation":"eqwrwqe",

"complianceEmail":"rupam.hashcash@gmail.com",

"complianceFaxNo":"1232`13",

"complianceMobileNo":"123",

"complianceName":"Rupam Jana",

"compliancePassportNo":"21313",

"complianceTelephoneNo":"+919903480303"

}

Response Body:

{

"Code":0,

"message":"Personnel Information successfully saved"

}

Corporate Bank Information

End points : https://api.paycircle.io:8443/Api/custody

Return an entity bank information details.

HTTP REQUEST : POST

/addCustodyCorporateBankInfo

Request Body:

{

"entityId":"201",

"bankAddress":"qweqwe",

"bankName":"eeee",

"accountType":"current"

}

Response Body:

{

"Code":0,

"message":"Broker Corp Bank information successfully saved !"

}

Association Information

End points : https://api.paycircle.io:8443/Api/custody

Return an entity association information details.

HTTP REQUEST : POST

/addCustodyAssociationInfo

Request Body:

{

"entityId":"201",

"brokerAssociationInfoList":[

{

"category":"Owners1",

"name":"1123123",

"ssnPassportNo":"sdafsd",

"corpIdNo":"dsafsdf"

}]

}

Response Body:

{

"Code":0,

"message":"Broker association successfully saved !"

}

Disclosure Information

End points : https://custody-admin.paybito.com:8443/Api/custody

Return an Disclosure information details.

HTTP REQUEST : POST

/addCustodyDisclosureInfo

Request Body:

{

"entityId":"201",

"check1":"Y",

"check2":"Y",

"check3":"Y",

"check4":"Y",

"check5":"Y",

"check6":"Y",

"check7":"Y",

"agree":"Y"

}

Response Body:

{

"Code":0,

"message":"message":"Broker disclosure successfully saved !"

}

All Custody Information

End points : https://custody-admin.paybito.com:8443/Api/custody/getAllBrokers

HTTP REQUEST : GET

Name Type Mandatory Description
searchValue String Yes
totalRow String Yes
fromRow String Yes

Response Body:

{

"totalRow":3,

"code":0,

"allBrokers":[

{

"entityId":201,

"brokerId":null,

"registrationType":null,

"name":"Tarun Bibar",

"dba":null,

"orgType":null,

"regDate":null,

"corpIdNo":null,

"entityActivity":null,

"entityGroupDesc":null,

"corpArticlesDoc":null,

"corpTaxIdDoc":null,

"createdOn":"2021-03-31 15:43:40.11366",

"updatedOn":null,

"status":0

}

]

"message":""

}

Individual Custody Information

End points : https://custody-admin.paybito.com:8443/Api/custody/getCustodyDetails

HTTP REQUEST : GET

Name Type Mandatory Description
entityId int Yes Entity Id may an integer number like 1, 2, 3,123 etc.

Response Body:

{

"corpBankInfo":[

{

"entityId":201,

"bankName":"eeee",

"bankAddress":"qweqwe",

"accountType":"current",

"referenceLettersDoc":"ReferenceLetter.pdf"

}],

"code":0,

"entityInfo":[

{

"entityId":201,

"brokerId":null,

"registrationType":"custody",

"name":"Tarun Bibar",

"dba":"Tarun Bibar",

"orgType":"Hashcash",

"regDate":"12/22/2020",

"corpIdNo":"123444",

"entityActivity":"qeqwewe",

"entityGroupDesc":"qeqwewe",

"corpArticlesDoc":"ArticlesDoc.pdf",

"corpTaxIdDoc":"TaxIdDoc.pdf",

"createdOn":"2021-03-31 15:43:40.11366",

"updatedOn":null,

"status":0

}],

"associationInfo":[

{

"category":"Owners1",

"name":"1123123",

"ssnPassportNo":"sdafsd",

"corpIdNo":"dsafsdf"},

{

"category":"Owners2",

"name":"fdsf",

"ssnPassportNo":"Rupam",

"corpIdNo":"Rupam"

},

{

"category":"Owners3",

"name":"Rupam",

"ssnPassportNo":"sdfsd",

"corpIdNo":"dsfasdf"

},{

"category":"Owners4",

"name":"fff",

"ssnPassportNo":"dsafs",

"corpIdNo":"dsfasdf"

},

{

"category":"Owners5",

"name":"sdfsd",

"ssnPassportNo":"None, Near St. Berchmanns school",

"corpIdNo":"sdfsdf"

},

{

"category":"Owners6",

"name":"dsfsdf",

"ssnPassportNo":"dsafsdf",

"corpIdNo":"dsafsdf"

}]

"personnelInfo":[

{

"entityId":201,

"directorName":"eqwqewr",

"directorTelephoneNo":"+919903480303",

"directorFaxNo":"12344",

"directorMobileNo":"12123123",

"directorEmail":"rupam.hashcash@gmail.com",

"directorPassportNo":"`123`123",

"complianceName":"Rupam Jana",

"complianceDesignation":"eqwrwqe",

"complianceTelephoneNo":"+919903480303",

"complianceFaxNo":"1232`13",

"complianceMobileNo":"123",

"complianceEmail":"rupam.hashcash@gmail.com",

"compliancePassportNo":"21313"

}],

"message":"",

"officeInfo":[

{

"entityId":201,

"regAddress":"bwwww",

"regCity":"Kolkata",

"regCountry":"India",

"regState":"West Bengal",

"regZipCode":"700141",

"regAreaCode":"99034",

"regTelephoneNo":"80303",

"regFaxNo":"111111",

"regEmail":"rupam.hashcash@gmail.com",

"regWebsite":"111111",

"correspondenceAddress":"None",

"correspondenceCity":"Kolkata",

"correspondenceCountry":"India",

"correspondenceState":"West Bengal",

"regZipCode":"700141",

"regAreaCode":"99034",

"regTelephoneNo":"80303",

"regFaxNo":"111111",

"regEmail":"rupam.hashcash@gmail.com",

"regWebsite":"111111",

"correspondenceAddress":"None",

"correspondenceCity":"Kolkata",

"correspondenceCountry":"India",

"correspondenceState":"West Bengal",

"correspondenceZipCode":"700141",

"correspondenceAreaCode":"99034",

"correspondenceTelephoneNo":"80303",

"correspondenceFaxNo":"1111",

"correspondenceEmail":"rupam.hashcash@gmail.com",

"correspondenceWebsite":"1111",

"branchAddress":"None",

"branchCity":"Kolkata",

"branchCountry":"India",

"branchState":"West Bengal",

"branchZipCode":"700141",

"branchAreaCode":"99034",

"branchTelephoneNo":"80303",

"branchFaxNo":"11111111111111",

"branchEmail":"rupam.hashcash@gmail.com",

"branchWebsite":"111111"

}]

}

Update Custody Status

End points : https://custody-admin.paybito.com:8443/Api/custody

Update an entity which is pending. By this API pending status is confirmed. An email will be send to the register email with custody Id and temporary password. This credentials are useful .for exchange login.

HTTP REQUEST : POST

/updateCustodyStatus

Request Body:

{

"entityId":"201",

"Status":1

}

Response Body:

{

"brokerId":"TARU31032021160617",

"Code":0,

"message":"Broker status successfully updated !"

}

Login Endpoint

Custody Login

End points : https://custody-admin.paybito.com:8443/Api/custody/getCustodyLogin

HTTP REQUEST : GET

Name Type Mandatory Description
userId String yes User id is the custody Id what would be sent in the register email.
password String yes Password also sends in email.

Response Body:

{"code":0,"Message":"Broker User ID and Passwaord successfully Checked!","message":""}

Balance Endpoint

Custody User Balance

End points : https://custody-admin.paybito.com:8443/Api/custody/getAllCustodyBalance

HTTP REQUEST : GET

Name Type Mandatory Description
ClientId String yes Client id is also user id. Already discuss above.
CurrencyId String yes

Currency id:

BTC=2

ETH=3

BCH=4

LTC=7

USDT=16

BAT=24

LINK=25

Response Body:

{

"TotalBalance":7.0001,

"code":0,

"ResultSet":[

{

"clientId":"TEST17032021170620",

"customerId":"1352",

"currencyName":"BTC",

"current_balance":"4"}],

"message":""

}

Portfolio Endpoint

Portfolio Graph

End points : https://custody-admin.paybito.com:8443/Api/custody

Return the value of graph

HTTP REQUEST : POST

/getCustodyPortfolio

Request Body:

{

"fromDate":"2021-03-03",

"toDate":"2021-03-31",

"userId":"TEST17032021170620",

"chartDuration":"1d"

}

Response Body:

{

"code": 0,

"ResultSet": [

{

"histDate": "2021-03-25 10:45:00",

"value": "364000"

}]

}

History Endpoint

History of Send and Received

End points : https://custody-admin.paybito.com:8443/Api/custody

HTTP REQUEST : POST

/getCustodyClientHistory

Request Body:

{

"clientId":"TEST17032021170620",

"txnType":"send",

"totalRowPerPage":1,

"pageNo":1

}

Response Body:

{

"code": 0,

"TotalRow": 6,

"ResultSet": [

{

"rnum": "1",

"transactionId": "103170220",

"clientId": "TEST17032021170620",

"userId": "1452",

"fullName": "Test Custody",

"description": "send to other",

"action": "Send",

"status": 1,

"txnDate": "18-03-2021 14:37:50",

"orderId": null,

"tradeId": "0",

"offerId": "0",

"offerQty": "0",

"offerPrice": "0",

"requestAmount": "0",

"requestPrice": "0",

"currency": "ETH",

"baseCurrency": null,

"currencytxnid": null,

"debitAmount": "0.009",

"creditAmount": "0",

"miningFees": "0.0001",

"txnCharge": "0",

"networkFees": "0",

"openingBalance": "0",

"closingBalance": "0",

"tradeAssetAmount": "ETH 0.009 Dr.",

"currencyUrl": "https://etherscan.io/tx/"

}

]

"message": ""

}

Fetch ROC and Price

End points : https://custody-admin.paybito.com:8443/Api/custody/getBrokerRocandPrice

Internally insert in ROC and Price

HTTP REQUEST : POST

Request Body:no

Response Body:

{

"code": 0,

"ReturnId":1,,

"ResultSet": [

{

"currencyId":1,

"currencyCode":"USD",

"closingBalance":0.0,

"sendAccess":0,

"receiveAccess":0,

"lastPrice":"0",

"roc":0.0,

"holdingInUsd":"0",

"totalBuy":0.0,

"totalSell":0.0,

"currencyType":1,

"walletOrder":"1",

}]

"message": ""

}

Monitor Balance Endpoint

End points : https://custody-admin.paybito.com:8443/AdminModel/admin

HTTP REQUEST : POST

/walletBalance

Request Body:

{

"currencyid":2,

}

Response Body:

[

{

"nodeBalance": "3",

"nodeAddress": "null",

"clientId": "3",

"currencyId": null

}

]

Crypto Send To Other Wallet Endpoint

End points : https://custody-admin.paybito.com:8443/TradeService/paybito

HTTP REQUEST : POST

/sendCryptoToOther

Request Body:

{

"toadd":"0xd90f566d8deE293AB10fcB281fE661178C8c1f03",

"amount":"0.009",

"description":"send to other",

"descriptionReceived":"receive ETH",

"status":"sending",

"action":"send",

"currencyid":3,

"currency":"ETH",

"clientId":"4",

"Password":"1452"

}

Response Body:

{

"error":”success”

}

Received Address Generate Endpoint

End points : https://custody-admin.paybito.com:8443/TradeService/paybito

HTTP REQUEST : POST

/receiveAddress

Request Body:

{

"clientId":"5",

"currencyid":"3",

"password":"ABC@-0-0091"

}

Response Body:

{

"error":”success”

"publicKey": "0x59B64f454745B8ECK7B5J7dd32a005876707fD1d1413",

"currencyid": 3

}

Node Address Validation Endpoint

End points : https://custody-admin.paybito.com:8443/TradeService/paybito

HTTP REQUEST : POST

/addressValidate

Request Body:

{

"currencyid":"3",

"address":"0x59B64f454745B8ECK7B5J7dd32a005876707fD1d1413"

}

Response Body:

{

"valid": "false"

}