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.
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.
| ||||
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. |
INVALID_PARAMS
COULD_NOT_AUTHENTICATE
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "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="
}