> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get Payment Routing > `settings`: whether it is on, how a checkout is given a processor (`mode`: `share`, by the share of the month's volume each should have; `order`, the first that can take it; `cheapest`, by the payment fee rates set in Finance), whether a declined card is moved to the next (`retry`), whether a returning buyer goes to their last one (`sticky`), and the health guard (`guard`, pausing a processor with `guardDeclines` of its last `guardWindow` routed payments declined) and `disputeAlert`, the dispute percent the store is told of. `processors` are in the routing in their order, each with its share, caps and order limits, its `state` (`rotation`, `cap`, `paused`, or `off` where it cannot take a card today) and its figures this month. `rules` are checked in their order, `available` is the connected card methods not in the routing yet, and `set` is false where the store has never set it up. Needs the `routing.read` permission (Read Payment Routing). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/payment-routing openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/payment-routing: get: tags: - Payment Routing summary: Get Payment Routing description: >- `settings`: whether it is on, how a checkout is given a processor (`mode`: `share`, by the share of the month's volume each should have; `order`, the first that can take it; `cheapest`, by the payment fee rates set in Finance), whether a declined card is moved to the next (`retry`), whether a returning buyer goes to their last one (`sticky`), and the health guard (`guard`, pausing a processor with `guardDeclines` of its last `guardWindow` routed payments declined) and `disputeAlert`, the dispute percent the store is told of. `processors` are in the routing in their order, each with its share, caps and order limits, its `state` (`rotation`, `cap`, `paused`, or `off` where it cannot take a card today) and its figures this month. `rules` are checked in their order, `available` is the connected card methods not in the routing yet, and `set` is false where the store has never set it up. Needs the `routing.read` permission (Read Payment Routing). operationId: routing.show parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: set: type: boolean settings: type: object properties: enabled: type: boolean mode: type: string retry: type: boolean sticky: type: boolean guard: type: boolean guardDeclines: type: integer guardWindow: type: integer disputeAlert: type: number processors: type: array items: type: object properties: provider: type: string name: type: string share: type: integer capMonth: type: integer capDay: nullable: true minOrder: nullable: true maxOrder: nullable: true state: type: string pausedReason: type: string pausedAt: nullable: true month: type: integer day: type: integer approved: nullable: true disputes: nullable: true fee: nullable: true rules: type: array items: type: object properties: id: type: string kind: type: string countries: type: array items: type: string amountOp: nullable: true amount: nullable: true action: type: string provider: type: string available: type: - array - object figures: type: object properties: routed: type: object properties: orders: type: integer volume: type: integer approved: nullable: true saved: type: object properties: orders: type: integer volume: type: integer disputes: nullable: true limits: type: object properties: rules: type: integer countries: type: integer guardWindowMin: type: integer guardWindowMax: type: integer example: success: true message: null code: null data: set: true settings: enabled: true mode: share retry: true sticky: true guard: true guardDeclines: 8 guardWindow: 20 disputeAlert: 0.75 processors: - provider: nmi name: NMI share: 60 capMonth: 25000 capDay: null minOrder: null maxOrder: null state: rotation pausedReason: '' pausedAt: null month: 0 day: 0 approved: null disputes: null fee: null - provider: tagada name: Tagada share: 50 capMonth: null capDay: null minOrder: null maxOrder: null state: rotation pausedReason: '' pausedAt: null month: 0 day: 0 approved: null disputes: null fee: null rules: - id: 728178f0-e4b4-4a8f-923a-1109ddeb07ef kind: country countries: - DE - AT amountOp: null amount: null action: only provider: nmi available: [] figures: routed: orders: 0 volume: 0 approved: null saved: orders: 0 volume: 0 disputes: null limits: rules: 50 countries: 100 guardWindowMin: 5 guardWindowMax: 200 '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.routing.show(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->routing->show(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.routing.show() components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.