Criar um recebedor

POST

/v1/recipient

Cadastra um recebedor para receber valores de split de pagamentos.

O cadastro é só a primeira etapa. Para completar o fluxo, o recebedor também precisa concluir o facematch (KYC) — enquanto o KYC não é aprovado, ele não participa de splits. Os três status possíveis do onboarding são:

Status	Significado
Awaiting face match completion	Aguardando o recebedor concluir a etapa de facematch (KYC).
Onboarding on verification	Recebemos todos os dados do formulário + facematch e estamos analisando as informações.
Onboarding completed	Cadastro completo e aprovado.

Referência completa em Status do split de pagamentos.

A conta bancária (bankAccount) pode ser enviada já no cadastro. Os códigos de banco (COMPE) homologados e os tipos de conta aceitos estão em Bancos homologados.

WARNING

Uma vez criado, o recebedor não pode ser editado nem excluído via API. Revise os dados antes de enviar — correções são feitas pelo suporte da Appmax caso a caso.

TIP

Um CNPJ só pode ser cadastrado uma vez. Tentar recriar retorna 422 com a mensagem "O valor indicado para o campo company.company document number já se encontra utilizado.".

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)

Corpo da Requisição

application/json

{

  

"triage": {

  

  

"revenue": 10000,

  

  

"storeUrl": "https://exemplo-loja.com.br"

  

},

  

"account": {

  

  

"email": "[email protected]",

  

  

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

  

  

"cpf": "00000000000",

  

  

"phone": "11900000000",

  

  

"dateOfBirth": "1990-01-01"

  

},

  

"company": {

  

  

"companyName": "Empresa Exemplo LTDA",

  

  

"companyDocumentNumber": "00000000000000",

  

  

"companyPostcode": "00000000",

  

  

"companyAddress": "Rua Exemplo",

  

  

"companyAddressNumber": "100",

  

  

"companyAddressState": "SP",

  

  

"companyAddressNeighborhood": "Bairro Exemplo",

  

  

"companyCity": "São Paulo",

  

  

"companyAddressComplement": "Complemento"

  

},

  

"bankAccount": {

  

  

"bank": 104,

  

  

"agency": "1234-0",

  

  

"account": "12345-2",

  

  

"bankAccountType": "CC"

  

},

  

"config": {

  

  

"hasAccountAccess": false

  

}

}

Respostas

Recebedor criado com sucesso.

Content-Type

application/json

{

  

"data": {

  

  

"recipient_hash": "bbd96f57-3e3c-5ea1-aa60-cb2518578faf"

  

}

}

POST

/v1/recipient

Exemplos

Sandboxhttps://api.sandboxappmax.com.br

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

{
  "triage": {
    "revenue": 10000,
    "storeUrl": "https://exemplo-loja.com.br"
  },
  "account": {
    "email": "[email protected]",
    "name": "Nome do Usuário",
    "cpf": "00000000000",
    "phone": "11900000000",
    "dateOfBirth": "1990-01-01"
  },
  "company": {
    "companyName": "Empresa Exemplo LTDA",
    "companyDocumentNumber": "00000000000000",
    "companyPostcode": "00000000",
    "companyAddress": "Rua Exemplo",
    "companyAddressNumber": "100",
    "companyAddressState": "SP",
    "companyAddressNeighborhood": "Bairro Exemplo",
    "companyCity": "São Paulo",
    "companyAddressComplement": "Complemento"
  },
  "bankAccount": {
    "bank": 104,
    "agency": "1234-0",
    "account": "12345-2",
    "bankAccountType": "CC"
  },
  "config": {
    "hasAccountAccess": false
  }
}

Duplo clique no JSON para editar