Gestion des sous-comptes
Utilisez notre API pour facilement gérer les sous-comptes : créer, supprimer, récupérer des informations et transférer du solde. Idéal pour ceux qui souhaitent gérer leur structure de compte de manière claire et efficace.
Lister les sous-comptes
Demander une liste de tous les sous-comptes d'un compte.
Paramètres
- Name
id
- Type
- integer
- Optional
- Optional
- Description
L'ID d'un sous-compte. Cela vous donnera seulement les données pour un sous-compte spécifique.
Requête
curl -G https://gateway.seven.io/api/subaccounts?action=read \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-H "Accept: application/json"
Réponse
[
{
"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"
}
},
{
"id": 12345
// ...
}
]
Créer un sous-compte
Créer un sous-compte via l'API.
Paramètres
- Name
name
- Type
- string
- Description
Nom et prénom complets du propriétaire du compte.
- Name
email
- Type
- string
- Description
Adresse e-mail du compte.
Requête
curl -G https://gateway.seven.io/api/subaccounts?action=create \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "name=John Doe" \
-d "email=john.doe@acme-inc.com"
Réponse en cas de succès
{
"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"
}
}
}
Réponse d'erreur
{
"success": false,
"error": "Invalid request"
}
Transfert automatique de solde
Avec cette API, vous pouvez configurer le transfert automatique de crédit pour un sous-compte. Cela peut transférer du crédit du compte principal vers le sous-compte lorsqu'un seuil défini est atteint. Pour désactiver, définissez simplement amount
à 0.
Paramètres
- Name
id
- Type
- integer
- Description
L'ID du sous-compte.
- Name
threshold
- Type
- float
- Description
Le seuil de crédit, en dessous duquel le crédit doit être transféré.
- Name
amount
- Type
- float
- Description
Le montant de crédit qui doit être envoyé du compte principal au sous-compte lorsque le
threshold
est atteint.
Requête
curl -G https://gateway.seven.io/api/subaccounts \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "id=49176123456789" \
-d "threshold=100.0" \
-d "amount=200.0"
Réponse en cas de succès
{
"success": true,
"error": null
}
Transfert manuel de crédit
Avec cette API, vous pouvez transférer du crédit du compte principal vers le sous-compte une fois.
Paramètres
- Name
id
- Type
- integer
- Description
ID du sous-compte.
- Name
amount
- Type
- float
- Description
Crédit à transférer.
Requête
curl -G https://gateway.seven.io/api/subaccounts?action=transfer_credits \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "id=123456789" \
-d "amount=250.0"
Réponse
{
"success": true,
"error": null
}
Suppression de sous-comptes
Avec cette API, les sous-comptes peuvent être supprimés en fonction de leur ID.
Paramètres
- Name
id
- Type
- integer
- Description
ID du sous-compte.
Requête
curl -G https://gateway.seven.io/api/subaccounts?action=delete \
-H "X-Api-Key: VOTRE_CLÉ_API" \
-d "id=123456789"
Réponse
{
"success": true,
"error": null
}