Get Partner Payers

get

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

The GET /partner/countries/{countryIso3Code}/states-and-provinces/{stateProvinceId}/cities/{cityId}/payers endpoint retrieves the list of payers 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, and cityId parameters are provided to retrieve the payers accurately.
Validation: Validate the request parameters to ensure they meet the requirements for retrieving the payers.

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 payers was successfully retrieved.

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

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

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