GET v1/xpressPay/byPhone/{phoneNumber}/settings

Get XpressPay settings for a given phone number.

Request Information

URI Parameters

Name	Description	Type	Additional information
phoneNumber		string	Required

Body Parameters

None.

Response Information

Resource Description

XpressPaySettingsResult

Name	Type	Additional information
XpressPaySettings	Collection of XpressPaySettings	None.
Errors	Collection of Exception	None.
IsSuccess	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "XpressPaySettings": [
    {
      "HangUpWhenConvenienceFeeDeclined": true,
      "SpanishConvenienceFeePrompt": "sample string 2",
      "ConvenienceFeeIVRPrompt": "sample string 3",
      "FacilityId": "5311c25c-4674-41c0-a4c6-83b86d2d45a7",
      "VoicemailFallbackNumber": "sample string 5",
      "ChargeNextMonthsRentBeforeDays": "sample string 6",
      "UsePMSConvenienceFee": true,
      "AccountLookupByAccountId": true,
      "AccountLookupByAccountIdVerify": true,
      "AccountLookupAcrossCrmAccount": true,
      "CallerIDExemptNumbers": "sample string 11",
      "Country": "sample string 12"
    },
    {
      "HangUpWhenConvenienceFeeDeclined": true,
      "SpanishConvenienceFeePrompt": "sample string 2",
      "ConvenienceFeeIVRPrompt": "sample string 3",
      "FacilityId": "5311c25c-4674-41c0-a4c6-83b86d2d45a7",
      "VoicemailFallbackNumber": "sample string 5",
      "ChargeNextMonthsRentBeforeDays": "sample string 6",
      "UsePMSConvenienceFee": true,
      "AccountLookupByAccountId": true,
      "AccountLookupByAccountIdVerify": true,
      "AccountLookupAcrossCrmAccount": true,
      "CallerIDExemptNumbers": "sample string 11",
      "Country": "sample string 12"
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:

<XpressPayModels.XpressPaySettingsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">true</IsSuccess>
  <XpressPaySettings>
    <XpressPayModels.XpressPaySettings>
      <AccountLookupAcrossCrmAccount>true</AccountLookupAcrossCrmAccount>
      <AccountLookupByAccountId>true</AccountLookupByAccountId>
      <AccountLookupByAccountIdVerify>true</AccountLookupByAccountIdVerify>
      <CallerIDExemptNumbers>sample string 11</CallerIDExemptNumbers>
      <ChargeNextMonthsRentBeforeDays>sample string 6</ChargeNextMonthsRentBeforeDays>
      <ConvenienceFeeIVRPrompt>sample string 3</ConvenienceFeeIVRPrompt>
      <Country>sample string 12</Country>
      <FacilityId>5311c25c-4674-41c0-a4c6-83b86d2d45a7</FacilityId>
      <HangUpWhenConvenienceFeeDeclined>true</HangUpWhenConvenienceFeeDeclined>
      <SpanishConvenienceFeePrompt>sample string 2</SpanishConvenienceFeePrompt>
      <UsePMSConvenienceFee>true</UsePMSConvenienceFee>
      <VoicemailFallbackNumber>sample string 5</VoicemailFallbackNumber>
    </XpressPayModels.XpressPaySettings>
    <XpressPayModels.XpressPaySettings>
      <AccountLookupAcrossCrmAccount>true</AccountLookupAcrossCrmAccount>
      <AccountLookupByAccountId>true</AccountLookupByAccountId>
      <AccountLookupByAccountIdVerify>true</AccountLookupByAccountIdVerify>
      <CallerIDExemptNumbers>sample string 11</CallerIDExemptNumbers>
      <ChargeNextMonthsRentBeforeDays>sample string 6</ChargeNextMonthsRentBeforeDays>
      <ConvenienceFeeIVRPrompt>sample string 3</ConvenienceFeeIVRPrompt>
      <Country>sample string 12</Country>
      <FacilityId>5311c25c-4674-41c0-a4c6-83b86d2d45a7</FacilityId>
      <HangUpWhenConvenienceFeeDeclined>true</HangUpWhenConvenienceFeeDeclined>
      <SpanishConvenienceFeePrompt>sample string 2</SpanishConvenienceFeePrompt>
      <UsePMSConvenienceFee>true</UsePMSConvenienceFee>
      <VoicemailFallbackNumber>sample string 5</VoicemailFallbackNumber>
    </XpressPayModels.XpressPaySettings>
  </XpressPaySettings>
</XpressPayModels.XpressPaySettingsResult>