Create Checkout

POST

/api/v1/merchants/checkouts

Create checkout for merchant

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful Response

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/merchants/checkouts' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customer_email": "test@example.com",
  "amount": 460,
  "currency_code": "GHS",
  "description": "Test mobile money checkout",
  "meta_data": {
    "order_id": "123456"
  }
}'

Response Example

200 - Success

{
    "data": {
        "id": "a8a28dc9-ed21-4aed-9e28-e659bff5dee9",
        "checkout_url": "http://localhost:3000/public/checkouts/PAY-SFSFTPSEOYAD"
    },
    "message": "Checkout session created",
    "status": "success"
}

Modified at 2025-12-04 16:37:28

Get Merchant Transaction

List Checkouts