POST
/
provisionings

Headers

ApiKey
string
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.

MerchantId
string
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
enum<string>
required

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

Available options:
live,
sandbox

Body

application/json
amount
number
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).

currency
string
required

Three-letter ISO currency code.

description
string
required

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

Response

200 - application/json
id
string
required

Unique identifier for the Provisioning

status
string
required

Type of this Transaction

date
string
required

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

withdrawal
object

Transaction executed on the merchant collectionAccount

deposit
object

Transaction executed on the merchant transferAccount

description
string
required

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

failureCause
object

Failure cause explaining why the Provisioning failed.

Retrieve a Provisionings collectionRetrieve a Provisioning from given id