PUT v1/Location/SearchAgentLocations
Returns an expanded list of agent locations. For example, if a given brand contains 20 locations in a given city the results list will contain 20 entries
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:
[
{
"agentToId": 1,
"agentToName": "sample string 2",
"locationId": 3,
"branchNumber": "sample string 4",
"locationName": "sample string 5",
"locationAddress": "sample string 6",
"locationAddress2": "sample string 7",
"locationCity": "sample string 8",
"locationState": "sample string 9",
"currency": "sample string 10",
"phone": "sample string 11",
"locationType": 12,
"collectionLocation": true,
"payoutLocation": true,
"sendLocation": true,
"latitude": 16.0,
"longitude": 17.0,
"businessHours": [
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
},
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
},
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
}
]
},
{
"agentToId": 1,
"agentToName": "sample string 2",
"locationId": 3,
"branchNumber": "sample string 4",
"locationName": "sample string 5",
"locationAddress": "sample string 6",
"locationAddress2": "sample string 7",
"locationCity": "sample string 8",
"locationState": "sample string 9",
"currency": "sample string 10",
"phone": "sample string 11",
"locationType": 12,
"collectionLocation": true,
"payoutLocation": true,
"sendLocation": true,
"latitude": 16.0,
"longitude": 17.0,
"businessHours": [
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
},
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
},
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
}
]
},
{
"agentToId": 1,
"agentToName": "sample string 2",
"locationId": 3,
"branchNumber": "sample string 4",
"locationName": "sample string 5",
"locationAddress": "sample string 6",
"locationAddress2": "sample string 7",
"locationCity": "sample string 8",
"locationState": "sample string 9",
"currency": "sample string 10",
"phone": "sample string 11",
"locationType": 12,
"collectionLocation": true,
"payoutLocation": true,
"sendLocation": true,
"latitude": 16.0,
"longitude": 17.0,
"businessHours": [
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
},
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
},
{
"dayOfWeek": "Monday",
"timeOpen": "sample string 1",
"timeClose": "sample string 2",
"timeZoneAbbrev": "sample string 3",
"timeZoneName": "sample string 4",
"comments": "sample string 5"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfAgentToLocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
<AgentToLocationResponse>
<_x003C_AgentToId_x003E_k__BackingField>1</_x003C_AgentToId_x003E_k__BackingField>
<_x003C_AgentToName_x003E_k__BackingField>sample string 2</_x003C_AgentToName_x003E_k__BackingField>
<_x003C_BranchNumber_x003E_k__BackingField>sample string 4</_x003C_BranchNumber_x003E_k__BackingField>
<_x003C_BusinessHours_x003E_k__BackingField>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
</_x003C_BusinessHours_x003E_k__BackingField>
<_x003C_CollectionLocation_x003E_k__BackingField>true</_x003C_CollectionLocation_x003E_k__BackingField>
<_x003C_Currency_x003E_k__BackingField>sample string 10</_x003C_Currency_x003E_k__BackingField>
<_x003C_Latitude_x003E_k__BackingField>16</_x003C_Latitude_x003E_k__BackingField>
<_x003C_LocationAddress2_x003E_k__BackingField>sample string 7</_x003C_LocationAddress2_x003E_k__BackingField>
<_x003C_LocationAddress_x003E_k__BackingField>sample string 6</_x003C_LocationAddress_x003E_k__BackingField>
<_x003C_LocationCity_x003E_k__BackingField>sample string 8</_x003C_LocationCity_x003E_k__BackingField>
<_x003C_LocationId_x003E_k__BackingField>3</_x003C_LocationId_x003E_k__BackingField>
<_x003C_LocationName_x003E_k__BackingField>sample string 5</_x003C_LocationName_x003E_k__BackingField>
<_x003C_LocationState_x003E_k__BackingField>sample string 9</_x003C_LocationState_x003E_k__BackingField>
<_x003C_LocationType_x003E_k__BackingField>12</_x003C_LocationType_x003E_k__BackingField>
<_x003C_Longitude_x003E_k__BackingField>17</_x003C_Longitude_x003E_k__BackingField>
<_x003C_PayoutLocation_x003E_k__BackingField>true</_x003C_PayoutLocation_x003E_k__BackingField>
<_x003C_Phone_x003E_k__BackingField>sample string 11</_x003C_Phone_x003E_k__BackingField>
<_x003C_SendLocation_x003E_k__BackingField>true</_x003C_SendLocation_x003E_k__BackingField>
</AgentToLocationResponse>
<AgentToLocationResponse>
<_x003C_AgentToId_x003E_k__BackingField>1</_x003C_AgentToId_x003E_k__BackingField>
<_x003C_AgentToName_x003E_k__BackingField>sample string 2</_x003C_AgentToName_x003E_k__BackingField>
<_x003C_BranchNumber_x003E_k__BackingField>sample string 4</_x003C_BranchNumber_x003E_k__BackingField>
<_x003C_BusinessHours_x003E_k__BackingField>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
</_x003C_BusinessHours_x003E_k__BackingField>
<_x003C_CollectionLocation_x003E_k__BackingField>true</_x003C_CollectionLocation_x003E_k__BackingField>
<_x003C_Currency_x003E_k__BackingField>sample string 10</_x003C_Currency_x003E_k__BackingField>
<_x003C_Latitude_x003E_k__BackingField>16</_x003C_Latitude_x003E_k__BackingField>
<_x003C_LocationAddress2_x003E_k__BackingField>sample string 7</_x003C_LocationAddress2_x003E_k__BackingField>
<_x003C_LocationAddress_x003E_k__BackingField>sample string 6</_x003C_LocationAddress_x003E_k__BackingField>
<_x003C_LocationCity_x003E_k__BackingField>sample string 8</_x003C_LocationCity_x003E_k__BackingField>
<_x003C_LocationId_x003E_k__BackingField>3</_x003C_LocationId_x003E_k__BackingField>
<_x003C_LocationName_x003E_k__BackingField>sample string 5</_x003C_LocationName_x003E_k__BackingField>
<_x003C_LocationState_x003E_k__BackingField>sample string 9</_x003C_LocationState_x003E_k__BackingField>
<_x003C_LocationType_x003E_k__BackingField>12</_x003C_LocationType_x003E_k__BackingField>
<_x003C_Longitude_x003E_k__BackingField>17</_x003C_Longitude_x003E_k__BackingField>
<_x003C_PayoutLocation_x003E_k__BackingField>true</_x003C_PayoutLocation_x003E_k__BackingField>
<_x003C_Phone_x003E_k__BackingField>sample string 11</_x003C_Phone_x003E_k__BackingField>
<_x003C_SendLocation_x003E_k__BackingField>true</_x003C_SendLocation_x003E_k__BackingField>
</AgentToLocationResponse>
<AgentToLocationResponse>
<_x003C_AgentToId_x003E_k__BackingField>1</_x003C_AgentToId_x003E_k__BackingField>
<_x003C_AgentToName_x003E_k__BackingField>sample string 2</_x003C_AgentToName_x003E_k__BackingField>
<_x003C_BranchNumber_x003E_k__BackingField>sample string 4</_x003C_BranchNumber_x003E_k__BackingField>
<_x003C_BusinessHours_x003E_k__BackingField>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
<AgentToLocationBusinessHoursResponse>
<_x003C_Comments_x003E_k__BackingField>sample string 5</_x003C_Comments_x003E_k__BackingField>
<_x003C_DayOfWeek_x003E_k__BackingField>Monday</_x003C_DayOfWeek_x003E_k__BackingField>
<_x003C_TimeClose_x003E_k__BackingField>sample string 2</_x003C_TimeClose_x003E_k__BackingField>
<_x003C_TimeOpen_x003E_k__BackingField>sample string 1</_x003C_TimeOpen_x003E_k__BackingField>
<_x003C_TimeZoneAbbrev_x003E_k__BackingField>sample string 3</_x003C_TimeZoneAbbrev_x003E_k__BackingField>
<_x003C_TimeZoneName_x003E_k__BackingField>sample string 4</_x003C_TimeZoneName_x003E_k__BackingField>
</AgentToLocationBusinessHoursResponse>
</_x003C_BusinessHours_x003E_k__BackingField>
<_x003C_CollectionLocation_x003E_k__BackingField>true</_x003C_CollectionLocation_x003E_k__BackingField>
<_x003C_Currency_x003E_k__BackingField>sample string 10</_x003C_Currency_x003E_k__BackingField>
<_x003C_Latitude_x003E_k__BackingField>16</_x003C_Latitude_x003E_k__BackingField>
<_x003C_LocationAddress2_x003E_k__BackingField>sample string 7</_x003C_LocationAddress2_x003E_k__BackingField>
<_x003C_LocationAddress_x003E_k__BackingField>sample string 6</_x003C_LocationAddress_x003E_k__BackingField>
<_x003C_LocationCity_x003E_k__BackingField>sample string 8</_x003C_LocationCity_x003E_k__BackingField>
<_x003C_LocationId_x003E_k__BackingField>3</_x003C_LocationId_x003E_k__BackingField>
<_x003C_LocationName_x003E_k__BackingField>sample string 5</_x003C_LocationName_x003E_k__BackingField>
<_x003C_LocationState_x003E_k__BackingField>sample string 9</_x003C_LocationState_x003E_k__BackingField>
<_x003C_LocationType_x003E_k__BackingField>12</_x003C_LocationType_x003E_k__BackingField>
<_x003C_Longitude_x003E_k__BackingField>17</_x003C_Longitude_x003E_k__BackingField>
<_x003C_PayoutLocation_x003E_k__BackingField>true</_x003C_PayoutLocation_x003E_k__BackingField>
<_x003C_Phone_x003E_k__BackingField>sample string 11</_x003C_Phone_x003E_k__BackingField>
<_x003C_SendLocation_x003E_k__BackingField>true</_x003C_SendLocation_x003E_k__BackingField>
</AgentToLocationResponse>
</ArrayOfAgentToLocationResponse>