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 has one of the following statuses:created, pending, successful or failed.
Create a provisioning
HUB2 API reference - Create a provisioningRetrieve provisionings
HUB2 API reference - List provisioningsdata holds the provisionings of the requested page, alongside totalItems, currentPage and countPerPage. Use the page and perPage query parameters to paginate (perPage defaults to 10). Do not rely on totalItems: it is not a real count and currently returns a fixed value (999999). To paginate, request pages until data comes back empty or holds fewer than perPage items. This shape may change to a plain array with a Content-Range header, like the other list endpoints: read data only when the response is an object.
data: the provisionings of the page.withdrawal: the transaction debited from the collection account.deposit: the transaction credited to the transfer account.failureCause(failed provisionings only):codeandmessageexplaining the failure.
GET /provisionings/{id}.
Failure
Once a provisioning is approved, HUB2 moves the funds between your accounts. If the movement cannot be completed, the provisioning moves to thefailed status and HUB2 sends a provisioning.failed webhook. No funds are moved.
The failureCause field of the failed provisioning explains why. Its code is one of:
The
message returned when you retrieve the provisioning with GET /provisionings/{id} gives the detail, for example the amount and currency that could not be moved.