WebsiteLoginStatus

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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitintegerOptionalExample: 5
offsetintegerOptionalExample: 0
Responses
200

OK

application/json
Responseobject
get
/v1/widget/purchase
200

OK

PreviousWidgetNextGET All Widget Deposits

Last updated

Was this helpful?