Aller au contenu principal

Tutoriel pour les distributeurs

Ce tutoriel montre comment utiliser l'API Distributeur pour gérer le cycle de vie complet des dépôts et des retraits pour les investisseurs dans les Fonds Spiko. Pour une référence complète de l'API, veuillez consulter la Référence de l'API.

1. Créer un investisseur​

Commençons par créer un profil d'investisseur pour John Doe.

curl -X POST "https://distributor-api.spiko.finance/v0/investors" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "details": {
      "type": "individual",
      "countryOfTaxResidence": "FR"
    },
    "country": "FR",
    "city": "Paris",
    "zipCode": "75001",
    "address": "12 rue de Rivoli",
    "dateOfBirth": "1999-08-24T14:15:22Z",
    "placeOfBirth": "Paris"
  }'

L'API renvoie un INVESTOR_ID qui est nécessaire pour les opérations suivantes.

2. Obtenir la liste des classes d'actions disponibles​

Récupérez la liste des classes d'actions disponibles via l'API.

curl -X GET "https://public-api.spiko.finance/share-classes/"

La réponse inclut le SHARE_CLASS_ID pour le Fonds Monétaire Spiko EU T-Bills, que nous utiliserons pour notre investissement.

3. Créer une souscription​

Créez un ordre de souscription de 10 000 € dans le Fonds Monétaire Spiko EU T-Bills.

curl -X POST "https://distributor-api.spiko.finance/v0/subscription-orders" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "investorId": "INVESTOR_ID",
    "amount": {
      "value": "10000",
      "currency": "EUR"
    },
    "shareClassId": "SHARE_CLASS_ID"
  }'

L'API renvoie un SUBSCRIPTION_ORDER_ID et une WIRE_REFERENCE. La WIRE_REFERENCE doit être incluse dans le virement bancaire de l'investisseur.

4. Paiement de la souscription​

L'investisseur doit transférer les fonds sur le compte bancaire du Fonds en utilisant la WIRE_REFERENCE fournie. Le compte bancaire du fonds est disponible dans le endpoint share-classes utilisé ci-dessus. Une fois que le fonds reçoit le transfert, l'ordre de souscription devient valide. Surveillez l'état de l'ordre en utilisant :

curl -X GET "https://distributor-api.spiko.finance/v0/subscription-orders/SUBSCRIPTION_ORDER_ID" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json"

5. Consulter le portefeuille​

Surveillez le portefeuille de l'investisseur à tout moment :

curl -X GET "https://distributor-api.spiko.finance/v0/portfolios/INVESTOR_ID" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json"

6. Enregistrer un compte bancaire​

Avant d'initier un rachat, enregistrez le compte bancaire de l'investisseur :

curl -X POST "https://distributor-api.spiko.finance/v0/bank-accounts" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "investorId": "INVESTOR_ID",
    "currency": "EUR",
    "accountNumber": "FRXXXXXXXXXXX",
    "bic": "XXXXXXX"
  }'

L'API renvoie un BANK_ACCOUNT_ID à utiliser dans les demandes de rachat.

7. Créer une demande de rachat​

Envoyez une demande de rachat en spécifiant le nombre d'actions à racheter :

curl -X POST "https://distributor-api.spiko.finance/v0/redemption-orders" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "investorId": "INVESTOR_ID",
    "bankAccountId": "BANK_ACCOUNT_ID",
    "sharesAmount": "100.50",
    "shareClassId": "SHARE_CLASS_ID"
  }'

8. Paiement du rachat​

La banque dépositaire traite le rachat et transfère les fonds correspondants sur le compte bancaire enregistré de l'investisseur.

9. Accéder aux relevés comptables​

Récupérez les relevés comptables historiques montrant les pus-values latentes et réalisées :

curl -X GET "https://distributor-api.spiko.finance/v0/accounting-positions?investorId=INVESTOR_ID&shareClassId=SHARE_CLASS_ID&from=2024-01-01&to=2024-11-07" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json"