Gerenciar Subcontas
Utilize nossa API para lidar facilmente com subcontas: criar, excluir, obter informações e transferir saldo. Ideal para todos que desejam gerenciar sua estrutura de contas de forma clara e eficiente.
Listar Subcontas
Solicite uma lista de todas as subcontas de uma conta.
Parâmetros
- Name
id
- Type
- integer
- Optional
- Optional
- Description
O ID de uma subconta. Com isso, você obtém apenas os dados de uma subconta específica.
Requisição
curl -G https://gateway.seven.io/api/subaccounts?action=read \
-H "X-Api-Key: SUA_CHAVE_API" \
-H "Accept: application/json"
Resposta
[
{
"id": "1234567891",
"username": null,
"company": "Company 1",
"balance": "36.8100",
"total_usage": "0.3000",
"auto_topup": {
"threshold": "1",
"amount": "5"
},
"contact": {
"name": "John Doe",
"email": "sms@acme-company1.com"
}
},
{
"id": "1234567892",
"username": "push2app",
"company": "Another Company",
"balance": "120.4000",
"total_usage": "0.0000",
"auto_topup": {
"threshold": null,
"amount": null
},
"contact": {
"name": "Donald Dummy",
"email": "contact@another-acme-company.com"
}
}
]
Criar Subconta
Crie uma subconta através da API.
Parâmetros
- Name
name
- Type
- string
- Description
Nome completo do proprietário da conta.
- Name
email
- Type
- string
- Description
Endereço de e-mail da conta.
Requisição
curl -G https://gateway.seven.io/api/subaccounts?action=create \
-H "X-Api-Key: SUA_CHAVE_API" \
-d "name=John Doe" \
-d "email=john.doe@acme-inc.com"
Resposta em caso de sucesso
{
"success": true,
"error": null,
"subaccount": {
"id": "123456789",
"username": null,
"company": null,
"balance": 0,
"total_usage": 0,
"auto_topup": {
"threshold": 0,
"amount": 0
},
"contact": {
"name": "John Doe",
"email": "john.doe@acme-inc.com"
}
}
}
Resposta em caso de erro
{
"success": false,
"error": "Invalid request"
}
Transferência automática de saldo
Com esta API, você pode configurar a transferência automática de saldo para uma subconta.
Isso pode transferir saldo do conta principal para a subconta quando um limite definido for atingido.
Para desativar, basta definir amount
como 0.
Parâmetros
- Name
id
- Type
- integer
- Description
O ID da subconta.
- Name
threshold
- Type
- float
- Description
O limite de saldo abaixo do qual o saldo deve ser transferido.
- Name
amount
- Type
- float
- Description
O valor do saldo que deve ser enviado da conta principal para a subconta quando
threshold
for atingido.
Requisição
curl -G https://gateway.seven.io/api/subaccounts?action=update \
-H "X-Api-Key: SUA_CHAVE_API" \
-d "id=49176123456789" \
-d "threshold=100.0" \
-d "amount=200.0"
Resposta em caso de sucesso
{
"success": true,
"error": null
}
Transferência manual de saldo
Com esta API, você pode transferir saldo da conta principal para a subconta uma única vez.
Parâmetros
- Name
id
- Type
- integer
- Description
ID da subconta.
- Name
amount
- Type
- float
- Description
Saldo a ser transferido.
Requisição
curl -G https://gateway.seven.io/api/subaccounts?action=transfer_credits \
-H "X-Api-Key: SUA_CHAVE_API" \
-d "id=123456789" \
-d "amount=250.0"
Resposta
{
"success": true,
"error": null
}
Exclusão de Subcontas
Com esta API, subcontas podem ser excluídas com base em seu ID.
Parâmetros
- Name
id
- Type
- integer
- Description
ID da subconta.
Request
curl -G https://gateway.seven.io/api/subaccounts?action=delete \
-H "X-Api-Key: SUA_CHAVE_API" \
-d "id=123456789"
Resposta
{
"success": true,
"error": null
}