Criar comprador

posthttps://sandbox-api.rebornpay.io/v1/buyersAuth obrigatória

Cadastra um novo comprador (pagador final) vinculado ao seller autenticado. O documento é mascarado na resposta.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Body

application/json

namestringrequired

Nome completo do buyer

documentTypeenumrequired

Tipo do documento de identificação

documentNumberstringrequired

CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números

emailstringrequired

E-mail do buyer para notificações

phonestringrequired

Telefone com DDD, apenas números

addressobjectrequired

streetstringrequired

Logradouro

numberstringrequired

Número

complementstringoptional

Complemento (opcional)

neighborhoodstringrequired

Bairro

citystringrequired

Cidade

statestringrequired

UF (2 letras)

zipCodestringrequired

CEP, apenas números

countrystringrequired

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

Responses

201Comprador criado com sucesso

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

errorsarrayrequired

Lista de erros da requisição

statusstringrequired

Código HTTP do erro

Example: 401

codestringrequired

Código interno do erro

Example: AUT-005

titlestringrequired

Título curto do erro

Example: API Key inválida

descriptionstringrequired

Descrição detalhada

Example: A API Key fornecida é inválida

actionstringoptional

Ação sugerida para o integrador

Example: Verifique sua API Key e tente novamente

additionalInfoobjectrequired

Informações adicionais sobre o erro

metadataobjectrequired

Metadados da resposta de erro

totalRecordsinteger · int32required

Total de erros na resposta

Example: 1

totalPagesinteger · int32required

Total de páginas

Example: 1

requestDatetimestring · date-timerequired

Data/hora da requisição (UTC)

Example: 2025-01-15T10:30:00Z

422Dados inválidos ou comprador já cadastrado

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 POST 'https://sandbox-api.rebornpay.io/v1/buyers' \  -H 'X-Api-Key: $API_KEY' \  -H 'Content-Type: application/json'

201Response 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": null,
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01310100",
    "country": "BR"
  },
  "createdAt": "2025-01-15T10:30:00",
  "updatedAt": "2025-01-15T10:30:00"
}