Get a checkout session
Authorizations
Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown
once when created in the dashboard, and are scoped (see x-required-scope on each
operation). Keep them on your server. Live keys are issued after your business is
verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.
Path Parameters
Response
The checkout session
"checkout_session"open: waiting for payment. complete: paid, escrow_id is set. expired: not paid by
expires_at. cancelled: you cancelled it.
open, complete, expired, cancelled The hosted checkout. Open it with @ketapay/checkout or redirect the buyer to it.
"https://app.ketapay.com/checkout/2c9a7f4e-1b3d-4e6a-8f2c-5d7b9e1a3c60"
Amount in kobo
x >= 045000000
"NGN"Totals for the whole escrow, in kobo. buyer_total = amount + buyer_fee + buyer_vat and
seller_payout = amount - seller_fee - commission. Until everything is released these
are what will apply; each milestone shows its own share.
What kind of deal this is. KetaPay uses it for risk checks and dispute handling.
goods, services, property, vehicle, digital, other KetaPay's copies, in order; the first is the cover
Send either file (an id from POST /files with purpose agreement) or url (an HTTPS
link KetaPay copies). JPEG, PNG, HEIC or WebP. Responses carry KetaPay's own url plus a
small thumbnail_url.
- Option 1
- Option 2
Send either file (an id from POST /files) or url (an HTTPS link KetaPay copies, so
it survives your copy being deleted). Responses always carry KetaPay's own url.
- Option 1
- Option 2
The plan. One entry for a single payment.
At least one of email and phone. Both is better.
- Option 1
- Option 2
The seller as you sent them, or your business when you sent none
- Option 1
- Option 2
- Option 3
Your cut, taken from the seller's side of each release. Never charged on money refunded
to the buyer. rate_bps is basis points (500 = 5%). min_amount and max_amount apply
to the whole escrow; each milestone's release carries its share. Must be within the
maximum rate in your KetaPay agreement. Not allowed when you sell your own goods (no
seller): commission_not_allowed.
Set once the buyer has paid
Your own id for this object, for example your order or project id. Filterable.
255"proj_4471"
Your own key-value pairs. KetaPay stores them and never reads them.
The url you sent at creation