Check Transaction Status

Retrieve the current status and details of a previously submitted transaction. Use this endpoint to verify that a transaction was successfully processed, check the current cashback processing status, get transaction details including amounts and timestamps, and confirm customer cashback credit status.

Development Environment

For testing and development, prepend the base URL: https://dev.api.grandshifts.com

GET/pos/v1/invoices/{invoiceNumber}/status

Use Cases

Verify that a transaction was successfully processed
Check the current cashback processing status
Get transaction details including amounts and timestamps
Confirm customer cashback credit status

Path Parameters

Property	Type	Description
invoiceNumberRequired	string	The unique invoice number from your PoS system that was used when submitting the transaction. Example: INV-2024-001234

Example Request

cURL

curl -X 'GET' \
  'https://dev.api.grandshifts.com/pos/v1/invoices/INV-2024-001234/status' \
  -H 'accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Response Schema

Property	Type	Description
invoiceIdRequired	number	Internal invoice ID. Example: 12345
invoiceNumberRequired	string	Invoice number. Example: INV-2024-001234
statusRequired	string	Current status. Enum: PENDING, APPROVED, REJECTED, PAID, REFUNDED, CANCELLED, CASHBACK_PROCESSED
grandTotalRequired	number	Grand total. Example: 977.5
vendorCashbackAmount	number	Cashback amount. Example: 48.88
cashbackProcessedAt	string	When cashback was processed. Example: 2024-01-15T10:30:05Z
refundedAt	string	When invoice was refunded (if applicable). Example: 2024-01-15T11:00:00Z
refundReason	string	Reason for refund (if applicable). Example: Customer requested refund

Success Response (200 OK)

Transaction status retrieved successfully.

Approved Transaction

{
  "invoiceId": 12345,
  "invoiceNumber": "INV-2024-001234",
  "status": "APPROVED",
  "grandTotal": 977.5,
  "vendorCashbackAmount": 48.88,
  "cashbackProcessedAt": "2024-01-15T10:30:05Z",
  "refundedAt": null,
  "refundReason": null
}

Example response for a refunded transaction:

Refunded Transaction

{
  "invoiceId": 12345,
  "invoiceNumber": "INV-2024-001234",
  "status": "REFUNDED",
  "grandTotal": 977.5,
  "vendorCashbackAmount": 48.88,
  "cashbackProcessedAt": "2024-01-15T10:30:05Z",
  "refundedAt": "2024-01-15T11:00:00Z",
  "refundReason": "Customer returned item"
}

Error Responses

401Unauthorized

Invalid or missing API key. Ensure you include a valid x-api-key header.

404Not Found

Transaction not found with the provided invoice number. Ensure the invoiceNumber matches exactly what was used during submission.