PUT v1/Location/SearchAgents

Returns a collapsed list of agent locations. For example, if a given brand contains 20 locations in a given city the results list will contain one entry with LocationCount = 20

Request Information

Parameters (ParameterName * = required)

Name
Description
Sample Value
AgentToId
ID of a payout agent (ex. BANCOMER
489712
CountryTo *
The 2-letter country code
MX
State *
State, province or territory
Baja California
City
Partial city name returns matches after 3+ characters
Tijuana
CityId
Numeric city ID
421020
DeliveryMethod *
Delivery method of the funds
OfficePickup
CurrencyTo
Payout currency that a location supports
MXN
TransferAmount
Amount sent in transaction
121.87
Brand
No description available
Not available
Locale
No description available
Not available
SendAmount
No description available
Not available
IsHybridPayAgentEnabled
No description available
Not available

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "city": "sample string 1",
    "cityId": 1,
    "state": "sample string 2",
    "country": "sample string 3",
    "locationCount": 4,
    "openPayment": true,
    "currency": "sample string 6",
    "customerRate": 7.0,
    "rateDecimals": 8,
    "displayOrder": 9,
    "payoutType": "NotOpen",
    "digitalAlias": "sample string 10",
    "isPremiumRate": true,
    "selectedAgentToInfoList": [
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      },
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      },
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      }
    ],
    "digitalCorrespondentGroups": true,
    "id": 13,
    "locationId": 14,
    "name": "sample string 15",
    "correspondentPayoutBrand": "sample string 16"
  },
  {
    "city": "sample string 1",
    "cityId": 1,
    "state": "sample string 2",
    "country": "sample string 3",
    "locationCount": 4,
    "openPayment": true,
    "currency": "sample string 6",
    "customerRate": 7.0,
    "rateDecimals": 8,
    "displayOrder": 9,
    "payoutType": "NotOpen",
    "digitalAlias": "sample string 10",
    "isPremiumRate": true,
    "selectedAgentToInfoList": [
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      },
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      },
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      }
    ],
    "digitalCorrespondentGroups": true,
    "id": 13,
    "locationId": 14,
    "name": "sample string 15",
    "correspondentPayoutBrand": "sample string 16"
  },
  {
    "city": "sample string 1",
    "cityId": 1,
    "state": "sample string 2",
    "country": "sample string 3",
    "locationCount": 4,
    "openPayment": true,
    "currency": "sample string 6",
    "customerRate": 7.0,
    "rateDecimals": 8,
    "displayOrder": 9,
    "payoutType": "NotOpen",
    "digitalAlias": "sample string 10",
    "isPremiumRate": true,
    "selectedAgentToInfoList": [
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      },
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      },
      {
        "agentToId": 1,
        "selectedAgentId": 2,
        "selectedAgentName": "sample string 3",
        "selectedAgentNo": "sample string 4"
      }
    ],
    "digitalCorrespondentGroups": true,
    "id": 13,
    "locationId": 14,
    "name": "sample string 15",
    "correspondentPayoutBrand": "sample string 16"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAgentToWithLocationContextResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <AgentToWithLocationContextResponse>
    <_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>sample string 16</_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>
    <_x003C_DigitalAlias_x003E_k__BackingField i:nil="true" />
    <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>false</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
    <_x003C_Id_x003E_k__BackingField>13</_x003C_Id_x003E_k__BackingField>
    <_x003C_IsPremiumRate_x003E_k__BackingField>false</_x003C_IsPremiumRate_x003E_k__BackingField>
    <_x003C_LocationId_x003E_k__BackingField>14</_x003C_LocationId_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>sample string 15</_x003C_Name_x003E_k__BackingField>
    <_x003C_OpenPayment_x003E_k__BackingField>false</_x003C_OpenPayment_x003E_k__BackingField>
    <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
    <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo" i:nil="true" />
    <_x003C_CityId_x003E_k__BackingField>1</_x003C_CityId_x003E_k__BackingField>
    <_x003C_City_x003E_k__BackingField>sample string 1</_x003C_City_x003E_k__BackingField>
    <_x003C_Country_x003E_k__BackingField>sample string 3</_x003C_Country_x003E_k__BackingField>
    <_x003C_Currency_x003E_k__BackingField>sample string 6</_x003C_Currency_x003E_k__BackingField>
    <_x003C_CustomerRate_x003E_k__BackingField>7</_x003C_CustomerRate_x003E_k__BackingField>
    <_x003C_DigitalAlias_x003E_k__BackingField>sample string 10</_x003C_DigitalAlias_x003E_k__BackingField>
    <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>true</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
    <_x003C_DisplayOrder_x003E_k__BackingField>9</_x003C_DisplayOrder_x003E_k__BackingField>
    <_x003C_IsPremiumRate_x003E_k__BackingField>true</_x003C_IsPremiumRate_x003E_k__BackingField>
    <_x003C_LocationCount_x003E_k__BackingField>4</_x003C_LocationCount_x003E_k__BackingField>
    <_x003C_OpenPayment_x003E_k__BackingField>true</_x003C_OpenPayment_x003E_k__BackingField>
    <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
    <_x003C_RateDecimals_x003E_k__BackingField>8</_x003C_RateDecimals_x003E_k__BackingField>
    <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo">
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
    </_x003C_SelectedAgentToInfoList_x003E_k__BackingField>
    <_x003C_State_x003E_k__BackingField>sample string 2</_x003C_State_x003E_k__BackingField>
  </AgentToWithLocationContextResponse>
  <AgentToWithLocationContextResponse>
    <_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>sample string 16</_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>
    <_x003C_DigitalAlias_x003E_k__BackingField i:nil="true" />
    <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>false</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
    <_x003C_Id_x003E_k__BackingField>13</_x003C_Id_x003E_k__BackingField>
    <_x003C_IsPremiumRate_x003E_k__BackingField>false</_x003C_IsPremiumRate_x003E_k__BackingField>
    <_x003C_LocationId_x003E_k__BackingField>14</_x003C_LocationId_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>sample string 15</_x003C_Name_x003E_k__BackingField>
    <_x003C_OpenPayment_x003E_k__BackingField>false</_x003C_OpenPayment_x003E_k__BackingField>
    <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
    <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo" i:nil="true" />
    <_x003C_CityId_x003E_k__BackingField>1</_x003C_CityId_x003E_k__BackingField>
    <_x003C_City_x003E_k__BackingField>sample string 1</_x003C_City_x003E_k__BackingField>
    <_x003C_Country_x003E_k__BackingField>sample string 3</_x003C_Country_x003E_k__BackingField>
    <_x003C_Currency_x003E_k__BackingField>sample string 6</_x003C_Currency_x003E_k__BackingField>
    <_x003C_CustomerRate_x003E_k__BackingField>7</_x003C_CustomerRate_x003E_k__BackingField>
    <_x003C_DigitalAlias_x003E_k__BackingField>sample string 10</_x003C_DigitalAlias_x003E_k__BackingField>
    <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>true</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
    <_x003C_DisplayOrder_x003E_k__BackingField>9</_x003C_DisplayOrder_x003E_k__BackingField>
    <_x003C_IsPremiumRate_x003E_k__BackingField>true</_x003C_IsPremiumRate_x003E_k__BackingField>
    <_x003C_LocationCount_x003E_k__BackingField>4</_x003C_LocationCount_x003E_k__BackingField>
    <_x003C_OpenPayment_x003E_k__BackingField>true</_x003C_OpenPayment_x003E_k__BackingField>
    <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
    <_x003C_RateDecimals_x003E_k__BackingField>8</_x003C_RateDecimals_x003E_k__BackingField>
    <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo">
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
    </_x003C_SelectedAgentToInfoList_x003E_k__BackingField>
    <_x003C_State_x003E_k__BackingField>sample string 2</_x003C_State_x003E_k__BackingField>
  </AgentToWithLocationContextResponse>
  <AgentToWithLocationContextResponse>
    <_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>sample string 16</_x003C_CorrespondentPayoutBrand_x003E_k__BackingField>
    <_x003C_DigitalAlias_x003E_k__BackingField i:nil="true" />
    <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>false</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
    <_x003C_Id_x003E_k__BackingField>13</_x003C_Id_x003E_k__BackingField>
    <_x003C_IsPremiumRate_x003E_k__BackingField>false</_x003C_IsPremiumRate_x003E_k__BackingField>
    <_x003C_LocationId_x003E_k__BackingField>14</_x003C_LocationId_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>sample string 15</_x003C_Name_x003E_k__BackingField>
    <_x003C_OpenPayment_x003E_k__BackingField>false</_x003C_OpenPayment_x003E_k__BackingField>
    <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
    <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo" i:nil="true" />
    <_x003C_CityId_x003E_k__BackingField>1</_x003C_CityId_x003E_k__BackingField>
    <_x003C_City_x003E_k__BackingField>sample string 1</_x003C_City_x003E_k__BackingField>
    <_x003C_Country_x003E_k__BackingField>sample string 3</_x003C_Country_x003E_k__BackingField>
    <_x003C_Currency_x003E_k__BackingField>sample string 6</_x003C_Currency_x003E_k__BackingField>
    <_x003C_CustomerRate_x003E_k__BackingField>7</_x003C_CustomerRate_x003E_k__BackingField>
    <_x003C_DigitalAlias_x003E_k__BackingField>sample string 10</_x003C_DigitalAlias_x003E_k__BackingField>
    <_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>true</_x003C_DigitalCorrespondentGroups_x003E_k__BackingField>
    <_x003C_DisplayOrder_x003E_k__BackingField>9</_x003C_DisplayOrder_x003E_k__BackingField>
    <_x003C_IsPremiumRate_x003E_k__BackingField>true</_x003C_IsPremiumRate_x003E_k__BackingField>
    <_x003C_LocationCount_x003E_k__BackingField>4</_x003C_LocationCount_x003E_k__BackingField>
    <_x003C_OpenPayment_x003E_k__BackingField>true</_x003C_OpenPayment_x003E_k__BackingField>
    <_x003C_PayoutType_x003E_k__BackingField>NotOpen</_x003C_PayoutType_x003E_k__BackingField>
    <_x003C_RateDecimals_x003E_k__BackingField>8</_x003C_RateDecimals_x003E_k__BackingField>
    <_x003C_SelectedAgentToInfoList_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DomainEntities.AgentTo">
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
      <d3p1:SelectedAgentToInfo>
        <d3p1:AgentToId>1</d3p1:AgentToId>
        <d3p1:SelectedAgentId>2</d3p1:SelectedAgentId>
        <d3p1:SelectedAgentName>sample string 3</d3p1:SelectedAgentName>
        <d3p1:SelectedAgentNo>sample string 4</d3p1:SelectedAgentNo>
      </d3p1:SelectedAgentToInfo>
    </_x003C_SelectedAgentToInfoList_x003E_k__BackingField>
    <_x003C_State_x003E_k__BackingField>sample string 2</_x003C_State_x003E_k__BackingField>
  </AgentToWithLocationContextResponse>
</ArrayOfAgentToWithLocationContextResponse>