Skip to main content
POST
Get checkout details

Authorizations

Authorization
string
header
default:ISSecretKey_test_xxxxxxxxxxxxxxxx
required

Use your KulmiPay secret key as the Bearer token.

Body

application/json
checkout_id
string
required
Minimum string length: 1
signature
string
required
Minimum string length: 1

Response

200 - application/json
id
string<uuid>
read-only
url
string
read-only
Minimum string length: 1
signature
string
read-only
Minimum string length: 1
first_name
string | null
Maximum string length: 45
Pattern: ^[a-zA-Z0-9-_ ]+$
last_name
string | null
Maximum string length: 45
Pattern: ^[a-zA-Z0-9-_ ]+$
phone_number
string | null
Maximum string length: 30
Pattern: ^[0-9-_+ ]+$
email
string<email> | null
Maximum string length: 254
country
string | null
Maximum string length: 2
Pattern: ^[a-zA-Z0-9-_ ]+$
address
string | null
Maximum string length: 140
Pattern: ^[a-zA-Z0-9-_ .,]+$
city
string | null
Maximum string length: 70
Pattern: ^[a-zA-Z0-9-_ .,]+$
state
string | null
Maximum string length: 70
Pattern: ^[a-zA-Z0-9-_ .,]+$
zipcode
string | null
Maximum string length: 10
Pattern: ^[a-zA-Z0-9-_ ]+$
api_ref
string | null
Maximum string length: 70
Pattern: ^[a-zA-Z0-9-_ ]+$
wallet_id
string | null
Maximum string length: 10
Pattern: ^[a-zA-Z0-9-_ ]+$
method
enum<string> | null
Available options:
M-PESA,
PESALINK
host
string<uri> | null
Maximum string length: 400
Pattern: ^[a-zA-Z0-9-_./=:?# ]+$
is_mobile
boolean
version
string | null
read-only
Minimum string length: 1
redirect_url
string<uri> | null
Maximum string length: 400
Pattern: ^[a-zA-Z0-9-_./=:?# ]+$
amount
string<decimal>
currency
enum<string>
Available options:
KES,
USD,
EUR,
GBP
paid
boolean
read-only
mobile_tarrif
enum<string>
Available options:
BUSINESS-PAYS,
CUSTOMER-PAYS
bitcoin_tarrif
enum<string>
Available options:
BUSINESS-PAYS,
CUSTOMER-PAYS
ach_tarrif
enum<string>
Available options:
BUSINESS-PAYS,
CUSTOMER-PAYS
created_at
string<date-time> | null
read-only
updated_at
string<date-time> | null
read-only