Skip to main content
POST
Payin Preview

Authorizations

Authorization
string
header
required

Secret API key from Settings → Developers → API keys. Example: Authorization: Bearer sk_test_…

Body

application/json
target_currency
string
required

Book currency to credit.

Example:

"NGN"

mode
enum<string>
required

Collection mode (same values as prepare).

Available options:
bank_details,
crypto_address,
momo,
interac
Example:

"bank_details"

amount
integer
required

What the payer sends in source_currency minor units.

Example:

5000000

source_currency
string

Currency the payer funds in; defaults to target_currency.

channel
string

Momo channel id when mode is momo (e.g. KE-MPESA).

network
string

Crypto network when mode is crypto_address (e.g. base).

Response

Preview

object
enum<string>

Object type discriminator.

Available options:
payin_preview
target_currency
string

Book currency that will be credited.

source_currency
string

Currency the payer funds in.

mode
string

Collection mode used for the estimate.

method
string

Start-compatible method string for POST /payins.

pay_amount
integer

Amount the payer should send (source minor units).

fee
integer

Total fee in fee_currency minor units.

fee_currency
string

Currency of the fee line.

partner_fee
integer

Partner portion of the fee.

margin
integer

Keette margin portion of the fee.

credit_amount
integer

Expected net credit to the target book.

target_gross
integer

Target-side amount before fee (after FX when cross-currency).

rate
string

Indicative FX rate when currencies differ.

rate_as_of
string<date-time>

When the indicative rate was observed.

indicative
boolean

true when FX is not a firm locked quote.

product
string

Pricing product key.

channel
string

Echo of momo channel when set.

network
string

Echo of crypto network when set.

scale_source
integer

Decimal places for source_currency.

scale_target
integer

Decimal places for target_currency.