Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Transactions

Requires ANY of the following access scopes: shopify_payments_payouts, shopify_payments.

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.

Was this section helpful?

Anchor to

The Transactions resource

Anchor to

Properties


id
->
id

The unique identifier of the transaction.


type

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

Show type properties
  • charge
  • refund
  • dispute
  • reserve
  • adjustment
  • credit
  • debit
  • payout
  • payout_failure
  • payout_cancellation

test

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


payout_id
->
id

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


payout_status

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
string

The ISO 4217 currency code of the transaction.


amount

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


fee
->
fee

The total amount of fees deducted from the transaction amount.


net
->
net

The net amount of the transaction.


source_id

The id of the resource leading to the transaction.


source_type

The type of the resource leading to the transaction.

Show source_type properties
  • charge
  • refund
  • dispute
  • reserve
  • adjustment
  • payout

source_order_transaction_id

The id of the Order Transaction that resulted in this balance transaction. If the source_type is an adjustment, the value will be null


Was this section helpful?
{}

The Transactions resource

{
"id": 54534554564,
"type": "credit",
"test": false,
"payout_id": 1234,
"payout_status": "scheduled",
"currency": "USD",
"amount": "102.53",
"fee": "3.07",
"net": "102.53",
"source_id": 1234,
"source_type": "adjustment",
"source_order_transaction_id": null,
"source_order_id": 1,
"processed_at": "2018-03-23T16:32:45Z",
"adjustment_order_transactions": [
{
"id": 12,
"amount": "102.53",
"fee": "2.53",
"net": "100.00",
"order": {
"id": 1,
"name": "#1001"
}
}
],
"adjustment_reason": "channel_credit"
}

Anchor to GET request, Return a list of all balance transactions
get
Return a list of all balance transactions

Retrieves a list of all balance transactions ordered by processing time, with the most recent being first. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.


api_version
string
required

last_id

Filter response to transactions exclusively before the specified ID


payout_id

Filter response to transactions paid out in the specified payout.


payout_status

Filter response to transactions with the specified payout status


since_id

Filter response to transactions exclusively after the specified ID.


test

Filter response to transactions placed in test mode.


Was this section helpful?

List all transactions associated with a payout.

Query parameters
payout_id=623721858

Filter response to transactions paid out in the specified payout.

Was this section helpful?
get

/admin/api/2025-07/shopify_payments/balance/transactions.json?payout_id=623721858

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/balance/transactions.json?payout_id=623721858" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"transactions": [
{
"id": 716142630,
"type": "debit",
"test": false,
"payout_id": 623721858,
"payout_status": "paid",
"currency": "USD",
"amount": "-0.75",
"fee": "0.00",
"net": "-0.75",
"source_id": 514396116,
"source_type": "adjustment",
"source_order_id": null,
"source_order_transaction_id": null,
"processed_at": "2024-10-31T20:00:00-04:00",
"adjustment_order_transactions": [],
"adjustment_reason": "tax_adjustment"
},
{
"id": 476425693,
"type": "credit",
"test": false,
"payout_id": 623721858,
"payout_status": "paid",
"currency": "USD",
"amount": "1.50",
"fee": "0.00",
"net": "1.50",
"source_id": 206869143,
"source_type": "adjustment",
"source_order_id": null,
"source_order_transaction_id": null,
"processed_at": "2024-10-31T20:00:00-04:00",