XaiGate Wallet

https://xaigate.gitbook.io
Admin
XaiGate Wallet is a decentralized cryptocurrency payment gateway that enables merchants and...
Tokens:10,160
Snippets:34
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Invoice Request Body Example

Source: https://xaigate.gitbook.io/api-docs/invoice/get-invoice

This snippet shows an example of the JSON request body required to get invoice information. It includes the mandatory 'apiKey' and 'invoiceNo' parameters.

```json
{
  "apiKey": "fdda9f03-6409-43eb-a6ef-e1f6cea71c2e",
  "invoiceNo": "INV2167234232"
}
```

--------------------------------

### Get Invoice Response Example (200 Ok)

Source: https://xaigate.gitbook.io/api-docs/invoice/get-invoice

This snippet provides an example of a successful response (200 Ok) when retrieving invoice information. It details various fields such as invoice number, amount, status, and payment URL.

```json
{
  "invoiceNo": "INV2167234232",
  "amount": "10",
  "paidAmount": "0",
  "toEmail": "example@hotmail.com",
  "toName": "My Store",
  "expiry": 60,
  "description": "3 Coffee",
  "status": "Paid",
  "payUrl": "https://wallet.xaigate.com/pay/INV2167234232?lang=en",
  "currency": "USD",
  "shopName": "My Store",
  "orderId": "10",
  "createdAt": "2023-12-07T09:03:07.976520Z",
  "updatedAt": "2023-12-07T09:03:07.976523Z"
}
```

--------------------------------

### Create User Request Body Example (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-user

This snippet shows an example of the JSON request body required to create a user. It includes the 'name', 'owner' object with 'id', 'name', 'species', and 'breed'. Note: The provided example seems to be for a pet, not a user, and may require adjustment for actual user creation.

```json
{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",
    "breed": "Golden Retriever",
}
}
```

--------------------------------

### Create User API Request Parameter Example (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-user

This example demonstrates the JSON format for the request parameter, specifically the 'apiKey', which is a required string for authenticating the user creation request.

```json
{
    "apiKey": "332a2eb7-916a-46e0-833a-a058375d1a34"
}
```

--------------------------------

### Get Transactions API Example Response (JavaScript Object)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-transactions

An example of how a successful response from the Get Transactions API might be represented as a JavaScript object. This structure includes transaction details and pagination information.

```javascript
{
    "name": "Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
        "species": "Dog"
    },
    "breed": "Golden Retriever"
}
```

--------------------------------

### Create User API Successful Response Example (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-user

This JSON snippet represents a successful response (HTTP 200 OK) from the Create User API. It includes the 'userId', 'createdAt' timestamp, and the 'status' of the newly created user.

```json
{
    "userId": "097f35dd-a806-43ef-ab0d-f121cb11567e",
    "createdAt": "2023-11-13T07:31:34.764154Z",
    "status": "active"
}
```

--------------------------------

### Withdraw Request Body Example (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/withdraw

Provides an example of the JSON request body required to initiate a fund withdrawal. It includes essential parameters like API key, user ID, coin type, destination address, amount, and network ID.

```json
{
  "apiKey": "033e15ee-3de7-4a93-800a-ae131b73c237",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a",
  "receivedAddress": "0x41053c22ac13c77daa6d65a4d235de7c38cc0c85",
  "coin": "ETH",
  "amount": 0.1,
  "networkId": 1
}
```

--------------------------------

### Get Wallet Balance Request (JavaScript)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-wallet-balance

This snippet demonstrates how to construct a request body for the getBalance API using JavaScript. It includes the required parameters: apiKey, userId, and coin.

```javascript
{
    "apiKey": "033e15ee-3de7-4a93-800a-ae131b73c237",
    "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a",
    "coin": "ETH"
}
```

--------------------------------

### Deposit/Withdraw Response JSON Example

Source: https://xaigate.gitbook.io/api-docs/ipns/deposit-withdraw-response

An example of a successful API response for a deposit or withdrawal transaction. This JSON object includes details such as transaction type, user ID, amount, symbol, status, transaction ID, source and destination addresses, and confirmations.

```json
{
    "type": "deposit",
    "userId": 2512,
    "amount": 0.1,
    "symbol": "BNB",
    "status": "success",
    "txid": "0x75da037d5ea7c4ebc59842052584b4657ad6c02ac7741c5f3193b3a5bf5b39c0",
    "from": "0x88374Fff7618B8d9fE80b5A561Ca601DA8439b45",
    "to": "0xf557a94caeb8886e72cccb1378640105ff369d5b",
    "confirmations": 12
}
```

--------------------------------

### Create Invoice Request Body Example

Source: https://xaigate.gitbook.io/api-docs/invoice/create-invoice

This JSON object represents a sample request body for creating an invoice. It includes all mandatory fields such as apiKey, orderId, currency, amount, and email, along with optional fields like shopName, successUrl, failUrl, notifyUrl, and description.

```json
{
  "apiKey": "fdda9f03-6409-43eb-a6ef-e1f6cea71c2e",
  "shopName": "My Store",
  "amount": 10,
  "currency": "USD",
  "orderId": "1",
  "email": "examplate@hotmail.com",
  "successUrl": "http://yourdomain.com/success-url",
  "failUrl": "http://yourdomain.com/fail-url",
  "notifyUrl": "http://yourdomain.com/notify-url",
  "description": "3 Coffee"
}
```

--------------------------------

### Withdraw Success Response Example (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/withdraw

Illustrates a successful response (HTTP 200 OK) from the withdrawal API. It contains details about the transaction, including unique IDs, transaction hash, explorer URL, amounts, and timestamps.

```json
{
  "id": "9f715070-cfd1-4aac-894a-f7e205729888",
  "txid": "replaceable_dcf11e0f-1ba4-4689-8105-3cd01f313db7",
  "explorerUrl": "https://sepolia.etherscan.io/tx/replaceable_dcf11e0f-1ba4-4689-8105-3cd01f313db7",
  "amount": "0.0487",
  "transactionFees": "0.0013",
  "processingFees": "0.0001",
  "totalAmount": "0.05",
  "toAddress": "0xD72F3aF2C1DaB33780ddd10e0d826e70598E4fe7",
  "walletId": "f70b0cbb-d86f-4bb8-a75f-578fbd201f35",
  "coinShortName": "ETH",
  "date": "2023-12-19T09:27:43.806112Z"
}
```

--------------------------------

### Get Invoice Information

Source: https://xaigate.gitbook.io/api-docs/invoice/get-invoice

Retrieves detailed information about a specific invoice using its invoice number and API key.

```APIDOC
## POST /api/v1/invoice/info

### Description
This endpoint retrieves detailed information about a specific invoice. It requires an API key for authentication and the invoice number to identify the invoice.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/invoice/info

### Parameters
#### Request Body
- **apiKey** (String) - Required - Your unique API key for authentication.
- **invoiceNo** (String) - Required - The invoice number for which to retrieve information.

### Request Example
```json
{
  "apiKey": "fdda9f03-6409-43eb-a6ef-e1f6cea71c2e",
  "invoiceNo": "INV2167234232"
}
```

### Response
#### Success Response (200)
- **invoiceNo** (String) - The invoice number.
- **amount** (String) - The total amount of the invoice.
- **paidAmount** (String) - The amount that has been paid.
- **toEmail** (String) - The email address of the recipient.
- **toName** (String) - The name of the recipient.
- **expiry** (Int) - The expiry time of the invoice in minutes (default: 60).
- **description** (String) - A description of the invoice.
- **status** (String) - The current status of the invoice (e.g., Pending, Expired, Paid, PaidPartial, Deleted).
- **payUrl** (String) - The URL to the payment page for the invoice.
- **currency** (String) - The currency of the invoice (e.g., USD).
- **shopName** (String) - The name of the shop or merchant.
- **orderId** (String) - The order ID associated with the invoice.
- **createdAt** (String) - The timestamp when the invoice was created.
- **updatedAt** (String) - The timestamp when the invoice was last updated.

#### Response Example
```json
{
  "invoiceNo": "INV2167234232",
  "amount": "10",
  "paidAmount": "0",
  "toEmail": "example@hotmail.com",
  "toName": "My Store",
  "expiry": 60,
  "description": "3 Coffee",
  "status": "Paid",
  "payUrl": "https://wallet.xaigate.com/pay/INV2167234232?lang=en",
  "currency": "USD",
  "shopName": "My Store",
  "orderId": "10",
  "createdAt": "2023-12-07T09:03:07.976520Z",
  "updatedAt": "2023-12-07T09:03:07.976523Z"
}
```
```

--------------------------------

### Create Invoice Response Example

Source: https://xaigate.gitbook.io/api-docs/invoice/create-invoice

This JSON object illustrates a successful response from the Create Invoice API. It contains details about the created invoice, including its unique invoice number (invoiceNo), amount, currency, status, expiry time, and a direct payment URL (payUrl).

```json
{
  "invoiceNo": "INV2167234232",
  "amount": "10",
  "paidAmount": "0",
  "toEmail": "example@hotmail.com",
  "toName": "My Store",
  "expiry": 60,
  "description": "3 Coffee",
  "status": "Pending",
  "payUrl": "https://wallet.xaigate.com/pay/INV2167234232?lang=en",
  "currency": "USD",
  "shopName": "My Store",
  "orderId": 10,
  "createdAt": "2023-12-07T09:03:07.976520Z",
  "updatedAt": "2023-12-07T09:03:07.976523Z"
}
```

--------------------------------

### Get Transactions API Request Body (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-transactions

This JSON object represents the structure of the request body required for the Get Transactions API. It includes mandatory 'apiKey' and 'userId' fields.

```json
{
  "apiKey": "033e15ee-3de7-4a93-800a-ae131b73c237",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a"
}
```

--------------------------------

### Get Transactions API Success Response (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-transactions

This JSON object illustrates a successful response (200 OK) from the Get Transactions API. It contains a list of transactions, along with pagination details.

```json
{
  "results": [
    {
      "id": "9f715070-cfd1-4aac-894a-f7e205729888",
      "txid": "0x9daacda4d233a5066ce8947636a3bd52632b7e9a571eefcf07b8cbc588f9ea40",
      "explorerUrl": "https://sepolia.etherscan.io/tx/0x9daacda4d233a5066ce8947636a3bd52632b7e9a571eefcf07b8cbc588f9ea40",
      "merchantId": "16",
      "coin": "ETH",
      "walletId": "f70b0cbb-d86f-4bb8-a75f-578fbd201f35",
      "sentAddress": "d5a74197-880e-4b41-9955-7e548782d513",
      "receivedAddress": "0xD72F3aF2C1DaB33780ddd10e0d826e70598E4fe7",
      "amount": "0.048700001090765",
      "confirmations": 1,
      "date": "2023-12-19T16:27:43.754Z",
      "networkFee": "0.0013000001199543476",
      "status": "success",
      "userId": null,
      "type": "withdraw",
      "errorMessage": null
    },
    {
      "id": "0xb68759a6c162ce6b3381098cd4048c090e5bebe905914fa4cf99a189fdef320b",
      "txid": "0xb68759a6c162ce6b3381098cd4048c090e5bebe905914fa4cf99a189fdef320b",
      "explorerUrl": "https://sepolia.etherscan.io/tx/0xb68759a6c162ce6b3381098cd4048c090e5bebe905914fa4cf99a189fdef320b",
      "merchantId": "16",
      "coin": "ETH",
      "walletId": "f70b0cbb-d86f-4bb8-a75f-578fbd201f35",
      "sentAddress": "0xd72f3af2c1dab33780ddd10e0d826e70598e4fe7",
      "receivedAddress": "0x529f23b8f62091ba4429560a89dd953ab892aa93",
      "amount": "0.05",
      "confirmations": 1,
      "date": "2023-12-19T16:25:50.080Z",
      "networkFee": "null",
      "status": "success",
      "userId": null,
      "type": "deposit",
      "errorMessage": null
    }
  ],
  "total": 2,
  "size": 20,
  "totalPages": 1,
  "page": 0
}
```

--------------------------------

### Generate New Wallet Address Request Body (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-new-wallet-address

This snippet shows an example of the JSON request body required to generate a new wallet address. It includes the apiKey, userId, and networkId as mandatory parameters.

```json
{
  "apiKey": "fdda9f03-6409-43eb-a6ef-e1f6cea71c2e",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a",
  "networkId": 1
}
```

--------------------------------

### Get Wallet Balance Success Response (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-wallet-balance

This snippet shows a successful response (200 OK) from the getBalance API. It includes the user's wallet balance and the short name of the coin.

```json
{
  "balance": "1",
  "coinShortName": "ETH"
}
```

--------------------------------

### POST /api/v1/getBalance

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-wallet-balance

Retrieves the current balance of a user's cryptocurrency wallet. Requires an API key, user ID, and coin type.

```APIDOC
## POST /api/v1/getBalance

### Description
Retrieves the current balance of a user's cryptocurrency wallet. Requires an API key, user ID, and coin type.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/getBalance

### Parameters
#### Request Body
- **apiKey** (String) - Required - The API key for authentication.
- **userId** (String) - Required - The unique identifier for the user.
- **coin** (String) - Required - The cryptocurrency symbol (e.g., ETH).

### Request Example
```json
{
  "apiKey": "033e15ee-3de7-4a93-800a-ae131b73c237",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a",
  "coin": "ETH"
}
```

### Response
#### Success Response (200)
- **balance** (String) - The current balance of the specified coin.
- **coinShortName** (String) - The short name or symbol of the coin.

#### Response Example
```json
{
  "balance": "1",
  "coinShortName": "ETH"
}
```

#### Error Response (401 Unauthorized)
This endpoint may return a 401 Unauthorized status code if the provided API key is invalid or missing.
```

--------------------------------

### POST /api/v1/getTransactions

Source: https://xaigate.gitbook.io/api-docs/api-documentation/get-transactions

Retrieves a list of transactions associated with a user's account. It supports filtering and pagination.

```APIDOC
## POST /api/v1/getTransactions

### Description
Retrieves a list of transactions associated with a user's account. It supports filtering and pagination.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/getTransactions

### Parameters
#### Query Parameters
- **apiKey** (String) - Required - The API key for authentication.
- **userId** (String) - Required - The ID of the user whose transactions are to be retrieved.

#### Request Body
This endpoint does not require a request body.

### Request Example
```json
{
  "apiKey": "033e15ee-3de7-4a93-800a-ae131b73c237",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a"
}
```

### Response
#### Success Response (200)
- **results** (Array) - A list of transaction objects.
- **total** (Int) - The total number of transactions available.
- **size** (Int) - The number of transactions returned in this response.
- **totalPages** (Int) - The total number of pages available.
- **page** (Int) - The current page number.

#### Item (within results array)
- **id** (String) - The unique identifier for the transaction.
- **txid** (String) - The transaction ID on the blockchain.
- **explorerUrl** (String) - A URL to view the transaction on a block explorer.
- **coin** (String) - The cryptocurrency symbol (e.g., ETH).
- **walletId** (String) - The ID of the wallet associated with the transaction.
- **sentAddress** (String) - The sending address for the transaction.
- **receivedAddress** (String) - The receiving address for the transaction.
- **amount** (String) - The amount transacted.
- **confirmations** (Int) - The number of confirmations for the transaction.
- **date** (String) - The date and time the transaction occurred (ISO 8601 format).
- **networkFee** (String) - The network fee paid for the transaction.
- **status** (String) - The status of the transaction (e.g., 'success').
- **type** (String) - The type of transaction (e.g., 'withdraw', 'deposit').
- **userId** (String) - The user ID associated with the transaction (can be null).
- **errorMessage** (String) - Any error message related to the transaction (can be null).

#### Response Example (200 OK)
```json
{
  "results": [
    {
      "id": "9f715070-cfd1-4aac-894a-f7e205729888",
      "txid": "0x9daacda4d233a5066ce8947636a3bd52632b7e9a571eefcf07b8cbc588f9ea40",
      "explorerUrl": "https://sepolia.etherscan.io/tx/0x9daacda4d233a5066ce8947636a3bd52632b7e9a571eefcf07b8cbc588f9ea40",
      "merchantId": "16",
      "coin": "ETH",
      "walletId": "f70b0cbb-d86f-4bb8-a75f-578fbd201f35",
      "sentAddress": "d5a74197-880e-4b41-9955-7e548782d513",
      "receivedAddress": "0xD72F3aF2C1DaB33780ddd10e0d826e70598E4fe7",
      "amount": "0.048700001090765",
      "confirmations": 1,
      "date": "2023-12-19T16:27:43.754Z",
      "networkFee": "0.0013000001199543476",
      "status": "success",
      "userId": null,
      "type": "withdraw",
      "errorMessage": null
    },
    {
      "id": "0xb68759a6c162ce6b3381098cd4048c090e5bebe905914fa4cf99a189fdef320b",
      "txid": "0xb68759a6c162ce6b3381098cd4048c090e5bebe905914fa4cf99a189fdef320b",
      "explorerUrl": "https://sepolia.etherscan.io/tx/0xb68759a6c162ce6b3381098cd4048c090e5bebe905914fa4cf99a189fdef320b",
      "merchantId": "16",
      "coin": "ETH",
      "walletId": "f70b0cbb-d86f-4bb8-a75f-578fbd201f35",
      "sentAddress": "0xd72f3af2c1dab33780ddd10e0d826e70598e4fe7",
      "receivedAddress": "0x529f23b8f62091ba4429560a89dd953ab892aa93",
      "amount": "0.05",
      "confirmations": 1,
      "date": "2023-12-19T16:25:50.080Z",
      "networkFee": "null",
      "status": "success",
      "userId": null,
      "type": "deposit",
      "errorMessage": null
    }
  ],
  "total": 2,
  "size": 20,
  "totalPages": 1,
  "page": 0
}
```

#### Error Response (401 Bad Request)
This endpoint may return a 401 Bad Request error if authentication fails or required parameters are missing.
```

--------------------------------

### POST /api/v1/createUser

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-user

Endpoint to create a new user. Requires an API key for authentication.

```APIDOC
## POST /api/v1/createUser

### Description
Endpoint to create a new user. Requires an API key for authentication.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/createUser

### Parameters
#### Request Body
- **apiKey** (string) - Required - The API key for authentication.

### Request Example
```json
{
    "apiKey": "332a2eb7-916a-46e0-833a-a058375d1a34"
}
```

### Response
#### Success Response (200 OK)
- **userId** (string) - The unique identifier for the created user.
- **status** (string) - The status of the created user (e.g., 'active').
- **createdAt** (string) - The timestamp when the user was created.

#### Response Example
```json
{
    "userId": "097f35dd-a806-43ef-ab0d-f121cb11567e",
    "createdAt": "2023-11-13T07:31:34.764154Z",
    "status": "active"
}
```

#### Error Response (401 Unauthorized)
This response indicates that the provided API key is invalid or missing.
```

--------------------------------

### POST /api/v1/invoice/create

Source: https://xaigate.gitbook.io/api-docs/invoice/create-invoice

This API is used to create orders for customers by generating invoices. It requires various details about the order and customer to successfully create an invoice.

```APIDOC
## POST /api/v1/invoice/create

### Description
This API is used to create orders for customers by generating invoices. It requires various details about the order and customer to successfully create an invoice.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/invoice/create

### Parameters
#### Query Parameters
None

#### Request Body
- **apiKey** (String) - Required - The API key for authentication.
- **orderId** (String) - Required - The unique identifier for the order.
- **currency** (String) - Required - The currency of the transaction (e.g., USD, EUR).
- **amount** (String) - Required - The total amount of the invoice.
- **email** (String) - Required - The email address of the customer.
- **shopName** (String) - Optional - The name of the shop.
- **notifyUrl** (String) - Optional - The URL to notify upon status changes.
- **failUrl** (String) - Optional - The URL to redirect to if the payment fails.
- **successUrl** (String) - Optional - The URL to redirect to upon successful payment.
- **description** (String) - Optional - A description of the order.

### Request Example
```json
{
  "apiKey": "fdda9f03-6409-43eb-a6ef-e1f6cea71c2e",
  "shopName": "My Store",
  "amount": "10",
  "currency": "USD",
  "orderId": "1",
  "email": "examplate@hotmail.com",
  "successUrl": "http://yourdomain.com/success-url",
  "failUrl": "http://yourdomain.com/fail-url",
  "notifyUrl": "http://yourdomain.com/notify-url",
  "description": "3 Coffee"
}
```

### Response
#### Success Response (200)
- **invoiceNo** (String) - The unique invoice number.
- **amount** (String) - The total amount of the invoice.
- **paidAmount** (String) - The amount that has been paid.
- **toEmail** (String) - The customer's email address.
- **toName** (String) - The name associated with the invoice (e.g., shop name).
- **expiry** (Int) - The expiration time of the invoice in minutes (default: 60).
- **description** (String) - The description of the invoice.
- **status** (String) - The current status of the invoice (e.g., Pending).
- **payUrl** (String) - The URL to the payment gateway for the invoice.
- **currency** (String) - The currency of the invoice.
- **shopName** (String) - The name of the shop.
- **orderId** (String) - The order ID associated with the invoice.
- **createdAt** (String) - The timestamp when the invoice was created.
- **updatedAt** (String) - The timestamp when the invoice was last updated.

#### Response Example
```json
{
  "invoiceNo": "INV2167234232",
  "amount": "10",
  "paidAmount": "0",
  "toEmail": "example@hotmail.com",
  "toName": "My Store",
  "expiry": 60,
  "description": "3 Coffee",
  "status": "Pending",
  "payUrl": "https://wallet.xaigate.com/pay/INV2167234232?lang=en",
  "currency": "USD",
  "shopName": "My Store",
  "orderId": "10",
  "createdAt": "2023-12-07T09:03:07.976520Z",
  "updatedAt": "2023-12-07T09:03:07.976523Z"
}
```
```

--------------------------------

### Supported Chains Information

Source: https://xaigate.gitbook.io/api-docs/getting-started/supported-chains

This section details the blockchains currently supported by the XaiGate API. The 'Network ID' provided can be used as the 'chain_id' parameter when calling Web3 APIs. XaiGate currently supports EVM-compatible blockchains only.

```APIDOC
## Supported Chains

### Description
This endpoint provides a list of supported EVM-compatible blockchains and their corresponding Network IDs. The Network ID can be used as the `chain_id` parameter when interacting with Web3 APIs.

### Method
GET

### Endpoint
/websites/xaigate_gitbook_io/supported-chains

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": "No request body needed for this informational endpoint."
}
```

### Response
#### Success Response (200)
- **chains** (array) - A list of supported blockchain objects.
  - **chain** (string) - The name of the blockchain.
  - **network_id** (integer or string) - The Network ID for the chain.
  - **type** (string) - The type of network (e.g., 'Mainnet').

#### Response Example
```json
{
  "chains": [
    {
      "chain": "Ethereum (ERC20)",
      "network_id": 1,
      "type": "Mainnet"
    },
    {
      "chain": "Binance Smart Chain (BEP20)",
      "network_id": 56,
      "type": "Mainnet"
    },
    {
      "chain": "Tron (TRC20)",
      "network_id": "TRX",
      "type": "Mainnet"
    }
  ]
}
```

### Error Handling
- **404 Not Found**: If the endpoint is not found.
- **500 Internal Server Error**: If there is a server-side issue.
```

--------------------------------

### POST /api/v1/withdraw

Source: https://xaigate.gitbook.io/api-docs/api-documentation/withdraw

Initiates a withdrawal of funds from a specified sub-user's wallet. Requires API key, user ID, coin, destination address, amount, and network ID.

```APIDOC
## POST /api/v1/withdraw

### Description
Allows you to withdraw funds from a sub-user's wallet.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/withdraw

### Parameters
#### Request Body
- **apiKey** (String) - Required - Your API key.
- **userId** (String) - Required - The ID of the sub-user initiating the withdrawal.
- **coin** (String) - Required - The cryptocurrency to withdraw (e.g., ETH).
- **receivedAddress** (String) - Required - The destination address for the withdrawal.
- **amount** (String) - Required - The amount of cryptocurrency to withdraw.
- **networkId** (String) - Required - The ID of the network for the transaction (e.g., 1, 56, TRX).

### Request Example
```json
{
  "apiKey": "033e15ee-3de7-4a93-800a-ae131b73c237",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a",
  "receivedAddress": "0x41053c22ac13c77daa6d65a4d235de7c38cc0c85",
  "coin": "ETH",
  "amount": 0.1,
  "networkId": 1
}
```

### Response
#### Success Response (200)
- **id** (String) - Unique identifier for the withdrawal transaction.
- **txid** (String) - Transaction ID on the blockchain.
- **explorerUrl** (String) - URL to view the transaction on a block explorer.
- **amount** (String) - The amount withdrawn.
- **transactionFees** (String) - Fees associated with the blockchain transaction.
- **processingFees** (String) - Fees charged by the platform for processing.
- **totalAmount** (String) - The total amount deducted (amount + fees).
- **toAddress** (String) - The address the funds were sent to.
- **walletId** (String) - The ID of the wallet from which funds were withdrawn.
- **coinShortName** (String) - The short name of the cryptocurrency withdrawn.
- **date** (String) - The date and time the withdrawal was processed.

#### Response Example
```json
{
  "id": "9f715070-cfd1-4aac-894a-f7e205729888",
  "txid": "replaceable_dcf11e0f-1ba4-4689-8105-3cd01f313db7",
  "explorerUrl": "https://sepolia.etherscan.io/tx/replaceable_dcf11e0f-1ba4-4689-8105-3cd01f313db7",
  "amount": "0.0487",
  "transactionFees": "0.0013",
  "processingFees": "0.0001",
  "totalAmount": "0.05",
  "toAddress": "0xD72F3aF2C1DaB33780ddd10e0d826e70598E4fe7",
  "walletId": "f70b0cbb-d86f-4bb8-a75f-578fbd201f35",
  "coinShortName": "ETH",
  "date": "2023-12-19T09:27:43.806112Z"
}
```
```

--------------------------------

### POST /api/v1/generateAddress

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-new-wallet-address

Generates a new cryptocurrency wallet address for a specified account. Requires an API key, user ID, and network ID.

```APIDOC
## POST /api/v1/generateAddress

### Description
Generates a new cryptocurrency wallet address for a specified account.

### Method
POST

### Endpoint
https://wallet-api.xaigate.com/api/v1/generateAddress

### Parameters
#### Request Body
- **apiKey** (String) - Required - Your API key for authentication.
- **userId** (String) - Required - The unique identifier for the user.
- **networkId** (String) - Required - The ID of the network for which to generate the address. Enum: 1, 56, TRX.

### Request Example
```json
{
  "apiKey": "fdda9f03-6409-43eb-a6ef-e1f6cea71c2e",
  "userId": "b3e36e1a-296f-4198-bda1-180c51aff14a",
  "networkId": 1
}
```

### Response
#### Success Response (200)
- **address** (String) - The newly generated wallet address.

#### Response Example
```json
{
    "address": "0x3A93c5618F5d10EA43dCda6A689a31228442F61c"
}
```

#### Error Response (401 Unauthorized)
(No specific details provided in the source text for this error response structure.)
```

--------------------------------

### Generate New Wallet Address Success Response (JSON)

Source: https://xaigate.gitbook.io/api-docs/api-documentation/create-new-wallet-address

This snippet illustrates a successful response (200 OK) from the generateAddress API. It contains the newly generated wallet address under the 'address' key.

```json
{
    "address": "0x3A93c5618F5d10EA43dCda6A689a31228442F61c"
}
```

--------------------------------

### Deposit/Withdraw Response

Source: https://xaigate.gitbook.io/api-docs/ipns/deposit-withdraw-response

This endpoint provides details about the response of a deposit or withdrawal operation, including transaction specifics and status.

```APIDOC
## Deposit/Withdraw Response

### Description
This endpoint provides details about the response of a deposit or withdrawal operation, including transaction specifics and status.

### Method
GET

### Endpoint
/websites/xaigate_gitbook_io/deposit_withdraw_response

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user making the deposit or withdrawal.
- **symbol** (string) - Required - The symbol of the cryptocurrency being transacted.

### Request Example
```json
{
  "userId": "2512",
  "symbol": "BNB"
}
```

### Response
#### Success Response (200)
- **type** (string) - Enum: "deposit", "withdraw" - The type of transaction.
- **userId** (string) - The ID of the user.
- **amount** (string) - The transaction amount.
- **symbol** (string) - The cryptocurrency symbol.
- **status** (string) - Enum: "success", "failed" - The status of the transaction.
- **txid** (string) - The transaction ID.
- **from** (string) - The sender's address.
- **to** (string) - The recipient's address.
- **confirmations** (integer) - The number of confirmations for the transaction.

#### Response Example
```json
{
    "type": "deposit",
    "userId": "2512",
    "amount": "0.1",
    "symbol": "BNB",
    "status": "success",
    "txid": "0x75da037d5ea7c4ebc59842052584b4657ad6c02ac7741c5f3193b3a5bf5b39c0",
    "from": "0x88374Fff7618B8d9fE80b5A561Ca601DA8439b45",
    "to": "0xf557a94caeb8886e72cccb1378640105ff369d5b",
    "confirmations": 12
}
```
```

--------------------------------

### Notify Invoice Response

Source: https://xaigate.gitbook.io/api-docs/ipns/notify-invoice-response

This endpoint provides the response details when an invoice notification is successfully processed. It includes information about the invoice, transaction, and relevant dates.

```APIDOC
## GET /websites/xaigate_gitbook_io/notify/invoice

### Description
This endpoint returns the details of a successfully notified invoice. It includes invoice identification, network information, notification URL, expiry, description, transaction details, sender and receiver addresses, and timestamps.

### Method
GET

### Endpoint
/websites/xaigate_gitbook_io/notify/invoice

### Parameters
#### Query Parameters
- **invoiceNo** (String) - Required - The unique identifier for the invoice.
- **networkName** (String) - Optional - The name of the network the invoice is associated with.
- **notifyUrl** (String) - Optional - The URL to which the notification was sent.
- **expiryOn** (String) - Optional - The expiration date and time of the invoice in ISO 8601 format.
- **description** (String) - Optional - A description of the invoice.
- **id** (String) - Optional - A unique ID for the notification record.
- **txid** (String) - Optional - The transaction ID associated with the invoice.
- **explorerUrl** (String) - Optional - A URL to view the transaction on a blockchain explorer.
- **sentAddress** (String) - Optional - The address from which the payment was sent.
- **receivedAddress** (String) - Optional - The address where the payment was received.
- **date** (String) - Optional - The date of the transaction or notification.
- **createdAt** (String) - Optional - The timestamp when the record was created.
- **updatedAt** (String) - Optional - The timestamp when the record was last updated.

### Response
#### Success Response (200)
- **invoiceNo** (String) - The unique identifier for the invoice.
- **networkName** (String) - The name of the network.
- **notifyUrl** (String) - The URL for notifications.
- **expiryOn** (String) - The expiration date and time.
- **description** (String) - A description of the invoice.
- **id** (String) - The unique ID of the notification record.
- **txid** (String) - The transaction ID.
- **explorerUrl** (String) - URL to the transaction explorer.
- **sentAddress** (String) - The sender's address.
- **receivedAddress** (String) - The receiver's address.
- **date** (String) - The date associated with the invoice or transaction.
- **createdAt** (String) - Timestamp of creation.
- **updatedAt** (String) - Timestamp of the last update.

#### Response Example
```json
{
    "invoiceNo": "M2126441028",
    "networkName": "Binance Smart Chain (BEP20)",
    "notifyUrl": "http://yourdomain.com/success-url",
    "expiryOn”: "2023-11-12T19:04:35Z",
    "description": "Hello world",
    "id": "0xdc30ed40d650c782f9902125cefbc9bbf5ccad02bf8bdc0ea672e9e73cc45d13",
    "txid": "0xdc30ed40d650c782f9902125cefbc9bbf5ccad02bf8bdc0ea672e9e73cc45d13",
    "explorerUrl": "https://testnet.bscscan.com/tx/0xdc30ed40d650c782f9902125cefbc9bbf5ccad02bf8bdc0ea672e9e73cc45d13",
    "sentAddress": "0x3a93c5618f5d10ea43dcda6a689a31228442f61c",
    "receivedAddress": "0x4cfdf40842d18b9c4e617b07aaa3b66aa52d5d7a",
    "date": "2023-11-16T04:50:04.045Z",
    "createdAt": "2023-11-12T18:04:35Z",
    "updatedAt": "2023-11-12T18:04:35Z"
}
```
```

--------------------------------

### Invoice Notification Response Structure

Source: https://xaigate.gitbook.io/api-docs/ipns/notify-invoice-response

This JSON object represents a successful response (HTTP 200 OK) from an invoice notification API. It includes details about the invoice such as its number, network, URLs, expiry, description, transaction ID, and relevant dates.

```json
{
    "invoiceNo": "INV99999999",
    "networkName": "Binance Smart Chain (BEP20)",
    "notifyUrl": "http://yourdomain.com/success-url",
    "expiryOn": "2023-11-12T19:04:35Z",
    "description": "Hello world",
    "id": "0xdc30ed40d650c782f9902125cefbc9bbf5ccad02bf8bdc0ea672e9e73cc45d13",
    "txid": "0xdc30ed40d650c782f9902125cefbc9bbf5ccad02bf8bdc0ea672e9e73cc45d13",
    "explorerUrl": "https://testnet.bscscan.com/tx/0xdc30ed40d650c782f9902125cefbc9bbf5ccad02bf8bdc0ea672e9e73cc45d13",
    "sentAddress": "0x3a93c5618f5d10ea43dcda6a689a31228442f61c",
    "receivedAddress": "0x4cfdf40842d18b9c4e617b07aaa3b66aa52d5d7a",
    "date": "2023-11-16T04:50:04.045Z",
    "createdAt": "2023-11-12T18:04:35Z",
    "updatedAt": "2023-11-12T18:04:35Z"
}
```
Tokens:
Raw