Criar pagador

POST/api/payers

Este endpoint permite cadastrar um novo pagador no sistema.

É necessário informar os dados básicos do pagador, como identificação, contato e endereço.

Dados da requisição

Campo	Descrição	Tipo	Obrigatório
name	Nome .	string	Sim
cnpj	CNPJ.	string	Sim
email	Email de contato.	string	Sim
phone	Telefone de contato.	string	Sim
address.street	Endereço.	string	Sim
address.number	Número do endereço.	string	Sim
address.neighborhood	Bairro.	string	Sim
address.complement	Complemento do endereço.	string, null	Sim
address.zipcode	CEP do endereço.	string	Sim
address.city	Cidade do endereço.	string	Sim
address.uf	Estado do endereço.	string	Sim
address.country	Pais do endereço.	string	Sim

Exemplo de requisição

{
  "name": "Empresa de pagamentos",
  "cnpj": "00000000000000",
  "email": "pagamentos@mail.com",
  "phone": "00000000000",
  "address": {
    "street": "Rua da Jóia",
    "number": "883",
    "neighborhood": "Rochdale",
    "complement": "Empresa azul",
    "zipcode": "06220250",
    "city": "São Paulo",
    "uf": "SP",
    "country": "Brasil"
  }
}

Exemplo de resposta

Sucesso - 201

{
  "id": "019ae060-0b50-74bf-bfc6-fe2b78427391",
  "name": "Empresa de pagamentos",
  "cnpj": "00000000000000",
  "phone": "00000000000",
  "email": "pagamentos@mail.com",
  "fullAddress": "Rua da Jóia, Nº883, Empresa azul",
  "neighborhood": "Rochdale",
  "zipcode": "06220250",
  "city": "São Paulo",
  "uf": "SP"
}