Resource URL Summary

Pass Through Call to Dispatch's "Update Payment Info" API

PUT /up/v5/rest/dispatch/updatePaymentInfo

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Pass Through Call to Dispatch's "Update Payment Info" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Update Payment Info" API (when configured).

URL

PUT /up/v5/rest/dispatch/updatePaymentInfo

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Dispatch "Update Payment Info" API.

UpdatePaymentInfo Object Format

{
    "MfgSvcrAcct": "FSSTEST",
    "Id": "CT.2019-4-30.100192",
    "Payment": [
        {
            "CoPayAmount": "20.00",
            "ServiceContractId": "4447587",
            "ServiceContractEndDate": "2019-11-21",
            "PONumber": "0555",
            "POAmount": 200,
            "VPONumber": "556896",
            "VPOAmount": 120,
            "WarrantyType": "REP"
        }
    ],
    "Coverage": {
        "Component": "",
        "CoverageElement": "",
        "CoverageDays": "",
        "BillTo": "",
        "MaxReimburse": "",
        "CoverageStartDate": "",
        "CoverageEndDate": ""
    }
}

UpdatePaymentInfo Object Properties

Property		Type	Required?	Description	Dispatch Field Mapping
`MfgSvcrAcct`		`string`	No	This servicer Id given by the requestor.	`MfgSvcrAcct`
`Id`		`string`	No	The call number that was used when the call was originally created.	`CallNo`
`Payment`		`array`	No	Pass through parameter to the Dispatch "Update Payment Info" API.	-
	`CoPayAmount`	`string`	No	This will determine how much servicer needs to charge the Consumer. It will collect from the consumer for the service.	`CoPayAmount`
	`ServiceContractId`	`string`	No	The Consumer Service contract number on the product. This is used in Claims processing.	`SvcContKey`
	`ServiceContractEndDate`	`string`	No	The Consumer Service contract expiration date. This is used in Claims processing.	`ContExpiryDate`
	`PONumber`	`string`	No	Purchase Order Number. For display purpose only.	`PONumber`
	`POAmount`	`integer`	No	Purchase Order Amount	`POAmount`
	`VPONumber`	`string`	No	Future use.	`VPONumber`
	`VPOAmount`	`integer`	No	Future use.	`VPOAmount`
	`WarrantyType`	`string`	No	Warranty Type. The primary ‘bill to’ (i.e. Manufacturers Warranty, Service Contract, Owners Warranty, Sales Fulfillment).	`WarrantyType`
`Coverage`		`object`	No	This field details who will pay for the call.	`Coverage`
	`Component`	`string`	No	Description about the component.	`Component`
	`CoverageElement`	`string`	No	This element explains what part of the element is covered under warranty.	`CoverageElement`
	`CoverageDays`	`string`	No	How long the warranty period is expressed in days.	`CoverageDays`
	`BillTo`	`string`	No	Pass through parameter to the Dispatch "Update Payment Info" API.	`BillTo`
	`MaxReimburse`	`string`	No	The max amount will be paid by Warranty.	`MaxReimburse`
	`CoverageStartDate`	`string`	No	Start date of the warranty.	`CoverageStartDate`
	`CoverageEndDate`	`string`	No	End date of the warranty.	CoverageEndDate

,
    "Id": "CT.2019-4-30.100192",
    "AckMsg": ""
}

Error

On error, a JSON-formatted version of the Dispatch "Update Payment Info" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}

Return Codes

In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.

ServiceBroker 5

UpdatePaymentInfo RESTified API

Analytics