WePay logo
      Nothing Found

Get a collection of transaction records

get/transaction_records

The GET /transaction_records call allows your platform to look up a collection of transaction records. Transactions records represent one entry (e.g. payout) and the impact to an account’s balance. Note: Generating transaction records may not complete for up to 6 hours. Learn how to generate Transaction and Reconciliation reports here.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page. If specified, then do not provide any other query parameters.

page_size
integer [ 1 .. 500 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 500.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window. Default: current time -7 days if not provided. Note: The time interval between create_time_start and create_time_end cannot exceed 35 days.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window. Default: current time if not provided. Note: The time interval between create_time_start and create_time_end cannot exceed 35 days.

account_id
string

Return all transaction records for resources owned by an account. Resources include: adjustments, disputes, payments, payouts, recoveries, and refunds.

payout_id
string

Transaction records for all resources contributing to this payout ID. create_time_start and create_time_end are not required and a default is not set for them when this parameter is provided in the request.

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

An array of transaction record objects.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": null,
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "create_time": 1510080181,
      • "currency": "USD",
      • "fee_amount": 59,
      • "gross_amount": 2000,
      • "id": "00000000-0000-0000-0000-000000013003",
      • "net_amount": 1941,
      • "owner": {
        • "id": "00000000-0000-0000-0000-0000767bf5cd",
        • "path": "/payments/00000000-0000-0000-0000-0000767bf5cd",
        • "resource": "payments",
        • "custom_data": null
        },
      • "path": "/transaction_records/00000000-0000-0000-0000-000000013003",
      • "resource": "transaction_records",
      • "type": "merchant_payment",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1510170113,
      • "currency": "USD",
      • "fee_amount": 40,
      • "gross_amount": 1000,
      • "id": "00000000-0000-0000-0000-0000000134cb",
      • "net_amount": 960,
      • "owner": {
        • "id": "00000000-0000-0000-0000-000042702825",
        • "path": "/payments/00000000-0000-0000-0000-000042702825",
        • "resource": "payments",
        • "custom_data": {
          • "a": 1
          }
        },
      • "path": "/transaction_records/00000000-0000-0000-0000-0000000134cb",
      • "resource": "transaction_records",
      • "type": "merchant_payment",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1510171435,
      • "currency": "USD",
      • "fee_amount": 32,
      • "gross_amount": 800,
      • "id": "00000000-0000-0000-0000-0000000134d4",
      • "net_amount": 768,
      • "owner": {
        • "id": "00000000-0000-0000-0000-000054714d76",
        • "path": "/payments/00000000-0000-0000-0000-000054714d76",
        • "resource": "payments",
        • "custom_data": null
        },
      • "path": "/transaction_records/00000000-0000-0000-0000-0000000134d4",
      • "resource": "transaction_records",
      • "type": "merchant_payment",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1510172479,
      • "currency": "USD",
      • "fee_amount": 20,
      • "gross_amount": 500,
      • "id": "00000000-0000-0000-0000-0000000134d7",
      • "net_amount": 480,
      • "owner": {
        • "id": "00000000-0000-0000-0000-00005e1c8d72",
        • "path": "/payments/00000000-0000-0000-0000-00005e1c8d72",
        • "resource": "payments",
        • "custom_data": null
        },
      • "path": "/transaction_records/00000000-0000-0000-0000-0000000134d7",
      • "resource": "transaction_records",
      • "type": "merchant_payment",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1510182803,
      • "currency": "USD",
      • "fee_amount": 25,
      • "gross_amount": 750,
      • "id": "00000000-0000-0000-0000-0000000134e9",
      • "net_amount": 725,
      • "owner": {
        • "id": "00000000-0000-0000-0000-00005c72c565",
        • "path": "/payments/00000000-0000-0000-0000-00005c72c565",
        • "resource": "payments",
        • "custom_data": null
        },
      • "path": "/transaction_records/00000000-0000-0000-0000-0000000134e9",
      • "resource": "transaction_records",
      • "type": "merchant_payment",
      • "api_version": "3.0"
      }
    ]
}