Skip to main content
POST
Request a settlement from the main account

Authorizations

Authorization
string
header
required

A merchant-scoped API key, issued by CloudPay staff or the merchant's owner. Acts with exactly its scopes.

Path Parameters

merchantID
string<uuid>
required

Body

application/json
destination_id
string<uuid>
required
amount
integer<int64>
required

Cents (KES minor units). 100 = KES 1.00.

Required range: x >= 1
Example:

100000

idempotency_key
string
required

Unique per customer per intended operation; a UUID is ideal.

Required string length: 8 - 100
note
string

Response

Replayed.

status
object
required
data
object