---
title: "MerchantAddress:List"
method: GET
path: "/v2/merchantaddresses/list"
tags: ["MerchantAddress"]
---

# MerchantAddress:List

`GET /v2/merchantaddresses/list`

## Request

- Base URL: `https://connect.pay.nl`
- URL: `https://connect.pay.nl/v2/merchantaddresses/list`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

Retrieve a simple list of all Addresses. You can supply a merchant code to retrieve the addresses for that merchant. If no merchant code is provided, the addresses associated with your own merchant registration will be returned.

## Query parameters

- `merchant` object
  - `eq` string: Get results that equal the given value
- `type` object
  - `eq` string: Get results that equal the given value

## Response `200`

OK

- MerchantMerchantAddressesListOutput: A collection of minimal merchant address representations.
  - `merchantAddresses` MerchantMerchantAddressListItemOutput[]: Collection of Merchant.MerchantAddressListItemOutput objects or an empty array
    - `code` string: The address code identifier.
    - `streetName` string: The name of the street.
    - `streetNumber` string: The street number.
    - `zipCode` string: A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.
    - `city` string: The name of a city.
    - `countryCode` string, nullable: The country code consisting of 2 uppercase letters.
    - `type` 'VISIT' | 'POSTAL' | 'COMPANY': The address type.
  - `total` integer, nullable: The total items the collection contains
  - `_links` LinkOutput[], nullable
    - `href` string, nullable: The URI to the linked resource
    - `rel` string, nullable: The name of the linked resource
    - `type` string, nullable: The (http(s)) method needed to approach the linked resource

## Other responses

- `400`: Bad request, see response body for more information
- `401`: Unauthorized. Supplied credentials are invalid
- `403`: Forbidden. Supplied credentials have no rights
- `404`: Resource not found
- `405`: Used HTTP method is not allowed
- `406`: Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410`: Indicates that this resource is no longer available for use
- `415`: Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429`: Rate limit reached.
- `500`: An internal error occurred.
- `503`: The server is currently unable to handle your request

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) - [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc?raw)