[v3] Get the status of a Transaction ID via API
Our updated BUY API documentation is available here.
We hope you enjoy the new experience! Reach out to us with your feedback or questions on supportbuyapi@purespectrum.com
Happy programming! 🎉
An external system may fetch a transaction in PureSpectrum for a number of reasons such as:
Making sure a TX is properly captured as completes
Knowing the status of a TX
Verifying the authenticity of a complete
Get the reconciliation information if the TX is reconciled
Request
GET : $apihost/$basepath/buyers/v3/surveys/{survey_id}/transactions/{transaction_id}/status($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)
Production host: https://api.spectrumsurveys.com/buyers/v3
Staging host: https://staging.spectrumsurveys.com/buyers/v3Considerations
Required Parameters must be present in the query string:
survey_idtransaction_id
Sample Request
GET : $apihost/$basepath/buyers/v3/surveys/18061/transactions/2ap6MR0tRS2l5jI1MVvlwW/statusResponse:
Response Code:
CODE: 200 OK
Response Body:
If reconciliation has not happened on the transaction
{
"status": 21,
"status_description": "Complete",
"reconciled": false,
"reconciliation_info": null
}If reconciliation has happened on the transaction
{
"status": 33,
"status_description": "Buyer_Reconciliation_Reject",
"reconciled": true,
"reconciliation_info": {
"reconciliation_date": "11-23-2025 22:26:58",
"original_status": 21,
"original_status_description": "Complete"
}
}reconciliation_dateformat and timezone: “MM-DD-YYYY HH:MM:SS" , Timezone is PST.
Response Error 1:
In case the Transaction ID does not exist for the survey
Response Code:
CODE: 400 Bad Request
Response Body:
{
"ps_api_response_code": 1014,
"ps_api_response_message": "Transaction Id does not exist for this survey. Please check the survey id and transaction Id and try again."
}Response Error 2:
In case the Transaction ID and Survey ID cannot be accessed with the used token
Response Code:
CODE: 403 Forbidden
Response Body:
{
"ps_api_response_code": 1012,
"ps_api_response_message": "User does not have a role in one of the following: operator,buyer"
}Response Error 3:
If the user tries to update the transaction status by using an Invalid access-token then the below error message will be displayed with 401 Unauthorized
Response Code:
CODE: 401 Unauthorized
Response Body:
{
"ps_api_response_code": 1012,
"ps_api_response_message": "Invalid access token"
}Response Error 4:
If the user tries to update the transaction status by using another buyer access token that does not belong to the transaction, then the below error message will be displayed with 403 Forbidden
Response Code:
CODE: 403 Forbidden
Response Body:
{
"ps_api_response_code": 9999,
"ps_api_response_message": "Not authorized to access transaction id"
}