{
  "opencollection": "1.0.0",
  "info": {
    "name": "Shopify Admin REST About Payments API",
    "version": "2025-01"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Shopify-Access-Token",
      "value": "{{X-Shopify-Access-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Shopify Retrieves A List Of Payments On A Particular Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-01"
        },
        {
          "info": {
            "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "amount\n                  required",
                "value": "",
                "type": "query",
                "description": "The amount of the payment."
              },
              {
                "name": "request_details\n                  required",
                "value": "",
                "type": "query",
                "description": "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
              },
              {
                "name": "session_id\n                  required",
                "value": "",
                "type": "query",
                "description": "A session ID provided by the card vault when creating a payment session."
              },
              {
                "name": "unique_token\n                  required",
                "value": "",
                "type": "query",
                "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-01"
        },
        {
          "info": {
            "name": "Shopify Retrieves The Payment Information For An Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/payments/:payment_id.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "payment_id"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-01"
        },
        {
          "info": {
            "name": "Shopify Counts The Number Of Payments Attempted On A Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-01/checkouts/:token/payments/count.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-01"
        },
        {
          "info": {
            "name": "Shopify Retrieves A List Of Payments On A Particular Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-04"
        },
        {
          "info": {
            "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "amount\n                  required",
                "value": "",
                "type": "query",
                "description": "The amount of the payment."
              },
              {
                "name": "request_details\n                  required",
                "value": "",
                "type": "query",
                "description": "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
              },
              {
                "name": "session_id\n                  required",
                "value": "",
                "type": "query",
                "description": "A session ID provided by the card vault when creating a payment session."
              },
              {
                "name": "unique_token\n                  required",
                "value": "",
                "type": "query",
                "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-04"
        },
        {
          "info": {
            "name": "Shopify Retrieves The Payment Information For An Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/payments/:payment_id.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "payment_id"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-04"
        },
        {
          "info": {
            "name": "Shopify Counts The Number Of Payments Attempted On A Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-04/checkouts/:token/payments/count.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-04"
        },
        {
          "info": {
            "name": "Shopify Retrieves A List Of Payments On A Particular Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-07"
        },
        {
          "info": {
            "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "amount\n                  required",
                "value": "",
                "type": "query",
                "description": "The amount of the payment."
              },
              {
                "name": "request_details\n                  required",
                "value": "",
                "type": "query",
                "description": "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
              },
              {
                "name": "session_id\n                  required",
                "value": "",
                "type": "query",
                "description": "A session ID provided by the card vault when creating a payment session."
              },
              {
                "name": "unique_token\n                  required",
                "value": "",
                "type": "query",
                "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-07"
        },
        {
          "info": {
            "name": "Shopify Retrieves The Payment Information For An Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/payments/:payment_id.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "payment_id"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-07"
        },
        {
          "info": {
            "name": "Shopify Counts The Number Of Payments Attempted On A Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-07/checkouts/:token/payments/count.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-07"
        },
        {
          "info": {
            "name": "Shopify Retrieves A List Of Payments On A Particular Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2020-10"
        },
        {
          "info": {
            "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "amount\n                  required",
                "value": "",
                "type": "query",
                "description": "The amount of the payment."
              },
              {
                "name": "request_details\n                  required",
                "value": "",
                "type": "query",
                "description": "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
              },
              {
                "name": "session_id\n                  required",
                "value": "",
                "type": "query",
                "description": "A session ID provided by the card vault when creating a payment session."
              },
              {
                "name": "unique_token\n                  required",
                "value": "",
                "type": "query",
                "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2020-10"
        },
        {
          "info": {
            "name": "Shopify Retrieves The Payment Information For An Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/payments/:payment_id.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "payment_id"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2020-10"
        },
        {
          "info": {
            "name": "Shopify Counts The Number Of Payments Attempted On A Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2020-10/checkouts/:token/payments/count.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2020-10"
        },
        {
          "info": {
            "name": "Shopify Retrieves A List Of Payments On A Particular Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-2021-01"
        },
        {
          "info": {
            "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "amount\n                  required",
                "value": "",
                "type": "query",
                "description": "The amount of the payment."
              },
              {
                "name": "request_details\n                  required",
                "value": "",
                "type": "query",
                "description": "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
              },
              {
                "name": "session_id\n                  required",
                "value": "",
                "type": "query",
                "description": "A session ID provided by the card vault when creating a payment session."
              },
              {
                "name": "unique_token\n                  required",
                "value": "",
                "type": "query",
                "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-2021-01"
        },
        {
          "info": {
            "name": "Shopify Retrieves The Payment Information For An Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/payments/:payment_id.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "payment_id"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-2021-01"
        },
        {
          "info": {
            "name": "Shopify Counts The Number Of Payments Attempted On A Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/2021-01/checkouts/:token/payments/count.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-2021-01"
        },
        {
          "info": {
            "name": "Shopify Retrieves A List Of Payments On A Particular Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#index-unstable"
        },
        {
          "info": {
            "name": "Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/payments.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "amount\n                  required",
                "value": "",
                "type": "query",
                "description": "The amount of the payment."
              },
              {
                "name": "request_details\n                  required",
                "value": "",
                "type": "query",
                "description": "The details of the request, including the following attributes:\n                    \n                        ip_address: The IP address of the customer.\n                        accept_language: The language preferences of the customer, in the same format as a standard Accept-Language request header.\n\n                        user_agent: The user agent string for the customer's device."
              },
              {
                "name": "session_id\n                  required",
                "value": "",
                "type": "query",
                "description": "A session ID provided by the card vault when creating a payment session."
              },
              {
                "name": "unique_token\n                  required",
                "value": "",
                "type": "query",
                "description": "A unique idempotency token generated by your app. This can be any value, but must be unique across all payment requests."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#create_payment-unstable"
        },
        {
          "info": {
            "name": "Shopify Retrieves The Payment Information For An Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/payments/:payment_id.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              },
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "payment_id"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#show-unstable"
        },
        {
          "info": {
            "name": "Shopify Counts The Number Of Payments Attempted On A Checkout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{store}.myshopify.com/admin/api/2025-01/admin/api/unstable/checkouts/:token/payments/count.json",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "token"
              }
            ]
          },
          "docs": "https://shopify.dev/docs/admin-api/rest/reference/sales-channels/payment#count-unstable"
        }
      ]
    }
  ],
  "bundled": true
}