Interface CreatePayoutBatchRequest

Parameters for creating a batch of payouts

Hierarchy

  • CreatePayoutBatchRequest

Properties

idempotency_key? payouts

Properties

Optional idempotency_key

idempotency_key?: string

Client-provided ID to avoid duplicate batches

payouts

payouts: {
    aggregated_merchant_id?: string;
    client_reference?: string;
    currency: Currency;
    mobile: string;
    name?: string;
    national_id?: string;
    payment_reason?: string;
    receive_amount: string | number;
}[]

Array of payouts to create

Type declaration

  • Optional aggregated_merchant_id?: string

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

  • Optional client_reference?: string

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

  • currency: Currency

    The amount currency

  • mobile: string

    The recipient mobile phone number

  • Optional name?: string

    The recipient name, may be used for user verification

  • Optional national_id?: string

    An optional field to save the recipient's national ID

  • Optional payment_reason?: string

    An optional message with a payment reason shown to customers

  • 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