O objeto address representam endereços associados aos customers. Um address possui os seguintes atributos:
| Atributo | Tipo | Descrição |
|---|---|---|
id | string | Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX |
line_1 | string | Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula. |
line_2 | string | Dados complementares do endereço. Neste campo pode ser informado complemento, referências. |
zip_code | integer | Código Postal (CEP). Apenas numérico. |
city | string | Cidade. |
state | string | Código do estado no formato ISO 3166-2. |
country | string | Código do país no formato ISO 3166-1 alpha-2. |
status | enum | Status do endereço. Valores possíveis: active ou deleted |
created_at | datetime | Data de criação do endereço (UTC). |
updated_at | datetime | Data de atualização do endereço (UTC). |
deleted_at | datetime | Data de exclusão do endereço (UTC). |
customer | object | Dados do cliente. Saiba mais sobre clientes. |
metadata | object | Informações adicionais sobre o endereço. Saiba mais sobre metadata. |
FORMATAÇÃO DO ENDEREÇO
O atributo
line_1deverá seguir o formato: Número, Rua, Bairro - nesta ordem e separados por vírgula, em virtude do antifraude ou boleto com registro, caso não tiver número pode enviar sem.O atributo
line_2poderá conter informações complementares do endereço, tais como andar, apto, sala, etc.
"line_1" : "375, Av. General Justo, Centro",
"line_2" : "7º andar, sala 01"
Atributos Descontinuados
O objeto
addresspossui ainda os atributos:street,number,complementeneighborhoodporém os mesmo serão descontinuados em breve, portanto, não é recomendado o uso destes campos.