PApagar

Editar cliente

Changed on
put/customers/{customer_id}

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/customers/{customer_id}
  • Auth
    HTTP basic

Path parameters

customer_idstring required

Código do cliente. Formato cus_XXXXXXXXXXXXXXXX.

Request body

namestring

Nome do cliente. Max: 64 caracteres.

emailstring

E-mail do cliente. Max: 64 caracteres

codestring

Código de referência do cliente no sistema da loja. Max: 52 caracteres

documentstring

CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE

document_typestring

Tipo de documento. Valores possíveis: CPF, CNPJ ou PASSPORT.

typestring

Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica).<br>Obrigatório, caso o document seja enviado.

genderstring

Sexo do cliente . Valores possíveis: male ou female

phoneobject

Telefones do cliente. Saiba mais sobre o telefones

birthdatestring date

Data de nascimento do cliente.

metadatastring

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

Response

200

idstring
namestring
emailstring
documentstring
genderstring
typestring
delinquentboolean
created_atstring
updated_atstring

Example response

{
  "id": "cus_6l5dMWZ0hkHZ4XnE",
  "name": "Peter Parker",
  "email": "parker@avengers.com",
  "document": "26224451990",
  "gender": "male",
  "type": "individual",
  "created_at": "2017-05-02T23:26:49Z",
  "updated_at": "2017-05-02T23:28:16Z",
  "phones": {
    "home_phone": {
      "country_code": "55",
      "number": "0000002000",
      "area_code": "021"
    }
  },
  "metadata": {
    "id": "my_customer_id"
  }
}

Changes