Interface KatanaPerpsPayoutProgram

Katana Perps Get Payout Program Response

See

interface KatanaPerpsPayoutProgram {
    assetAddress: string;
    assetSymbol: string;
    quantityEarned: string;
    quantityPaid: string;
    quantityOwed: string;
    escrowContractAddress?: string;
}

Properties

assetAddress assetSymbol quantityEarned quantityPaid quantityOwed escrowContractAddress?

Properties

assetAddress

assetAddress: string

Contract address of the rewarded asset for the payout program

assetSymbol

assetSymbol: string

Symbol of the rewarded asset for the payout program

quantityEarned

quantityEarned: string

Total quantity earned for the requested wallet for the payout program

  • Format: Asset Units

quantityPaid

quantityPaid: string

Total quantity paid to the requested wallet for the payout program

  • Format: Asset Units

quantityOwed

quantityOwed: string

Total quantity owed to the requested wallet for the payout program

  • Minimums: Each program has a minimum quantity that must be earned before a payout can be made
  • Logical Flow: When (quantityEarned - quantityPaid) is below the program minimum, quantityOwed will be 0 and a payout cannot be made.
  • Format: Asset Units

Optional escrowContractAddress

escrowContractAddress?: string

Address of the escrow contract for the payout program

  • Only present for programs paid out via the v1 Escrow contract; omitted for programs paid out by direct deposit to the exchange.

Settings

Member Visibility

Theme

On This Page

assetAddressassetSymbolquantityEarnedquantityPaidquantityOwedescrowContractAddress