Cadastra um novo parceiro

POST

/api/v1/partners

Cria um parceiro com dados pessoais/empresariais. bank_account, pix e address
são opcionais e podem ser informados depois.

Quando enviado, bank_account.bank_code é o código compe (3 dígitos) do banco
e é resolvido via catalogue. A hierarquia (parent) é derivada do access_token.

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK

application/json

Parceiro criado com sucesso.

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠422Erro de Parâmetro

🔴500Erro do Servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://gtw.unnotech.com.br/public/api/v1/partners' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partner": {
        "type": "pf",
        "name": "Fulano de Tal",
        "email": "fulano@detal.com.br",
        "phone": "11987654321",
        "document_number": "12345678901",
        "parent_uuid": "a52a555d-68f8-4560-b544-8ebc76a447ac"
    },
    "pix": {
        "key": "fulano@detal.com.br",
        "type": "CPF"
    },
    "address": {
        "zipcode": "01310100",
        "uf": "SP",
        "city": "São Paulo",
        "district": "Centro",
        "neighborhood": "Bela Vista",
        "street": "Avenida Paulista",
        "number": "1000",
        "complement": "Sala 202"
    },
    "bank_account": {
        "type": "CC",
        "agency": "1234",
        "bank_code": "001",
        "agency_digit": "1",
        "account_number": "567890123",
        "account_digit": "5"
    }
}'

Response Example

200 - Sucesso

Sucesso

{
    "data": {
        "partner_id": "3ea1d784-4c6f-4dd0-bfa3-5e027c172fd1"
    },
    "message": "Parceiro cadastrado com sucesso!"
}

Modificado em 2026-08-18 04:28:10

Página anterior

Lista parceiros com filtros e paginação

Próxima página

Detalha um parceiro pelo UUID