Transactions

Balance Transactions make up the canonical "statement of account", or ledger for a Shopify Payments account. Every single movement of money in or out of the account is recorded here.

What you can do with Transactions

The Shopify API lets you do the following with the Transactions resource. More detailed versions of these general actions may be available:

Transactions properties

id
"id": 54534554564

The unique identifier of the transaction.

type
"type": "charge"

The type of the balance transaction. The value will be one of the following:

  • charge
  • refund
  • dispute
  • reserve
  • adjustment
  • credit
  • debit
  • payout
  • payout_failure
  • payout_cancellation
test
"test": false

If the transaction was created for a test mode Order or payment.

payout_id
"payout_id": 1234

The id of the payout the transaction was paid out in.

payout_status
"payout_status": "scheduled"

The status of the payout the transaction was paid out in, or pending if the transaction has not yet been included in a payout.

currency
"currency": "USD"

The ISO 4217 currency code of the transaction.

amount
"amount": "102.53"

The gross amount of the transaction, in a decimal formatted string.

fee
"fee": "3.07"

The total amount of fees deducted from the transaction amount.

net
"net": "102.53"

The net amount of the transaction.

source_id
"source_id": 1234

The id of the resource leading to the transaction.

source_type
"source_type": "charge"

The type of the resource leading to the transaction.

  • charge
  • refund
  • dispute
  • reserve
  • adjustment
  • payout
source_order_transaction_id
"source_order_transaction_id": 12

The id of the Order Transaction that resulted in this balance transaction.

source_order_id
"source_order_id": 1

The id of the Order that this transaction ultimately originated from.

processed_at
"processed_at": "2018-03-23T16:32:45Z"

The time the transaction was processed.

Endpoints

GET /admin/shopify_payments/balance/transactions.json
Retrieves a list of all balance transactions ordered by processing time, with the most recent being first.
since_id

Filter response to transactions exclusively after the specified ID.

last_id

Filter response to transactions exclusively before the specified ID

test

Filter response to transactions placed in test mode.

payout_id

Filter response to transactions paid out in the specified payout.

payout_status

Filter response to transactions with the specified payout status

List all transactions associated with a payout.

GET /admin/shopify_payments/balance/transactions.json?payout_id=623721858
View Response
HTTP/1.1 200 OK
{
  "transactions": []
}

Sign up for a Partner account to get started.

Sign up