GET All Org Purchases

Get merchant's list of purchases

post

Get merchant's list of purchases

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

Request

Method: GET
URL: http://localhost:3000/v1/purchase/search

Headers

Authorization: Bearer {{ORGANIZATION_API_KEY}}

Query Params

limit: number
offset: number

Body

{
  "searchText?": string,
  "statuses": string[],
  "widgetUuids": string[],
  "merchants": string[],
  "createdAt": Date;
}

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

Body

objectOptionalExample:

{ // "searchText": "sam" // "statuses": ["Completed"] // "widgetUuids": ["903fea77-636c-477a-9692-d189b92b56bc", "95ba9ae3-7b71-482d-9989-23e420483c59"] // "merchants": ["Merchant #1"] // "createdAt": "2025-04-25T16:43" }

Responses

201

Created

application/json

Responseobject

post/v1/merchant/purchase/search

POST /v1/merchant/purchase/search HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 283

"{\r\n    // \"searchText\": \"sam\"\r\n    // \"statuses\": [\"Completed\"]\r\n    // \"widgetUuids\": [\"903fea77-636c-477a-9692-d189b92b56bc\", \"95ba9ae3-7b71-482d-9989-23e420483c59\"]\r\n    // \"merchants\": [\"Merchant #1\"]\r\n    // \"createdAt\": \"2025-04-25T16:43\"\r\n}"

201

Created

{
  "data": {
    "purchases": [
      {
        "id": "9707d9d6-e38b-46a5-93e6-e182e2998bcc",
        "title": "F-16 Fighting Falcon",
        "subTitle": "Fighter aircraft",
        "siteName": "MySuperSite",
        "asset": "TRX",
        "blockchain": "tron",
        "address": "TJ82CHL6mrUpiobrq1Co1CYeML1BrPF1sa",
        "transactions": [],
        "fiatAmount": 5,
        "fiatCurrency": "USD",
        "currentDate": "2025-05-02T10:50:55.762Z",
        "confirmationAmount": 20,
        "amount": 0,
        "plannedAmount": 20.401369,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 5,
        "creationDate": "2025-05-02T10:11:11.181Z",
        "allocationDate": "2025-05-02T10:11:25.435Z",
        "expirationDate": "2025-05-02T10:21:25.435Z",
        "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": "customer@gmail.com"
      },
      {
        "id": "cabcb234-7409-4611-adf6-4484b49e0d44",
        "title": "F-16 Fighting Falcon",
        "subTitle": "Fighter aircraft",
        "siteName": "MySuperSite",
        "address": null,
        "transactions": [],
        "fiatAmount": 5,
        "fiatCurrency": "USD",
        "currentDate": "2025-05-02T10:50:55.762Z",
        "confirmationAmount": 1,
        "amount": 0,
        "plannedAmount": 0,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 0,
        "creationDate": "2025-05-02T10:09:59.653Z",
        "allocationDate": null,
        "expirationDate": null,
        "status": "Failed",
        "acceptPartialPayment": true,
        "widgetName": "MyFirstWidget9",
        "sweepingStatus": "TBD",
        "sweepingFee": "TBD",
        "merchantName": "Merchant #1",
        "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
        "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
        "purchaseIdentifier": "customer@gmail.com"
      },
      {
        "id": "35798a3f-593a-4d96-a391-f72fe2114e4f",
        "title": "Payment",
        "subTitle": "The payment description",
        "siteName": "Merchant Site",
        "address": null,
        "transactions": [],
        "fiatAmount": 1.5,
        "fiatCurrency": "USD",
        "currentDate": "2025-05-02T10:50:55.762Z",
        "confirmationAmount": 1,
        "amount": 0,
        "plannedAmount": 0,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 0,
        "creationDate": "2025-04-30T10:18:27.773Z",
        "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": "customer@gmail.com"
      },
      {
        "id": "914a5275-2efe-4f8e-a297-c7351eb6a70a",
        "title": "Payment",
        "subTitle": "The payment description",
        "siteName": "Merchant Site",
        "address": null,
        "transactions": [],
        "fiatAmount": 1.5,
        "fiatCurrency": "USD",
        "currentDate": "2025-05-02T10:50:55.762Z",
        "confirmationAmount": 1,
        "amount": 0,
        "plannedAmount": 0,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 0,
        "creationDate": "2025-04-30T09:12:21.503Z",
        "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": "customer@gmail.com"
      },
      {
        "id": "5068ff2c-dc7c-483c-b523-ae7bf224d547",
        "title": "Payment",
        "subTitle": "The payment description",
        "siteName": "Merchant Site",
        "asset": "TRX",
        "blockchain": "tron",
        "address": "TSRgRsSagJkeTza5Ei2bamDHp3sscbWhud",
        "transactions": [],
        "fiatAmount": 1.5,
        "fiatCurrency": "USD",
        "currentDate": "2025-05-02T10:50:55.762Z",
        "confirmationAmount": 20,
        "amount": 0,
        "plannedAmount": 6.125299,
        "baseCurrency": "USD",
        "baseCurrencyAmount": 0,
        "plannedBaseCurrencyAmount": 1.500047,
        "creationDate": "2025-04-30T09:10:51.468Z",
        "allocationDate": "2025-04-30T09:11:33.747Z",
        "expirationDate": "2025-04-30T09:21:33.747Z",
        "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": "customer@gmail.com"
      }
    ],
    "total": 389
  }
}

PreviousGET Widget by ID NextGET Org Purchase by ID

Last updated 1 year ago