WePay logo
      Nothing Found

Get a transaction record

get/transaction_records/{id}

The GET /transaction_records/{id} call allows your platform to look up a single transaction record. 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
path Parameters
id
required
string [ 1 .. 255 ] characters
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
id
required
string

ID of the transaction record, generated by WePay when the transaction record is created.

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_records
create_time
required
integer <int64> >= 0

The time (in UNIX) when the transaction record was created.

api_version
string
currency
string

ISO 4217 currency code. Possible values include: CAD & USD. Note: as of today, currency supports a single value.

Enum: Description
USD

United States Dollar

CAD

Canadian Dollar

… 1 more
fee_amount
integer

The fee amount applied to the transaction.

gross_amount
integer

The gross amount associated with the transaction.

net_amount
integer

The net amount associated with the transaction (gross - fee = net).

object

Owner returns ID and path. Possible values include: adjustments, disputes, payments, payouts, recoveries, refunds.

type
string

The type of transaction record. Possible values include: adjustment, app_fee, app_fee_chargeback, app_fee_chargeback_reversal, app_fee_refund, merchant_chargeback, merchant_chargeback_fee, merchant_chargeback_reversal, merchant_payment, merchant_payment_refund, payout, payout_return, recovery, recovery_return.

Enum: Description
merchant_payment

The net value is the amount credited to the merchant, the fee_amount value is the amount credited the the platform, and the gross value is the amount debited from the payer.

app_fee

The net value is the amount kept by the platform, the fee_amount value is the amount credited to WePay, and the gross value is the amount total amount debited from the merchant.

… 12 more
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "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"
}