WebAPI

<back to all web services

GetPayment

/GetPayment will retrive an unregistered payment made on a transaction given a license plate number, and an FjNo

The following routes are available for this service:
GET/GetPayment/{PlateNumber}/{FjNo}To retrieve an unregistered payment, and the crossings for which the payment was made
Parameters:
NameParameterData TypeRequiredDescription
PlateNumberpathstringYes
FjNopathintegerYes

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetPayment HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <FjNo>0</FjNo>
  <PlateNumber>String</PlateNumber>
</GetPayment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPaymentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <CreditCardNumber>String</CreditCardNumber>
  <CrossingHistories>
    <CrossingHistory>
      <Direction>String</Direction>
      <Fare>0</Fare>
      <PlateNo>String</PlateNo>
      <TransactionDate>0001-01-01T00:00:00</TransactionDate>
      <TransactionId>0</TransactionId>
    </CrossingHistory>
  </CrossingHistories>
  <CurrentBalance>0</CurrentBalance>
  <ExpireDate>0001-01-01T00:00:00</ExpireDate>
  <PaymentAmount>0</PaymentAmount>
  <PaymentDate>0001-01-01T00:00:00</PaymentDate>
  <PlateInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebCRMV2.Data.Web.Models">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:AccountTagID>0</d2p1:AccountTagID>
    <d2p1:AgencyId>0</d2p1:AgencyId>
    <d2p1:AxleCount>0</d2p1:AxleCount>
    <d2p1:Comment>String</d2p1:Comment>
    <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
    <d2p1:CreatedBy>String</d2p1:CreatedBy>
    <d2p1:DMVExpDate>0001-01-01T00:00:00</d2p1:DMVExpDate>
    <d2p1:DMVRegDate>0001-01-01T00:00:00</d2p1:DMVRegDate>
    <d2p1:DMVVehCode>String</d2p1:DMVVehCode>
    <d2p1:DeletionStateCode>0</d2p1:DeletionStateCode>
    <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
    <d2p1:Extensions>String</d2p1:Extensions>
    <d2p1:IsRegistrationFeePaid>false</d2p1:IsRegistrationFeePaid>
    <d2p1:LastUpd>0001-01-01T00:00:00</d2p1:LastUpd>
    <d2p1:LastUpdApp>String</d2p1:LastUpdApp>
    <d2p1:LastUpdBy>String</d2p1:LastUpdBy>
    <d2p1:LicPlateCountry>String</d2p1:LicPlateCountry>
    <d2p1:LicPlateNo>String</d2p1:LicPlateNo>
    <d2p1:LicPlateState>String</d2p1:LicPlateState>
    <d2p1:LookUpDt>0001-01-01T00:00:00</d2p1:LookUpDt>
    <d2p1:LookupStatus>0</d2p1:LookupStatus>
    <d2p1:PlateId>0</d2p1:PlateId>
    <d2p1:PlateStatusDate>0001-01-01T00:00:00</d2p1:PlateStatusDate>
    <d2p1:PlateStatusId>0</d2p1:PlateStatusId>
    <d2p1:PlateTypeId>0</d2p1:PlateTypeId>
    <d2p1:ProgramId>0</d2p1:ProgramId>
    <d2p1:SerialNumber>0</d2p1:SerialNumber>
    <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
    <d2p1:SubAccountId>0</d2p1:SubAccountId>
    <d2p1:VehClassIAGId>0</d2p1:VehClassIAGId>
    <d2p1:VehClassId>0</d2p1:VehClassId>
    <d2p1:VehSeqNo>0</d2p1:VehSeqNo>
    <d2p1:VehicleClassCode>0</d2p1:VehicleClassCode>
    <d2p1:VehicleColor>String</d2p1:VehicleColor>
    <d2p1:VehicleDetailId>0</d2p1:VehicleDetailId>
    <d2p1:VehicleIdentificationNumber>String</d2p1:VehicleIdentificationNumber>
    <d2p1:VehicleMake1>String</d2p1:VehicleMake1>
    <d2p1:VehicleMakeId>0</d2p1:VehicleMakeId>
    <d2p1:VehicleModel>String</d2p1:VehicleModel>
    <d2p1:VehicleYear>String</d2p1:VehicleYear>
    <d2p1:isDeleted>false</d2p1:isDeleted>
    <d2p1:isDualTires>false</d2p1:isDualTires>
    <d2p1:oldAccountTagId>0</d2p1:oldAccountTagId>
  </PlateInfo>
  <RemainingCount>0</RemainingCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</GetPaymentResult>