Dom Docs
Dom Pagamentos

Consultar cliente

GEThttps://{apiUrl}/customers/{id}

Atualizado em · 2 min de leitura

Endpoint: GET https://{apiUrl}/customers/{id}

Recupera todas as informações de um cliente, incluindo endereço e tokens de cartões salvos na carteira.

Parâmetros

GEThttps://{apiUrl}/customers/{id}
URL base da API
Token de autenticação
Path Params
idstringrequired

Identificador único do cliente (UUID)

curl --request GET \
  --url "https://{apiUrl}/customers/{id}"
Response

Choose an example:

application/json
Responses

Exemplo de resposta

json
{
  "id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
  "name": "João da Silva",
  "email": "joao@dopagamentos.com",
  "code_external": "REF_CUSTOMER_001",
  "document": "11111111111",
  "document_type": "CPF",
  "gender": "male",
  "birthdate": "1981-06-01",
  "mobile_phone": "48999999999",
  "address": {
    "street": "Av. General",
    "number": "s/n",
    "neighborhood": "Centro",
    "zip_code": "88036200",
    "city": "Florianópolis",
    "state": "SC"
  },
  "cards_tokens": [
    {
      "token": "65432f17bd804123456789abcdefghijklmno",
      "last_4_digits": "1234",
      "brand": "mastercard",
      "holder_name": "Joao da Silva",
      "expire": "12/2035",
      "active": "Y"
    }
  ],
  "status": "active",
  "created_at": "2024-10-01T15:36:00Z"
}

Tokens de cartão (cards_tokens)

CampoTipoDescrição
tokenstringToken único do cartão para uso em transações
last_4_digitsstringÚltimos 4 dígitos do cartão
brandstringBandeira do cartão (visa, mastercard, etc.)
holder_namestringNome do titular
expirestringData de expiração no formato MM/YYYY
activestring"Y" se ativo, "N" se inativo
Esta página foi útil?