Pular para o conteúdo principal

8.3. Parceiros

Autenticação​

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

KeyValue
apikey{{apikey}}
aviso

Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.


POST Cadastrar Parceiro​

/v3/partners

Cadastra um novo parceiro na plataforma.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
namestringSimNome do parceiro
nicknamestringNãoNome fantasia ou apelido
legalNamestringNãoRazão social
descriptionstringNãoDescrição do parceiro
personType.codenumberSimTipo de pessoa (2 = Jurídica)
identityType.codenumberSimTipo de documento (4 = CNPJ)
identitystringSimNúmero do documento
birthDatestring | nullNãoData de fundação
referenceCodestringNãoCódigo de referência externo
notestringNãoObservações adicionais

Exemplo de Requisição e Resposta​

Visualizar Body
{
"name": "string",
"nickname": "string",
"legalName": "string",
"description": "string",
"personType": {
"code": 2,
"name": "Pessoa Jurídica"
},
"identityType": {
"code": 4,
"name": "CNPJ"
},
"identity": "00.000.000/0001-00",
"birthDate": null,
"referenceCode": "string",
"note": "string"
}

GET Consultar Parceiros​

/v3/partners

Retorna a lista de parceiros cadastrados, com suporte a busca por texto.

Parâmetros de Query​

ParâmetroTipoObrigatórioDescrição
searchTextstringNãoTexto para busca por nome, documento ou apelido

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location --request GET 'https://integration.ajin.io/v3/partners?searchText=' \
--header 'apikey: {{apikey}}'