Interface Payout

Payout response

Hierarchy

  • Payout

Properties

aggregated_merchant_id? batch_id? client_reference? currency fee id mobile name? national_id? payment_reason? payout_error? receive_amount status timestamp

Properties

Optional aggregated_merchant_id

aggregated_merchant_id?: string

The id of an aggregated merchant identity used for this payout

Optional batch_id

batch_id?: string

ID of the batch this payout belongs to (if applicable)

Optional client_reference

client_reference?: string

A unique string that you provide to correlate the payout in your system

currency

currency: Currency

The amount currency

fee

fee: string

The fee for sending the payout

id

id: string

A unique identifier for the payout object

mobile

mobile: string

The recipient mobile phone number

Optional name

name?: string

The recipient name

Optional national_id

national_id?: string

An optional field to save the recipient's national ID

Optional payment_reason

payment_reason?: string

An optional message with a payment reason shown to customers

Optional payout_error

payout_error?: PayoutError

Details about the reason for a failed payout

receive_amount

receive_amount: string

The amount to be paid out to the recipient, net of fees

status

status: PayoutStatus

The status of the payout

timestamp

timestamp: string

The time and date that this payout request was recorded

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc