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
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.
Endpoints
- get/admin/api/latest/shopify_
payments/balance/transactions. json?payout_ id=623721858 Return a list of all balance transactions
The Transactions resource
Properties
The unique identifier of the transaction.
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
If the transaction was created for a test mode Order or payment.
The id of the payout the transaction was paid out in.
The status of the payout the transaction was paid out in, or pending
if the transaction has not yet been included in a payout.
The ISO 4217 currency code of the transaction.
The gross amount of the transaction, in a decimal formatted string.
The total amount of fees deducted from the transaction amount.
The net amount of the transaction.
The id of the resource leading to the transaction.
The type of the resource leading to the transaction.
Show source_type properties
- charge
- refund
- dispute
- reserve
- adjustment
- payout
The id of the Order Transaction that resulted in this balance transaction. If the source_type is an adjustment, the value will be null
The Transactions resource
Anchor to GET request, Return a list of all balance transactionsgetReturn 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.
Filter response to transactions exclusively before the specified ID
Filter response to transactions paid out in the specified payout.
Filter response to transactions with the specified payout status
Filter response to transactions exclusively after the specified ID.
Filter response to transactions placed in test mode.
List all transactions associated with a payout.
List all transactions associated with a payout.
Filter response to transactions paid out in the specified payout.
/admin/api/2025-07/shopify_ payments/balance/transactions. json?payout_ id= 623721858
Response
examples
List all transactions associated with a payout.
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}"
await admin.rest.resources.PaymentTransaction.transactions({ session: session, payout_id: "623721858", });
# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::PaymentTransaction.transactions( session: test_session, payout_id: "623721858", )
// Session is built by the OAuth process await shopify.rest.PaymentTransaction.transactions({ session: session, payout_id: "623721858", });
response
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","adjustment_order_transactions":[],"adjustment_reason":"tax_adjustment"},{"id":396322840,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"0.25","fee":"0.00","net":"0.25","source_id":105592054,"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":348058882,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-0.75","fee":"0.00","net":"-0.75","source_id":616988872,"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":699519475,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-50.00","fee":"0.00","net":"-50.00","source_id":460709370,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2024-01-11T07:34:56-05:00","adjustment_order_transactions":[],"adjustment_reason":"billing"},{"id":77412310,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"50.00","fee":"0.00","net":"50.00","source_id":374511569,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2024-01-11T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":1044362223,"type":"refund","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-3.45","fee":"0.00","net":"-3.45","source_id":1006917261,"source_type":"Payments::Refund","source_order_id":217130470,"source_order_transaction_id":1006917261,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":1006917261,"type":"refund","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-3.45","fee":"0.00","net":"-3.45","source_id":1006917261,"source_type":"Payments::Refund","source_order_id":217130470,"source_order_transaction_id":1006917261,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":777128868,"type":"refund","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-8.05","fee":"0.00","net":"-8.05","source_id":777128868,"source_type":"Payments::Refund","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":758509248,"type":"adjustment","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-1.50","fee":"-0.25","net":"-1.75","source_id":764194150,"source_type":"charge","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":746296004,"type":"charge","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"10.00","fee":"2.00","net":"8.00","source_id":746296004,"source_type":"charge","source_order_id":625362839,"source_order_transaction_id":890672011,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":515523000,"type":"charge","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"11.50","fee":"0.65","net":"10.85","source_id":1006917261,"source_type":"Payments::Refund","source_order_id":217130470,"source_order_transaction_id":1006917261,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":482793472,"type":"adjustment","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"0.45","fee":"0.00","net":"0.45","source_id":204289877,"source_type":"charge","source_order_id":217130470,"source_order_transaction_id":567994517,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":382557793,"type":"adjustment","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"0.20","fee":"0.00","net":"0.20","source_id":204289877,"source_type":"charge","source_order_id":217130470,"source_order_transaction_id":567994517,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":365577382,"type":"adjustment","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-3.45","fee":"0.00","net":"-3.45","source_id":1006917261,"source_type":"Payments::Refund","source_order_id":217130470,"source_order_transaction_id":1006917261,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":201521674,"type":"refund","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-2.00","fee":"0.00","net":"-2.00","source_id":971443537,"source_type":"charge","source_order_id":625362839,"source_order_transaction_id":461790020,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":188711209,"type":"capture","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-11.37","fee":"0.00","net":"-11.37","source_id":188711209,"source_type":"charge","source_order_id":923751907,"source_order_transaction_id":972637531,"processed_at":"2024-01-10T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":977134221,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"15.00","net":"-115.00","source_id":297752803,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":774282320,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"15.00","net":"-115.00","source_id":46484353,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":726130462,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-11.50","fee":"15.00","net":"-26.50","source_id":598735659,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":590656313,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"15.00","net":"-115.00","source_id":297752803,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":585267611,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-50.00","fee":"0.00","net":"-50.00","source_id":46484353,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":295058327,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"-15.00","net":"115.00","source_id":297752803,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":144665135,"type":"dispute","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"2.83","fee":"-15.00","net":"17.83","source_id":297752803,"source_type":"Payments::Dispute","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2023-12-31T07:34:56-05:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":1039379438,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-10.00","fee":"0.00","net":"-10.00","source_id":98265485,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"channel_transfer"},{"id":996672915,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":996672915,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":972818242,"type":"reserve","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-42.00","fee":"0.00","net":"-42.00","source_id":null,"source_type":null,"source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":951890146,"type":"advance","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":null,"source_type":null,"source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":911614749,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":31693764,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"shop_cash_refund"},{"id":843310825,"type":"charge","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"11.50","fee":"0.63","net":"10.87","source_id":843310825,"source_type":"charge","source_order_id":625362839,"source_order_transaction_id":897736458,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":841651232,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":841651232,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":781687747,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":781687747,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":777723124,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":777723124,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":744334347,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":14450113,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[{"id":348327371,"amount":"11.50","order":{"id":625362839,"name":"#1001"},"fees":"0.00","net":"11.50"}],"adjustment_reason":"shopify_collective_credit"},{"id":717600021,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":717600021,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"chargeback_protection"},{"id":645292099,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":717600021,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"chargeback_protection"},{"id":637679484,"type":"SHOPIFY_COLLECTIVE_DEBIT_REVERSAL","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"1.00","fee":"0.00","net":"1.00","source_id":637679484,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":620327031,"type":"charge","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"11.50","fee":"0.63","net":"10.87","source_id":620327031,"source_type":"charge","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":524892362,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":87730317,"source_type":"adjustment","source_order_id":625362839,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[{"id":348327371,"amount":"11.50","order":{"id":625362839,"name":"#1001"},"fees":"0.00","net":"11.50"}],"adjustment_reason":"shopify_collective_debit"},{"id":510004917,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":504962724,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"shop_cash_campaign_billing"},{"id":504303358,"type":"seller_protection_credit_reversal","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":504303358,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":459441379,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.00","fee":"0.00","net":"100.00","source_id":14450113,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[{"id":348327371,"amount":"11.50","order":{"id":625362839,"name":"#1001"},"fees":"0.00","net":"11.50"}],"adjustment_reason":"shopify_collective_credit"},{"id":427940661,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"150.00","fee":"0.00","net":"150.00","source_id":427940661,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":381560291,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-150.00","fee":"0.00","net":"-150.00","source_id":381560291,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"chargeback_protection"},{"id":357948134,"type":"charge","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"10.00","fee":"0.46","net":"9.54","source_id":971443537,"source_type":"charge","source_order_id":625362839,"source_order_transaction_id":461790020,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":344667176,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"100.50","fee":"0.50","net":"100.00","source_id":291591126,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"shop_cash"},{"id":316417004,"type":"charge","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"11.50","fee":"0.50","net":"11.00","source_id":316417004,"source_type":"charge","source_order_id":753768948,"source_order_transaction_id":316417004,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":294868963,"type":"debit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"-100.00","fee":"0.00","net":"-100.00","source_id":294868963,"source_type":"Payments::Balance::AdjustmentReversal","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null},{"id":268738895,"type":"credit","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"1000.00","fee":"0.00","net":"1000.00","source_id":60315799,"source_type":"adjustment","source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":[],"adjustment_reason":"anomaly"},{"id":232023232,"type":"reserve","test":false,"payout_id":623721858,"payout_status":"paid","currency":"USD","amount":"42.00","fee":"0.00","net":"42.00","source_id":null,"source_type":null,"source_order_id":null,"source_order_transaction_id":null,"processed_at":"2016-08-04T18:07:57-04:00","adjustment_order_transactions":null,"adjustment_reason":null}]}