Update OpenAPI docs to v2.6.1

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.6.1](https://github.com/circlefin/openapi-internal/compare/v2.6.0...v2.6.1) (2023-10-16)
+
+
+### Fixes
+
+* docs updates for Circle Mint Singapore launch, travel rule 
+
 ## [2.6.0](https://github.com/circlefin/openapi-internal/compare/v2.5.0...v2.6.0) (2023-10-10)
 
 

VERSION

@@ -1 +1 @@
-2.6.0
+2.6.1

openapi/json/account.json

@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "Core Functionality",
     "description": "All of Circle's APIs share a common set of core functionality that lets you manage your Circle Account in a programmatic way.\n\nWith a Circle Account your business can deposit traditional money from 80+ countries and seamlessly convert them into \"digital currency dollars\": USDC. You can then use USDC for everyday payments and treasury flows.\n"
   },
@@ -1387,7 +1387,7 @@
           }
         ],
         "summary": "Create a deposit address",
-        "description": "Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.\n",
+        "description": "Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. \n",
         "operationId": "createBusinessDepositAddress",
         "tags": [
           "Addresses"
@@ -1505,7 +1505,7 @@
           }
         ],
         "summary": "Create a recipient address",
-        "description": "Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.\n",
+        "description": "Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.\n",
         "operationId": "createBusinessRecipientAddress",
         "tags": [
           "Addresses"
@@ -2982,7 +2982,7 @@
             "example": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63"
           },
           "status": {
-            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.",
+            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed. Circle Mint Singapore customers may have transfers in the `pending` status if the recipient addresses are not verified.",
             "type": "string",
             "enum": [
               "pending",

openapi/json/accounts.json

@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "Accounts API",
     "description": "The Accounts API allows you to easily create and host digital wallets for your customers, and manage transfers of funds across accounts- whether they are within the Circle platform, or in / out of the platform via on-chain USDC, EUROC, BTC, and ETH connectivity."
   },
@@ -1365,7 +1365,7 @@
             "example": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63"
           },
           "status": {
-            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.",
+            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed. Circle Mint Singapore customers may have transfers in the `pending` status if the recipient addresses are not verified.",
             "type": "string",
             "enum": [
               "pending",

openapi/json/circle-apis.json

@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "All Circle APIs",
     "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification."
   },
@@ -1624,7 +1624,7 @@
           }
         ],
         "summary": "Create a deposit address",
-        "description": "Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit.\n",
+        "description": "Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. \n",
         "operationId": "createBusinessDepositAddress",
         "tags": [
           "Addresses"
@@ -1742,7 +1742,7 @@
           }
         ],
         "summary": "Create a recipient address",
-        "description": "Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address.\n",
+        "description": "Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status.\n",
         "operationId": "createBusinessRecipientAddress",
         "tags": [
           "Addresses"
@@ -11706,7 +11706,7 @@
             "example": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63"
           },
           "status": {
-            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.",
+            "description": "Status of the transfer. Status `pending` indicates that the transfer is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed. Circle Mint Singapore customers may have transfers in the `pending` status if the recipient addresses are not verified.",
             "type": "string",
             "enum": [
               "pending",

openapi/json/general.json

@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "API Overview",
     "description": "Common endpoints shared across all Circle APIs."
   },

openapi/json/payments.json

@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "Payments API",
     "description": "The Circle Payments API allows you to take payments from your end users via traditional methods such as debit & credit cards and receive settlement in USDC.\n\nThe Circle Payments API has been designed with any business or internet commerce in mind, not just crypto applications, and it's based on Circle's extensive experience processing millions of card payments since 2014.\n"
   },

openapi/json/payouts.json

@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.6.0",
+    "version": "2.6.1",
     "title": "Payouts API",
     "description": "The Circle Payouts API allows you to programmatically make fast, global payouts to your customers, vendors, and suppliers. Make payouts on supported blockchains."
   },

openapi/yaml/account.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.6.0
+  version: 2.6.1
   title: Core Functionality
   description: 'All of Circle''s APIs share a common set of core functionality that
     lets you manage your Circle Account in a programmatic way.
@@ -897,14 +897,14 @@ paths:
       security:
       - bearerAuth: []
       summary: Create a deposit address
-      description: 'Generates a new blockchain address for a wallet for a given currency/chain
-        pair. Circle may reuse addresses on blockchains that support reuse. For example,
-        if you''re requesting two addresses for depositing USD and ETH, both on Ethereum,
-        you may see the same Ethereum address returned. Depositing cryptocurrency
-        to a generated address will credit the associated wallet with the value of
-        the deposit.
-
-        '
+      description: "Generates a new blockchain address for a wallet for a given currency/chain\
+        \ pair. Circle may reuse addresses on blockchains that support reuse. For\
+        \ example, if you're requesting two addresses for depositing USD and ETH,\
+        \ both on Ethereum, you may see the same Ethereum address returned. Depositing\
+        \ cryptocurrency to a generated address will credit the associated wallet\
+        \ with the value of the deposit. Note: Circle Mint Singapore customers must\
+        \ verify all transfer recipients using the UI in the Circle Console, as transfers\
+        \ from unverified addresses will be held in `pending` status. \n"
       operationId: createBusinessDepositAddress
       tags:
       - Addresses
@@ -977,6 +977,9 @@ paths:
       summary: Create a recipient address
       description: 'Stores an external blockchain address. Once added, the recipient
         address must be verified to ensure that you know and trust each new address.
+        Note: Circle Mint Singapore customers must verify all transfer recipients
+        using the UI in the Circle Console, as transfers from unverified addresses
+        will be held in `pending` status.
 
         '
       operationId: createBusinessRecipientAddress
@@ -2131,7 +2134,9 @@ components:
         status:
           description: Status of the transfer. Status `pending` indicates that the
             transfer is in the process of running; `complete` indicates it finished
-            successfully; `failed` indicates it failed.
+            successfully; `failed` indicates it failed. Circle Mint Singapore customers
+            may have transfers in the `pending` status if the recipient addresses
+            are not verified.
           type: string
           enum:
           - pending

openapi/yaml/accounts.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.6.0
+  version: 2.6.1
   title: Accounts API
   description: The Accounts API allows you to easily create and host digital wallets
     for your customers, and manage transfers of funds across accounts- whether they
@@ -1004,7 +1004,9 @@ components:
         status:
           description: Status of the transfer. Status `pending` indicates that the
             transfer is in the process of running; `complete` indicates it finished
-            successfully; `failed` indicates it failed.
+            successfully; `failed` indicates it failed. Circle Mint Singapore customers
+            may have transfers in the `pending` status if the recipient addresses
+            are not verified.
           type: string
           enum:
           - pending

openapi/yaml/circle-apis.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.6.0
+  version: 2.6.1
   title: All Circle APIs
   description: Circle's General, Core Functionality, Payments, Payouts, Accounts,
     and Crypto Payments APIs bundled into one OpenAPI Specification.
@@ -1030,14 +1030,14 @@ paths:
       security:
       - bearerAuth: []
       summary: Create a deposit address
-      description: 'Generates a new blockchain address for a wallet for a given currency/chain
-        pair. Circle may reuse addresses on blockchains that support reuse. For example,
-        if you''re requesting two addresses for depositing USD and ETH, both on Ethereum,
-        you may see the same Ethereum address returned. Depositing cryptocurrency
-        to a generated address will credit the associated wallet with the value of
-        the deposit.
-
-        '
+      description: "Generates a new blockchain address for a wallet for a given currency/chain\
+        \ pair. Circle may reuse addresses on blockchains that support reuse. For\
+        \ example, if you're requesting two addresses for depositing USD and ETH,\
+        \ both on Ethereum, you may see the same Ethereum address returned. Depositing\
+        \ cryptocurrency to a generated address will credit the associated wallet\
+        \ with the value of the deposit. Note: Circle Mint Singapore customers must\
+        \ verify all transfer recipients using the UI in the Circle Console, as transfers\
+        \ from unverified addresses will be held in `pending` status. \n"
       operationId: createBusinessDepositAddress
       tags:
       - Addresses
@@ -1110,6 +1110,9 @@ paths:
       summary: Create a recipient address
       description: 'Stores an external blockchain address. Once added, the recipient
         address must be verified to ensure that you know and trust each new address.
+        Note: Circle Mint Singapore customers must verify all transfer recipients
+        using the UI in the Circle Console, as transfers from unverified addresses
+        will be held in `pending` status.
 
         '
       operationId: createBusinessRecipientAddress
@@ -8244,7 +8247,9 @@ components:
         status:
           description: Status of the transfer. Status `pending` indicates that the
             transfer is in the process of running; `complete` indicates it finished
-            successfully; `failed` indicates it failed.
+            successfully; `failed` indicates it failed. Circle Mint Singapore customers
+            may have transfers in the `pending` status if the recipient addresses
+            are not verified.
           type: string
           enum:
           - pending

openapi/yaml/general.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.6.0
+  version: 2.6.1
   title: API Overview
   description: Common endpoints shared across all Circle APIs.
 tags:

openapi/yaml/payments.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.6.0
+  version: 2.6.1
   title: Payments API
   description: 'The Circle Payments API allows you to take payments from your end
     users via traditional methods such as debit & credit cards and receive settlement

openapi/yaml/payouts.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.6.0
+  version: 2.6.1
   title: Payouts API
   description: The Circle Payouts API allows you to programmatically make fast, global
     payouts to your customers, vendors, and suppliers. Make payouts on supported blockchains.