Skip to main content
POST
/
v1
/
checkouts
Generate a checkout
curl --request POST \
  --url https://staging-api.mobipurse.com/v1/checkouts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 200000,
  "country": "CI",
  "currency": "XOF",
  "locale": "fr",
  "webhookURL": "https://webhook.site/100ebe83-961d-4096-8741-05772dafcfa1",
  "redirectURL": "https://mobipurse.com"
}
'
{
  "statusCode": 200,
  "data": {
    "url": "https://staging.mobipurse.com/checkouts/DMBC20251110154056OSPHM",
    "reference": "DMBC20251110154056OSPHM",
    "merchantsReference": "DMBC20251110154056OSPHM",
    "amount": 200000,
    "fee": 9600,
    "status": "pending"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate this from your Mobipurse dashboard under Settings → API Keys.

Body

application/json
​
amount
integer
required

The amount to charge in the lowest currency denomination (e.g., 200000 for 2000.00)

Required range: x >= 1
Example:

200000

​
country
string
required

The 2-character ISO country code

Pattern: ^[A-Z]{2}$
Example:

"CI"

​
currency
string
required

The 3-character ISO currency code

Pattern: ^[A-Z]{3}$
Example:

"XOF"

​
reference
string

Unique merchant reference for the checkout. Must be unique for each checkout.

Example:

"2a59004d-72a9-4bdc-9893-abff8fa6ffb4"

​
locale
string

Locale of the checkout page. Defaults to 'en' if not specified.

Example:
["en", "fr"]
​
webhookURL
string<uri>

URL to receive webhook notifications for payment events

Example:

"https://webhook.site/100ebe83-961d-4096-8741-05772dafcfa1"

​
redirectURL
string<uri>

URL to redirect the customer after payment completion

Example:

"https://mobipurse.com"

Response

Checkout created successfully

​
statusCode
integer
Example:

200

​
data
object