API Payout access

Retired Boards Appdev Graphql Basics And Troubleshooting

Topic summary

Access errors when querying Shopify Payments via GraphQL, specifically payouts and account fields. The API returns: “Access denied for summary field. Required access: read_shopify_payments access scope. Also: User must have the shopify_payments_transfers permission.”

Configured app scopes: read_orders, read_customers, read_shopify_payments_payouts, read_shopify_payments_accounts. The error cites read_shopify_payments, which is not available in the Admin UI, creating a permissions mismatch.

Behavior noted: removing the summary.adjustmentsFee field from the payouts query avoids the error for one user, but another reports the same access error even when only querying shopifyPaymentsAccount { id }.

Context: “Scopes” are OAuth permissions controlling which API fields can be accessed; payouts refer to Shopify Payments bank transfers, and shopify_payments_transfers appears to be an additional permission requirement.

Status: Multiple users report the issue; prior threads suggest no known fix. No resolution or official guidance provided yet. Key open questions: Is read_shopify_payments a deprecated or hidden scope, is there a separate entitlement (shopify_payments_transfers) needed, and what is the correct scope set to access payouts/account fields?

Summarized with AI on February 3. AI used: gpt-5.
1

I’ve created a private app with following permissions:

read_orders, read_customers, read_shopify_payments_payouts, read_shopify_payments_accounts

Following query returns an error:

{
  shopifyPaymentsAccount {
    payouts (first: 1){
     edges{ 
      node {
	id
	issuedAt
	status
	net {
	 amount
	 currencyCode
	}
	transactionType
	summary {
         adjustmentsFee {
	  amount
         }
	}
      }
     }
   }
  }
}

Error:

Access denied for summary field. Required access: `read_shopify_payments` access scope. Also: User must have the shopify_payments_transfers permission.

read_shopify_payments is nort available in the Admin UI but I thought it should work. If I remove

summary { adjustmentsFee { amount } }

from the query above, there is no errror.

Can I get this fixed?

Thanks

Zin

1 Like
2

I also hit this error when querying below. I saw some other posts listing the same issue with no fix.

{
  shopifyPaymentsAccount {
    id
  }
}