Reconciliation via API
- Claudio Baldi
- Chad Nuesmeyer
- Anshuman Saha
PRODUCTION API END POINTS:
Single survey:
POST : https://api.spectrumsurveys.com/buyers/v2/adjustments/surveys/{surveyId}
Multiple Survey:
https://api.spectrumsurveys.com/buyers/v2/adjustmentsDESCRIPTION:
STAGING API and Payload:
1 - Reconciliation Single Survey:
Buyer API endPoint:
POST : https://staging.spectrumsurveys.com/buyers/v2/adjustments/surveys/{surveyId}
API: POST
Access-token: Buyer accountRequest Payload:
[
{
"transaction_id": "7lNK5AGrSL3bk5tV4gw0Tr"
},
{
"transaction_id": "7dTdSUUWkR9DBs7rUi5jdT"
},
{
"transaction_id": "5EmEbeX9mEblEpwP6yHG1K"
},
{
"transaction_id": "6HkYQWFMcIcDOTxfnIi6op"
}
]Â
Response:
{
"adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
"summary": {
"transactions": 4,
"eligible": 4,
"completes": 1,
"rejected": 0
}
}Â
2 - Reconciliation multiple surveys (Bulk Reconciliation)
Buyer API endPoint:
POST : https://staging.spectrumsurveys.com/buyers/v2/adjustments
API:POST
Access-token:Buyer accountRequest Payload:
[
{
"transaction_id": "7by1JwD0oLzX1iip0liui4"
},
{
"transaction_id": "7Er50MDCnV0b0bc91S8Qr1"
},
{
"transaction_id": "41JBHVbfHas8kzAwYhGW9l"
},
{
"transaction_id": "7mwVC728181yok8mKgDzQv"
},
{
"transaction_id": "21NJOoeCB4mXoMZXg77bNo"
},
{
"transaction_id": "5j2UOEpgsMlXoLix0qtU0W"
}
]Â
Response:
{
"adjustment_id": "46e10177-c3a3-4246-a33a-0c8306f3a9a6",
"summary": {
"transactions": 6,
"eligible": 6,
"completes": 0,
"rejected": 2
}
}NOTE 1:
The system always records any Reconciliation process made via API or UI and this information can be find on the Survey dashboard → Reconciliation Tab
These are the label show:
Reject : Reconciliation via UI - TX changes to
buyer_rejectsReject (API): Reconciliation via API - TX changes to
buyer_rejectsComplete: Reconciliation via UI - TX changes to
completeComplete (API): Reconciliation via UI - TX changes to
buyer_rejectsAccept: Reconciliation via UI - Any TX in the file will changes to
completeif they are eligible, and the TX current completes not in the file, will changebuyer_rejectsAccept (API): Reconciliation via API - Any TX in the file will changes to
completeif they are eligible, and the TX current completes not in the file, will changebuyer_rejects
Â
Â
NOTE 2:
if you need to test the Reconciliation API and you want to create some test transactions, please ask your account manager or contact the PureSpectrum product team and they will give you access to a document that will allow you to create a transaction via API.
Â
NOTE 3:
10pm PT is the absolute latest you can submit a reconciliation for it to be included in the next months invoice.
Â