# /catalogs/countries/{idCountry}/deliver-methods/{idDelivery}/payouts/{idpayout}/locations ## Purpose Returns the available physical payout locations (branches/agents) for a selected payout method. ## When to use Use this endpoint to: - Populate branch/location selection for cash pickup flows - Display branch details including address, business hours, and pickup instructions ## Authentication Requires x-client-id and x-secret-key headers. ## Notes - Requires idCountry, idDelivery, and idpayout. - Response may include fields such as WhatToBring and BusinessHours for customer guidance. ## Common errors - 400 Validation errors - 401 Invalid credentials - 404 Locations not found (when applicable) - 500 Internal error Endpoint: GET /catalogs/countries/{idCountry}/deliver-methods/{idDelivery}/payouts/{idpayout}/locations Version: 1.0.0 ## Header parameters: - `x-client-id` (string, required) Error codes: required=400001, type=400002, minLength=400003, maxLength=400004 Example: "xxxx123456789" - `x-secret-key` (string, required) Error codes: required=400001, type=400002, minLength=400003, maxLength=400004 Example: "xxxx987654321" ## Path parameters: - `idCountry` (string, required) Country ISO3 code (e.g., USA, MEX, COL) Example: "USA" - `idDelivery` (string, required) Delivery method ID Example: "C" - `idpayout` (string, required) Payout method ID Example: "1001" ## Response 200 fields (application/json): - `PaymentLocationCode` (string) - `PaymentLocationName` (string) - `CityName` (string) - `SubDivisionName` (string) - `AddressBranch` (string) - `WhatToBring` (string) - `BusinessHours` (string) ## Response 400 fields (application/json): - `errors` (array) List of object errorsError catalog for 400 (click to expand)CodeDescription400000The body of the request is required. Invalid JSON format of the request body.400001client_id is required400005secret_key is required - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) - `errors.details` (string) ## Response 401 fields (application/json): - `errors` (array) List of object errorsError catalog for 401 (click to expand)CodeDescription401000Invalid credentials - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) - `errors.details` (string) ## Response 404 fields (application/json): - `errors` (array) List of object errorsError catalog for 404 (click to expand)CodeDescription401000Location not found - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) - `errors.details` (string) ## Response 500 fields (application/json): - `errors` (array) List of object errorsError catalog for 500 (click to expand)CodeDescription500000Internal Error - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) - `errors.details` (string)