Skip to main content
POST
/
payment
/
collection
Collect payment
curl --request POST \
  --url https://sandbox.kulmipay.com/api/v1/payment/collection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "KES",
  "amount": "1500.00",
  "api_ref": "<string>",
  "phone_number": "<string>",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "public_key": "<string>",
  "wallet_id": "<string>"
}
'
{
  "invoice": {},
  "signature": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.kulmipay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
default:ISSecretKey_test_xxxxxxxxxxxxxxxx
required

Use your KulmiPay secret key as the Bearer token.

Body

application/json
​
method
enum<string>
required
Available options:
M-PESA,
PESALINK
​
currency
string
required
Example:

"KES"

​
amount
string
required
Example:

"1500.00"

​
api_ref
string
required
​
phone_number
string
​
email
string
​
first_name
string
​
last_name
string
​
public_key
string
​
wallet_id
string
​
mobile_tarrif
enum<string>
Available options:
BUSINESS-PAYS,
CUSTOMER-PAYS
​
bank_tarrif
enum<string>
Available options:
BUSINESS-PAYS,
CUSTOMER-PAYS

Response

201 - application/json

Collection created

​
invoice
object
​
signature
string