Webhooks

Update Webhook

Switchwallet provides our merchants with a webhook payload when a deposit or withdrawal is made on our system.

Updates webhook url

PUT https://development.switchwallet.io/api/v1/merchant/webhook

Headers

Name	Type	Description
Authorization*	ApiKey {{SecretKey}}

Request Body

Name	Type	Description
webhookUrl*	https://webhook.site
publicKey	YOUR_PUBLIC_KEY

200: OK

{
    // Response
}

Deposit Payload

This is the payload you'll receive when a deposit is being made to your generated wallet address.

{
  "TransactionType": 1,
  "Data": {
    "Checksum": "E94077842C4080E431CAFCF8D213DE333D604B1032772647C17F56692ECB165DF4C0F72A0E098137C7188D0723483380757FB1F8E16280E7F02B88CF4354F112"
    "Amount": 10,
    "Charge": 0.0,
    "TotalAmountDeposited": 10,
    "DepositAddress": "0xf474cf03cceff28abc65c9cbae594f725c80e12d",
    "ReceiveAddress": "0x85326fa56359ca13a724e756e9ef58d8f6061121",
    "Currency": 6,
    "NetworkChain": "BSC",
    "Status": 3,
    "MerchantClient": {
      "Email": "[email protected]"
    },
    "TransactionHash": "0x94babf921f689214a4e2a3cba2f698d0cda676d5ce1636a853ede234b54b1af4",
   }
}

Key	Type	Description
transactionType	enum	This is the different type of transactions on the system. Values are Deposit = 1, Withdrawal,Transfer, MerchantDeposit and Remittance.
data	object	This is the object having the main properties of the transaction.
checksum	string	This is a hash property of the data for security validations.
amount	decimal	The amount deposited from a client or external address.
charge	decimal	The amount charged by us for the transaction.
totalAmountDeposited	decimal	This is the total of the amount and charge on this transaction.
depositAddress	string	This is the wallet address of the client sending funds from.
receieveAddress	string	This is the wallet address of the merchant who is receiveing the funds.
currency	enum	This is the currency of the transaction.Values are BUSD, LTC, BNB, DAI, USDT, XEND, WNT.
networkChain	enum	This is the network chain of the currencies. Values are BSC, ETH, POLYGON, CELO, ARBITRUM, AVALANCHE, HECOCHAIN.
status	enum	This is the status of the transaction. Values are NOT_REFELECTED, PENDING, CONFIRMED, FAILED, NOT_PROPAGATED.
merchantClient	object	This has the email address of the merchant client as a property.
email	string	This is the email of the the merchant client.
transactionalHash	string	This is the transactional hash of the transaction on the blockchain.

Withdrawal Payload

This is the payload you'll receive when a withdrawal is being made from your generated wallet.

{
  "TransactionType": 2,
  "Data": {
    "Checksum": "E94077842C4080E431CAFCF8D213DE333D604B1032772647C17F56692ECB165DF4C0F72A0E098137C7188D0723483380757FB1F8E16280E7F02B88CF4354F112"
    "ReceiverAddress": "0xf474cf03cceff28abc65c9cbae594f725c80e12d",
    "AmountRequested": 10,
    "AmountSent": 10,
    "Charge": 0.1,
    "TotalAmountWithdrawn": 9.99,
    "Currency": "BUSD",
    "NetworkChain": "BSC",
    "Status": 3,
    "MerchantClient": {
      "Email": "[email protected]"
    },
    "TransactionHash": "0x4dd08922b45c0ae7f39884beb83cf86e6202426f469fa7d6e65d2829c249fa3f",
    "MerchantReference": "MerchantRef40",
  }
}

Key	Type	Description
transactionType	enum	This is the different type of transactions on the system. Values are Deposit = 1, Withdrawal,Transfer, MerchantDeposit and Remittance.
data	object	This is the object having the main properties of the transaction.
checksum	string	This is a hash property of the data for security validations.
receieverAddress	string	This is the wallet address where the funds is being withdrawn to.
amountRequested	decimal	This is the amount requested to be withdrawn.
amountSent	decimal	This is the amount sent minus the charge.
charge	decimal	The amount charged by us for the transaction.
totalAmountWithdrawn	decimal	This is the total amount and charge on this transaction.
currency	enum	This is the currency of the transaction.Values are BUSD, LTC, BNB, DAI, USDT, XEND, WNT.
networkChain	enum	This is the network chain of the currencies. Values are BSC, ETH, POLYGON, CELO, ARBITRUM, AVALANCHE, HECOCHAIN.
status	enum	This is the status of the transaction. Values are NOT_REFELECTED, PENDING, CONFIRMED, FAILED, NOT_PROPAGATED.
merchantClient	object	This has the email address of the merchant client as a property.
email	string	This is the email address of the merchant client.
transactionalHash	string	This is the transactional hash of the transaction on the blockchain.
merchantReference	string	This is a unique reference on the system.