Versions Compared

Version Old Version 19 New Version 20
Changes made by

Chad Nuesmeyer

Claudio Baldi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PRODUCTION API END POINTS:

...

Code Block
languagejson
[
    {
        "transaction_id": "7lNK5AGrSL3bk5tV4gw0Tr",
        "change_reason": "Suspected Fraud" // optional
    },
    {
        "transaction_id": "7dTdSUUWkR9DBs7rUi5jdT"
    },
    {
        "transaction_id": "5EmEbeX9mEblEpwP6yHG1K"
    },
    {
        "transaction_id": "6HkYQWFMcIcDOTxfnIi6op"
    }
]

RESPONSE PAYLOAD:

Tip

CODE: 200 OK

Code Block
languagejson
{
    "adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
    "summary": {
        "currentCompletes": 19,
        "previouslyRejectedCompletes": 1,
        "rejectingCompletesInCurrentUpload": 1,
        "acceptingCompletesInCurrentUpload": 0,
        "resultingCompletes": 18,
        "totalRawCompletes": 20,
        "totalRejects": 2,
        "rejectPercentage": "10.00",
        "desiredStatus": {21/33},
        "eligible": 1,
        "rejected": 1,
        "completed": 0,
        "test": 0,
        "transactions": 2,
        "transactionsWithDesiredStatus": 0,
        "summaryPerSurvey": [
            {
                "surveyId": 38226312,
                "currentCompletes": 19,
                "previouslyRejectedCompletes": 1,
                "rejectingCompletesInCurrentUpload": 1,
                "acceptingCompletesInCurrentUpload": 0,
                "resultingCompletes": 18,
                "totalRawCompletes": 20,
                "totalRejects": 2,
                "rejectPercentage": "10.00",
                "desiredStatus": 33,
                "eligible": 1,
                "rejected": 01,
                "completed": 2,0,
                "test": 0,
                "transactions": 2,
                "transactionsWithDesiredStatus": 0,
                "validCap": true
            }
        ],
        "validCap": true,
        "invoiced": 0,
        "isApiUser": true
    }
}
Note

NOTE: If one or more transaction_id/s (TXs) passed are ineligible or already reconciled, the system will start the reconciliation process and those TXs will be skipped.

Response explanation:

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

...

Note

NOTE: to get the transactions not eligible to reconcile or not reconciled withing the recon process you can use this formula

transactions - eligible = not eligible / not reconciled

Errors Codes:

All transactions are invalid or belong to another survey

  • The reconciliation process will not start

Warning

CODE: 400 Bad Request

Code Block
{
    "ps_api_response_code": 9999,
    "ps_api_response_message": "Unable to find surveys associated with submitted transactions"
}

Some, but not all, transactions are invalid or belong to another survey

  • The reconciliation process will not start

Warning

CODE: 400 Bad Request

Code Block
{
    "ps_api_response_code": 9999,
    "ps_api_response_message": "Some transactions belongs to another survey, Please check the request"
}

All transactions are ineligible for reconciliation

  • The reconciliation process will not start

Warning

CODE: 400 Bad Request

Code Block
{
    "ps_api_response_code": 9999,
    "ps_api_response_message": "File contain transactions that are ineligible for reconciliation. You may only reconcile completes in a closed survey, or completes from a prior month calendar or the survey has been already reconciled"
}

The total TX rejects allowed is reached. The limit set at the moment is 50%

  • The reconciliation process will not start

Warning

CODE: 400 Bad Request

Code Block
{
    "ps_api_response_code": 9999,
    "ps_api_response_message": "The number of total rejects, for this survey exceeds our threshold of 50% and can't be processed. Please upload a new file or contact PureSpectrum for assistance"
}

DESCRIPTION:

STAGING API and Payload:

...