Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Provisioning

Create a Provisioning

Move funds from merchant's collection account to transfer account

post/provisionings

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Request body

amountnumber required

Amount intended to be moved from CollectionAccount to TransferAccount. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).

currencystring required

Three-letter ISO currency code.

descriptionstring required

An arbitrary string attached to the Transfer. Mostly useful for displaying to user.

Example request

{
  "amount": 100,
  "currency": "XOF"
}

Response

idstring required

Unique identifier for the Provisioning

statusstring required

Type of this Transaction

datestring required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

descriptionstring required

An arbitrary string attached to the Transfer. Mostly useful for displaying to user.

failureCauseProvisioningFailureCauseDto

Example response

{
  "id": "prov_z1urYtVFgEebtcj8fxp4v",
  "status": "pending",
  "date": "2020-10-15T12:09:49.355Z",
  "withdrawal": {
    "id": "wtd_z1urYtVFgEebtcj8fxp4v",
    "type": "withdrawal",
    "date": "2020-10-15T12:09:49.355Z",
    "amount": 100,
    "currency": "XOF"
  },
  "deposit": {
    "id": "dep_z1urYtVFgEebtcj8fxp4v",
    "type": "deposit",
    "date": "2020-10-15T12:09:49.355Z",
    "amount": 100,
    "currency": "XOF"
  }
}