GET All Widgets

Get all merchant's widgets

get

Get all merchant's widgets

This endpoint is used to get all merchant's widgets by its ORGANIZATION_API_KEY.

Request

• Method: GET

• URL: http://localhost:3000/v1/widget

Headers

• Authorization: Bearer {{ORGANIZATION_API_KEY}}

Response

• Status: 200 OK

• Content Type: application/json

Response Body

{
  "data": [
    {
      "id": string,
      "apiKey": string,
      "status": Enum['Active', 'Inactive']
      "name": string,
      "description": string,
      "merchant": string,
      "assetsByBlockchain": {
         "blockchain": Enum('ethereum', 'tron', 'binance-smart-chain', 'MATIC', 'bitcoin'),
         "assets": [
          Enum('USDT', 'USDC', 'ETH', 'MATIC','BNB', 'TRX', 'BTC)
       ],
       "confirmationsAmount": number, // min 1
       "expirationTime": number,
       "expirationTimeAction": Enum('FailRequest', 'UpdateRate')
     },
     "reusableAddress": boolean,
     "sweepingGasTolerance": number,
     "aggregationWallet": string,
     "sweepingFrequency": {
        "type":Enum('Daily', 'Weekly'),
        "period": string, // Represents either "08:00:00" or "Monday 09:00:00"
      },
      "acceptPartialPayment": boolean,
      "sweepingCost": Enum('Merchant', 'Customer'),
      "webhookUrl": string,
      "redirectUrl": string,
      "purchasesToday": number,
      "purchasesTotal": number,
      "incomeToday": number,
      "incomeTotal": number,
      "balance": number
    }
  ]
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

Responseobject

get

/v1/merchant/widget

HTTPcURLJavaScriptPython

GET /v1/merchant/widget HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "id": "21a12efa-33c5-4461-8d03-2449391b549a",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "UpdateRate",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 3,
          "confirmationsAmount": "3",
          "expirationTimeAction": "UpdateRate",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "378a2829-bed1-45fb-b009-9873264572c2",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 10,
          "confirmationsAmount": "10",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 1,
          "confirmationsAmount": "10",
          "expirationTimeAction": "UpdateRate",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site2.com",
      "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "2844eca8-6b89-449f-8ec4-9d678e57791b",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "601a35f7-68d2-4406-8ee6-c8a4fd3d1930",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 1,
          "confirmationsAmount": "10",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 1,
          "confirmationsAmount": "10",
          "expirationTimeAction": "UpdateRate",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site2.com",
      "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "ae51a757-4f24-43ce-b349-c2c76aabe27a",
      "status": "Active",
      "name": "MyFirstWidget1111",
      "description": "Some nice description111",
      "merchant": "Merchant #1111",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 1,
          "confirmationsAmount": "1",
          "expirationTimeAction": "UpdateRate",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 1,
          "confirmationsAmount": "1",
          "expirationTimeAction": "UpdateRate",
          "assets": [
            "USDT",
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site2.com",
      "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
      "purchasesToday": 0,
      "purchasesTotal": 5,
      "incomeToday": 0,
      "incomeTotal": 25,
      "balance": 5
    },
    {
      "id": "5b853530-e4ec-4670-bae8-7eb192bdef2c",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "5da30c5c-4863-4d37-bf5b-ef396acaef5d",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "2ca0b7c7-c0c9-4482-a4cf-6a5cce7b4374",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "567184ec-72d9-45ce-91e1-3eb4c4db81d8",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "1fd06fef-98c1-443e-9318-f09ed43db23c",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "76df9940-bcaa-4e68-a803-4c6ea199f895",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [
        {
          "blockchain": "tron",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "USDT",
            "TRX"
          ]
        },
        {
          "blockchain": "ethereum",
          "expirationTime": 5,
          "confirmationsAmount": "5",
          "expirationTimeAction": "FailRequest",
          "assets": [
            "ETH",
            "USDC"
          ]
        }
      ],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "d34a9f9f-64fc-4bc3-828b-9964c1954aa5",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "c1ce409f-2a4d-46d2-9e91-bcff999835ec",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "68e6dcf0-f9f6-4856-b6ba-edf2d294773e",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "7b5cd04b-92f6-4b8f-9b47-9a4c32e39220",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "d815f1ea-1a4f-4cb6-886c-be6c4e2af520",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "23014fb3-dd71-4165-9fe9-91627daf6ad8",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "56686a8d-6003-4b0b-b874-82c3d4b26a70",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    },
    {
      "id": "993e6bca-f7de-4528-9658-a235a010b76a",
      "status": "Active",
      "name": "MyFirstWidget",
      "description": "Some nice description",
      "merchant": "Merchant #1",
      "blockchainAssets": [],
      "reusableAddress": true,
      "sweepingGasTolerance": "20.00000000",
      "aggregationWallet": "dd32332trgdjdrawe",
      "sweepingFrequency": {
        "type": "Daily",
        "period": "14:00:00"
      },
      "acceptPartialPayment": true,
      "sweepingCost": "Customer",
      "webhookUrl": "http://merchant-site.com",
      "redirectUrl": "http://redirect-url.com",
      "purchasesToday": 0,
      "purchasesTotal": 0,
      "incomeToday": 0,
      "incomeTotal": 0,
      "balance": 0
    }
  ]
}