Account Provisioning

Introduction

Account provisioning is a type of transaction that moves funds from the collection account (pay-in account) to the transfer account (pay-out account) of the same merchant.

A provisioning request made with an API key is subject to validation and approval by HUB2. Below a certain amount, it may be approved automatically. Contact the support team for more information on provisioning conditions.

A provisioning has one of the following statuses: created, pending, successful or failed.

Create a provisioning

HUB2 API reference - Create a provisioning

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())

The response is an approval request (action) that has been created and is awaiting approval:

{
    "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"
}

Once the request is approved, the resulting provisioning appears in the provisionings list and in the dashboard.

Retrieve provisionings

HUB2 API reference - List provisionings

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())

The response is an array of provisionings. Use the page and perPage query parameters to paginate (perPage defaults to 10).

[
    {
        "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"
    }
]

withdrawal: the transaction debited from the collection account.
deposit: the transaction credited to the transfer account.

To retrieve a single provisioning, use GET /provisionings/{id}.

Getting started

Transfers

Payments

Webhooks

Processing Only

Payment Links

Submerchants

Other

Introduction

Create a provisioning

Retrieve provisionings

​Introduction

​Create a provisioning

​Retrieve provisionings

Introduction

Create a provisioning

Retrieve provisionings