Skip to content

Create payment

POST api/v2/paygate/payment/wallet/
Create a payment by wallet

Request Header

Field Type Required Description
X-Idempotency-Key string No Optional idempotency key for payment creation. Requests with the same API key, idempotency key, action and JSON body replay the original status and response for 24 hours.

Request Body schema

application/json

Field Type Required Description Example
endpoint string Yes Api key "92b6aee5-54a0-496c-8972-aff1f78010c1"
amount integer Yes Amount in minor units 1000
currency integer Yes Number code 404
buyer object Yes Buyer at the endpoint in JSON format {"remote_id": "string", "ip": "string"}
client_id string No Transaction id at the endpoint.
Max 255 chars
"string"
success_url string or null No Redirect URL after success result "http://example.com"
fail_url string or null No Redirect URL after fail result "http://example.com"
notify_url string or null No Notification URL of changed status "http://example.com"
bank_code string Yes The customer's bank code. "000000"
first_name string Yes The customer's fisrt name. "John"
last_name string Yes The customer's last name. "Smith"
payment_method string Yes A code payment method. Momo "momo"
phone string Yes The customer's phone. "254712345678"
country string Yes The customer's code country. (ISO 3166-1 alpha-2) "KE"

Request sample

{
    "endpoint": "92b6aee5-54a0-496c-8972-aff1f78010c1",
    "amount": 1000,
    "currency": 404,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "client_id": "string",
    "success_url": "http://example.com",
    "fail_url": "http://example.com",
    "notify_url": "http://example.com",
    "first_name": "John",
    "last_name": "Smith",
    "phone": "254712345678",
    "payment_method": "momo",
    "country": "KE",
    "bank_code": "000000"
}

Response sample


STATUS 201

{
  "redirect_url": "https://example.com",
  "info": {
    "tx": "69cbbe70-d9bb-46e3-b67f-4d259712112e",
    "payment": {},
    "status": "create",
    "currency": {
      "id": 29,
      "title": "KES",
      "char_code": "KES",
      "num_code": 404,
      "depth": 2
    },
    "amount": 100,
    "created_at": "2025-06-03T11:41:20.547225Z",
    "errors": [],
    "parts_tx": [],
    "additional_data": {},
    "endpoint_logo": null
  }
}