GET All Widget Purchases

Get widget's list of purchases

get

Get widget's list of purchases

This endpoint is used to get all purchases by WIDGET_API_KEY.

Request

Headers

  • Authorization: Bearer {{WIDGET_API_KEY}}

Query Params

  • limit: number

  • offset: number

Response

  • Status: 200 OK

  • Content Type: application/json

Response Body

{
  "data": 
    "purchases": [
      {
        "id": string,
        "title": string,
        "subTitle": string,
        "siteName": string,
        "asset": Enum('USDT', 'USDC', 'ETH', 'MATIC','BNB', 'TRX', 'BTC'),
        "blockchain": Enum('ethereum', 'tron', 'binance-smart-chain', 'MATIC', 'bitcoin'),
        "address": string,
        "transaction": string[],
        "fiatAmount": number,
        "fiatCurrency": [
            Enum('USD', 'EUR')
         ],
        "currentDate": Date,
        "amount": number,
        "plannedAmount": number,
        "baseCurrencyAmount": number,
        "plannedBaseCurrencyAmount": number,
        "creationDate": Date,
        "allocationDate": Date,
        "expirationDate": Date,
        "status": ENUM('Allocated', 'Expired', 'Unconfirmed', 'Confirming', 'Completed', 'Overcharge', 'Undercharge', 'Failed', 'GenerateAddressFailed', 'Swept'),
        "widgetId": string,
        "redirectUrl": string,
        "confirmationAmount": number,
        "acceptPartialPayment": boolean,
        "widgetName": string,
        "sweepingStatus": <TBD>,
        "sweepingFee": <TBD>
        "merchantName": string,
        "redirectUrl": string,
        "widgetId": string,
        "purchaseIdentifier": string,
      }
    ],
   "total": number
}
Authorizations
Query parameters
limitintegerOptionalExample: 5
offsetintegerOptionalExample: 0
Responses
200

OK

application/json
Responseobject
get
GET /v1/widget/purchase HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": {
    "purchases": [
      {
        "id": "4f251421-d481-4590-a493-4b180dbcc4f5",
        "title": "Payment",
        "subTitle": "The payment description",
        "siteName": "Merchant Site",
        "asset": "USDC",
        "blockchain": "ethereum",
        "address": "0xe4827dc95c976ec1f7e5f2c02ec1824b9aa400c9",
        "transactions": [],
        "fiatAmount": 1.5,
        "fiatCurrency": "USD",
        "currentDate": "2025-05-02T11:08:23.236Z",
        "confirmationAmount": 12,
        "amount": 0,
        "plannedAmount": 1.51,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 1.500131,
        "creationDate": "2025-04-30T08:14:03.255Z",
        "allocationDate": "2025-04-30T08:14:48.095Z",
        "expirationDate": "2025-04-30T08:24:48.095Z",
        "status": "Allocated",
        "acceptPartialPayment": true,
        "widgetName": "MyFirstWidget9",
        "sweepingStatus": "TBD",
        "sweepingFee": "TBD",
        "merchantName": "Merchant #1",
        "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
        "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
        "purchaseIdentifier": "[email protected]"
      },
      {
        "id": "9dda9e39-dd1c-4fcf-aaa7-1e917c5be829",
        "title": "woocommerce",
        "subTitle": "woocommerce",
        "siteName": "woocommerce",
        "address": null,
        "transactions": [],
        "fiatAmount": 500000,
        "fiatCurrency": "EUR",
        "currentDate": "2025-05-02T11:08:23.236Z",
        "confirmationAmount": 1,
        "amount": 0,
        "plannedAmount": 0,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 0,
        "creationDate": "2025-04-30T07:12:04.149Z",
        "allocationDate": null,
        "expirationDate": null,
        "status": "Initiated",
        "acceptPartialPayment": true,
        "widgetName": "MyFirstWidget9",
        "sweepingStatus": "TBD",
        "sweepingFee": "TBD",
        "merchantName": "Merchant #1",
        "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
        "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
        "purchaseIdentifier": "inabit_wc_order_kObFb1WCr4jaG_1745997123"
      },
      {
        "id": "1d3130d8-490c-4bbe-9293-98a6946e0e2a",
        "title": "woocommerce",
        "subTitle": "woocommerce",
        "siteName": "woocommerce",
        "address": null,
        "transactions": [],
        "fiatAmount": 500000,
        "fiatCurrency": "EUR",
        "currentDate": "2025-05-02T11:08:23.236Z",
        "confirmationAmount": 1,
        "amount": 0,
        "plannedAmount": 0,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 0,
        "creationDate": "2025-04-30T07:04:06.042Z",
        "allocationDate": null,
        "expirationDate": null,
        "status": "Initiated",
        "acceptPartialPayment": true,
        "widgetName": "MyFirstWidget9",
        "sweepingStatus": "TBD",
        "sweepingFee": "TBD",
        "merchantName": "Merchant #1",
        "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
        "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
        "purchaseIdentifier": "inabit_wc_order_6SgURExYzGpTn_1745996645"
      },
      {
        "id": "b5b20231-527c-43c5-927c-bdd1caeed1bf",
        "title": "woocommerce",
        "subTitle": "woocommerce",
        "siteName": "woocommerce",
        "address": null,
        "transactions": [],
        "fiatAmount": 1000000,
        "fiatCurrency": "EUR",
        "currentDate": "2025-05-02T11:08:23.236Z",
        "confirmationAmount": 1,
        "amount": 0,
        "plannedAmount": 0,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 0,
        "creationDate": "2025-04-30T06:57:38.846Z",
        "allocationDate": null,
        "expirationDate": null,
        "status": "Initiated",
        "acceptPartialPayment": true,
        "widgetName": "MyFirstWidget9",
        "sweepingStatus": "TBD",
        "sweepingFee": "TBD",
        "merchantName": "Merchant #1",
        "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
        "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
        "purchaseIdentifier": "inabit_wc_order_xekGDPxdCjej4_1745996258"
      },
      {
        "id": "0ccbcc91-d79e-4958-8298-77695d5dfca6",
        "title": "woocommerce",
        "subTitle": "woocommerce",
        "siteName": "woocommerce",
        "asset": "USDC",
        "blockchain": "ethereum",
        "address": "0x3e2338973beb76d02d07298e9e0e45de7523782c",
        "transactions": [],
        "fiatAmount": 500000,
        "fiatCurrency": "EUR",
        "currentDate": "2025-05-02T11:08:23.236Z",
        "confirmationAmount": 12,
        "amount": 0,
        "plannedAmount": 569599.87,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 569530,
        "creationDate": "2025-04-30T06:53:52.333Z",
        "allocationDate": "2025-04-30T06:53:58.019Z",
        "expirationDate": "2025-04-30T07:03:58.019Z",
        "status": "Allocated",
        "acceptPartialPayment": true,
        "widgetName": "MyFirstWidget9",
        "sweepingStatus": "TBD",
        "sweepingFee": "TBD",
        "merchantName": "Merchant #1",
        "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
        "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
        "purchaseIdentifier": "inabit_wc_order_bIVN8dMsplAbs_1745996032"
      }
    ],
    "total": 268
  }
}

Last updated

Was this helpful?