Get Partner Payer Locations

get

https://sandbox-api.readyremit.com/v1/partner/countries/{countryIso3Code}/states-and-provinces/{stateProvinceId}/cities/{cityId}/payers/{payerId}/locations

The GET /partner/countries/{countryIso3Code}/states-and-provinces/{stateProvinceId}/cities/{cityId}/payers/{payerId}/locations endpoint retrieves the list of locations for a specific payer within a specified city for a given state or province and country. This operation is specifically for Cash Pickup services.

Implementation Guide:

Prerequisite: Ensure that the countryIso3Code, stateProvinceId, cityId, and payerId parameters are provided to retrieve the locations accurately.
Validation: Validate the request parameters to ensure they meet the requirements for retrieving the locations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The list of locations for the payer was successfully retrieved.

400The request was invalid. This response typically occurs if the countryIso3Code, stateProvinceId, cityId, or payerId parameter is missing or invalid.

401The request requires user authentication. This response occurs if the authentication token is missing or invalid.

404The locations could not be retrieved. This response occurs if the countryIso3Code, stateProvinceId, cityId, or payerId does not match any existing records.