Obter comprador

gethttps://sandbox-api.rebornpay.io/v1/buyers/{buyerId}Auth obrigatória

Retorna os dados de um comprador pelo seu UUID.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Path Parameters

buyerIdstringrequired

Responses

200Dados do comprador

idstring · uuidrequired

Identificador único do buyer

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

namestringrequired

Nome completo do buyer

Example: João Silva

documentTypestring · enumrequired

Tipo do documento

Example: CPF

CPFCNPJ

documentNumberstringrequired

Documento mascarado por segurança

Example: 123.***.***-01

emailstringrequired

E-mail do buyer

Example: joao.silva@email.com

phonestringrequired

Telefone com DDD

Example: 11999998888

addressobjectrequired

Endereço do buyer

streetstringrequired

Logradouro

Example: Rua das Flores

numberstringrequired

Número

Example: 123

complementstringoptional

Complemento

Example: Apto 45

neighborhoodstringrequired

Bairro

Example: Centro

citystringrequired

Cidade

Example: São Paulo

statestringrequired

Example: SP

zipCodestringrequired

CEP

Example: 01310100

countrystringrequired

País (ISO 3166-1 alpha-2)

Example: BR

createdAtstring · date-timerequired

Data de criação (UTC)

updatedAtstring · date-timerequired

Data da última atualização (UTC)

401API Key ausente ou inválida

idstring · uuidrequired

Identificador único do buyer

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

namestringrequired

Nome completo do buyer

Example: João Silva

documentTypestring · enumrequired

Tipo do documento

Example: CPF

CPFCNPJ

documentNumberstringrequired

Documento mascarado por segurança

Example: 123.***.***-01

emailstringrequired

E-mail do buyer

Example: joao.silva@email.com

phonestringrequired

Telefone com DDD

Example: 11999998888

addressobjectrequired

Endereço do buyer

streetstringrequired

Logradouro

Example: Rua das Flores

numberstringrequired

Número

Example: 123

complementstringoptional

Complemento

Example: Apto 45

neighborhoodstringrequired

Bairro

Example: Centro

citystringrequired

Cidade

Example: São Paulo

statestringrequired

Example: SP

zipCodestringrequired

CEP

Example: 01310100

countrystringrequired

País (ISO 3166-1 alpha-2)

Example: BR

createdAtstring · date-timerequired

Data de criação (UTC)

updatedAtstring · date-timerequired

Data da última atualização (UTC)

404Comprador não encontrado

idstring · uuidrequired

Identificador único do buyer

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

namestringrequired

Nome completo do buyer

Example: João Silva

documentTypestring · enumrequired

Tipo do documento

Example: CPF

CPFCNPJ

documentNumberstringrequired

Documento mascarado por segurança

Example: 123.***.***-01

emailstringrequired

E-mail do buyer

Example: joao.silva@email.com

phonestringrequired

Telefone com DDD

Example: 11999998888

addressobjectrequired

Endereço do buyer

streetstringrequired

Logradouro

Example: Rua das Flores

numberstringrequired

Número

Example: 123

complementstringoptional

Complemento

Example: Apto 45

neighborhoodstringrequired

Bairro

Example: Centro

citystringrequired

Cidade

Example: São Paulo

statestringrequired

Example: SP

zipCodestringrequired

CEP

Example: 01310100

countrystringrequired

País (ISO 3166-1 alpha-2)

Example: BR

createdAtstring · date-timerequired

Data de criação (UTC)

updatedAtstring · date-timerequired

Data da última atualização (UTC)

curl -X GET 'https://sandbox-api.rebornpay.io/v1/buyers/{buyerId}' \  -H 'X-Api-Key: $API_KEY'

200Response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "João Silva",
  "documentType": "CPF",
  "documentNumber": "123.***.***-01",
  "email": "joao.silva@email.com",
  "phone": "11999998888",
  "address": {
    "street": "Rua das Flores",
    "number": "123",
    "complement": "Apto 45",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01310100",
    "country": "BR"
  },
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}