Skip to main content

Get PayPal Integration

GET 

/api/paypal/integrations/:id

Returns one PayPal integration with its connection status, merchant identity and granted permissions.

Authentication: Requires Bearer token.

transaction_search_granted is true when the merchant granted transaction-search access while connecting; can_import_transactions is true when transactions can be imported (connected, and transaction search granted).

platform_available is false when PayPal is not yet available on SKU.io; connecting, refreshing status, creating pay links, refunding and importing then return 409. connected_at is when the account last finished connecting with PayPal (null when not connected).

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

connection_method is paypal_connect (signed in with Connect with PayPal), api_keys (connected with the merchant's own PayPal REST app keys) or null when not connected. For an api_keys account, client_id is the app's Client ID (the secret is never returned), webhook_registered says whether SKU.io's webhook is subscribed on that app and webhook_url is where PayPal delivers its events. last_client_id is the Client ID of a disconnected api_keys account. can_switch_to_paypal_connect is true for an api_keys account once Connect with PayPal is available; switching keeps the account's pay links and payments.

credentials_rejected is true when PayPal no longer accepts an api_keys account's Client ID and Secret (rotated or deleted app); credentials_rejected_at says since when. Such an account is not ready_to_transact until new keys are saved. switch_needs_same_account_confirmation is true when switching an api_keys account to Connect with PayPal must be confirmed with confirm_same_account (its payments don't yet say which PayPal account they were taken with). can_delete is false once the account has taken a payment; delete_blocked_reason then says why.

Permission: Integrations → List (integrations.index) or Sales Orders → Payments (sales_orders.manage_payments). For an already disconnected account, delete_blocked_reason says it stays here, disconnected (no Disconnect advice).

Request​

Responses​

OK

Response Headers
    Content-Type