PayFanout API reference
    Preparing search index...

    Interface RefundRequest

    interface RefundRequest {
        amount?: number;
        idempotencyKey: string;
        pspPaymentId: string;
        reason?: RefundReason;
    }
    Index
    amount? idempotencyKey pspPaymentId reason?
    amount?: number

    Omit for a full refund.

    idempotencyKey: string
    pspPaymentId: string

    The PSP's payment id — PayFanout has no internal-id store, so the host app resolves its own id -> pspPaymentId first.

    reason?: RefundReason

    Best-effort per PSP: mapped to the provider's own vocabulary where one exists (Stripe accepts exactly these), passed through or withheld where none does.

    Settings
    Member Visibility

    On This Page
    Properties