The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Transactions
2024-04
Requires ANY of the following access scopes:
shopify_payments_payouts
, shopify_payments
.
Requires access to protected customer data.
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?
#Endpoints
- get/admin
/api /2024-04 /shopify_payments /balance /transactions.json?payout_id=623721858 Return a list of all balance transactions
The Transactions resource
Properties
id
-> id
The unique identifier of the transaction.
test
-> 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
-> 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.
The ISO 4217 currency code of the transaction.
amount
-> 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
-> sourceId
The id of the resource leading to the transaction.
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", "order": { "id": 1, "name": "#1001" } } ] }
getReturn 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?
Query parameters
payout id= 623721858
Filter response to transactions paid out in the specified payout.
Was this section helpful?
get
/adminCopy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-04/shopify_payments/balance/transactions.json?payout_id=623721858" \ -H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK { "transactions": [ { "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-09-26T14:13:38-04:00", "adjustment_order_transactions": [] }, { "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-09-26T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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-09-25T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": "2024-09-15T14:13:38-04:00", "adjustment_order_transactions": 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": [] }, { "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 }, { "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 }, { "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 }, { "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": [] }, { "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 }, { "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 }, { "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 }, { "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" } } ] }, { "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": [] }, { "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": [] }, { "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 }, { "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 }, { "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" } } ] }, { "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": [] }, { "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 }, { "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" } } ] }, { "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 }, { "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": [] }, { "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 }, { "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": [] }, { "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 }, { "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 }, { "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": [] }, { "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 }, { "id": 222417706, "type": "advance_funding", "test": false, "payout_id": 623721858, "payout_status": "paid", "currency": "USD", "amount": "-10.00", "fee": "0.00", "net": "-10.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 }, { "id": 217609728, "type": "charge", "test": false, "payout_id": 623721858, "payout_status": "paid", "currency": "USD", "amount": "11.50", "fee": "0.00", "net": "11.50", "source_id": 930299385, "source_type": "charge", "source_order_id": 625362839, "source_order_transaction_id": 348327371, "processed_at": "2016-08-04T18:07:57-04:00", "adjustment_order_transactions": null }, { "id": 193054836, "type": "charge", "test": false, "payout_id": 623721858, "payout_status": "paid", "currency": "USD", "amount": "11.50", "fee": "0.50", "net": "11.00", "source_id": 193054836, "source_type": "charge", "source_order_id": 753768948, "source_order_transaction_id": 192808135, "processed_at": "2016-08-04T18:07:57-04:00", "adjustment_order_transactions": null }, { "id": 138130604, "type": "credit", "test": false, "payout_id": 623721858, "payout_status": "paid", "currency": "USD", "amount": "150.00", "fee": "0.00", "net": "150.00", "source_id": 138130604, "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 }, { "id": 117567798, "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": 117567798, "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 } ] }