Approvisionnement de compte

Introduction

L’approvisionnement (provisioning) est un type de transaction qui transfère des fonds du compte de collecte (compte pay-in) vers le compte de transfert (compte pay-out) d’un même marchand.

Une demande d’approvisionnement effectuée avec une clé API est soumise à validation et approbation par HUB2. En dessous d’un certain montant, elle peut être approuvée automatiquement. Contactez l’équipe support pour plus d’informations sur les conditions d’approvisionnement.

Un approvisionnement a l’un des statuts suivants : created, pending, successful ou failed.

Créer un approvisionnement

Référence API HUB2 - Créer un approvisionnement

curl --location --request POST 'https://api.hub2.io/provisionings' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 200,
    "currency": "XOF",
    "description": "Provisioning test"
}'

const headers = {
    'ApiKey': '[REDACTED]',
    'MerchantId': '[REDACTED]',
    'Environment': 'sandbox',
    'Content-Type': 'application/json'
};

const data = {
    amount: 200,
    currency: "XOF",
    description: "Provisioning test"
};

fetch('https://api.hub2.io/provisionings', {
    method: 'POST',
    headers: headers,
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch((error) => console.error('Error:', error));

import requests

headers = {
    'ApiKey': '[REDACTED]',
    'MerchantId': '[REDACTED]',
    'Environment': 'sandbox',
    'Content-Type': 'application/json',
}

data = {
    "amount": 200,
    "currency": "XOF",
    "description": "Provisioning test",
}

response = requests.post('https://api.hub2.io/provisionings', headers=headers, json=data)

print(response.json())

La réponse est une demande d’approbation (action) créée et en attente d’approbation :

{
    "id": 32,
    "action": "provisioning",
    "status": "created",
    "authorId": "apiKey",
    "merchantId": "[REDACTED]",
    "params": {
        "amount": 200,
        "currency": "XOF",
        "description": "Provisioning test",
        "mode": "sandbox"
    },
    "createdAt": "2023-11-07T11:21:19.561Z",
    "updatedAt": "2023-11-07T11:21:19.561Z"
}

Une fois la demande approuvée, l’approvisionnement correspondant apparaît dans la liste des approvisionnements et dans le tableau de bord HUB2.

Récupérer les approvisionnements

Référence API HUB2 - Lister les approvisionnements

curl --location --request GET 'https://api.hub2.io/provisionings?page=1&perPage=10' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Environment: sandbox' \
--header 'Content-Type: application/json'

import fetch from 'node-fetch';

const url = 'https://api.hub2.io/provisionings?page=1&perPage=10';
const headers = {
    'ApiKey': '[REDACTED]',
    'MerchantId': '[REDACTED]',
    'Environment': 'sandbox',
    'Content-Type': 'application/json'
};

fetch(url, { method: 'GET', headers: headers })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch((error) => console.error('Error:', error));

import requests

url = "https://api.hub2.io/provisionings?page=1&perPage=10"
headers = {
    'ApiKey': '[REDACTED]',
    'MerchantId': '[REDACTED]',
    'Environment': 'sandbox',
    'Content-Type': 'application/json',
}

response = requests.get(url, headers=headers)

print(response.json())

La réponse est un objet paginé : data contient les approvisionnements de la page demandée, accompagné de totalItems, currentPage et countPerPage. Utilisez les paramètres de requête page et perPage pour paginer (perPage vaut 10 par défaut). Ne vous fiez pas à totalItems : ce n’est pas un nombre total réel, il vaut actuellement toujours 999999. Pour paginer, demandez les pages jusqu’à ce que data soit vide ou contienne moins de perPage éléments. Cette forme pourra évoluer vers un simple tableau accompagné d’un en-tête Content-Range, comme les autres points de terminaison de liste : ne lisez data que si la réponse est un objet.

{
    "data": [
        {
            "id": "prov_xxxxxxxxxxxxxxxxxxxxx",
            "date": "2023-10-17T12:31:27.793Z",
            "withdrawal": {
                "id": "wtd_xxxxxxxxxxxxxxxxxxxxx",
                "type": "withdrawal",
                "date": "2023-10-17T12:31:27.959Z",
                "amount": 100,
                "currency": "XOF"
            },
            "deposit": {
                "id": "dep_xxxxxxxxxxxxxxxxxxxxx",
                "type": "deposit",
                "date": "2023-10-17T12:31:27.959Z",
                "amount": 100,
                "currency": "XOF"
            },
            "description": "Provisioning test",
            "status": "successful"
        },
        {
            "id": "prov_yyyyyyyyyyyyyyyyyyyyy",
            "date": "2023-10-17T12:31:04.405Z",
            "withdrawal": {
                "id": "wtd_yyyyyyyyyyyyyyyyyyyyy",
                "type": "withdrawal",
                "date": "2023-10-17T12:31:04.473Z",
                "amount": 100,
                "currency": "XOF"
            },
            "deposit": {
                "id": "dep_yyyyyyyyyyyyyyyyyyyyy",
                "type": "deposit",
                "date": "2023-10-17T12:31:04.473Z",
                "amount": 100,
                "currency": "XOF"
            },
            "description": "Provisioning test",
            "status": "successful"
        }
    ],
    "totalItems": 999999,
    "currentPage": 1,
    "countPerPage": 10
}

data : les approvisionnements de la page.
withdrawal : la transaction débitée du compte de collecte.
deposit : la transaction créditée sur le compte de transfert.
failureCause (approvisionnements en échec uniquement) : code et message expliquant l’échec.

Pour récupérer un seul approvisionnement, utilisez GET /provisionings/{id}.

Échec

Une fois un approvisionnement approuvé, HUB2 déplace les fonds entre vos comptes. Si le mouvement ne peut pas être effectué, l’approvisionnement passe au statut failed et HUB2 envoie un webhook provisioning.failed. Aucun fonds n’est déplacé. Le champ failureCause de l’approvisionnement en échec en explique la raison. Son code prend l’une des valeurs suivantes :

Code	Signification
`domain_error`	Une règle de compte a empêché le mouvement : fonds insuffisants sur le compte de collecte, compte verrouillé ou compte non ouvert.
`internal_error`	Une erreur inattendue est survenue côté HUB2. Réessayez plus tard et contactez le support si elle persiste.

Le message renvoyé lorsque vous récupérez l’approvisionnement avec GET /provisionings/{id} donne le détail, par exemple le montant et la devise qui n’ont pas pu être déplacés.

Guide de démarrage

Transferts

Paiements

Paiement instantané

Webhooks

Processing Only

Payment Links

Abonnements

Sous-marchands

Autres produits

Introduction

Créer un approvisionnement

Récupérer les approvisionnements

Échec

​Introduction

​Créer un approvisionnement

​Récupérer les approvisionnements

​Échec

Introduction

Créer un approvisionnement

Récupérer les approvisionnements

Échec