OpenAPI specification
Release: ActiveSingle operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
Loading, please wait…
Retrieve transaction details.
/v1/party/{partyId}/baas/transactions/{transactionId}/inquiryThis endpoint returns more granular details about the transaction line item. 💰Cash Advances Any POS transaction that has a cash advance (also commonly referred to as "Cash Back" not to be confused with cash back from rewards) amount, will have values for cash_withdrawal and purchase_amount. Note that the sum of cash_withdrawal and purchase_amount is equal to the transaction_total. For display purposes, it is recommended that you always display the transaction_total as the official amount for the transaction line item. The values given for cash_withdrawal and purchase_amount are to be used for the granular breakdown. If the POS transaction is not associated with a cash advance, then cash_withdrawal and purchase_amount will be null. 🔻ACH Transfers If the transaction line item is an ACH transfer, the fields ach_status, ach_transfer_id and can_cancel would be populated.
Showing 7 of 7 top-level parameters (7 total fields) for Transaction Details Inquiry
partyIdRequiredstringpathThe UUID of the Payfare (banking service) user.
transactionIdRequiredstringpathThe unique id of the transaction. For reward redemptions, the value would be "redemption"
Api-KeyRequiredstringheaderCommerceHub API key. Use the same value as the first part of the HMAC signing input.
Auth-Token-TypeRequiredstringheaderIdentifies the CommerceHub HMAC authentication scheme.
Available enum values
Selecting a value updates the request header.
Client-Request-IdRequiredstringheaderFresh client request identifier included in the HMAC signing input. Generate a new identifier for every request, for example using String(Date.now()). Use exactly the same value in the header and signature; this does not establish an idempotency or retry guarantee.
TimestampRequiredstringheaderRequest time as a 13-digit Unix timestamp in milliseconds, generated using String(Date.now()). Use exactly this value in the HMAC signing input. Accepted clock skew awaits confirmation.
AuthorizationRequiredstringheaderBase64(HMAC-SHA-256(apiSecret, apiKey + clientRequestId + timestamp)), without a prefix. Use exactly the values sent in the corresponding headers.
Request
Transaction Details InquiryResponse
Top-level fields returned in a successful (200) response.
statusstringThe status field.
messagestringThe message field.
dataobjectThe data field.
curl --request GET 'https://cert.api.fiservapps.com/ch/v1/party/{partyId}/baas/transactions/{transactionId}/inquiry' \
--header 'Api-Key: YOUR_API_KEY' \
--header 'Auth-Token-Type: HMAC' \
--header 'Client-Request-Id: YOUR_CLIENT_REQUEST_ID' \
--header 'Timestamp: YOUR_TIMESTAMP' \
--header 'Authorization: YOUR_BASE64_SIGNATURE' \
--header 'Accept: application/json'Standard HTTP error reference. Not every status applies to every operation.
| HTTP | Meaning | Guidance |
|---|---|---|
| 400 | Bad Request | Check the URL parameters, headers, and request payload. |
| 401 | Unauthorized | Verify the API key, HMAC signature, request ID, and timestamp. |
| 403 | Forbidden | Verify access to the requested service and resource. |
| 404 | Not Found | Check the endpoint and resource identifiers. |
| 409 | Conflict | Check the current resource state before repeating the operation. |
| 422 | Unprocessable Content | Review the returned validation details and correct the request. |
| 429 | Too Many Requests | Respect Retry-After when present; confirm retry safety before resending mutations. |
| 500 | Internal Server Error | Record the response and request identifier; confirm the outcome before retrying a mutation. |
| 502 | Bad Gateway | An upstream response failed. Confirm the outcome before retrying a mutation. |
| 503 | Service Unavailable | Respect Retry-After when present and confirm the outcome before retrying a mutation. |
| 504 | Gateway Timeout | The upstream response timed out. Check the operation outcome before resending. |
Single operation + dependencies. Includes the request, responses, and referenced schemas for this API—not the full product specification.
No Postman workflow is mapped to this operation. No product-wide collection is substituted.
QA collections: Configure your environment and credentials before running. Some requests create resources or move funds.