Reconciliations
Receive reconciliation information in real time
Positive reconciliations (e.g. term to complete) and negative reconciliations (complete to term) can be communicated via a daily, weekly, or monthly email report or via webhook.
A supplier may provide Prodege with a webhook URL which will be called when reconciliations occur. Please see below for a description of the data that will be included for each reconciliation.
Reconciliation Webhook Parameters
Parameter Name
Parameter Type
Description
reconciliations
Array
Array of reconciliations. See elements model and example below.
signature
String
reconciliations Model
Parameter Name
Parameter Type
Description
transid
Numeric
The id that uniquely identifies this project transaction.
newstatus
Numeric
The new status for this transaction (1 for Success, 2 for Overquota, 3 for Disqualification, 4 for Quality Termination).
projectid
Numeric
The id that uniquely identifies this project.
vpid
String
The Supplier Panelist ID.
passthruvariables
String
Data passed into the survey URL.
reconciliations example:
[
{
"transid":123,
"newstatus":1,
"projectid":123,
"vpid":"xyz",
"passthruvariables":"var1=1234567&var2=abcdefg"
},
{
"transid":456,
"newstatus":1,
"projectid":123,
"vpid":"abc",
"passthruvariables":"var1=1234567&var2=abcdefg"
},
{
"transid":789,
"newstatus":2,
"projectid":456,
"vpid":"d12",
"passthruvariables":"var1=7654321&var2=gfedcba"
}
]
Returning a success response (200) will indicate that the reconciliations have been received successfully. Returning a failure response (e.g. 500) will indicate that the reconciliations were not successfully received and the batch of reconciliations will be sent again the next hour.
If there is an issue with an individual transid, the errors array described below can be returned with detailed explanations.
Reconciliation Webhook Response Parameters
Parameter Name
Parameter Type
Description
errors
Array
Array of transids and associated errors. See elements model and example below.
errors Model
Property Name
Property Type
Description
transid
Numeric
The id that uniquely identifies this project transaction.
error
String
A description of the error that occurred for that reconciliation.
Errors example:
[
{
"transid":123,
"error":"error msg..."
},
{
"transid":456,
"error":"error msg 2..."
}
]
Last updated