Interface CreatePayoutRequest

Parameters for creating a new payout

Hierarchy

  • CreatePayoutRequest

Properties

aggregated_merchant_id? client_reference? currency mobile name? national_id? payment_reason? receive_amount

Properties

Optional aggregated_merchant_id

aggregated_merchant_id?: string

The id of an aggregated merchant identity to use for this payout

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

mobile

mobile: string

The recipient mobile phone number

Optional name

name?: string

The recipient name, may be used for user verification

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

receive_amount

receive_amount: string | number

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc