This page's content:


HTTP Method




The zip code operation is a server-to-server HTTP POST used by the merchant website to query EBANX for the address for a given zip code.

Only available for Brazil

Request parameters

integration_key string, length 100, required

Your unique and secret integration key.

zipcode string, length 8, 00000000, required

A valid Brazilian zip code.

Response parameters

status string

The status of the the request (SUCCESS or ERROR).

zipcode.state string, length 2

The state code (two-letter code). string, length 128

The city name. string, length 256

The street name. It may be empty because the zipcode may not have been assigned to a specific street.