Skip to main content
POST
Create a ready-to-use test customer

Authorizations

Authorization
string
header
required

A tenant API key of the test twin (sk_test_...), issued by CloudPay staff from cloudpay-admin. A live key gets 403 live_mode_required.

Body

application/json
msisdn
string

Kenyan mobile number in local or international format.

Example:

712345678

display_name
string
pin
string

4-6 digits; repeated (0000) and sequential (1234, 4321) PINs are refused.

Pattern: ^[0-9]{4,6}$
Example:

"4821"

kyc_tier
integer
default:0
Required range: 0 <= x <= 3
new_device
boolean
default:false

Response

Customer ready.

status
object
required
data
object