Versions Compared

Version Old Version 10 New Version Current
Changes made by

Jason Andrew

Jason Andrew

Saved on

Key

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

Status
colourGreen
title5.4.0

A pass-through API to Dispatch (when configured) which allows the Dispatch's "Update Payment Info" API to be called.         


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

PUT /up/v5/rest/dispatch/updatePaymentInfo

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Code Block
languagejs
{
    "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


TypeRequired?DescriptionDispatch Field Mapping
MfgSvcrAcctstringNo

This servicer Id given by the requestor.

MfgSvcrAcct
IdstringNoThe call number that was used when the call was originally created.CallNo
PaymentarrayNo

Pass through parameter to the Dispatch "Update Payment Info" API. 

-

CoPayAmountstringNoThis will determine how much servicer needs to charge the Consumer. It will collect from the consumer for the service.CoPayAmount

ServiceContractIdstringNoPass through parameter to the Dispatch "Update Payment Info" API. The Consumer Service contract number on the product. This is used in Claims processing.SvcContKey

ServiceContractEndDatestringNoPass through parameter to the Dispatch "Update Payment Info" API. 

The Consumer Service contract expiration date. This is used in Claims processing.

ContExpiryDate

PONumberstringNoPass through parameter to the Dispatch "Update Payment Info" API. Purchase Order Number. For display purpose only.PONumber

POAmountintegerNoPass through parameter to the Dispatch "Update Payment Info" API. 

Purchase Order Amount

POAmount

VPONumberstringNoPass through parameter to the Dispatch "Update Payment Info" API. Future use.VPONumber

VPOAmountintegerNoPass through parameter to the Dispatch "Update Payment Info" API. Future use.VPOAmount

WarrantyTypestringNoPass through parameter to the Dispatch "Update Payment Info" API. Warranty Type. The primary ‘bill to’ (i.e.
Manufacturers Warranty, Service Contract, Owners Warranty, Sales Fulfillment).		WarrantyType
CoverageobjectNoPass through parameter to the Dispatch "Update Payment Info" API. This field details who will pay for the call.Coverage

ComponentstringNoPass through parameter to the Dispatch "Update Payment Info" API. Description about the component.Component

CoverageElementstringNoPass through parameter to the Dispatch "Update Payment Info" API. This element explains what part of the element is covered under warranty.CoverageElement

CoverageDaysstringNoPass through parameter to the Dispatch "Update Payment Info" API. 

How long the warranty period is expressed in days.

CoverageDays

BillTostringNoPass through parameter to the Dispatch "Update Payment Info" API. BillTo

MaxReimbursestringNoPass through parameter to the Dispatch "Update Payment Info" API. 

The max amount will be paid by Warranty.

MaxReimburse

CoverageStartDatestringNoPass through parameter to the Dispatch "Update Payment Info" API. Start date of the warranty.CoverageStartDate

CoverageEndDatestringNoPass through parameter to the Dispatch "Update Payment Info" APIEnd date of the warranty. CoverageEndDate  


Code Block
languagejs
,
    "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.

Code Block
languagejs
{
    "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.