PUT v1/Location/SearchAgentPayoutCities

Returns a list of available payout cities where correpsondent locations are present for a given country. This query includes CityId in the result.

Request Information

Parameters (ParameterName * = required)

Name

Description

Sample Value

DeliveryMethod *

Delivery method of the funds

OfficePickup

CurrencyTo

Payout currency that a location supports

MXN

CountryTo *

The 2-letter country code

City *

Partial city name returns matches after 3+ characters

Tijuana

State

State, province or territory

Baja California

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "cityName": "sample string 1",
    "cityId": 1,
    "stateAbbrev": "sample string 2",
    "state": "sample string 3",
    "formattedCityState": "sample string 4"
  },
  {
    "cityName": "sample string 1",
    "cityId": 1,
    "stateAbbrev": "sample string 2",
    "state": "sample string 3",
    "formattedCityState": "sample string 4"
  },
  {
    "cityName": "sample string 1",
    "cityId": 1,
    "stateAbbrev": "sample string 2",
    "state": "sample string 3",
    "formattedCityState": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <CityResponse>
    <_x003C_CityId_x003E_k__BackingField>1</_x003C_CityId_x003E_k__BackingField>
    <_x003C_CityName_x003E_k__BackingField>sample string 1</_x003C_CityName_x003E_k__BackingField>
    <_x003C_FormattedCityState_x003E_k__BackingField>sample string 4</_x003C_FormattedCityState_x003E_k__BackingField>
    <_x003C_StateAbbrev_x003E_k__BackingField>sample string 2</_x003C_StateAbbrev_x003E_k__BackingField>
    <_x003C_State_x003E_k__BackingField>sample string 3</_x003C_State_x003E_k__BackingField>
  </CityResponse>
  <CityResponse>
    <_x003C_CityId_x003E_k__BackingField>1</_x003C_CityId_x003E_k__BackingField>
    <_x003C_CityName_x003E_k__BackingField>sample string 1</_x003C_CityName_x003E_k__BackingField>
    <_x003C_FormattedCityState_x003E_k__BackingField>sample string 4</_x003C_FormattedCityState_x003E_k__BackingField>
    <_x003C_StateAbbrev_x003E_k__BackingField>sample string 2</_x003C_StateAbbrev_x003E_k__BackingField>
    <_x003C_State_x003E_k__BackingField>sample string 3</_x003C_State_x003E_k__BackingField>
  </CityResponse>
  <CityResponse>
    <_x003C_CityId_x003E_k__BackingField>1</_x003C_CityId_x003E_k__BackingField>
    <_x003C_CityName_x003E_k__BackingField>sample string 1</_x003C_CityName_x003E_k__BackingField>
    <_x003C_FormattedCityState_x003E_k__BackingField>sample string 4</_x003C_FormattedCityState_x003E_k__BackingField>
    <_x003C_StateAbbrev_x003E_k__BackingField>sample string 2</_x003C_StateAbbrev_x003E_k__BackingField>
    <_x003C_State_x003E_k__BackingField>sample string 3</_x003C_State_x003E_k__BackingField>
  </CityResponse>
</ArrayOfCityResponse>