Subcontas ValidaPay

Criar subconta PF

Com esta funcionalidade você pode criar subcontas Pessoa Física na ValidaPay. Ao criar a subconta ela ficará associada à sua conta (chamaremos de conta Master).

Case de uso:

Como SaaS tenho vários Sellers, preciso gerar cobranças para esses Sellers e receber split em cada venda.

⚠️ Atenção: Não é possivel criar uma subconta com mesmo email e telefone da master account.

⚠️ Atenção: Dados de renda/faturamento no campo financialDetails são obrigatórios

POST/v1/proposals
Base URL Produção:https://api.validapay.com.br
Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string · header · required

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

proposals/write

Body

application/json

Content-Type:application/json
{
    "documentNumber": "77753120093",
    "phoneNumber": "+5511912345678",
    "email": "validapay@validapay.com.br",
    "motherName": "Teste Mãe",
    "fullName": "Richard Feynman",
    "socialName": "",
    "birthDate": "31-12-2000",
    "address": {
        "postalCode": "06455030",
        "street": "Alameda Xingu",
        "number": "350",
        "addressComplement": "",
        "neighborhood": "Alphaville Industrial",
        "city": "Barueri",
        "state": "SP"
    },
    "isPoliticallyExposedPerson": false,
    "financialDetails": {
        "declaredIncome": "1DINP02", 
        "occupation": "ONP07", 
        "netWorth": "NWNP02" 
    },
    "webhookUrl": "https://api.teste.com.br" 
}

Schema

FieldTypeRequiredDescription
documentNumber
stringRequiredCPF do titular
phoneNumber
stringRequiredNúmero de telefone do titular
email
stringRequiredemail do titular
motherName
stringRequired-
fullName
stringRequiredNome completo do titular
socialName
stringOptional-
birthDate
stringRequiredData de nascimento do titular
address
object--
isPoliticallyExposedPerson
booleanRequired-
financialDetails
object--
webhookUrl
stringOptionalURL onde você gostaria de receber a notificação de criação de conta
const url = 'https://sandbox.validapay.com.br/v1/proposals';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "documentNumber": "77753120093",
    "phoneNumber": "+5511912345678",
    "email": "validapay@validapay.com.br",
    "motherName": "Teste Mãe",
    "fullName": "Richard Feynman",
    "socialName": "",
    "birthDate": "31-12-2000",
    "address": {
        "postalCode": "06455030",
        "street": "Alameda Xingu",
        "number": "350",
        "addressComplement": "",
        "neighborhood": "Alphaville Industrial",
        "city": "Barueri",
        "state": "SP"
    },
    "isPoliticallyExposedPerson": false,
    "financialDetails": {
        "declaredIncome": "1DINP02", 
        "occupation": "ONP07", 
        "netWorth": "NWNP02" 
    },
    "webhookUrl": "https://api.teste.com.br" 
}
)
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

201201
{
    "status": "UNFINISHED",
    "message": "Formulário criado com sucesso",
    "formId": "a6358673-dd00-4c6d-9592-df393513a78a"
}
200200
{
    "status": "FINISHED",
    "message": "Formulário atualizado com sucesso",
    "formId": "cda0e605-44f7-4cbc-850c-ef3a2073c685"
}