Endereços

O objeto address representam endereços associados aos customers. Um address possui os seguintes atributos:

AtributoTipoDescrição
idstringCódigo do endereço. Formato: addr_XXXXXXXXXXXXXXXX
line_1stringDados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula.
line_2stringDados complementares do endereço. Neste campo pode ser informado complemento, referências.
zip_codeintegerCódigo Postal (CEP).
citystringCidade.
statestringCódigo do estado no formato ISO 3166-2.
countrystringCódigo do país no formato ISO 3166-1 alpha-2.
statusenumStatus do endereço. Valores possíveis: active ou deleted
created_atdatetimeData de criação do endereço.
updated_atdatetimeData de atualização do endereço.
deleted_atdatetimeData de exclusão do endereço.
customerobjectDados do cliente. Saiba mais sobre clientes.
metadataobjectInformações adicionais sobre o endereço. Saiba mais sobre metadata.

❗️

FORMATAÇÃO DO ENDEREÇO

O atributo line_1 deverá 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_2 poderá 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 address possui ainda os atributos: street, number, complement e neighborhood porém os mesmo serão descontinuados em breve, portanto, não é recomendado o uso destes campos.