Data Formatting
This section defines the required formats for parameters used by the API resources.
Parameter Formats
- Name
email- Type
- string (email format)
- Description
Email address in standard format.
Example:testuser@gmail.com
- Name
mobile_phone- Type
- string (E.164)
- Description
Complete phone number with country code, without spaces or hyphens.
Example:+237678923563
- Name
amount- Type
- double
- Description
The amount to be transferred to a user.
Example:6789.23
- Name
from_currency- Type
- string (currency code)
- Description
The currency in which the amount is sent. Use the country currency code in uppercase.
Example:XOF
- Name
to_currency- Type
- string (currency code)
- Description
The currency in which the amount will be paid. Use the country currency code in uppercase.
Example:XAF
- Name
fxrate- Type
- double
- Description
For this field, always set the value to 1
Example:"fxrate": 1
- Name
aml_cft- Type
- boolean
- Description
Certifies the information sent through the request. For payment requests, the action is considered only if
aml_cftis set totrue.
Example:true
- Name
status- Type
- string (enum)
- Description
Status of a payment request. Possible values:
new,pending,paid,failed(all lowercase).
Example:new