MENU navbar-image

Introduction

API do Sistema Multi Benefícios

Essa documentação está disponível para auxiliar o desenvolvimento de sistemas da Multi Benefícios.

Authenticating requests

Para autenticar solicitações, inclua um cabeçalho Authorization com o valor "Bearer {YOUR_AUTH_KEY}".

Todos os endpoints autenticados são marcados com um emblema requires authentication na documentação abaixo.

Autenticação

Registro de novo usuário. (Apenas para desenvolvimento, os usuários são coletados de outra origem) Registra um novo usuário no sistema.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20",
    "name": "AqBank2",
    "email": "sarah.ayla.dacunha@santosferreira.adv.br",
    "password": "1q2w3e4r",
    "social_reason": "AQBank Instituição de Pagamentos S\/A",
    "cnpj": "85.388.237\/0001-44",
    "phone_code": "11",
    "phone_number": "996036733"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "auth": {
            "type": "Bearer",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDAvYXBpL2F1dGgvcmVnaXN0ZXIiLCJpYXQiOjE3Mjg0OTUzNTksImV4cCI6MTcyODg1NTM1OSwibmJmIjoxNzI4NDk1MzU5LCJqdGkiOiJtemo3b2R3ZHhwTmt3ZVo2Iiwic3ViIjoiMyIsInBydiI6Ijk2OWQ3MmRlNmI0MTQzZWYxNDY2MTg5MTExNjU4NmRiNjY1MDlkNjUiLCJwdWkiOiI1NzIwYzNjNS0yMDI3LTQ3YmItYjEwMC02ODEzMTBjYTFmNDMifQ.T_G7dmeeMpBkYN45c76cEoe0OiymHeeplJUoqu7P_9s",
            "expiration_at": "13-10-2024 18:35:59"
        },
        "code": {
            "token": "715820",
            "expiration_at": "13-10-2024 18:36:00"
        },
        "user": {
            "cpf": "927.724.939-20",
            "name": "AqBank2",
            "email": "sarah.ayla.dacunha@santosferreira.adv.br",
            "public_id": "5720c3c5-2027-47bb-b100-681310ca1f43",
            "id": 3
        }
    }
}

Request   

POST api/auth/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

name   string   

O nome do usuário. Example: AqBank2

email   string   

O email do usuário. Example: sarah.ayla.dacunha@santosferreira.adv.br

password   string   

A senha do usuário. Example: 1q2w3e4r

social_reason   string   

A razão social da empresa Example: AQBank Instituição de Pagamentos S/A

cnpj   string   

O cnpj da empresa Example: 85.388.237/0001-44

phone_code   string   

O código do telefone. Example: 11

phone_number   string   

O número do telefone. Example: 996036733

Primeiro acesso. Configura o primeiro acesso do usuário após o registro.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/first-access"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cnpj": "85.388.237\/0001-44",
    "code": "843176",
    "email": "sarah.ayla.dacunha@santosferreira.adv.br",
    "password": "1q2w3e4r",
    "password_confirmation": "1q2w3e4r"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "auth": {
            "type": "Bearer",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
            "expiration_at": "13-10-2024 17:44:57"
        }
    }
}

Request   

POST api/auth/first-access

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cnpj   string   

O CNPJ da empresa. Example: 85.388.237/0001-44

code   string   

O código token. Para gerar o código endpoint /api/auth/code Example: 843176

email   string   

O email do usuário. Example: sarah.ayla.dacunha@santosferreira.adv.br

password   string   

A senha do usuário. Example: 1q2w3e4r

password_confirmation   string   

A confirmação da senha do usuário.. Example: 1q2w3e4r

Usuário ja acessou anteriormente. Retorna se o usuário já acessou o sistema anteriormente

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/already-accessed"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "alreadyAccessed": false
    }
}

Request   

POST api/auth/already-accessed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

Login do usuário. Realiza a autenticação do usuário no sistema.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20",
    "password": "1q2w3e4r",
    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
    "remember": "0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "auth": {
            "type": "Bearer",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDAvYXBpL2F1dGgvbG9naW4iLCJpYXQiOjE3Mjg0OTU1MjMsImV4cCI6MTcyODg1NTUyMywibmJmIjoxNzI4NDk1NTIzLCJqdGkiOiJuOXlwUVU3YXhuWnRUU0RNIiwic3ViIjoiMyIsInBydiI6Ijk2OWQ3MmRlNmI0MTQzZWYxNDY2MTg5MTExNjU4NmRiNjY1MDlkNjUiLCJwdWkiOiI1NzIwYzNjNS0yMDI3LTQ3YmItYjEwMC02ODEzMTBjYTFmNDMifQ.p7to_AIS966f8XMs5ALT7Oex0-_bRJSAf7w9me9FRho",
            "expiration_at": "13-10-2024 18:38:43"
        }
    }
}

Request   

POST api/auth/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

password   string   

A senha do usuário. Example: 1q2w3e4r

public_company_id   string   

O public id da empresa. Example: fe652f49-26b1-47aa-a777-e18ce6024cb1

remember   string   

O número do telefone. Example: 0

Gerar código token de autenticação. Envia um código de autenticação via SMS ou e-mail.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/code"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "sarah.ayla.dacunha@santosferreira.adv.br",
    "cnpj": "85.388.237\/0001-44",
    "cpf": "927.724.939-20"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "code": "346802",
        "email": {
            "cookies": {},
            "transferStats": {}
        },
        "sms": {
            "cookies": {},
            "transferStats": {}
        }
    }
}

Request   

POST api/auth/code

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

O email do usuário. Example: sarah.ayla.dacunha@santosferreira.adv.br

cnpj   string   

A CNPJ do usuário. Example: 85.388.237/0001-44

cpf   string   

O CPF do usuário. Example: 927.724.939-20

Valida código token de autenticação. Retorna se código é valido

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/code-validate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20",
    "code": "321654"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "code": "346802",
        "email": {
            "cookies": {},
            "transferStats": {}
        },
        "sms": {
            "cookies": {},
            "transferStats": {}
        }
    }
}

Request   

POST api/auth/code-validate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

code   string   

O código token. Example: 321654

Esqueci a senha. Envia email para o usuário com o código token

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/forgot-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": true
}

Request   

POST api/auth/forgot-password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

Redefinir senha. Redefine a senha de autenticação do usuário no sistema.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/reset-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20",
    "code": "432587",
    "password": "1q2w3e4r",
    "password_confirmation": "1q2w3e4r"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": true
}

Request   

POST api/auth/reset-password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

code   string   

O código token. Example: 432587

password   string   

A senha do usuário. Example: 1q2w3e4r

password_confirmation   string   

A confirmação da senha do usuário. Example: 1q2w3e4r

Logout do usuário. Invalida o token JWT do usuário.

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/logout"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": "Desconectado com sucesso"
}

Request   

POST api/auth/logout

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Dados do usuário. Retorna os dados do usuário (dados gerais e de faturamento).

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/me"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "user": {
            "public_id": "5720c3c5-2027-47bb-b100-681310ca1f43",
            "cpf": "927.724.939-20",
            "name": "AqBank2",
            "email": "sarah.ayla.dacunha@santosferreira.adv.br",
            "email_verified_at": "2024-10-09T17:37:48.000000Z"
        },
        "companies": [
            {
                "id": 2,
                "public_id": "b2a6c1e1-ac52-46a5-a8eb-ddcb093106ec",
                "public_company_id": "9fb0cac0-5017-4611-af77-f70ec6bb4334",
                "public_user_id": "5720c3c5-2027-47bb-b100-681310ca1f43",
                "social_reason": "AQBank Instituição de Pagamentos S/A",
                "cnpj": "85.388.237/0001-44"
            }
        ],
        "phones": [
            {
                "id": 1,
                "public_id": "95070bb8-21ed-44b2-8294-8460f2ab0547",
                "public_user_id": "5720c3c5-2027-47bb-b100-681310ca1f43",
                "phone_code": "11",
                "phone_number": "996036733",
                "phone_verified_at": null
            }
        ],
        "addresses": []
    }
}

Request   

GET api/auth/me

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Atualiza o bearer token de autenticação.

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/refresh"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "code": "346802",
        "email": {
            "cookies": {},
            "transferStats": {}
        },
        "sms": {
            "cookies": {},
            "transferStats": {}
        }
    }
}

Request   

POST api/auth/refresh

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Primeiro acesso código token Envia código token por email e sms

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/collaborator/first-access-code"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "042.537.917-51"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "auth": {
            "type": "Bearer",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
            "expiration_at": "13-10-2024 17:44:57"
        }
    }
}

Request   

POST api/auth/collaborator/first-access-code

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do colaborador. Example: 042.537.917-51

Primeiro acesso. Configura o primeiro acesso do usuário após o registro.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/collaborator/first-access"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "042.537.917-51",
    "code": "843176",
    "email": "sarah.ayla.dacunha@santosferreira.adv.br",
    "password": "1q2w3e4r",
    "password_confirmation": "1q2w3e4r",
    "social_name": "Bento",
    "phone_code": "12",
    "phone_number": "951900130",
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "corrupti",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "auth": {
            "type": "Bearer",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
            "expiration_at": "13-10-2024 17:44:57"
        }
    }
}

Request   

POST api/auth/collaborator/first-access

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do colaborador. Example: 042.537.917-51

code   string   

O código token. Para gerar o código endpoint /api/auth/code Example: 843176

email   string   

O email do usuário. Example: sarah.ayla.dacunha@santosferreira.adv.br

password   string   

A senha do usuário. Example: 1q2w3e4r

password_confirmation   string   

A confirmação da senha do usuário.. Example: 1q2w3e4r

social_name   string   

O nome social do colaborador. Example: Bento

phone_code   string   

O código do telefone. Example: 12

phone_number   string   

O número do telefone. Example: 951900130

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: corrupti

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

Login do usuário. Realiza a autenticação do usuário no sistema.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/auth/collaborator/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "927.724.939-20",
    "password": "1q2w3e4r"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "auth": {
            "type": "Bearer",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDAvYXBpL2F1dGgvbG9naW4iLCJpYXQiOjE3Mjg0OTU1MjMsImV4cCI6MTcyODg1NTUyMywibmJmIjoxNzI4NDk1NTIzLCJqdGkiOiJuOXlwUVU3YXhuWnRUU0RNIiwic3ViIjoiMyIsInBydiI6Ijk2OWQ3MmRlNmI0MTQzZWYxNDY2MTg5MTExNjU4NmRiNjY1MDlkNjUiLCJwdWkiOiI1NzIwYzNjNS0yMDI3LTQ3YmItYjEwMC02ODEzMTBjYTFmNDMifQ.p7to_AIS966f8XMs5ALT7Oex0-_bRJSAf7w9me9FRho",
            "expiration_at": "13-10-2024 18:38:43"
        }
    }
}

Request   

POST api/auth/collaborator/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 927.724.939-20

password   string   

A senha do usuário. Example: 1q2w3e4r

Bandeiras

Lista as bandeiras

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/flag/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"flags": [
		{
			"id": 1,
		    "public_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
		    "name": "Visa",
		    "description": null
		}, ...
	]
}
}

Request   

GET api/flag/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra uma bandeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/flag/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Elo",
    "description": "Elo seu cartão"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "name": "Outra bandeira",
        "description": null,
        "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
        "id": 5
    }
}

Request   

POST api/flag/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

O nome da bandeira. Example: Elo

description   string  optional  

A descrição da bandeira. Example: Elo seu cartão

Exibe uma bandeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/flag/show/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "flags": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Mastercard",
            "description": "Mastercard tudo em um"
        }
    }
}

Request   

GET api/flag/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Atualiza uma bandeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/flag/update/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Visa",
    "description": "Visa o melhor"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "flags": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Visa",
            "description": "Visa o melhor"
        }
    }
}

Request   

POST api/flag/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Body Parameters

name   string   

O nome da bandeira. Example: Visa

description   string  optional  

A descrição da bandeira. Example: Visa o melhor

Exclui uma bandeira (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/flag/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "flags": null
    }
}

Request   

DELETE api/flag/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/flag/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"flags": [
		{
			"id": 5,
		    "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
		    "name": "Outra bandeira",
		    "description": "uma bandeira qualquer"
		    }, ...
	    ]
    }
 }

Request   

GET api/flag/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Beneficios

Lista os beneficios

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"beneficios": [
		{
			"id": 1,
			"public_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
			"name": "Adicionar saldo",
			"description": null,
			"flexible_value": "0.00",
			"fixed_value": "0.00"
		}, ...
	]
}
}

Request   

GET api/benefit/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um beneficio

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_collaborator_id": "123748b3-4a66-4ddd-babb-17603f45d874",
    "name": "Educação",
    "description": "Cursos oferecidos pela empresa",
    "flexible_value": "0.00",
    "fixed_value": "2.100,25"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
"code": 201,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
     "public_collaborator_id": "",
	"name": "Educação",
	"description": "Cursos oferecidos pela empresa",
	"flexible_value": 0,
	"fixed_value": 2100.25,
	"public_id": "a3aef6db-c8d2-47d2-85cb-78a97340fd2c"
	"id": 5
}
}

Request   

POST api/benefit/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

public_collaborator_id   string  optional  

uuid O Public_id do collaborador. Example: 123748b3-4a66-4ddd-babb-17603f45d874

name   string   

O nome do beneficio. Example: Educação

description   string  optional  

A descrição do beneficio. Example: Cursos oferecidos pela empresa

flexible_value   decimal  optional  

O valor flexível do beneficio. Example: 0.00

fixed_value   decimal  optional  

O valor fixo do beneficio. Example: 2.100,25

Exibe um beneficio

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/show/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "beneficios": {
            "id": 5,
            "public_id": "a3aef6db-c8d2-47d2-85cb-78a97340fd2c",
            "public_collaborator_id": "",
            "name": "Educação",
            "description": "Cursos oferecidos pela empresa",
            "flexible_value": "0.00",
            "fixed_value": "2100.25"
        }
    }
}

Request   

GET api/benefit/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Atualiza um beneficio

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/update/a3aef6db-c8d2-47d2-85cb-78a97340fd2c"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_collaborator_id": "123748b3-4a66-4ddd-babb-17603f45d874",
    "name": "Educação",
    "description": "Cursos oferecidos pela empresa",
    "flexible_value": "0.00",
    "fixed_value": "2.100,25"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "beneficios": {
            "id": 5,
            "public_collaborator_id": "",
            "public_id": "a3aef6db-c8d2-47d2-85cb-78a97340fd2c",
            "name": "Educação",
            "description": "Cursos oferecidos pela empresa",
            "flexible_value": 0,
            "fixed_value": 100.99
        }
    }
}

Request   

POST api/benefit/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: a3aef6db-c8d2-47d2-85cb-78a97340fd2c

Body Parameters

public_collaborator_id   string  optional  

uuid O Public_id do collaborador. Example: 123748b3-4a66-4ddd-babb-17603f45d874

name   string   

O nome do beneficio. Example: Educação

description   string  optional  

A descrição do beneficio. Example: Cursos oferecidos pela empresa

flexible_value   decimal  optional  

O valor flexível do beneficio. Example: 0.00

fixed_value   decimal  optional  

O valor fixo do beneficio. Example: 2.100,25

Exclui um beneficio (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/destroy/a3aef6db-c8d2-47d2-85cb-78a97340fd2c"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "beneficios": null
    }
}

Request   

DELETE api/benefit/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: a3aef6db-c8d2-47d2-85cb-78a97340fd2c

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "beneficios": [
            {
                "id": 5,
                "public_id": "a3aef6db-c8d2-47d2-85cb-78a97340fd2c",
                "name": "Educação",
                "description": "Cursos oferecidos pela empresa",
                "flexible_value": "0.00",
                "fixed_value": "100.99"
            }
        ]
    }
}

Request   

GET api/benefit/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Transfere um valor de beneficio para outro

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/benefit/transfer"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "benefit_id_origin": "officiis",
    "benefit_id_to": "repellendus",
    "amount": "10,25"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": true
}

Request   

POST api/benefit/transfer

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

collaborator_id   string  optional  

uuid required O Public_id do colaborador Example: animi

Body Parameters

benefit_id_origin   string  optional  

uuid required O Public_id do beneficio de onde vai sair o valor Example: officiis

benefit_id_to   string  optional  

uuid required O Public_id do beneficio para onde vai o valor Example: repellendus

amount   decimal   

O valor do beneficio que vai ser transferido. Example: 10,25

Cartões

Lista os cartões

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": [
	{
		"id": 1,
		"public_id": "9415a7c1-dcef-4799-b739-61835b38a8e9",
		"public_collaborator_id": "c0286009-0ebc-47a9-b171-4e86718ba10d",
		"public_flag_id": "26356445-1c28-4246-82da-2d50599b05f5",
		"number": "4899 1130 1492 2683",
		"validate": "12\/2029",
		"cvv": "972",
		"active": 1
	}, ...
}

Request   

GET api/card/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um cartão

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_collaborator_id": "0e746e6b-480f-495d-a947-099c05ceedbc",
    "public_flag_id": "b19e1b71-28ba-44f4-a3f4-5c9cc56aedfa",
    "number": "4619 6049 2941 5325",
    "validate": "12\/2029",
    "cvv": "406",
    "password": "312059",
    "status": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "name": "Outra cartão",
        "description": null,
        "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
        "id": 5
    }
}

Request   

POST api/card/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

public_collaborator_id   string   

O uuid do colaborador. Example: 0e746e6b-480f-495d-a947-099c05ceedbc

public_flag_id   string   

O uuid da bandeira. Example: b19e1b71-28ba-44f4-a3f4-5c9cc56aedfa

number   string   

O uuid da bandeira. Example: 4619 6049 2941 5325

validate   string   

O uuid da bandeira. Example: 12/2029

cvv   string   

O uuid da bandeira. Example: 406

password   string   

O uuid da bandeira. Example: 312059

status   string   

O uuid da bandeira. Example: 1

Exibe um cartão

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/show/9415a7c1-dcef-4799-b739-61835b38a8e9"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "id": 1,
        "public_id": "9415a7c1-dcef-4799-b739-61835b38a8e9",
        "public_collaborator_id": "b8d8f84b-fefc-4b19-a0b9-5523ef7ce07f",
        "public_flag_id": "26356445-1c28-4246-82da-2d50599b05f5",
        "number": "4899 1130 1492 2683",
        "validate": "12/2029",
        "cvv": "972",
        "password": "$2y$10$QbVwWS0dPEqfI9oePicYPu3eenDcTvT27ZoyvhTDUC.tNrjYtWjFy",
        "status": 1,
        "contactless": 0
    }
}

Request   

GET api/card/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: 9415a7c1-dcef-4799-b739-61835b38a8e9

Atualiza um cartão

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/update/9415a7c1-dcef-4799-b739-61835b38a8e9"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_collaborator_id": "0e746e6b-480f-495d-a947-099c05ceedbc",
    "public_flag_id": "b19e1b71-28ba-44f4-a3f4-5c9cc56aedfa",
    "number": "4619 6049 2941 5325",
    "validate": "12\/2029",
    "cvv": "406",
    "password": "312059",
    "status": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "cards": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra cartão",
            "description": "uma cartão qualquer"
        }
    }
}

Request   

POST api/card/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: 9415a7c1-dcef-4799-b739-61835b38a8e9

Body Parameters

public_collaborator_id   string   

O uuid do colaborador. Example: 0e746e6b-480f-495d-a947-099c05ceedbc

public_flag_id   string   

O uuid da bandeira. Example: b19e1b71-28ba-44f4-a3f4-5c9cc56aedfa

number   string   

O uuid da bandeira. Example: 4619 6049 2941 5325

validate   string   

O uuid da bandeira. Example: 12/2029

cvv   string   

O uuid da bandeira. Example: 406

password   string   

O uuid da bandeira. Example: 312059

status   string   

O uuid da bandeira. Example: 1

Exclui uma cartão (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/destroy/9415a7c1-dcef-4799-b739-61835b38a8e9"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "cards": null
    }
}

Request   

DELETE api/card/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: 9415a7c1-dcef-4799-b739-61835b38a8e9

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": null
}

Request   

GET api/card/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Exibe cartões solicitados (colaborador logado)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/requested"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": [
        {
            "collaborator_name": "César Thomas Carlos Figueiredo",
            "department_name": "Administração",
            "cpf": "852.771.658-51",
            "card_number": "2683"
        }
    ]
}

Request   

GET api/card/requested

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Exibe cartões solicitados (colaborador logado)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/blocked"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": [
        {
            "collaborator_name": "César Thomas Carlos Figueiredo",
            "department_name": "Administração",
            "cpf": "852.771.658-51",
            "card_number": "2683"
        }
    ]
}

Request   

GET api/card/blocked

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Colaboradores

Lista os colaboradores

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"colaboradores": [
		{
			"id": 1,
			"public_id": "b8d8f84b-fefc-4b19-a0b9-5523ef7ce07f",
			"public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
			"public_company_id": "9cf12e1a-408b-40b8-a921-649596233409",
			"date_birth": "1988-01-02",
			"gender": 1,
			"brand_card_enum": null,
			"check_account": 0,
			"requested_card_enum": null,
			"requested_card_date": null,
			"user_name": "Diego Julio das Neves",
			"social_reason": "Daniela e Catarina Padaria ME"
		}, ...
	]
}
}

Request   

GET api/collaborator/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um colaborador

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "sarah.ayla.dacunha@santosferreira.adv.br",
    "date_birth": "02\/10\/1990",
    "gender": "1",
    "phone_code": "11",
    "phone_number": "996036733",
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "quam",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS",
    "address_main": true,
    "public_company_id": "3378e331-289a-4158-887d-0c6b56b30d68",
    "public_department_id": "d6ef59ff-c1f2-4b95-bcef-90911ae412c5"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
"code": 201,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"user": {
		"cpf": "927.724.939-22",
		"name": "AqBank2",
		"email": "sarah.ayla.dacunha@santosferreira.adv.br",
		"public_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43"
		"id": 3
	},
	"collaborator": {
		"public_user_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43",
         "public_department_id": "d6ef59ff-c1f2-4b95-bcef-90911ae412c5",
		"date_birth": "1969-12-31",
		"gender": "1",
		"public_id": "69ed0a61-20b3-4404-9897-a1722eeb5a6a"
		"id": 4
	},
	"address": {
		"public_user_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43",
		"address_street": "Rua 22",
		"address_number": "322",
		"address_complement": "22",
		"address_district": "Esplanada",
		"address_city": "Caxias do Sul",
		"address_state": "RS",
		"address_main": "1",
		"public_id": "bc3420f4-422d-47e4-9b85-417111e134eb"
		"id": 3
	},
	"phone": {
		"public_user_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43",
		"phone_code": "22",
		"phone_number": "951900122",
		"public_id": "d854f20f-583d-4d2c-a5d2-94208a5f64c3"
		"id": 3
	}
}
}

Request   

POST api/collaborator/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

O email do usuário. Example: sarah.ayla.dacunha@santosferreira.adv.br

date_birth   string  optional  

A data de nascimento. Example: 02/10/1990

gender   string  optional  

O sexo do usuário 1 - masculino, 0 - feminino. Example: 1

phone_code   string   

O código do telefone. Example: 11

phone_number   string   

O número do telefone. Example: 996036733

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: quam

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

address_main   boolean  optional  

Flag para endereço principal. Example: true

public_company_id   A  optional  

empresa a qual o colaborador pertence. Example: 3378e331-289a-4158-887d-0c6b56b30d68

public_department_id   O  optional  

departamento ao qual o colaborador pertence. Example: d6ef59ff-c1f2-4b95-bcef-90911ae412c5

Exibe um colaborador

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/show/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "colaboradores": {
            "id": 4,
            "public_id": "a62af96c-d244-43fe-a810-7bd826166e30",
            "public_user_id": "64e72dca-8e2a-4fe4-ae23-70bdf00b748f",
            "public_company_id": null,
            "public_department_id": "d6ef59ff-c1f2-4b95-bcef-90911ae412c5",
            "date_birth": "1990-02-10",
            "gender": 1,
            "brand_card_enum": null,
            "check_account": 0,
            "requested_card_enum": null,
            "requested_card_date": null,
            "departments": null
        }
    }
}

Request   

GET api/collaborator/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Atualiza um colaborador

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/update/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "sarah.ayla.dacunha@santosferreira.adv.br",
    "date_birth": "02\/10\/1990",
    "gender": "1",
    "phone_code": "11",
    "phone_number": "996036733",
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "in",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS",
    "address_main": true,
    "public_company_id": "3378e331-289a-4158-887d-0c6b56b30d68",
    "public_department_id": "a62af96c-d244-43fe-a810-7bd826166e30"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "colaboradores": {
            "collaborator": {
                "id": 4,
                "public_id": "69ed0a61-20b3-4404-9897-a1722eeb5a6a",
                "public_user_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43",
                "public_company_id": null,
                "public_department_id": "d6ef59ff-c1f2-4b95-bcef-90911ae412c5",
                "date_birth": "1990-02-10",
                "gender": "1",
                "brand_card_enum": null,
                "check_account": 0,
                "requested_card_enum": null,
                "requested_card_date": null,
                "departments": null
            },
            "address": {
                "id": 3,
                "public_id": "bc3420f4-422d-47e4-9b85-417111e134eb",
                "public_user_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43",
                "public_company_id": null,
                "address_postal_code": null,
                "address_street": "Rua Didi Bocó",
                "address_number": "315",
                "address_complement": null,
                "address_district": "Esplanada",
                "address_city": "Caxias do Sul",
                "address_state": "RS",
                "address_main": "1"
            },
            "phone": {
                "id": 3,
                "public_id": "d854f20f-583d-4d2c-a5d2-94208a5f64c3",
                "public_user_id": "01a80ac4-59e7-45a5-84ca-a0846c98aa43",
                "public_company_id": null,
                "phone_code": "12",
                "phone_number": "951900133",
                "phone_verified_at": null
            }
        }
    }
}

Request   

POST api/collaborator/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Body Parameters

email   string   

O email do usuário. Example: sarah.ayla.dacunha@santosferreira.adv.br

date_birth   string  optional  

A data de nascimento. Example: 02/10/1990

gender   string  optional  

O sexo do usuário 1 - masculino, 0 - feminino. Example: 1

phone_code   string   

O código do telefone. Example: 11

phone_number   string   

O número do telefone. Example: 996036733

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: in

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

address_main   boolean   

Flag para endereço principal. Example: true

public_company_id   A  optional  

empresa a qual o colaborador pertence. Example: 3378e331-289a-4158-887d-0c6b56b30d68

public_department_id   O  optional  

departamento ao qual o colaborador pertence. Example: a62af96c-d244-43fe-a810-7bd826166e30

Exclui um colaborador (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "colaboradores": null
    }
}

Request   

DELETE api/collaborator/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista colaboradores desativados (lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "colaboradores": [
            {
                "id": 4,
                "public_id": "a62af96c-d244-43fe-a810-7bd826166e30",
                "public_user_id": "64e72dca-8e2a-4fe4-ae23-70bdf00b748f",
                "public_company_id": null,
                "public_department_id": "d6ef59ff-c1f2-4b95-bcef-90911ae412c5",
                "date_birth": "1990-02-10",
                "gender": 1,
                "brand_card_enum": null,
                "check_account": 0,
                "requested_card_enum": null,
                "requested_card_date": null,
                "departments": null
            }
        ]
    }
}

Request   

GET api/collaborator/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Lista colaboradores aguardando cadastro (sem empresa associada)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/collaborator/waiting-registration"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "colaboradores": [
            {
                "id": 4,
                "public_id": "d25d65db-098f-45fc-bdd0-a89e4ce86ac5",
                "public_user_id": "372439af-7b20-4693-8294-5e9a04b5f04f",
                "public_company_id": null,
                "public_department_id": "d6ef59ff-c1f2-4b95-bcef-90911ae412c5",
                "date_birth": "1969-12-31",
                "gender": 1,
                "brand_card_enum": null,
                "check_account": 0,
                "requested_card_enum": null,
                "requested_card_date": null,
                "departments": null
            }
        ]
    }
}

Request   

GET api/collaborator/waiting-registration

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Departamentos

Lista os Departamentos

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/department/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"departamentos": [
		{
			"id": 1,
			"public_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
			"public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
			"name": "Administração",
			"description": null,
			"collaborators": [
				{
					"id": 1,
					"public_id": "2a8093e0-489a-4487-a170-628faa1c6e0b",
					"public_department_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
					"public_collaborator_id": "b8d8f84b-fefc-4b19-a0b9-5523ef7ce07f"
				}, ...
			],
			"benefits": [
				{
					"id": 1,
					"public_id": "6106a630-33a5-481c-bb9b-2121da743718",
					"public_department_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
					"public_benefit_id": "eeb07b19-81f8-4875-8130-e9b5e4115624"
				}
			]
		}, ...
	]
}
}

Request   

GET api/department/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um departamento

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/department/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
    "name": "RH",
    "description": "Recursos Humanos",
    "collaborators": [
        "b8d8f84b-fefc-4b19-a0b9-5523ef7ce07f",
        "e1c9f981-e359-4f4e-b823-e24974a2e0c0"
    ],
    "benefits": [
        "eeb07b19-81f8-4875-8130-e9b5e4115624",
        "ea89eafb0-4338-4436-9608-e29383086dd4"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
        "name": "RH",
        "description": "Recursos Humanos",
        "public_id": "8dda06cf-9797-4d8c-85a4-3a1d39552af6",
        "id": 5
    }
}

Request   

POST api/department/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

public_company_id   string   

O public id da empresa ao qual pertence. Example: fe652f49-26b1-47aa-a777-e18ce6024cb1

name   string   

A razão social da departamento Example: RH

description   O  optional  

nome fantasia da departamento Example: Recursos Humanos

collaborators   string[]  optional  

Os colaboradores do departamento

benefits   string[]  optional  

Os beneficios do departamento

Exibe uma departamento

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/department/show/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"departamentos": {
		"id": 1,
		"public_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
		"public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
		"name": "Administração",
		"description": null,
		"created_at": "2024-10-12T14:00:06.000000Z",
		"updated_at": "2024-10-12T14:00:06.000000Z",
		"deleted_at": null,
		"collaborators": [
			{
				"id": 2,
				"public_id": "31460c24-7225-4f1b-bedd-1f66ab4ca1f9",
				"public_department_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
				"public_collaborator_id": "998f9cad-52b0-409f-abeb-7c8b9fc707b2",
				"created_at": "2024-10-12T14:00:06.000000Z",
				"updated_at": "2024-10-12T14:00:06.000000Z",
				"deleted_at": null
			}, ...
		],
		"benefits": [
			{
				"id": 1,
				"public_id": "6106a630-33a5-481c-bb9b-2121da743718",
				"public_department_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
				"public_benefit_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
				"created_at": "2024-10-12T14:00:06.000000Z",
				"updated_at": "2024-10-12T14:00:06.000000Z",
				"deleted_at": null
			}
		]
	}
}
}

Request   

GET api/department/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Atualiza uma departamento

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/department/update/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
    "name": "RH",
    "description": "Recursos Humanos",
    "collaborators": [
        "b8d8f84b-fefc-4b19-a0b9-5523ef7ce07f",
        "e1c9f981-e359-4f4e-b823-e24974a2e0c0"
    ],
    "benefits": [
        "eeb07b19-81f8-4875-8130-e9b5e4115624",
        "ea89eafb0-4338-4436-9608-e29383086dd4"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "departamentos": {
            "id": 7,
            "public_id": "88d8aaed-4a02-425b-8f05-4fbecc9e1c2c",
            "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
            "name": "RH",
            "description": "Recursos Humanos",
            "created_at": "2024-10-12T16:22:02.000000Z",
            "updated_at": "2024-10-12T16:22:02.000000Z",
            "deleted_at": null,
            "collaborators": [],
            "benefits": []
        }
    }
}

Request   

POST api/department/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Body Parameters

public_company_id   string   

O public id da empresa ao qual pertence. Example: fe652f49-26b1-47aa-a777-e18ce6024cb1

name   string   

A razão social da departamento Example: RH

description   O  optional  

nome fantasia da departamento Example: Recursos Humanos

collaborators   string[]  optional  

Os colaboradores do departamento

benefits   string[]  optional  

Os beneficios do departamento

Exclui uma departamento (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/department/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "departamentos": null
    }
}

Request   

DELETE api/department/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/department/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "departamentos": [
            {
                "id": 5,
                "public_id": "c5ab9ee1-8d45-4431-898c-59c61a889287",
                "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
                "name": "RH",
                "description": "Recursos Humanos"
            }
        ]
    }
}

Request   

GET api/department/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Empresas

Lista empresas relacioandas a um CPF

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/to-login"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpf": "170.975.647-09"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


[
{
	"email": "sarah.ayla.dacunha@santosferreira.adv.br",
	"public_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
	"cnpj": "85.388.237\/0001-44",
	"social_reason": "Guilherme e Raul Alimentos ME"
}, ...
]

Request   

POST api/company/to-login

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpf   string   

O CPF do usuário. Example: 170.975.647-09

Lista as Empresas

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"empresas": [
		{
			"id": 1,
			"public_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
			"public_company_id": null,
			"public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
			"social_reason": "Tatiane e Sarah Advocacia Ltda",
			"trade_name": "Tati Sarah Advogadas",
			"cnpj": "22.648.804\/0001-42"
		}, ...
	]
}
}

Request   

GET api/company/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Empresas relacionadas a outra empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/related/fe652f49-26b1-47aa-a777-e18ce6024cb1"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": [
        {
            "id": 2,
            "public_id": "0c872d9a-dff3-42db-a70b-0af89c7eb8c1",
            "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "social_reason": "Edson e Emilly Comercio de Bebidas ME",
            "trade_name": null,
            "cnpj": "72.074.121/0001-99"
        },
        {
            "id": 3,
            "public_id": "9cf12e1a-408b-40b8-a921-649596233409",
            "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "social_reason": "Daniela e Catarina Padaria ME",
            "trade_name": null,
            "cnpj": "01.082.211/0001-83"
        }
    ]
}

Request   

GET api/company/related/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: fe652f49-26b1-47aa-a777-e18ce6024cb1

Cadastra uma empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "843176",
    "public_user_id": "1535b3e4-cc85-4754-b364-b4e342a27208",
    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
    "social_reason": "AQBank Instituição de Pagamentos S\/A",
    "trade_name": "Tati Sarah Advogadas",
    "cnpj": "85.388.237\/0001-44",
    "phone_code": "11",
    "phone_number": "996036733",
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "ipsum",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
"code": 201,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"company": {
		    "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
		    "public_company_id": null,
		    "social_reason": "Tatiane e Sarah Advocacia Ltda",
             "trade_name": "Tati Sarah Advogadas",
		    "cnpj": "22.648.804\/0001-42",
		    "public_id": "20423356-3f2d-4120-848f-ec7a0450e268"
		    "id": 5
	    },
	"address": {
		    "address_street": "Rua Didi Rodolfo Belló",
		    "address_number": "315",
		    "address_complement": null,
		    "address_district": "Esplanada",
		    "address_city": "Caxias do Sul",
		    "address_state": "RS",
		    "public_id": "56b081a1-a44b-4eaa-ba9c-881672519b36",
		    "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9"
		    "id": 4
	    },
	"phone": {
		    "phone_code": "12",
		    "phone_number": "951900130",
		    "public_id": "7a7187ba-6adc-4057-ad8c-2b1bdfdc4a66",
		    "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9"
		    "id": 3
	    }
    }
 }

Request   

POST api/company/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

O código token. Para gerar o código endpoint /api/auth/code Example: 843176

public_user_id   string   

O public id do usuário. Example: 1535b3e4-cc85-4754-b364-b4e342a27208

public_company_id   string   

O public id da empresa ao qual pertence. Example: fe652f49-26b1-47aa-a777-e18ce6024cb1

social_reason   string  optional  

A razão social da empresa Example: AQBank Instituição de Pagamentos S/A

trade_name   string  optional  

O nome fantasia da empresa Example: Tati Sarah Advogadas

cnpj   string   

O cnpj da empresa Example: 85.388.237/0001-44

phone_code   string   

O código do telefone. Example: 11

phone_number   string   

O número do telefone. Example: 996036733

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: ipsum

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

Exibe uma empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/show/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "empresas": {
            "id": 3,
            "public_id": "9cf12e1a-408b-40b8-a921-649596233409",
            "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "social_reason": "Daniela e Catarina Padaria ME",
            "trade_name": null,
            "cnpj": "01.082.211/0001-83"
        }
    }
}

Request   

GET api/company/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Atualiza uma empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/update/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "843176",
    "public_user_id": "1535b3e4-cc85-4754-b364-b4e342a27208",
    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
    "social_reason": "AQBank Instituição de Pagamentos S\/A",
    "trade_name": "Tati Sarah Advogadas",
    "cnpj": "85.388.237\/0001-44",
    "phone_code": "11",
    "phone_number": "996036733",
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "et",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "empresas": {
            "company": {
                "id": 1,
                "public_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
                "public_company_id": null,
                "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
                "social_reason": "Tatiane e Sarah Advocacia Ltda",
                "trade_name": "Tati Sarah Advogadas",
                "cnpj": "22.648.804/0001-42"
            },
            "address": {
                "id": 1,
                "public_id": "2beebd6f-a9b9-42f3-a212-6b7401074d73",
                "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
                "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
                "address_postal_code": "12603-100",
                "address_street": "Rua Didi Dedé Mussum e Zacarias",
                "address_number": "315",
                "address_complement": null,
                "address_district": "Esplanada",
                "address_city": "Caxias do Sul",
                "address_state": "RS",
                "address_main": 1
            },
            "phone": {
                "id": 1,
                "public_id": "2beebd6f-a9b9-42f3-a212-6b7401074d73",
                "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
                "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
                "phone_code": "13",
                "phone_number": "951900133",
                "phone_verified_at": null
            }
        }
    }
}

Request   

POST api/company/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Body Parameters

code   string   

O código token. Para gerar o código endpoint /api/auth/code Example: 843176

public_user_id   string   

O public id do usuário. Example: 1535b3e4-cc85-4754-b364-b4e342a27208

public_company_id   string   

O public id da empresa ao qual pertence. Example: fe652f49-26b1-47aa-a777-e18ce6024cb1

social_reason   string   

A razão social da empresa Example: AQBank Instituição de Pagamentos S/A

trade_name   string  optional  

O nome fantasia da empresa Example: Tati Sarah Advogadas

cnpj   string   

O cnpj da empresa Example: 85.388.237/0001-44

phone_code   string   

O código do telefone. Example: 11

phone_number   string   

O número do telefone. Example: 996036733

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: et

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

Exclui uma empresa (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "empresas": null
    }
}

Request   

DELETE api/company/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"empresas": [
		    {
			    "id": 3,
			    "public_id": "9cf12e1a-408b-40b8-a921-649596233409",
			    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
			    "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
			    "social_reason": "Daniela e Catarina Padaria ME",
			    "trade_name": null,
			    "cnpj": "01.082.211\/0001-83"
		    }, ..
	    ]
    }
 }

Request   

GET api/company/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Empresa logada. Retorna a empresa logada no sistema.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/get-logged-in"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "id": 1,
        "public_id": "2f2957d8-903c-4d87-acfe-8eda4e813dc4",
        "public_company_id": null,
        "public_user_id": "44e108ab-3aca-4939-8337-70378b4668e1",
        "social_reason": "AQBank Instituição de Pagamentos S/A",
        "trade_name": null,
        "cnpj": "85.388.237/0001-44"
    }
}

Request   

GET api/company/get-logged-in

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Salva a empresa logada no sistema. Define a empresa logada.

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/set-logged-in"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": []
}

Request   

GET api/company/set-logged-in

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Cria um pagamento para adicionar saldo à conta da empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/payment"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "amount": "1000",
    "payment_type": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "amount": "1000",
        "payment_type": 1,
        "public_company_id": "0c872d9a-dff3-42db-a70b-0af89c7eb8c1",
        "public_id": "26e38f1a-d23e-4baf-a114-033403114678",
        "api_transaction_id": "27ac7257-8fd9-41e2-98bd-3e4065c64956",
        "ticket_url": "",
        "ticket_barcode": "",
        "pix_qrcode": "00020101021226890014BR.GOV.BCB.PIX2567qrcode.globalscm.com.br/pix/v2/cob/c77e6d28d09b48b5a4ad4ddb14c9a21c5204000053039865802BR5909GlobalSCM6009Sao Paulo62070503***630430BA",
        "credit_card_id": 0,
        "payment_status": 1,
        "id": 1
    }
}

Request   

POST api/company/payment

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

amount   decimal   

Valor a ser adicionado. Example: 1000

payment_type   integer   

Tipo de pagamento (1 pix, 2 boleto, 3 CC). Example: 1

Lista os pagamentos criados pela empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/payment-list"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_id": "9cf12e1a-408b-40b8-a921-649596233409",
    "payment_status": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": [
        {
            "amount": "1000.00",
            "paid_at": null,
            "api_transaction_id": "27ac7257-8fd9-41e2-98bd-3e4065c64956",
            "payment_type": 1
        }
    ]
}

Request   

POST api/company/payment-list

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

company_id   string   

O identificador público da empresa. Example: 9cf12e1a-408b-40b8-a921-649596233409

payment_status   integer  optional  

O status do pagamento (opcional). Example: 1

Endereços

Lista os endereços

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/address/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"endereços": [
		    {
			    "id": 1,
			    "public_id": "2beebd6f-a9b9-42f3-a212-6b7401074d73",
			    "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
			    "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
			    "public_collaborator_id": null,
			    "address_postal_code": "12603-100",
			    "address_street": "Rua Jovino Balbino da Silva",
			    "address_number": "247",
			    "address_complement": "13B",
			    "address_district": "Vila Nunes",
			    "address_city": "Lorena",
			    "address_state": "SP",
			    "address_main": 1,
			    "user_name": "GR Alimentos",
			    "social_reason": "Guilherme e Raul Alimentos ME"
		    }, ...
	    ]
    }
 }

Request   

GET api/address/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um endereço

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/address/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "cumque",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "address_street": "Rua Didi Rodolfo Belló",
        "address_number": "315",
        "address_complement": null,
        "address_district": "Esplanada",
        "address_city": "Caxias do Sul",
        "address_state": "RS",
        "public_id": "cee1aea6-92c5-49d5-904f-c71da05dce06",
        "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
        "id": 3
    }
}

Request   

POST api/address/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: cumque

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

Exibe um endereço

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/address/show/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "endereços": {
            "id": 3,
            "public_id": "cee1aea6-92c5-49d5-904f-c71da05dce06",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "address_postal_code": null,
            "address_street": "Rua Didi Rodolfo Belló",
            "address_number": "315",
            "address_complement": "2013",
            "address_district": "Esplanada",
            "address_city": "Caxias do Sul",
            "address_state": "RS",
            "address_main": 0
        }
    }
}

Request   

GET api/address/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Atualiza um endereço

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/address/update/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "address_postal_code": "95095-061",
    "address_street": "Rua Didi Rodolfo Belló",
    "address_number": "315",
    "address_complement": "enim",
    "address_district": "Esplanada",
    "address_city": "Caxias do Sul",
    "address_state": "RS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "endereços": {
            "id": 3,
            "public_id": "cee1aea6-92c5-49d5-904f-c71da05dce06",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "address_postal_code": null,
            "address_street": "Rua Didi Rodolfo Belló",
            "address_number": "315",
            "address_complement": "2013",
            "address_district": "Esplanada",
            "address_city": "Caxias do Sul",
            "address_state": "RS",
            "address_main": 0
        }
    }
}

Request   

POST api/address/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Body Parameters

address_postal_code   string   

O CEP do endereço. Example: 95095-061

address_street   string   

O logradouro do endereço. Example: Rua Didi Rodolfo Belló

address_number   string   

O número do endereço. Example: 315

address_complement   string  optional  

O complemento do endereço. Example: Example: enim

address_district   string   

O bairro do endereço. Example: Esplanada

address_city   string   

A cidade do endereço. Example: Caxias do Sul

address_state   string   

O estado do endereço. Example: RS

Exclui um endereço (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/address/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "endereços": null
    }
}

Request   

DELETE api/address/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/address/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"endereços": [
		{
			"id": 3,
			"public_id": "cee1aea6-92c5-49d5-904f-c71da05dce06",
			"public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
			"address_postal_code": null,
			"address_street": "Rua Didi Rodolfo Belló",
			"address_number": "315",
			"address_complement": "2013",
			"address_district": "Esplanada",
			"address_city": "Caxias do Sul",
			"address_state": "RS",
			"address_main": 0
		}, ...
	]
}
}

Request   

GET api/address/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Endpoints

GET api/card/requested-all

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/requested-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
strict-transport-security: max-age=31536000; includeSubDomains; preload
access-control-allow-origin: *
 

{
    "status": "O bearer token não é válido"
}

Request   

GET api/card/requested-all

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/card/active-all

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/active-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
strict-transport-security: max-age=31536000; includeSubDomains; preload
access-control-allow-origin: *
 

{
    "status": "O bearer token não é válido"
}

Request   

GET api/card/active-all

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/card/active

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/active"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
strict-transport-security: max-age=31536000; includeSubDomains; preload
access-control-allow-origin: *
 

{
    "status": "O bearer token não é válido"
}

Request   

GET api/card/active

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/card/cancel/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/cancel/ut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/cancel/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: ut

POST api/card/activate/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/activate/rerum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/activate/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: rerum

POST api/card/unlock/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/unlock/quod"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/unlock/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: quod

POST api/card/change-password/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/change-password/cum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/change-password/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: cum

POST api/card/contactless-payment/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/contactless-payment/est"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/contactless-payment/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: est

POST api/card/temporary-block/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/temporary-block/blanditiis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/temporary-block/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: blanditiis

POST api/card/block/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/card/block/officiis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/card/block/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: officiis

GET api/extract/index

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/extract/index"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
strict-transport-security: max-age=31536000; includeSubDomains; preload
access-control-allow-origin: *
 

{
    "status": "O bearer token não é válido"
}

Request   

GET api/extract/index

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/extract/show/{public_id}

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/extract/show/quia"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
strict-transport-security: max-age=31536000; includeSubDomains; preload
access-control-allow-origin: *
 

{
    "status": "O bearer token não é válido"
}

Request   

GET api/extract/show/{public_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string   

The ID of the public. Example: quia

POST api/extract/list

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/extract/list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/extract/list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/extract/get-balance

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/extract/get-balance"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/extract/get-balance

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/webhook/company-payment

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/webhook/company-payment"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/webhook/company-payment

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/webhook/apicard-transaction

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/webhook/apicard-transaction"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/webhook/apicard-transaction

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Grupos

Lista os grupos

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/group/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"grupos": [
		{
			"id": 1,
		    "public_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
		    "name": "Adicionar saldo",
		    "description": null
		}, ...
	]
}
}

Request   

GET api/group/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um grupo

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/group/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_code": "Outro grupo",
    "role_number": "quae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "name": "Outro grupo",
        "description": null,
        "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
        "id": 5
    }
}

Request   

POST api/group/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

role_code   string   

O nome da grupo. Example: Outro grupo

role_number   string  optional  

A descrição da grupo. Example: Example: quae

Exibe um grupo

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/group/show/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "grupos": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outro grupo",
            "description": "um grupo qualquer"
        }
    }
}

Request   

GET api/group/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Atualiza um grupo

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/group/update/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_code": "Outro grupo",
    "role_number": "um grupo qualquer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "grupos": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outro grupo",
            "description": "um grupo qualquer"
        }
    }
}

Request   

POST api/group/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Body Parameters

role_code   string   

O nome da grupo. Example: Outro grupo

role_number   string  optional  

A descrição da grupo. Example: um grupo qualquer

Exclui um grupo (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/group/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "grupos": null
    }
}

Request   

DELETE api/group/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/group/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"grupos": [
		{
			"id": 5,
		    "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
		    "name": "Outro grupo",
		    "description": "um grupo qualquer"
		    }, ...
	    ]
    }
 }

Request   

GET api/group/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Motivos

Lista as motivos

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/reason/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"motivos": [
		{
			"id": 1,
		    "public_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
		    "name": "Adicionar saldo",
		    "description": null
		}, ...
	]
}
}

Request   

GET api/reason/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra uma motivo

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/reason/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason_code": "Outra motivo",
    "reason_number": "provident"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "name": "Outra motivo",
        "description": null,
        "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
        "id": 5
    }
}

Request   

POST api/reason/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

reason_code   string   

O nome da motivo. Example: Outra motivo

reason_number   string  optional  

A descrição da motivo. Example: Example: provident

Exibe uma motivo

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/reason/show/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "motivos": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra motivo",
            "description": "uma motivo qualquer"
        }
    }
}

Request   

GET api/reason/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Atualiza uma motivo

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/reason/update/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason_code": "Outra motivo",
    "reason_number": "uma motivo qualquer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "motivos": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra motivo",
            "description": "uma motivo qualquer"
        }
    }
}

Request   

POST api/reason/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Body Parameters

reason_code   string   

O nome da motivo. Example: Outra motivo

reason_number   string  optional  

A descrição da motivo. Example: uma motivo qualquer

Exclui uma motivo (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/reason/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "motivos": null
    }
}

Request   

DELETE api/reason/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/reason/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"motivos": [
		{
			"id": 5,
		    "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
		    "name": "Outra motivo",
		    "description": "uma motivo qualquer"
		    }, ...
	    ]
    }
 }

Request   

GET api/reason/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Operadores

Lista os Operadores

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/operator/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": [
           {
               "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
               "user": "GR Alimentos",
               "public_group_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
               "group": "Recursos Humanos",
               "roles": [
                   {
                       "public_role_id": "060625aa-fec9-435c-8528-495363272025",
                       "role": "Controle de colaboradores"
                   },
                   {
                       "public_role_id": "d804497f-0b0d-4af3-9f98-5b797a383e23",
                       "role": "Gerenciamento de cartões"
                   }
               ]
           }, ...
       ]
}

Request   

GET api/operator/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um operador

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/operator/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_company_id": "dolores",
    "public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
    "roles": [
        "fa515d4c-9281-40ef-981f-249606e03a7c",
        "eeb07b19-81f8-4875-8130-e9b5e4115624"
    ],
    "groups": [
        "85c7d9aa-39dc-470b-8a00-cf1db0037826",
        "d96904a1-32b4-4254-9564-72ecd7d67150"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
        "public_company_id": null,
        "public_id": "d35d6a34-ccad-4f63-8457-e1c6f962bd5a",
        "id": 2
    }
}

Request   

POST api/operator/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

public_company_id   string  optional  

O public id da empresa ao qual pertence. Example: Example: dolores

public_user_id   string   

O public id do usuário relacionado Example: 123748b3-4a66-4ddd-babb-17603f45d874

roles   string[]  optional  

Os colaboradores do operador

groups   string[]  optional  

Os grupos de permissões do operador

Exibe uma operador

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/operator/show/d35d6a34-ccad-4f63-8457-e1c6f962bd5a"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "operadores": {
            "id": 2,
            "public_id": "d35d6a34-ccad-4f63-8457-e1c6f962bd5a",
            "public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
            "public_company_id": null
        }
    }
}

Request   

GET api/operator/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: d35d6a34-ccad-4f63-8457-e1c6f962bd5a

Atualiza uma operador

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/operator/update/d35d6a34-ccad-4f63-8457-e1c6f962bd5a"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "public_company_id": "ea",
    "public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
    "groups": [
        "85c7d9aa-39dc-470b-8a00-cf1db0037826",
        "d96904a1-32b4-4254-9564-72ecd7d67150"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "operadores": {
            "id": 2,
            "public_id": "d35d6a34-ccad-4f63-8457-e1c6f962bd5a",
            "public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
            "public_company_id": null
        }
    }
}

Request   

POST api/operator/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: d35d6a34-ccad-4f63-8457-e1c6f962bd5a

Body Parameters

public_company_id   string  optional  

O public id da empresa ao qual pertence. Example: Example: ea

public_user_id   string   

O public id do usuário relacionado Example: 123748b3-4a66-4ddd-babb-17603f45d874

groups   string[]  optional  

Os grupos de permissões do operador

Exclui uma operador (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/operator/destroy/d35d6a34-ccad-4f63-8457-e1c6f962bd5a"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "operadores": null
    }
}

Request   

DELETE api/operator/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: d35d6a34-ccad-4f63-8457-e1c6f962bd5a

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/operator/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "operadores": [
            {
                "id": 2,
                "public_id": "d35d6a34-ccad-4f63-8457-e1c6f962bd5a",
                "public_user_id": "123748b3-4a66-4ddd-babb-17603f45d874",
                "public_company_id": null
            }
        ]
    }
}

Request   

GET api/operator/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Permissões

Lista as permissões

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/role/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"permissões": [
		{
			"id": 1,
		    "public_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
		    "name": "Adicionar saldo",
		    "description": null
		}, ...
	]
}
}

Request   

GET api/role/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra uma permissão

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/role/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_code": "Outra permissão",
    "role_number": "dolores"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "name": "Outra permissão",
        "description": null,
        "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
        "id": 5
    }
}

Request   

POST api/role/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

role_code   string   

O nome da permissão. Example: Outra permissão

role_number   string  optional  

A descrição da permissão. Example: Example: dolores

Exibe uma permissão

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/role/show/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "permissões": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra permissão",
            "description": "uma permissão qualquer"
        }
    }
}

Request   

GET api/role/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Atualiza uma permissão

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/role/update/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_code": "Outra permissão",
    "role_number": "uma permissão qualquer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "permissões": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra permissão",
            "description": "uma permissão qualquer"
        }
    }
}

Request   

POST api/role/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Body Parameters

role_code   string   

O nome da permissão. Example: Outra permissão

role_number   string  optional  

A descrição da permissão. Example: uma permissão qualquer

Exclui uma permissão (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/role/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "permissões": null
    }
}

Request   

DELETE api/role/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/role/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"permissões": [
		{
			"id": 5,
		    "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
		    "name": "Outra permissão",
		    "description": "uma permissão qualquer"
		    }, ...
	    ]
    }
 }

Request   

GET api/role/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Recargas

Lista as recargas

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/recharge/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"recargas": [
		{
			"id": 1,
		    "public_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
		    "name": "Adicionar saldo",
		    "description": null
		}, ...
	]
}
}

Request   

GET api/recharge/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra uma recarga

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/recharge/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Premiação de jan",
    "description": "Meta cumprida2",
    "public_reason_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
    "public_status_id": "5fd74f23-64f4-4186-9900-40591607d5b0",
    "recurrent": false,
    "amount": 80,
    "recurrent_date": "2024-11-20",
    "schedule_date": "2024-11-20",
    "collaborators": [
        {
            "collaborator_id": "2fc17bf4-27f9-40b7-b276-06dc1ebc159e",
            "benefit_id": "eeb07b19-81f8-4875-8130-e9b5e4115624",
            "benefit_amount": 25,
            "flexible": 0
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "name": "Premiação de jan",
    "description": "Meta cumprida2",
    "public_reason_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
    "public_status_id": "5fd74f23-64f4-4186-9900-40591607d5b0",
    "amount": "80",
    "schedule_date": "2024-11-20",
    "public_company_id": "0c872d9a-dff3-42db-a70b-0af89c7eb8c1",
    "public_id": "8adf86b7-e54e-4ce3-a900-e62c3909b50a",
    "public_user_id": "7fdc78f5-7f42-4b17-afe4-9cc458430959",
    "id": 16,
    "processed": true
}

Request   

POST api/recharge/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

O nome da recarga. Example: Premiação de jan

description   string  optional  

A descrição da recarga. Example: Meta cumprida2

public_reason_id   string   

O identificador público do motivo. Example: 77fc8501-958d-4f12-baa3-b79759e8961f

public_status_id   string   

O identificador público do status. Example: 5fd74f23-64f4-4186-9900-40591607d5b0

recurrent   boolean  optional  

Indica se a recarga é recorrente. Example: false

amount   number   

O valor total da recarga. Example: 80

recurrent_date   date  optional  

A data de recorrência da recarga (se aplicável). Example: 2024-11-20

schedule_date   date   

A data agendada para a recarga. Example: 2024-11-20

collaborators   string[]   

Lista de colaboradores e seus benefícios.

Exibe uma recarga

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/recharge/show/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "recargas": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra recarga",
            "description": "uma recarga qualquer"
        }
    }
}

Request   

GET api/recharge/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Atualiza uma recarga

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/recharge/update/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason_code": "Outra recarga",
    "reason_number": "uma recarga qualquer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "recargas": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra recarga",
            "description": "uma recarga qualquer"
        }
    }
}

Request   

POST api/recharge/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Body Parameters

reason_code   string   

O nome da recarga. Example: Outra recarga

reason_number   string  optional  

A descrição da recarga. Example: uma recarga qualquer

Exclui uma recarga (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/recharge/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "recargas": null
    }
}

Request   

DELETE api/recharge/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/recharge/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"recargas": [
		{
			"id": 5,
		    "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
		    "name": "Outra recarga",
		    "description": "uma recarga qualquer"
		    }, ...
	    ]
    }
 }

Request   

GET api/recharge/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Saldo

Lista o extrato do saldo da empresa

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/company/extract-list"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_id": "9cf12e1a-408b-40b8-a921-649596233409"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": [
        {
            "transaction_id": "6e9d9eb4-bf0f-42bc-a67b-4d9b43aa08ec",
            "transaction_amount": "-80.00",
            "transaction_balance": "920.00",
            "balance_date": "2024-11-21 11:54:51",
            "transaction_error": 0,
            "recharge_id": "96b7e776-9903-4d03-ab86-662d0f4774f5",
            "recharge_name": "Premiação de jan",
            "recharge_amount": "80.00",
            "recharge_schedule_date": "2024-11-20 00:00:00",
            "recharge_processed": 1,
            "payment_id": null,
            "payment_amount": null,
            "payment_due_date": null,
            "payment_paid_at": null,
            "payment_status": null,
            "payment_error": null
        },
        {
            "transaction_id": "79341e6e-621a-42e7-801c-c687c22d807c",
            "transaction_amount": "1000.00",
            "transaction_balance": "1000.00",
            "balance_date": "2024-11-21 11:45:14",
            "transaction_error": 0,
            "recharge_id": null,
            "recharge_name": null,
            "recharge_amount": null,
            "recharge_schedule_date": null,
            "recharge_processed": null,
            "payment_id": "f0b14f7a-875a-4b42-9a3c-b8301bd7fd49",
            "payment_amount": "1000.00",
            "payment_due_date": null,
            "payment_paid_at": "2024-11-21 11:45:14",
            "payment_status": 5,
            "payment_error": 0
        }
    ]
}

Request   

POST api/company/extract-list

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

company_id   string   

O identificador público da empresa. Example: 9cf12e1a-408b-40b8-a921-649596233409

Status

Lista as statuss

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/status/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"statuss": [
		{
			"id": 1,
		    "public_id": "77fc8501-958d-4f12-baa3-b79759e8961f",
		    "name": "Adicionar saldo",
		    "description": null
		}, ...
	]
}
}

Request   

GET api/status/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra uma status

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/status/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason_code": "Outra status",
    "reason_number": "non"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "name": "Outra status",
        "description": null,
        "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
        "id": 5
    }
}

Request   

POST api/status/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

reason_code   string   

O nome da status. Example: Outra status

reason_number   string  optional  

A descrição da status. Example: Example: non

Exibe uma status

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/status/show/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "statuss": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra status",
            "description": "uma status qualquer"
        }
    }
}

Request   

GET api/status/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Atualiza uma status

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/status/update/e381728b-f053-4629-b1e3-33c289279f0f"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason_code": "Outra status",
    "reason_number": "uma status qualquer"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "statuss": {
            "id": 5,
            "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
            "name": "Outra status",
            "description": "uma status qualquer"
        }
    }
}

Request   

POST api/status/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: e381728b-f053-4629-b1e3-33c289279f0f

Body Parameters

reason_code   string   

O nome da status. Example: Outra status

reason_number   string  optional  

A descrição da status. Example: uma status qualquer

Exclui uma status (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/status/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "statuss": null
    }
}

Request   

DELETE api/status/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/status/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"statuss": [
		{
			"id": 5,
		    "public_id": "e381728b-f053-4629-b1e3-33c289279f0f",
		    "name": "Outra status",
		    "description": "uma status qualquer"
		    }, ...
	    ]
    }
 }

Request   

GET api/status/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Telefones

Lista os telefones

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/phone/index"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"telefones": [
		{
			"id": 1,
			"public_id": "2beebd6f-a9b9-42f3-a212-6b7401074d73",
			"public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
			"phone_code": "11",
			"phone_number": "996036733",
			"phone_verified_at": null
		}, ...
	]
}
}

Request   

GET api/phone/index

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Cadastra um telefone

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/phone/store"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone_code": "12",
    "phone_number": "951900130"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "code": 201,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "phone_code": "12",
        "phone_number": "951900130",
        "public_id": "ee4beb8f-4e2a-4e5d-b098-ce841b8582d7",
        "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
        "id": 3
    }
}

Request   

POST api/phone/store

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

phone_code   string   

O código do telefone. Example: 12

phone_number   string   

O número do telefone. Example: 951900130

Exibe um telefone

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/phone/show/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "telefones": {
            "id": 1,
            "public_id": "2beebd6f-a9b9-42f3-a212-6b7401074d73",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "public_company_id": "fe652f49-26b1-47aa-a777-e18ce6024cb1",
            "phone_code": "13",
            "phone_number": "951900133",
            "phone_verified_at": null
        }
    }
}

Request   

GET api/phone/show/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Atualiza um telefone

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/phone/update/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone_code": "12",
    "phone_number": "951900120"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "telefones": {
            "id": 3,
            "public_id": "ee4beb8f-4e2a-4e5d-b098-ce841b8582d7",
            "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
            "phone_code": "12",
            "phone_number": "951900120",
            "phone_verified_at": null
        }
    }
}

Request   

POST api/phone/update/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Body Parameters

phone_code   string   

O código do telefone. Example: 12

phone_number   string   

O número do telefone. Example: 951900120

Exclui um telefone (envia para lixeira)

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/phone/destroy/cee1aea6-92c5-49d5-904f-c71da05dce06"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": 200,
    "success": true,
    "message": "a requisição foi bem-sucedida.",
    "data": {
        "telefones": null
    }
}

Request   

DELETE api/phone/destroy/{public_id}

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_id   string  optional  

uuid required O Public_id do recurso. Example: cee1aea6-92c5-49d5-904f-c71da05dce06

Lista arquivos na lixeira

requer autenticação

Example request:
const url = new URL(
    "https://apibeneficios.aqbank.com.br/api/phone/trash"
);

const headers = {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
"code": 200,
"success": true,
"message": "a requisição foi bem-sucedida.",
"data": {
	"telefones": [
		{
			    "id": 3,
			    "public_id": "ee4beb8f-4e2a-4e5d-b098-ce841b8582d7",
			    "public_user_id": "2c7bd9d9-6c76-4adb-a424-16cd0e5ebed9",
			    "phone_code": "12",
			    "phone_number": "951900120",
			    "phone_verified_at": null
		    }, ...
	    ]
    }
 }

Request   

GET api/phone/trash

Headers

Authorization      

Example: Bearer {token}

Content-Type      

Example: application/json

Accept      

Example: application/json