Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

PRODUCTION API END POINTS:

Single survey: 
POST: https://api.spectrumsurveys.com/buyers/v2/adjustments/surveys/{surveyId}?operationType=LIVE_RECONCILIATION&reconStatus={1/2} 

Multiple Survey: 
POST: https://api.spectrumsurveys.com/buyers/v2/adjustments?operationType=LIVE_RECONCILIATION&reconStatus={1/2}

Change the transaction status to Complete use

  • reconStatus = 1

Change the transaction status to Buyer_Reconciliation_Reject use

  • reconStatus = 2

Example Single Survey Call:

API: 

Change to Complete
POST:
{url}/adjustments/surveys/:surveyId?operationType=LIVE_RECONCILIATION&reconStatus=1

Change to Buyer_Reconciliation_Reject
POST:
{url}/adjustments/surveys/:surveyId?operationType=LIVE_RECONCILIATION&reconStatus=2

REQUEST PAYLOAD:

[
    {
        "transaction_id": "7lNK5AGrSL3bk5tV4gw0Tr"
    },
    {
        "transaction_id": "7dTdSUUWkR9DBs7rUi5jdT"
    },
    {
        "transaction_id": "5EmEbeX9mEblEpwP6yHG1K"
    },
    {
        "transaction_id": "6HkYQWFMcIcDOTxfnIi6op"
    }
]

RESPONSE PAYLOAD:

{
    "adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
    "summary": {
        "desiredStatus": {21/33},
        "transactions": 4,
        "eligible": 4,
        "liveReconciled": 2,
        "rejected": 0
    }
}

Response explanation:

"eligible": are the transactions that are eligible and the status changed within the process

"liveReconciled": are the transactions that are already live reconciled from the list

"rejected": are the transactions that are already reconciled and not accepted for reconciliation.

"transactions": total completes uploaded

DESCRIPTION:

STAGING API and Payload:

1 - Reconciliation Single Survey:

Buyer API endPoint - Change the transaction to Buyer_Reconciliation_Reject:

POST : https://staging.spectrumsurveys.com/buyers/v2/adjustments/surveys/{surveyId}?operationType=LIVE_RECONCILIATION&reconStatus=2
API: POST
Access-token: Buyer account

Request Payload:

[
    {
        "transaction_id": "7lNK5AGrSL3bk5tV4gw0Tr"
    },
    {
        "transaction_id": "7dTdSUUWkR9DBs7rUi5jdT"
    },
    {
        "transaction_id": "5EmEbeX9mEblEpwP6yHG1K"
    },
    {
        "transaction_id": "6HkYQWFMcIcDOTxfnIi6op"
    }
]

Response:

{
    "adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
    "summary": {
        "desiredStatus": 33,
        "transactions": 4,
        "eligible": 4,
        "liveReconciled": 2,
        "rejected": 0
    }
}

2 - Reconciliation multiple surveys (Bulk Reconciliation)

Buyer API endPoint - Change the transaction to Buyer_Reconciliation_Reject:

POST : https://staging.spectrumsurveys.com/buyers/v2/adjustments?operationType=LIVE_RECONCILIATION&reconStatus=2
API:POST
Access-token:Buyer account

Request 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": {
        "desiredStatus": 33,
        "transactions": 6,
        "eligible": 6,
        "liveReconciled": 2,
        "rejected": 2
    }
}

Note:

For testing purposes, use this document to create a test transaction:

How to create a Complete on Staging - Reconciliation Testing

  • No labels