GET Org Purchase by ID

Get merchant's purchase by UUID

get

Get merchant's purchase by UUID

This endpoint is used to get mercpurchase by purchase's unique identifier (UUID).

Request

• Method: GET

• URL: http://localhost:3000/v1/purchase/:purchaseUuid

Headers

• Authorization: Bearer {{ORGANIZATION_API_KEY}}

Response

• Status: 200 OK

• Content Type: application/json

Response Body

{
  "data": {
    {
      "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,
    }
  }
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

Responseobject

get/v1/merchant/purchase/dadb4fff-d69e-4760-980a-182b15421ff9

HTTPcURLJavaScriptPython

GET /v1/merchant/purchase/dadb4fff-d69e-4760-980a-182b15421ff9 HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "data": {
    "id": "057590e2-002d-4c3b-b646-6a9fbcda89b0",
    "title": "Payment Title X",
    "subTitle": "The payment description XXX",
    "siteName": "Merchant Site",
    "asset": "TRX",
    "blockchain": "tron",
    "address": "TSRgRsSagJkeTza5Ei2bamDHp3sscbWhud",
    "transactions": [
      "302ae537cde6d88bafc5f84f8406ffab48f973bd31cce40de15b66d9adcfb00a"
    ],
    "fiatAmount": 2.5,
    "fiatCurrency": "USD",
    "currentDate": "2025-05-02T10:52:02.871Z",
    "confirmationAmount": 20,
    "amount": 10.174252,
    "plannedAmount": 10.174252,
    "baseCurrency": "USD",
    "baseCurrencyAmount": 2.499494,
    "plannedBaseCurrencyAmount": 2.499979,
    "creationDate": "2025-04-29T15:28:48.742Z",
    "allocationDate": "2025-04-29T15:29:07.974Z",
    "expirationDate": "2025-04-29T15:39:07.974Z",
    "status": "Completed",
    "acceptPartialPayment": true,
    "widgetName": "MyFirstWidget9",
    "sweepingStatus": "TBD",
    "sweepingFee": "TBD",
    "merchantName": "Merchant #1",
    "redirectUrl": "https://dev-merchant.aybabtu.xyz/",
    "widgetId": "8157eb9f-0ace-45ae-b8c9-7953637896cf",
    "purchaseIdentifier": "[e-mail]"
  }
}