Endpoints

https://api.ebanx.com/ws/zipcode

https://sandbox.ebanx.com/ws/zipcode

HTTP Method

GET

Response

JSON

This is a server-to-server HTTP GET used by the merchant website to query EBANX for the address for a given zipcode.

Request parameters

integration_key

string, length 100, required

Your unique and secret integration key.

zipcode

string, length 8, 00000000, required

A valid brazilian zipcode.

Response parameters

status

string

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

zipcode.state

string, length 2

The state code (two-letter code).

zipcode.city

string, length 128

The city name.

zipcode.name

string, length 256

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