Type alias PaymentTransactionQueryParams

Type declaration

• amount: string | number

  Use whole numbers and up to two decimals as necessary. Example: "100" or "100.00"

• amount_from: string | number

  Filter from amount. Use whole numbers and up to two decimals as necessary. Example: "100" or "100.00"

• amount_to: string | number

  Filter to amount. Use whole numbers and up to two decimals as necessary. Example: "100" or "100.00"

• card_brand: string

  Card brand. Case sensitive values are 'visa', 'mastercard', 'amex', 'discover', 'jcb', diners'. Return multiple transactions by separating the card_brand with a comma.

• cardholder_name: string

  Name of the cardholder. Case sensitive, partial matches returned.

• end_date: string

  End date for transactions. Format: "mm/dd/yy"

• first_6: string

  First 6 digits of the card number. Return multiple transactions by separating the first_6 with a comma.

• last_4: string

  Last 4 digits of the card number. Return multiple transactions by separating the last_4 with a comma.

• limit: string | number

  Limit the number of transactions returned.

• offset: string | number

  Offset / skip n transactions.

• order_id: string

  ID of the order. Case sensitive. Return multiple transactions by separating the order_id with a comma.

• payment_type: string

  Type of transaction processed. Case sensitive values are 'sale', 'authorize', 'capture', 'void' and 'refund'

• start_date: string

  Start date for transactions. Format: "mm/dd/yy"

• Optional transaction_id?: string

  ID of the transaction

• trxn_status: string

  Status of the transaction. Case sensitive values are 'approved' and 'declined'. Default returns both types