Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Criar endereço

Para a criação de um address é necessário informar o customer_id do cliente ao qual será associado o endereço.

post
https://api.stone.com.br/core/v5/customers/{customer_id}/addresses

Path Parameters

customer_idstringrequired

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX

Body

application/json
line_1stringrequired

Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres.

line_2string

Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres.

zip_codestringrequired

CEP. Max: 16 caracteres. (Apenas numérico)

citystringrequired

Cidade. Max: 64 caracteres.

statestringrequired

Código do estado no formato ISO 3166-2. Saiba mais sobre ISO 3166-2

countrystringrequired

Código do país no formato ISO 3166-1 alpha-2. Saiba mais sobre ISO 3166-1 alpha-2

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. Saiba mais sobre metadata

Response

application/json

200

idstring

Example:addr_Pn5x69LCWhrANX2o

line_1string

Example:375, Av. General Justo, Centro

line_2string

Example:8º andar

zip_codestring

Example:20021130

citystring

Example:Rio de Janeiro

statestring

Example:RJ

countrystring

Example:BR

statusstring

Example:active

created_atstring

Example:2017-04-19T17:49:36Z

updated_atstring

Example:2017-04-19T17:49:36Z

customerobject
Show Child Parameters
metadataobject
Show Child Parameters
post/customers/{customer_id}/addresses

Body

{ "line_1": "375, Av. General Justo, Centro", "line_2": "8º andar", "zip_code": "20021130", "city": "Rio de Janeiro", "state": "RJ", "country": "BR", "metadata": { "id": "my_address_id" } }
 
application/json

Listar endereços

Este recurso permite a recuperação dos endereços de um determinado cliente através do seu identificador(customer_id). Pode ser utilizados alguns parâmetros como filtro da listagem.

get
https://api.stone.com.br/core/v5/customers/{customer_id}/addresses

Query Parameters

pageinteger(int32)

Página atual.

Default:1

sizeinteger(int32)

Quantidade de itens.

Default:10

Path Parameters

customer_idstringrequired

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

Response

application/json

200

dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/customers/{customer_id}/addresses
 
application/json

Obter endereço

Através dos identificadores do cliente (customer_id) e do endereço (address_id) é possível obter o endereço do cliente.

get
https://api.stone.com.br/core/v5/customers/{customer_id}/addresses/{address_id}

Path Parameters

customer_idstringrequired

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_idstringrequired

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.

Response

application/json

200

idstring

Example:addr_Pn5x69LCWhrANX2o

line_1string

Example:375, Av. General Justo, Centro

line_2string

Example:10º andar

zip_codestring

Example:20021130

citystring

Example:Rio de Janeiro

statestring

Example:RJ

countrystring

Example:BR

statusstring

Example:deleted

created_atstring

Example:2017-04-19T17:49:36Z

updated_atstring

Example:2017-04-19T17:50:18Z

deleted_atstring

Example:2017-04-19T17:50:34Z

customerobject
Show Child Parameters
metadataobject
Show Child Parameters
get/customers/{customer_id}/addresses/{address_id}
 
application/json

Editar endereço

Com o verbo HTTP PUT, através dos identificadores do cliente (customer_id) e do endereço (address_id) é possível atualizar informações complementares do endereço.

put
https://api.stone.com.br/core/v5/customers/{customer_id}/addresses/{address_id}

Path Parameters

customer_idstringrequired

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_idstringrequired

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.

Body

application/json
line_2string

Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres.

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. Saiba mais sobre metadata.

Response

application/json

200

idstring

Example:addr_Pn5x69LCWhrANX2o

line_1string

Example:375, Av. General Justo, Centro

line_2string

Example:10º andar

zip_codestring

Example:20021130

citystring

Example:Rio de Janeiro

statestring

Example:RJ

countrystring

Example:BR

statusstring

Example:active

created_atstring

Example:2017-04-19T17:49:36Z

updated_atstring

Example:2017-04-19T17:50:18Z

customerobject
Show Child Parameters
metadataobject
Show Child Parameters
put/customers/{customer_id}/addresses/{address_id}

Body

{ "line_2": "10º andar", "metadata": { "id": "work" } }
 
application/json

Excluir endereço

Com o verbo HTTP DELETE, através do identificador do endereço(address_id) e do identificador do cliente (customer_id) ao qual o endereço está associado, é possível remover o endereço da Wallet do cliente.

delete
https://api.stone.com.br/core/v5/customers/{customer_id}/addresses/{address_id}

Path Parameters

customer_idstringrequired

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_idstringrequired

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.

Response

application/json

200

idstring

Example:addr_GEjbAjaUK9h1PRLa

line_1string

Example:10882, Malibu Point, Central Malibu

streetstring

Example:Malibu Point

numberstring

Example:10882

zip_codestring

Example:90265

neighborhoodstring

Example:Central Malibu

citystring

Example:Malibu

statestring

Example:CA

countrystring

Example:US

statusstring

Example:deleted

created_atstring

Example:2018-12-14T18:57:18Z

updated_atstring

Example:2018-12-14T18:58:36Z

deleted_atstring

Example:2018-12-14T18:58:36Z

customerobject
Show Child Parameters
delete/customers/{customer_id}/addresses/{address_id}
 
application/json