Skip to main content
GET
Get a payout

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Path Parameters

id
string
required

The payout id (UUID).

Response

The payout.

id
string<uuid>
required

Payout id — your handle for polling and support.

amount_mwk
string
required

The amount instructed — exact decimal string at 2 decimal places.

Example:

"250000.00"

fee
string | null
required

What the provider charged for this payout, passed through to you at cost — an exact decimal string at two decimal places (fees are not whole kwacha), so parse it with a decimal library and never a float.

null means the fee is not known — usually because the payout is still in flight, but a terminal payout can also read null when the provider reported no fee for it. It never means free, so do not treat null as zero, and do not treat it as proof the payout is still moving — status is what tells you that.

A failed payout reads "0.00" — fees apply to successful transfers only — and a reversed payout keeps the fee it was charged, because it did succeed before it was clawed back.

Use POST /fees/quote to know the cost BEFORE you send: this field cannot tell you in advance, and your balance must cover the amount plus the fee.

Example:

"2710.00"

rail
enum<string>
required
Available options:
bank,
momo
status
enum<string>
required

Lifecycle: received → validated → held → submitted → pending → succeeded | failed. succeeded, failed and reversed are terminal. reversed means the payout succeeded and the provider then clawed the transfer back — it is not a failure and carries no failure object.

Available options:
received,
validated,
held,
submitted,
pending,
succeeded,
failed,
reversed
Example:

"succeeded"

destination
object
required

The destination snapshot as validated at accept — shape follows rail.

failure
object | null
required

Set exactly when status is failed; null otherwise.

created_at
string<date-time>
required
terminal_at
string<date-time> | null
required

When the payout first reached a terminal state. A payout that is later reversed keeps the timestamp of its original settlement — this never moves once set.