WePay logo
      Nothing Found

Get a list of Transaction Summaries

get/transaction_summaries

Retrieve a specific transaction using the transaction_id and transaction_type parameters, or retrieve a list of transactions using the various query parameters -- either (create_time_start, create_time_end) or (finish_time_start, finish_time_end) at minimum. Retrieve all transactions associated with a specific Payout using the payout_id parameter.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
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.

account_id
string <uuid>

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

transaction_type
Array of any

The type of money movement the transaction represents.

Items Enum: Description
payment

A sale transaction.

refund

A refund.

… 5 more
status
Array of any

The status of the transaction.

Items Enum: Description
unknown

The status is unknown.

pending

WePay has started processing the transaction

… 7 more
currency
string

Specifies the currency of the transaction.

Enum: Description
USD

United States Dollar

CAD

Canadian Dollar

… 1 more
card_brand
string

Specifies the brand of the card used in the transaction.

Enum: Description
unspecified

Card brand not specified

visa

Visa card

… 14 more
payout_id
string <uuid>

The V3 Universal Unique Identifier (UUID) for a deposit.

transaction_id
string <uuid>

The V3 Universal Unique Identifier (UUID) of the transaction.

sort_value
string

The field to sort by.

Enum: Description
create_time

The time the transaction was created.

finish_time

The time the transaction completed.

page_size
integer [ 0 .. 500 ]

Return no more than this number of records per page. Defaults to 50. Maximum allowed is 100.

page
string

A base64 encoded string used to retrieve a page of results. Default is the empty string.

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

A list of transaction summaries.

api_version
required
string
path
required
string

Path of resource and resource ID.

resource
required
string

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

Value: Description
transaction_summaries

Fetch a list of transaction summaries.

next
string or null

A base64 encoded string that can be used to retrieve the next page of results.

previous
string or null

A base64 encoded string that can be used to retrieve the previous page of results.

400

INVALID_PARAMS

401

COULD_NOT_AUTHENTICATE

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "results": [
    • {
      • "transaction_id": "00000000-0000-0000-0000-000000000001",
      • "transaction_type": "payment",
      • "merchant": {
        • "account_id": "5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
        • "name": "Bob's Burgers",
        • "reference_id": "A42002Bobs",
        • "fees_paid": 200,
        • "net_amount": 1000,
        • "payout_id": "00000000-0000-0000-0000-00000000003e1",
        • "payout_finish_time": 1681408466
        },
      • "status": "completed",
      • "create_time": 1681407958,
      • "finish_time": 1681407958,
      • "modify_time": 1681407958,
      • "start_time": 1681407958,
      • "amount": 1200,
      • "wepay_fees_charged": 50,
      • "app_fees_charged": 150,
      • "fee_payer": "payee",
      • "app_net_amount": 150,
      • "refunded_amount": 0,
      • "chargedback_amount": 0,
      • "currency": "USD",
      • "payer_name": "John Smith",
      • "payer_email": "johnboysmith@gmail.com",
      • "long_description": "Big Daddy Burger and Cajun fries. $12.00",
      • "short_description": "bought a burger and fries",
      • "card": {
        • "brand": "visa",
        • "last_four": "1111",
        • "input_source": "CARD SWIPED"
        },
      • "associated_transaction": {
        • "type": "",
        • "transaction_id": "",
        • "amount": 0,
        • "merchant_net_amount": 0
        },
      • "transaction_reference_id": "sale-12554",
      • "terminal": {
        • "uuid": "5ed0967f-19e8-2541-b3f8-a9e9eae4223e",
        • "name": "front_register",
        • "serial_number": "A1234BC56",
        • "model": "verifone_p400"
        },
      • "resource": "transaction_summaries",
      • "owner": {
        • "id": "5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
        • "path": "/accounts/5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
        • "resource": "accounts"
        },
      • "api_version": "3.2"
      },
    • {
      • "transaction_id": "00000000-0000-0000-0000-000000000002",
      • "transaction_type": "payment",
      • "merchant": {
        • "account_id": "5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
        • "name": "Bob's Burgers",
        • "reference_id": "A42002Bobs",
        • "fees_paid": 200,
        • "net_amount": 1000,
        • "payout_id": "00000000-0000-0000-0000-00000000003e1",
        • "payout_finish_time": 1681408466
        },
      • "status": "pending",
      • "create_time": 1681407958,
      • "finish_time": 1681407958,
      • "modify_time": 1681407958,
      • "start_time": 1681407958,
      • "amount": 1200,
      • "wepay_fees_charged": 50,
      • "app_fees_charged": 150,
      • "fee_payer": "payee",
      • "app_net_amount": 150,
      • "refunded_amount": 0,
      • "chargedback_amount": 0,
      • "currency": "USD",
      • "payer_name": "John Smith",
      • "payer_email": "johnboysmith@gmail.com",
      • "long_description": "Big Daddy Burger and Cajun fries. $12.00",
      • "short_description": "bought a burger and fries",
      • "card": {
        • "brand": "visa",
        • "last_four": "1111",
        • "input_source": "CARD KEYED"
        },
      • "associated_transaction": {
        • "type": "",
        • "transaction_id": "",
        • "amount": 0,
        • "merchant_net_amount": 0
        },
      • "transaction_reference_id": "sale-12555",
      • "terminal": {
        • "uuid": "5ed0967f-19e8-2541-b3f8-a9e9eae4223e",
        • "name": "front_register",
        • "serial_number": "A1234BC56",
        • "model": "verifone_p400"
        },
      • "resource": "transaction_summaries",
      • "owner": {
        • "id": "5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
        • "path": "/accounts/5ed0888f-19e9-4312-b3f8-a9e9eae2421e",
        • "resource": "accounts"
        },
      • "api_version": "3.2"
      }
    ],
  • "api_version": "3.2",
  • "path": "/transaction_summaries?time_range_end_time=1667514437&merchant_id=5ed0888f-19e9-4312-b3f8-a9e9eae2421e&page_size=2&time_range_start_time=1667300000",
  • "resource": "transaction_summaries",
  • "previous": null,
  • "next": "ad81kkdkckaka="
}