Get Status

Retrieve invoice status and details by ID

Endpoint

GET {BASE_URL}/crypto/v1/status/{id}

{id} is the invoice ID returned by createInvoice.

Get invoice status

get

Path parameters

idstringRequired

Invoice id returned from createInvoice.

Header parameters

apikeystringRequired

Merchant API key.

merchantidstringRequired

Merchant identifier bound to the API key.

Responses

200

Status found

application/json

successconst: Required

403

Missing API key or merchant ID header

application/json

404

Invoice not found

application/json

405

Invalid API key or merchant lookup failure

application/json

406

Missing id parameter

application/json

408

Merchant not associated with API key

application/json

412

Merchant not enrolled

application/json

501

Credential validation server error

application/json

505

Data fetch server error

application/json

get

/crypto/v1/status/{id}

HTTPcURLJavaScriptPython

GET /crypto/v1/status/{id} HTTP/1.1
Host: api.example.com
apikey: text
merchantid: text
Accept: */*

{
  "success": true,
  "data": {
    "id": "text",
    "client": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "paidAmount": 1,
    "subTotal": 1,
    "total": 1,
    "partialPaymentsEnabled": true,
    "tippingEnabled": true,
    "currency": "text",
    "completed": true,
    "description": "text",
    "transactions": [
      {
        "tx": "text",
        "sender": "text",
        "amount": 1,
        "cryptoAmount": 1,
        "timestamp": "2026-03-21T20:13:45.919Z",
        "network": "text"
      }
    ],
    "createdAt": "2026-03-21T20:13:45.919Z",
    "merchant": {
      "name": "text",
      "initiator": "text"
    }
  }
}

Required Headers

Header	Required	Type
apikey	Yes	String
merchantid	Yes	String

Success Response (200)

{
  "success": true,
  "data": {
    "client": {
      "name": "Optional Customer Name",
      "email": "[email protected]",
      "phone": "[phone]",
      "referenceID": "order-10001"
    },
    "paidAmount": 0.1,
    "subTotal": 0.1,
    "total": 0.1,
    "partialPaymentsEnabled": false,
    "tippingEnabled": true,
    "currency": "USDC",
    "completed": true,
    "description": "Optional Order Description",
    "transactions": [
      {
        "tx": "0xd1c7fe2821a9df5240f3d31e570a760322fa979f84c0655a8f9f857023e7064f",
        "sender": "0x2F67f1426f33E25A920F0b2139cd460fDfb8997C",
        "amount": 0.1,
        "cryptoAmount": 100000,
        "timestamp": "2024-09-05T21:00:27.000Z",
        "network": "MATIC_POLYGON"
      }
    ],
    "createdAt": "2024-09-05T20:59:47.429Z",
    "merchant": {
      "name": "Business Name",
      "initiator": "POS API Key Name"
    },
    "id": "66da1bc34f03a871430c1a71"
  }
}

Not Found Example (404)

{
  "success": false,
  "error": "Transaction not found."
}

Auth Failure Example (403)

{
  "success": false,
  "error": "No API-Key provided"
}

Response Fields

Field	Type	Description
id	String	Invoice identifier
client	Object	Submitted client object
paidAmount	Number	Total paid amount in USD-equivalent invoice accounting
subTotal	Number	Invoice subtotal
total	Number	Invoice total after client-facing fees
partialPaymentsEnabled	Boolean	Partial payment behavior flag
tippingEnabled	Boolean	Tipping behavior flag
currency	String	Invoice settlement currency (commonly USDC)
completed	Boolean	Invoice completion state
description	String	Optional invoice description
transactions	Array	Payments posted to invoice
createdAt	Datetime	Invoice creation timestamp
merchant	Object	Merchant name and key initiator

Error Statuses

Status	Meaning
403	Missing apikey or merchantid
404	Invoice not found
405	Invalid API key or merchant lookup failure
406	Missing id path parameter
408	Merchant is not associated with API key
412	Merchant is not enrolled in cryptoPOS-V1
501	Credential validation server error
505	Data fetch server error