Skip to main content
POST
/
payments
/
payin
Initiate PayIn
curl --request POST \
  --url https://getmipay.com/api/v1/payments/payin \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'operation: <operation>' \
  --header 'service: <service>' \
  --data '
{
  "amount": 1000,
  "currency": "XAF",
  "wallet": "690000000",
  "description": "Payment for Order #123",
  "customer_name": "John Doe",
  "customer_email": "john@example.com",
  "callback_url": "https://yourapp.com/webhooks/payment"
}
'
{
  "success": true,
  "message": "Payment initiated successfully",
  "data": {
    "transaction_reference": "MPAYIN_ABC123DEF456",
    "soleaspay_reference": "MLS690d472dd7ee7B",
    "amount": 1000,
    "fee_amount": 50,
    "net_amount": 950,
    "currency": "XAF",
    "status": "pending",
    "service_used": "3",
    "service_name": "OM CI",
    "otp_required": true,
    "payment_url": "null",
    "webhook_urls": {
      "success": "https://getmipay.com/api/webhooks/success",
      "failure": "https://getmipay.com/api/webhooks/failure"
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
operation
enum<string>
required

Operation type - must be '2' for PayIn

Available options:
2
Example:

"2"

​
service
string
required

Service identifier for the payment method.

Services requiring OTP:

  • 3 - OM CI (Orange Money Côte d'Ivoire)
  • 4 - OM SN (Orange Money Senegal)
  • 5 - OM BF (Orange Money Burkina Faso)
Example:

"1"

​
otp
string

One-Time Password for Orange Money services.

Required only for: OM CI (service: 3), OM SN (service: 4), OM BF (service: 5) Format: Maximum 8 characters/digits Note: This header is optional for services that don't require OTP

Maximum string length: 8
Example:

"123456"

Body

application/json

Payment details to collect from customer

​
amount
number
required

Amount in smallest currency unit (100 XAF = 1€)

Required range: x >= 100
Example:

1000

​
currency
enum<string>
default:XAF
required
Available options:
XAF,
XOF
Example:

"XAF"

​
wallet
string
required

Customer mobile money wallet number

Example:

"690000000"

​
description
string
required
Maximum string length: 255
Example:

"Payment for Order #123"

​
customer_name
string
required
Maximum string length: 255
Example:

"John Doe"

​
customer_email
string<email>
Example:

"john@example.com"

​
callback_url
string<uri>

URL to receive payment status updates

Example:

"https://yourapp.com/webhooks/payment"

Response

Payment initiated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Payment initiated successfully"

​
data
object