This section talks about the commonly used keywords across the API.
Chimoney Object ✌
Where it begins...✨
{
valueInUSD, // amount to send
email, // Required if twitter is not provided.
twitter, // Required if email is not provided. Uses email if it is also provided
enabledToRedeem, // A array of assets enabled for this transaction. Optional.
}
enabledToRedeem array
An array of supported assets to be redeemed. Useful for:
- restricting what receivers can get with their Chimoney
- linking a transaction to a particular asset in the instance that you want the receivers to redeem the linked asset
- Get a list of supported assets using the Get list of all assets. endpoint.
Sub accounts
A parent account can have one more sub accounts.
Sub accounts can call many endpoints via their parent.
To perform a transaction as a sub account, pass the subAccount
id to the body of any API call and you will perform the transaction as that account.
For example:
- payout from a subaccount wallet
- check sub account balance etc.
issueID
This is a reference to a previously initiated send Chimoney transaction.
It is used at various endpoints across the product. e.g Get transaction details by issueID.
chiRef
This is yet another reference to a previously initiated send Chimoney transaction.
It is used at various endpoints across the product. e.g Redeem airtime.
redirect_url
This is the URL to redirect to after payment is confirmed. An example use case is with the payments endpoint.