> ## 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.

# Change Payment Routing

> Changes the settings named and keeps the rest. Switching it on needs a processor in the routing that can take a card today. Answers the whole of Payment Routing again, as "Get Payment Routing" does.

Needs the `routing.write` permission (Change Payment Routing).



## OpenAPI

````yaml /api-reference/openapi.json put /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:
    put:
      tags:
        - Payment Routing
      summary: Change Payment Routing
      description: >-
        Changes the settings named and keeps the rest. Switching it on needs a
        processor in the routing that can take a card today. Answers the whole
        of Payment Routing again, as "Get Payment Routing" does.


        Needs the `routing.write` permission (Change Payment Routing).
      operationId: routing.update
      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
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether checkouts are routed.
                mode:
                  type: string
                  description: How a checkout is given a processor.
                  enum:
                    - share
                    - order
                    - cheapest
                retry:
                  type: boolean
                  description: >-
                    Whether a declined card is moved to the next processor. A
                    card declined as stolen, lost or fake never is.
                sticky:
                  type: boolean
                  description: >-
                    Whether a returning buyer goes to the processor they last
                    paid with.
                guard:
                  type: boolean
                  description: >-
                    Whether a processor whose keys fail, or with too many
                    declines, is paused. The last one in rotation never is.
                guardDeclines:
                  type: integer
                  description: >-
                    How many of the window's payments declined pause a
                    processor, from 1 to `guardWindow`.
                  example: 8
                guardWindow:
                  type: integer
                  description: >-
                    How many of its last routed payments are judged, from 5 to
                    200.
                  example: 20
                disputeAlert:
                  type: number
                  description: >-
                    The percent of a processor's paid orders disputed that the
                    store is told of, once a week at most, above 0 and up to
                    100. Empty or null for none. Nothing is moved for it.
                  example: 0.75
      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'
        '422':
          $ref: '#/components/responses/Refused'
        '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.update();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->routing->update();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.routing.update()
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  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'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      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.