WePay logo
      Nothing Found

Retrieve a specific Account's transaction metrics.

get/transaction_metrics

Get a collection of pre-calculated metrics about transactions. This endpoint requires one of (create_time_start, create_time_end) or (finish_time_start, finish_time_end) to be set.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
account_id
required
string <uuid>

The V3 account ID for the merchant that the transaction is under.

create_time_start
integer >= 0

The Unix epoch time in seconds for the start of the time range.

create_time_end
integer >= 0

The Unix epoch time in seconds for the end of the time range.

finish_time_start
integer >= 0

The Unix epoch time in seconds for the start of the time range.

finish_time_end
integer >= 0

The Unix epoch time in seconds for the end of the time range.

group_by_seconds
integer >= 0

The bucket size in seconds, e.g. 86400 is a bucket size of one day. The default is all data in one bucket.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects

A list of records in the given bucket size giving a breakdown of transaction counts by transaction_type.

required
Array of objects

A list of records in the given bucket size giving a breakdown of transaction fees.

required
Array of objects

A list of payment_method_details_record entries.

api_version
required
string
resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
transaction_metrics

Fetch pre-calculated metrics about your transactions.

required
object or null

Details the owner resource and owner path.

path
required
string

Path of resource and resource ID.

400

INVALID_PARAMS

401

COULD_NOT_AUTHENTICATE

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "transaction_count_summary_records": [
    • {
      • "finish_time_start": 0,
      • "finish_time_end": 10,
      • "total_transaction_count": 2,
      • "transaction_count_breakdown_by_type": [
        • {
          • "type": "payment",
          • "count": 2
          }
        ]
      },
    • {
      • "finish_time_start": 10,
      • "finish_time_end": 20,
      • "total_transaction_count": 2,
      • "transaction_count_breakdown_by_type": [
        • {
          • "type": "payment",
          • "count": 2
          }
        ]
      }
    ],
  • "transaction_fee_summary_records": [
    • {
      • "finish_time_start": 0,
      • "finish_time_end": 10,
      • "entity_fee_breakdown_record": {
        • "total_fee_amount": 2,
        • "merchant_fees_paid": 2,
        • "wepay_fees_charged": 0,
        • "app_fees_charged": 2,
        • "app_net_amount": 2
        },
      • "payment_method_fee_breakdown_record": {
        • "total_fee_amount": 2,
        • "payment_method_fee_details_list": [
          • {
            • "card_brand": "visa",
            • "total_fee_amount": 1,
            • "merchant_fees_paid": 1,
            • "wepay_fees_charged": 0,
            • "app_fees_charged": 1,
            • "app_net_amount": 0
            },
          • {
            • "card_brand": "ach",
            • "total_fee_amount": 1,
            • "merchant_fees_paid": 0,
            • "wepay_fees_charged": 0,
            • "app_fees_charged": 1,
            • "app_net_amount": 1
            }
          ]
        }
      },
    • {
      • "finish_time_start": 10,
      • "finish_time_end": 20,
      • "entity_fee_breakdown_record": {
        • "total_fee_amount": 2,
        • "merchant_fees_paid": 2,
        • "wepay_fees_charged": 0,
        • "app_fees_charged": 2,
        • "app_net_amount": 2
        },
      • "payment_method_fee_breakdown_record": {
        • "total_fee_amount": 2,
        • "payment_method_fee_details_list": [
          • {
            • "card_brand": "visa",
            • "total_fee_amount": 1,
            • "merchant_fees_paid": 1,
            • "wepay_fees_charged": 0,
            • "app_fees_charged": 1,
            • "app_net_amount": 0
            },
          • {
            • "card_brand": "ach",
            • "total_fee_amount": 1,
            • "merchant_fees_paid": 0,
            • "wepay_fees_charged": 0,
            • "app_fees_charged": 1,
            • "app_net_amount": 1
            }
          ]
        }
      }
    ],
  • "transaction_payment_method_summary_records": [
    • {
      • "finish_time_start": 0,
      • "finish_time_end": 10,
      • "payment_method_breakdown_record": {
        • "total_sales_amount": 20,
        • "mastercard_sales_amount": 0,
        • "visa_sales_amount": 10,
        • "bank_card_inactive_sales_amount": 0,
        • "interac_sales_amount": 0,
        • "switch_maestro_sales_amount": 0,
        • "solo_sales_amount": 0,
        • "china_union_pay_sales_amount": 0,
        • "unspecified_sales_amount": 0,
        • "amex_sales_amount": 0,
        • "jcb_sales_amount": 0,
        • "diners_club_sales_amount": 0,
        • "discover_sales_amount": 0,
        • "ach_sales_amount": 10,
        • "maestro_sales_amount": 0,
        • "other_sales_amount": 0,
        • "total_sales_count": 2,
        • "mastercard_sales_count": 0,
        • "visa_sales_count": 1,
        • "discover_sales_count": 0,
        • "amex_sales_count": 0,
        • "ach_sales_count": 1,
        • "switch_maestro_sales_count": 0,
        • "solo_sales_count": 0,
        • "china_union_pay_sales_count": 0,
        • "unspecified_sales_count": 0,
        • "jcb_sales_count": 0,
        • "maestro_sales_count": 0,
        • "other_sales_count": 0
        },
      • "payment_method_details_list": [
        • {
          • "type": "ach",
          • "sales_amount": 10,
          • "count": 1
          },
        • {
          • "type": "visa",
          • "sales_amount": 10,
          • "count": 1
          }
        ],
      • "card_present_breakdown_record": {
        • "card_present_amount": 10,
        • "card_present_count": 1,
        • "card_present_fee_amount": 1,
        • "card_not_present_amount": 10,
        • "card_not_present_count": 1,
        • "card_not_present_fee_amount": 1
        },
      • "currency_breakdown_list": [
        • {
          • "currency": "USD",
          • "amount": 20,
          • "count": 2,
          • "fee_amount": 2
          }
        ],
      • "payment_instrument_breakdown_list": [
        • {
          • "payment_instrument": "ach",
          • "amount": 10,
          • "count": 1,
          • "fee_amount": 1
          },
        • {
          • "payment_instrument": "credit",
          • "amount": 10,
          • "count": 1,
          • "fee_amount": 1
          }
        ]
      },
    • {
      • "finish_time_start": 10,
      • "finish_time_end": 20,
      • "payment_method_breakdown_record": {
        • "total_sales_amount": 20,
        • "mastercard_sales_amount": 0,
        • "visa_sales_amount": 10,
        • "bank_card_inactive_sales_amount": 0,
        • "interac_sales_amount": 0,
        • "switch_maestro_sales_amount": 0,
        • "solo_sales_amount": 0,
        • "china_union_pay_sales_amount": 0,
        • "unspecified_sales_amount": 0,
        • "amex_sales_amount": 0,
        • "jcb_sales_amount": 0,
        • "diners_club_sales_amount": 0,
        • "discover_sales_amount": 0,
        • "ach_sales_amount": 10,
        • "maestro_sales_amount": 0,
        • "other_sales_amount": 0,
        • "total_sales_count": 2,
        • "mastercard_sales_count": 0,
        • "visa_sales_count": 1,
        • "discover_sales_count": 0,
        • "amex_sales_count": 0,
        • "ach_sales_count": 1,
        • "switch_maestro_sales_count": 0,
        • "solo_sales_count": 0,
        • "china_union_pay_sales_count": 0,
        • "unspecified_sales_count": 0,
        • "jcb_sales_count": 0,
        • "maestro_sales_count": 0,
        • "other_sales_count": 0
        },
      • "payment_method_details_list": [
        • {
          • "type": "ach",
          • "sales_amount": 10,
          • "count": 1
          },
        • {
          • "type": "visa",
          • "sales_amount": 10,
          • "count": 1
          }
        ],
      • "card_present_breakdown_record": {
        • "card_present_amount": 10,
        • "card_present_count": 1,
        • "card_present_fee_amount": 1,
        • "card_not_present_amount": 10,
        • "card_not_present_count": 1,
        • "card_not_present_fee_amount": 1
        },
      • "currency_breakdown_list": [
        • {
          • "currency": "USD",
          • "amount": 20,
          • "count": 2,
          • "fee_amount": 2
          }
        ],
      • "payment_instrument_breakdown_list": [
        • {
          • "payment_instrument": "ach",
          • "amount": 10,
          • "count": 1,
          • "fee_amount": 1
          },
        • {
          • "payment_instrument": "credit",
          • "amount": 10,
          • "count": 1,
          • "fee_amount": 1
          }
        ]
      }
    ],
  • "api_version": "3.2",
  • "resource": "transaction_metrics",
  • "path": "/transaction_metrics?merchant_id=5ed0888f-19e9-4312-b3f8-a9e9eae2421e&finish_time_start=1667300000&finish_time_end=1667514437",
  • "owner": {
    • "id": "5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
    • "path": "/accounts/5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
    • "resource": "accounts"
    }
}