Editar um recebedor

PUT

/v1/recipient/{recipient_hash}

Atualiza os dados cadastrais de um recebedor criado em POST /v1/recipient. A resposta devolve o recipient_hash do recebedor atualizado.

A edição é parcial: todos os blocos (account, company, bankAccount) e todos os campos dentro deles são opcionais. Só os campos enviados são alterados — o que não for enviado permanece como está.

Só é possível editar recebedores cadastrados pela própria empresa autenticada. Um recipient_hash inexistente ou de outra empresa retorna 404.

Campos que não podem ser editados

CPF e e-mail do titular (account.cpf, account.email), razão social e CPF/CNPJ da empresa (company.companyName, company.companyDocumentNumber, company.personType) e os dados de triagem (triage) não são alterados por este endpoint. Se forem enviados, são ignorados silenciosamente e a requisição retorna 200.

Bloco	O que altera
account	Nome, telefone e data de nascimento do titular.
company	Endereço da empresa.
bankAccount	Conta bancária principal já cadastrada do recebedor. Indisponível para recebedores lojistas (ver abaixo).

Telefone — caracteres não numéricos são removidos antes de salvar. O número não pode estar em uso por outro usuário da Appmax.

Data de nascimento — o titular precisa ser maior de idade (18 anos ou mais).

Conta bancária — o endpoint edita a conta principal existente; ele não cria uma conta nova nem troca qual conta é a principal. A edição é recusada quando o recebedor não tem conta cadastrada, quando há uma solicitação de saque pendente ou quando a conta foi criada pelo Max. Códigos de banco (COMPE) e tipos de conta aceitos estão em Bancos homologados.

Recebedor lojista — quando o recebedor foi cadastrado para um usuário que já é lojista na Appmax (possui lojas), o bloco bankAccount não pode ser alterado por este endpoint. Enviá-lo para esse recebedor retorna 422 com Recipient with merchant role cannot update bank account..

Validação antes da escrita

Todas as regras de negócio acima são checadas antes de qualquer alteração ser salva. Se a requisição retornar 422, nenhum bloco foi alterado — inclusive os demais blocos enviados na mesma requisição.

Autorizações

bearerAuth

Token Bearer do merchant obtido via POST /oauth2/token usando as credenciais do merchant (não do app). Veja Autenticação.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

recipient_hash*

Hash do recebedor (retornado em POST /v1/recipient).

Tipo

string

Obrigatório

Exemplo"d9bd0dae-3274-5e5a-939f-f50d867eb652"

Corpo da Requisição

application/json

{

  

"account": {

  

  

"name": "Nome do Usuário",

  

  

"phone": "11900000000",

  

  

"dateOfBirth": "1990-01-01"

  

},

  

"company": {

  

  

"companyPostcode": "00000000",

  

  

"companyAddress": "Rua Exemplo",

  

  

"companyAddressNumber": "100",

  

  

"companyAddressState": "SP",

  

  

"companyAddressComplement": "Complemento",

  

  

"companyAddressNeighborhood": "Bairro Exemplo",

  

  

"companyCity": "São Paulo"

  

},

  

"bankAccount": {

  

  

"bank": "104",

  

  

"agency": "1234-0",

  

  

"account": "12345-2",

  

  

"bankAccountType": "CC"

  

}

}

Respostas

Recebedor atualizado com sucesso.

Content-Type

application/json

{

  

"data": {

  

  

"recipient_hash": "d9bd0dae-3274-5e5a-939f-f50d867eb652"

  

}

}

PUT

/v1/recipient/{recipient_hash}

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

Parâmetros da URL

recipient_hash

Authorization (Bearer)

Cole uma vez e use em todos os playgrounds — o token fica salvo somente nesta aba do navegador e é apagado quando ela for fechada.

Corpo

{
  "account": {
    "name": "Nome do Usuário",
    "phone": "11900000000",
    "dateOfBirth": "1990-01-01"
  },
  "company": {
    "companyPostcode": "00000000",
    "companyAddress": "Rua Exemplo",
    "companyAddressNumber": "100",
    "companyAddressState": "SP",
    "companyAddressComplement": "Complemento",
    "companyAddressNeighborhood": "Bairro Exemplo",
    "companyCity": "São Paulo"
  },
  "bankAccount": {
    "bank": "104",
    "agency": "1234-0",
    "account": "12345-2",
    "bankAccountType": "CC"
  }
}

Duplo clique no JSON para editar