Get Transaction ID Information via API
On this page, you have two APIs:
Get Transaction information from a Transaction ID
Get Transaction information from a Survey ID
These APIs help an external system to have the information linked to a transaction. it might be used to:
Understand the status and any changes due to an existing reconciliation
Date and Time of any redirections
Information about Supplier
Survey details
Screener Answers
Get Transaction information from a Transaction ID
GET: $apihost/buyers/v3/surveys/1117045/transactions/3KT9WPQX5hQBOhof8RZRRA($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)
Response
CODE: 200 ok
[
{
"Survey ID": 1117045,
"Parent ID": "1117045",
"PSID": "d4a736a6-d5ef-b0ed-5d1e-fdec30a51339",
"Transaction ID": "3KT9WPQX5hQBOhof8RZRRA",
"Project Name": "teste123",
"Child Type": "Parent",
"Survey Country": "United States",
"Survey Language": "English",
"Supplier ID": 36,
"Supplier Name": "PramodNagar",
"Supplier Group": "",
"PO / Billing": "PS1117045",
"Requested By": "wtest",
"Supplier Respondent ID": "",
"Supplier Sid": "",
"Buyer ID": 25,
"Buyer Name": "PureSpectrum Buyer",
"PS Entry DateTime": "2025-03-05 09:27:31",
"Buyer Survey Entry Datetime": "2025-03-05 09:29:01",
"Buyer Survey Return Datetime": "2025-03-05 09:29:06",
"PS Exit Datetime": "2025-03-05 09:29:06",
"Respondent Status Code": 21,
"Respondent Status Description": "Complete",
"Offer ID": "",
"Respondent Source": "screener",
"Expected Buyer CPI": 1.3,
"Expected Buyer CPI Fx": "",
"Block": 1,
"Is Block Factor": 1,
"GPP": 0,
"GPP LOI": 1,
"GPP IR": 40,
"Respondent LOI": "",
"Respondent Buyer CPI": "1.30",
"Reconciliation Status": 0,
"Reconciliation Date": "2025-03-06 00:53:36",
"Reconciliation Reason": "",
"Transaction Original Status": "",
"Transaction Original Description": "",
"PM": "wasp-service-operator@test.com,jonastest2@test.com",
"Buyer PM Email": "",
"Sub Supplier Name": "",
"PS_Termination Reason": "",
"PS_Termination Code": "",
"PS_QuotaFull Reason": "",
"Gender": "Male",
"Gender Code": 111,
"Age": 33,
"Income": 545757,
"Race": "",
"Race Code": "",
"Race/Ethnicity": "",
"Race/Ethnicity Code": "",
"HispanicOrigin": "",
"HispanicOrigin Code": "",
"Relationship": "",
"Relationship Code": "",
"Employment": "",
"Employment Code": "",
"Education": "",
"Education Code": "",
"Device": "Desktop",
"Device Code": 111,
"ZipCode": "12345",
"Children Count": "",
"Child1 Age": "",
"Child1 Gender": "",
"Child2 Age": "",
"Child2 Gender": "",
"Child3 Age": "",
"Child3 Gender": "",
"Child4 Age": "",
"Child4 Gender": "",
"Child5 Age": "",
"Child5 Gender": "",
"Region": "Northeast",
"Region Code": 1,
"Division": "Middle Atlantic",
"Division Code": 2,
"State": "New York",
"State Code": 36,
"Browser": "Chrome",
"UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36",
"IP": "186.235.38.101",
"Programmatic Direct Transaction": true,
"Buyer PM": "",
"Reconciliation By": "",
"Respondent Substatus Description": "",
"Modular Transaction": false
}
]
Get Transaction information from a Survey ID
{{BASE_URL}}/buyers/v3/surveys/1114200/transactions?status=17,21&supplier_ids=2,100&page=1&limit=3status: comma-separated respondent status codes. (OPTIONAL)
supplier_ids: comma-separated respondent supplier IDs. (OPTIONAL)
page: (OPTIONAL) (DEFAULT = 1)
limit: max count of transactions in response. (OPTIONAL) (MAX/DEFAULT = 1000)
Response header
total: total count transactions.
total_page: total count of pages.
Response
CODE: 200 ok
[
{
"Survey ID": 1117045,
"Parent ID": "1117045",
"PSID": "d4a736a6-d5ef-b0ed-5d1e-fdec30a51339",
"Transaction ID": "3KT9WPQX5hQBOhof8RZRRA",
"Project Name": "teste123",
"Child Type": "Parent",
"Survey Country": "United States",
"Survey Language": "English",
"Supplier ID": 36,
"Supplier Name": "PramodNagar",
"Supplier Group": "",
"PO / Billing": "PS1117045",
"Requested By": "wtest",
"Supplier Respondent ID": "",
"Supplier Sid": "",
"Buyer ID": 25,
"Buyer Name": "PureSpectrum Buyer",
"PS Entry DateTime": "2025-03-05 09:27:31",
"Buyer Survey Entry Datetime": "2025-03-05 09:29:01",
"Buyer Survey Return Datetime": "2025-03-05 09:29:06",
"PS Exit Datetime": "2025-03-05 09:29:06",
"Respondent Status Code": 21,
"Respondent Status Description": "Complete",
"Offer ID": "",
"Respondent Source": "screener",
"Expected Buyer CPI": 1.3,
"Expected Buyer CPI Fx": "",
"Block": 1,
"Is Block Factor": 1,
"GPP": 0,
"GPP LOI": 1,
"GPP IR": 40,
"Respondent LOI": "",
"Respondent Buyer CPI": "1.30",
"Reconciliation Status": 0,
"Reconciliation Date": "2025-03-06 00:49:57",
"Reconciliation Reason": "",
"Transaction Original Status": "",
"Transaction Original Description": "",
"PM": "wasp-service-operator@test.com,jonastest2@test.com",
"Buyer PM Email": "",
"Sub Supplier Name": "",
"PS_Termination Reason": "",
"PS_Termination Code": "",
"PS_QuotaFull Reason": "",
"Gender": "Male",
"Gender Code": 111,
"Age": 33,
"Income": 545757,
"Race": "",
"Race Code": "",
"Race/Ethnicity": "",
"Race/Ethnicity Code": "",
"HispanicOrigin": "",
"HispanicOrigin Code": "",
"Relationship": "",
"Relationship Code": "",
"Employment": "",
"Employment Code": "",
"Education": "",
"Education Code": "",
"Device": "Desktop",
"Device Code": 111,
"ZipCode": "12345",
"Children Count": "",
"Child1 Age": "",
"Child1 Gender": "",
"Child2 Age": "",
"Child2 Gender": "",
"Child3 Age": "",
"Child3 Gender": "",
"Child4 Age": "",
"Child4 Gender": "",
"Child5 Age": "",
"Child5 Gender": "",
"Region": "Northeast",
"Region Code": 1,
"Division": "Middle Atlantic",
"Division Code": 2,
"State": "New York",
"State Code": 36,
"Browser": "Chrome",
"UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36",
"IP": "186.235.38.101",
"Programmatic Direct Transaction": true,
"Buyer PM": "",
"Reconciliation By": "",
"Respondent Substatus Description": "",
"Modular Transaction": false
},
{
"Survey ID": 1117085,
"Parent ID": "1117045",
"PSID": "3266000f-81dd-4d91-5aba-f46400752926",
"Transaction ID": "1K5qC6eBDbBojulmxzmUKe",
"Project Name": 1117085,
"Child Type": "Specific Audience",
"Survey Country": "United States",
"Survey Language": "English",
"Supplier ID": 36,
"Supplier Name": "PramodNagar",
"Supplier Group": "",
"PO / Billing": "PS1117045",
"Requested By": "wtest",
"Supplier Respondent ID": "testetstetschildparent",
"Supplier Sid": "",
"Buyer ID": 25,
"Buyer Name": "PureSpectrum Buyer",
"PS Entry DateTime": "2025-03-05 09:03:48",
"Buyer Survey Entry Datetime": "2025-03-05 09:05:22",
"Buyer Survey Return Datetime": "2025-03-05 09:05:27",
"PS Exit Datetime": "2025-03-05 09:05:27",
"Respondent Status Code": 21,
"Respondent Status Description": "Complete",
"Offer ID": "",
"Respondent Source": "screener",
"Expected Buyer CPI": 1.3,
"Expected Buyer CPI Fx": "",
"Block": 1,
"Is Block Factor": 1,
"GPP": 0,
"GPP LOI": 1,
"GPP IR": 40,
"Respondent LOI": "",
"Respondent Buyer CPI": "1.30",
"Reconciliation Status": 0,
"Reconciliation Date": "2025-03-06 00:49:57",
"Reconciliation Reason": "",
"Transaction Original Status": "",
"Transaction Original Description": "",
"PM": "wasp-service-operator@test.com,jonastest2@test.com",
"Buyer PM Email": "",
"Sub Supplier Name": "",
"PS_Termination Reason": "",
"PS_Termination Code": "",
"PS_QuotaFull Reason": "",
"Gender": "Male",
"Gender Code": 111,
"Age": 37,
"Income": 70000,
"Race": "",
"Race Code": "",
"Race/Ethnicity": "",
"Race/Ethnicity Code": "",
"HispanicOrigin": "",
"HispanicOrigin Code": "",
"Relationship": "",
"Relationship Code": "",
"Employment": "",
"Employment Code": "",
"Education": "",
"Education Code": "",
"Device": "Desktop",
"Device Code": 111,
"ZipCode": "12345",
"Children Count": "",
"Child1 Age": "",
"Child1 Gender": "",
"Child2 Age": "",
"Child2 Gender": "",
"Child3 Age": "",
"Child3 Gender": "",
"Child4 Age": "",
"Child4 Gender": "",
"Child5 Age": "",
"Child5 Gender": "",
"Region": "Northeast",
"Region Code": 1,
"Division": "Middle Atlantic",
"Division Code": 2,
"State": "New York",
"State Code": 36,
"Browser": "Chrome",
"UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36",
"IP": "186.333.38.101",
"Programmatic Direct Transaction": true,
"Buyer PM": "",
"Reconciliation By": "",
"Respondent Substatus Description": "",
"Modular Transaction": false
}
]Any date value has this format and timezone: “MM-DD-YYYY HH:MM:SS" , Timezone is PST.
Information returned:
Field returned | Descriptions | Remove (Y/N) |
Survey ID |
|
|
Parent ID |
|
|
PSID |
|
|
Transaction ID |
|
|
Project Name |
|
|
Child Type | Traffic channel type |
|
Survey Country |
|
|
Survey Language |
|
|
Supplier ID |
|
|
Supplier Name |
|
|
Supplier Group |
|
|
PO / Billing |
|
|
Requested By | The user that requested the project |
|
Supplier Respondent ID |
|
|
Supplier Sid |
|
|
Buyer ID |
|
|
Buyer Name |
|
|
PS Entry DateTime |
|
|
Buyer Survey Entry Datetime |
|
|
Buyer Survey Return Datetime |
|
|
PS Exit Datetime |
|
|
Respondent Status Code |
|
|
Respondent Status Description |
|
|
Offer ID |
|
|
Respondent Source | buyer_api / screener |
|
Expected Buyer CPI |
|
|
Expected Buyer CPI Fx |
|
|
Block |
|
|
Is Block Factor | Should this transaction be used when calculating a block? |
|
GPP | General Pricing Parameters = Overall LOI / Overall IR |
|
GPP LOI | General Pricing Parameters = Overall LOI / Overall IR |
|
GPP IR | General Pricing Parameters = Overall LOI / Overall IR |
|
Respondent LOI |
|
|
Respondent Buyer CPI |
|
|
Reconciliation Status |
|
|
Reconciliation Date |
|
|
Reconciliation Reason |
|
|
Transaction Original Status |
|
|
Transaction Original Description |
|
|
PM |
|
|
Buyer PM Email |
|
|
Sub Supplier Name |
|
|
PS_Termination Reason |
|
|
PS_Termination Code |
|
|
PS_QuotaFull Reason |
|
|
Gender |
|
|
Gender Code |
|
|
Age |
|
|
Income |
|
|
Race |
|
|
Race Code |
|
|
Race/Ethnicity |
|
|
Race/Ethnicity Code |
|
|
HispanicOrigin |
|
|
HispanicOrigin Code |
|
|
Relationship |
|
|
Relationship Code |
|
|
Employment |
|
|
Employment Code |
|
|
Education |
|
|
Education Code |
|
|
Device |
|
|
Device Code |
|
|
ZipCode |
|
|
Children Count |
|
|
Child1 Age |
|
|
Child1 Gender |
|
|
Child2 Age |
|
|
Child2 Gender |
|
|
Child3 Age |
|
|
Child3 Gender |
|
|
Child4 Age |
|
|
Child4 Gender |
|
|
Child5 Age |
|
|
Child5 Gender |
|
|
Region |
|
|
Region Code |
|
|
Division |
|
|
Division Code |
|
|
State |
|
|
State Code |
|
|
Browser |
|
|
UserAgent |
|
|
IP |
|
|
Programmatic Direct Transaction |
|
|
AT |
|
|
AT Code |
|
|
Buyer PM |
|
|
Reconciliation By |
|
|
Respondent Substatus Description |
|
|
Modular Transaction |
|
|
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 get the transaction details 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 get the transaction details 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": 1014,
"ps_api_response_message": "Not authorized to access survey"
}Response Error 5:
If the user tries to get the transaction details by sending the limit more than the allowed limit.
Response Code:
CODE: 400 Bad Request
Response Body:
{
"ps_api_response_code": 1014,
"ps_api_response_message": "Limit can not be greater than 1000."
}