Create charge for a customer via mobile

Charge a mobile money wallet directly, without an invoice behind it. Send the payer a code first with Send a one-time code, then call this with that code in otp. Until a valid code arrives the endpoint answers 428 Precondition Required.

POST https://api.leapa.co/v2/charges/mobile

This endpoint needs your API key

Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.

Request

curl -X POST "https://api.leapa.co/v2/charges/mobile" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 45000,
    "currency": "BIF",
    "description": "Room 204, two nights",
    "customer": {
      "email": "jeanne@example.com",
      "address": {
        "city": "string",
        "state": "string",
        "type": "personal",
        "country": "AD",
        "zip": "string",
        "line1": "string",
        "line2": "string"
      },
      "first_name": "Jeanne",
      "last_name": "Ndayishimiye",
      "birth_date": "2026-01-31",
      "phone_number": "+25779123456"
    },
    "source": {
      "brand": "ecocash",
      "currency": "BIF",
      "number": "string",
      "country_code": "BI",
      "default": false
    },
    "source_id": "src_0e7b3c95af",
    "customer_id": "cus_3d8e51fa20",
    "captured": false,
    "invoice_reference_id": "string",
    "customer_reference_id": "string",
    "otp": "string"
  }'

Response

Created

{
  "id": "obj_5f21c8a40b",
  "object": "string",
  "amount": 45000,
  "currency": "BIF",
  "description": "Room 204, two nights",
  "status": "succeeded",
  "source": {
    "id": "obj_5f21c8a40b",
    "brand": "ecocash",
    "funding": "credit",
    "last4": "string",
    "email": "jeanne@example.com",
    "fingerprint": "string",
    "token": "string",
    "language": "string",
    "number": "string",
    "cvc_check": "pass",
    "exp_month": "string",
    "exp_year": "string",
    "statement_descriptor": "string",
    "country_code": "string"
  },
  "affiliate": "dwelinn",
  "amount_refunded": 45000,
  "available_date": 0,
  "captured": false,
  "created_date": 0,
  "disputed": false,
  "failure_code": "string",
  "failure_message": "string",
  "invoice_id": "inv_7c1f9a2b48",
  "live": false,
  "modified_date": 0,
  "refunded": false,
  "customer_id": "cus_3d8e51fa20",
  "processing_id": "string",
  "quittance_number": "string"
}

Request body

application/json

Required. Send it as JSON.

amountinteger<int64>required
Amount to charge, in the smallest unit the currency uses. BIF has no minor unit, so 45000 is 45,000 francs.
currencystringrequired
Currency of the charge. It has to match the currency account your API key was issued for.
Allowed values:BIFUSDKESXAF
descriptionstringrequired
What the payment is for. Shown in your Leapa dashboard and on the payer’s statement.
Must be:5 to 100 characters
customerCustomerRequestMobile
A new customer to create and charge in one call. Send this or customer_id, not both.
- emailstring
  Customer's email address. Constraints: Not null, Valid email format
- addressAddressRequestGeneric
- first_namestring
  Customer's firstname. Constraints: Size(min=3, max=30)
  Must be:at most 30 characters
- last_namestring
  Customer's lastName. Constraints: Size(min=3, max=30)
  Must be:at most 30 characters
- birth_datestring
  Customer's birthdate. Constraints: format(YYYY-MM-DD)
  Must be:matches ^\d{4}-\d{2}-\d{2}$
- phone_numberstring
  Customer's phone number. Constraints: only digit 0-9 and Size(min=1, max=15)
  Must be:matches ^\+?(?:[0-9] ?){6,14}[0-9]$
sourceMobileRequest
The mobile money wallet to charge. Send this or source_id, not both.
- brandstringrequired
  Customer mobile money brand)
  Allowed values:ecocashenotiibb+pesaflashbrbbcbbancobubbciand 78 more
- currencystringrequired
  Currency code
  Allowed values:BIFUSDKESXAF
- numberstringrequired
  Customer mobile money number)
- country_codestringrequired
  Customer mobile money country code)
  Allowed values:BI
- defaultbooleanrequired
  Indicating whether this payment method is the default sources of payment. Constraints: Not null
source_idstring
A wallet already saved on the customer. Send this or source.
customer_idstring
An existing customer to charge. Send this or customer.
capturedbooleanrequired
Whether to immediately capture the charge or not.
invoice_reference_idstring
Your own id for the bill this charge settles, echoed back on the charge. It does not create or settle a Leapa invoice.
customer_reference_idstring
Your own id for the customer, echoed back on the charge so you can match it to your records.
otpstring
The six-digit code the payer received from Send a one-time code. The charge answers 428 until you send a valid one.
Must be:6 to 6 characters

Response

application/json

idstring
objectstring
amountinteger<int64>
currencystring
Allowed values:BIFUSDKESXAF
descriptionstring
statusstring
Allowed values:succeededpaidpendingfailed
sourceSourceObject
- idstring
  Source id
- brandstring
  Payment Method Brand Name: Either Mastercard, Visa or Ecocash(Mobile Money)
  Allowed values:ecocashlumicashmastercardvisa
- fundingstring
  Card funding type. Either credit, debit, prepaid, or unknown
  Allowed values:creditdebitprepaidunknown
- last4string
  Last Four ditgits of the card
- emailstring
  Email of the card Owner.
- fingerprintstring
  Unique identifier of the card number as returned by the CyberSource TMS API
- tokenstring
  Unique identifier of the card data as returned by the CyberSource TMS API
- languagestring
  Prefered Language of the Customer. Used for Mobile Money.
- numberstring
  The mobile money number.
- cvc_checkstring
  Card Verification Code check result
  Allowed values:passfailunavailableunchecked
- exp_monthstring
  Two digit number representing the expiration number
- exp_yearstring
  Four digit number representing the expiration date
- statement_descriptorstring
  Provides information about the charge that customers see on their statements. Maximum 22 characters.
- country_codestring
  Country Code, needed when the Payment Method is Mobile Money.
affiliatestring
Allowed values:dwelinn
amount_refundedinteger<int64>
available_dateinteger<int64>
capturedboolean
created_dateinteger<int64>
disputedboolean
failure_codestring
failure_messagestring
invoice_idstring
liveboolean
modified_dateinteger<int64>
refundedboolean
customer_idstring
processing_idstring
quittance_numberstring

Status codes

201Created
400Bad request
401Unauthorized
402Payment required
403Forbidden
404Not found
428Precondition required
500Server error