diff --git a/CHANGELOG.md b/CHANGELOG.md index 015f733..ef51715 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## [2.15.0](https://github.com/circlefin/openapi-internal/compare/v2.14.0...v2.15.0) (2025-01-09) + + +### Features + +* Add France to create recipient address documentation +* remove cbit docs + + +### Bug Fixes + +* remove FLOW, TRX and add Sui, ZKS + ## [2.14.0](https://github.com/circlefin/openapi-internal/compare/v2.13.0...v2.14.0) (2024-12-03) diff --git a/VERSION b/VERSION index edcfe40..68e69e4 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.14.0 +2.15.0 diff --git a/openapi/json/account.json b/openapi/json/account.json index fec5d09..f6691a0 100644 --- a/openapi/json/account.json +++ b/openapi/json/account.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.14.0", + "version": "2.15.0", "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" }, @@ -23,10 +23,6 @@ "name": "Wires", "description": "Create, get instructions, and get information on 1st party bank accounts for wire transfers." }, - { - "name": "CBIT", - "description": "Create and get information on CBIT accounts." - }, { "name": "CUBIX", "description": "Create and get information on CUBIX accounts." @@ -241,7 +237,6 @@ "type": "string", "enum": [ "wire", - "cbit", "cubix" ] } @@ -903,267 +898,6 @@ } } }, - "/v1/businessAccount/banks/cbit": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a CBIT bank account", - "operationId": "createBusinessCbitAccount", - "tags": [ - "CBIT" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CbitFiatAccountCreationRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a bank account for CBIT transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateBusinessCbitAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", - "transferTypesInfo": { - "cbit": { - "currencies": [ - "USD" - ] - } - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - }, - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List all CBIT bank accounts.", - "operationId": "listBusinessCbitAccounts", - "tags": [ - "CBIT" - ], - "responses": { - "200": { - "description": "Successfully retrieved all bank accounts for CBIT transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListBusinessCbitAccountsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", - "transferTypesInfo": { - "cbit": { - "currencies": [ - "USD" - ] - } - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - ] - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/businessAccount/banks/cbit/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a CBIT bank account", - "operationId": "getBusinessCbitAccount", - "tags": [ - "CBIT" - ], - "responses": { - "200": { - "description": "Successfully retrieved a bank account for CBIT transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetBusinessCbitAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", - "transferTypesInfo": { - "cbit": { - "currencies": [ - "USD" - ] - } - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/businessAccount/banks/cbit/{id}/instructions": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get CBIT instructions", - "description": "Get the CBIT transfer instructions into the Circle bank account given your bank account id.", - "operationId": "getBusinessCbitAccountInstructions", - "tags": [ - "CBIT" - ], - "responses": { - "200": { - "description": "Successfully retrieved CBIT transfer instructions for the bank account.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListBusinessCbitAccountInstructionsResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CbitInstruction" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, "/v1/businessAccount/banks/cubix": { "post": { "security": [ @@ -1848,7 +1582,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. 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", + "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\n**For France customers:**\n\nCircle Mint France customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status. Please see Help Center articles below for details:\n- [Circle Mint France Travel Rule](https://help.circle.com/s/article/Circle-Mint-France-Travel-Rule)\n- [Circle Mint France wallet verification](https://help.circle.com/s/article/Circle-Mint-France-wallet-verification)\n", "operationId": "createBusinessRecipientAddress", "tags": [ "Addresses" @@ -2595,7 +2329,6 @@ "description": "The destination bank account type.", "enum": [ "wire", - "cbit", "cubix" ] }, @@ -2816,6 +2549,7 @@ "$ref": "#/components/schemas/PayoutStatus" }, "trackingRef": { + "type": "string", "description": "A payout tracking reference. Will be present once known.", "nullable": true, "example": "CIR-6ESOQANEP3NAO" @@ -2858,7 +2592,6 @@ "type": "string", "enum": [ "wire", - "cbit", "cubix", "pix", "sepa", @@ -3450,88 +3183,6 @@ } } }, - "CbitFiatAccountResponse": { - "type": "object", - "required": [ - "id", - "status", - "trackingRef", - "walletAddress", - "createDate", - "updateDate", - "transferTypesInfo" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" - }, - "trackingRef": { - "type": "string", - "description": "Tracking ref that needs to be set in the public description field when you send the funds to Circle CBIT wallet.", - "example": "CIR25XSXT8" - }, - "walletAddress": { - "type": "string", - "description": "Your CBIT wallet address.", - "example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - }, - "transferTypesInfo": { - "type": "object", - "description": "A map which shows transfer types supported on this account as well as additional information for each. For CBIT accounts this will always only show information for CBIT transfers.", - "additionalProperties": { - "$ref": "#/components/schemas/TransferTypeInfo" - }, - "example": { - "cbit": { - "currencies": [ - "USD" - ] - } - } - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "CbitFiatAccountCreationRequest": { - "type": "object", - "required": [ - "idempotencyKey", - "walletAddress" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "walletAddress": { - "type": "string", - "description": "CBIT wallet address.", - "example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - } - } - }, - "CbitInstruction": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the CBIT public description field.", - "example": "CIR25XSXT8" - }, - "walletAddress": { - "type": "string", - "description": "Circle wallet address that needs to be set in the CBIT recipient wallet field.", - "example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - } - } - }, "CubixFiatAccountResponse": { "type": "object", "required": [ @@ -3734,7 +3385,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -3742,8 +3392,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] }, "TransferSourceBlockchainLocation": { diff --git a/openapi/json/circle-apis.json b/openapi/json/circle-apis.json index 3aa8530..941655f 100644 --- a/openapi/json/circle-apis.json +++ b/openapi/json/circle-apis.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.14.0", + "version": "2.15.0", "title": "All Circle APIs", "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, @@ -79,10 +79,6 @@ "name": "Settlements", "description": "Get information on settlement batches." }, - { - "name": "CBIT", - "description": "Create and get information on CBIT accounts." - }, { "name": "CUBIX", "description": "Create and get information on CUBIX accounts." @@ -1423,267 +1419,6 @@ } } }, - "/v1/businessAccount/banks/cbit": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a CBIT bank account", - "operationId": "createBusinessCbitAccount", - "tags": [ - "CBIT" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CbitFiatAccountCreationRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a bank account for CBIT transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateBusinessCbitAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", - "transferTypesInfo": { - "cbit": { - "currencies": [ - "USD" - ] - } - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - }, - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List all CBIT bank accounts.", - "operationId": "listBusinessCbitAccounts", - "tags": [ - "CBIT" - ], - "responses": { - "200": { - "description": "Successfully retrieved all bank accounts for CBIT transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListBusinessCbitAccountsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", - "transferTypesInfo": { - "cbit": { - "currencies": [ - "USD" - ] - } - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - ] - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/businessAccount/banks/cbit/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a CBIT bank account", - "operationId": "getBusinessCbitAccount", - "tags": [ - "CBIT" - ], - "responses": { - "200": { - "description": "Successfully retrieved a bank account for CBIT transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetBusinessCbitAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", - "transferTypesInfo": { - "cbit": { - "currencies": [ - "USD" - ] - } - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/businessAccount/banks/cbit/{id}/instructions": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get CBIT instructions", - "description": "Get the CBIT transfer instructions into the Circle bank account given your bank account id.", - "operationId": "getBusinessCbitAccountInstructions", - "tags": [ - "CBIT" - ], - "responses": { - "200": { - "description": "Successfully retrieved CBIT transfer instructions for the bank account.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListBusinessCbitAccountInstructionsResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CbitInstruction" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, "/v1/businessAccount/banks/cubix": { "post": { "security": [ @@ -2352,7 +2087,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. 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", + "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\n**For France customers:**\n\nCircle Mint France customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status. Please see Help Center articles below for details:\n- [Circle Mint France Travel Rule](https://help.circle.com/s/article/Circle-Mint-France-Travel-Rule)\n- [Circle Mint France wallet verification](https://help.circle.com/s/article/Circle-Mint-France-wallet-verification)\n", "operationId": "createBusinessRecipientAddress", "tags": [ "Addresses" @@ -5211,7 +4946,6 @@ "type": "string", "enum": [ "wire", - "cbit", "cubix" ] } @@ -7390,7 +7124,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -7398,8 +7131,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] }, "TokenAmount": { @@ -8738,88 +8472,6 @@ } } }, - "CbitFiatAccountResponse": { - "type": "object", - "required": [ - "id", - "status", - "trackingRef", - "walletAddress", - "createDate", - "updateDate", - "transferTypesInfo" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" - }, - "trackingRef": { - "type": "string", - "description": "Tracking ref that needs to be set in the public description field when you send the funds to Circle CBIT wallet.", - "example": "CIR25XSXT8" - }, - "walletAddress": { - "type": "string", - "description": "Your CBIT wallet address.", - "example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - }, - "transferTypesInfo": { - "type": "object", - "description": "A map which shows transfer types supported on this account as well as additional information for each. For CBIT accounts this will always only show information for CBIT transfers.", - "additionalProperties": { - "$ref": "#/components/schemas/TransferTypeInfo" - }, - "example": { - "cbit": { - "currencies": [ - "USD" - ] - } - } - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "CbitFiatAccountCreationRequest": { - "type": "object", - "required": [ - "idempotencyKey", - "walletAddress" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "walletAddress": { - "type": "string", - "description": "CBIT wallet address.", - "example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - } - } - }, - "CbitInstruction": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the CBIT public description field.", - "example": "CIR25XSXT8" - }, - "walletAddress": { - "type": "string", - "description": "Circle wallet address that needs to be set in the CBIT recipient wallet field.", - "example": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" - } - } - }, "CubixFiatAccountResponse": { "type": "object", "required": [ @@ -11287,7 +10939,6 @@ "description": "The destination bank account type.", "enum": [ "wire", - "cbit", "cubix" ] }, @@ -11431,6 +11082,7 @@ "$ref": "#/components/schemas/PayoutStatus" }, "trackingRef": { + "type": "string", "description": "A payout tracking reference. Will be present once known.", "nullable": true, "example": "CIR-6ESOQANEP3NAO" @@ -11467,7 +11119,6 @@ "type": "string", "enum": [ "wire", - "cbit", "cubix", "pix", "sepa", @@ -12963,7 +12614,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -12971,8 +12621,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] } }, diff --git a/openapi/json/general.json b/openapi/json/general.json index e3ea0a4..9fcb092 100644 --- a/openapi/json/general.json +++ b/openapi/json/general.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.14.0", + "version": "2.15.0", "title": "API Overview", "description": "Common endpoints shared across all Circle APIs." }, @@ -603,7 +603,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -611,8 +610,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] }, "TokenAmount": { diff --git a/openapi/json/payments.json b/openapi/json/payments.json index ebe6b31..649984c 100644 --- a/openapi/json/payments.json +++ b/openapi/json/payments.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.14.0", + "version": "2.15.0", "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" }, @@ -4019,7 +4019,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -4027,8 +4026,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] }, "Address": { diff --git a/openapi/json/payouts.json b/openapi/json/payouts.json index e755819..99b6426 100644 --- a/openapi/json/payouts.json +++ b/openapi/json/payouts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.14.0", + "version": "2.15.0", "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." }, @@ -1181,7 +1181,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -1189,8 +1188,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] }, "Address": { @@ -1343,7 +1343,6 @@ "BTC", "CELO", "ETH", - "FLOW", "HBAR", "NEAR", "NOBLE", @@ -1351,8 +1350,9 @@ "PAH", "POLY", "SOL", - "TRX", - "XLM" + "SUI", + "XLM", + "ZKS" ] } }, diff --git a/openapi/yaml/account.yaml b/openapi/yaml/account.yaml index e467a91..6264af3 100644 --- a/openapi/yaml/account.yaml +++ b/openapi/yaml/account.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 servers: - url: https://api-sandbox.circle.com info: - version: 2.14.0 + version: 2.15.0 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. @@ -21,8 +21,6 @@ tags: - name: Wires description: Create, get instructions, and get information on 1st party bank accounts for wire transfers. -- name: CBIT - description: Create and get information on CBIT accounts. - name: CUBIX description: Create and get information on CUBIX accounts. - name: PIX @@ -165,7 +163,6 @@ paths: type: string enum: - wire - - cbit - cubix - name: status description: Queries items with the specified status. Matches any status if @@ -601,165 +598,6 @@ paths: $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthorized' - /v1/businessAccount/banks/cbit: - post: - security: - - bearerAuth: [] - summary: Create a CBIT bank account - operationId: createBusinessCbitAccount - tags: - - CBIT - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CbitFiatAccountCreationRequest' - responses: - '201': - description: Successfully created a bank account for CBIT transfers. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: CreateBusinessCbitAccountResponse - properties: - data: - $ref: '#/components/schemas/CbitFiatAccountResponse' - examples: - response: - value: - data: - id: b8627ae8-732b-4d25-b947-1df8f4007a29 - status: pending - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - cbit: - currencies: - - USD - createDate: '2020-04-10T02:13:30.000Z' - updateDate: '2020-04-10T02:13:30.000Z' - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/NotAuthorized' - get: - security: - - bearerAuth: [] - summary: List all CBIT bank accounts. - operationId: listBusinessCbitAccounts - tags: - - CBIT - responses: - '200': - description: Successfully retrieved all bank accounts for CBIT transfers. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: ListBusinessCbitAccountsResponse - properties: - data: - type: array - items: - $ref: '#/components/schemas/CbitFiatAccountResponse' - examples: - response: - value: - data: - - id: b8627ae8-732b-4d25-b947-1df8f4007a29 - status: pending - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - cbit: - currencies: - - USD - createDate: '2020-04-10T02:13:30.000Z' - updateDate: '2020-04-10T02:13:30.000Z' - '401': - $ref: '#/components/responses/NotAuthorized' - /v1/businessAccount/banks/cbit/{id}: - get: - parameters: - - $ref: '#/components/parameters/IdPath' - security: - - bearerAuth: [] - summary: Get a CBIT bank account - operationId: getBusinessCbitAccount - tags: - - CBIT - responses: - '200': - description: Successfully retrieved a bank account for CBIT transfers. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: GetBusinessCbitAccountResponse - properties: - data: - $ref: '#/components/schemas/CbitFiatAccountResponse' - examples: - response: - value: - data: - id: b8627ae8-732b-4d25-b947-1df8f4007a29 - status: pending - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - cbit: - currencies: - - USD - createDate: '2020-04-10T02:13:30.000Z' - updateDate: '2020-04-10T02:13:30.000Z' - '401': - $ref: '#/components/responses/NotAuthorized' - '404': - $ref: '#/components/responses/NotFound' - /v1/businessAccount/banks/cbit/{id}/instructions: - get: - parameters: - - $ref: '#/components/parameters/IdPath' - security: - - bearerAuth: [] - summary: Get CBIT instructions - description: Get the CBIT transfer instructions into the Circle bank account - given your bank account id. - operationId: getBusinessCbitAccountInstructions - tags: - - CBIT - responses: - '200': - description: Successfully retrieved CBIT transfer instructions for the bank - account. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: ListBusinessCbitAccountInstructionsResponse - properties: - data: - $ref: '#/components/schemas/CbitInstruction' - examples: - response: - value: - data: - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - '401': - $ref: '#/components/responses/NotAuthorized' - '404': - $ref: '#/components/responses/NotFound' /v1/businessAccount/banks/cubix: post: security: @@ -1188,13 +1026,13 @@ paths: security: - bearerAuth: [] 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. - - ' + 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\n**For France customers:**\n\nCircle Mint France customers must verify\ + \ all transfer recipients using the UI in the Circle Console, as transfers\ + \ from unverified addresses will be held in pending status. Please see Help\ + \ Center articles below for details:\n- [Circle Mint France Travel Rule](https://help.circle.com/s/article/Circle-Mint-France-Travel-Rule)\n\ + - [Circle Mint France wallet verification](https://help.circle.com/s/article/Circle-Mint-France-wallet-verification)\n" operationId: createBusinessRecipientAddress tags: - Addresses @@ -1677,7 +1515,6 @@ components: description: The destination bank account type. enum: - wire - - cbit - cubix BankDestination: type: object @@ -1851,6 +1688,7 @@ components: status: $ref: '#/components/schemas/PayoutStatus' trackingRef: + type: string description: A payout tracking reference. Will be present once known. nullable: true example: CIR-6ESOQANEP3NAO @@ -1883,7 +1721,6 @@ components: type: string enum: - wire - - cbit - cubix - pix - sepa @@ -2364,71 +2201,6 @@ components: - pending - processed - failed - CbitFiatAccountResponse: - type: object - required: - - id - - status - - trackingRef - - walletAddress - - createDate - - updateDate - - transferTypesInfo - properties: - id: - $ref: '#/components/schemas/Id' - status: - $ref: '#/components/schemas/ExternalFiatAccountStatus' - trackingRef: - type: string - description: Tracking ref that needs to be set in the public description - field when you send the funds to Circle CBIT wallet. - example: CIR25XSXT8 - walletAddress: - type: string - description: Your CBIT wallet address. - example: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - type: object - description: A map which shows transfer - types supported on this account as well as additional information for - each. For CBIT accounts this will always only show information for CBIT - transfers. - additionalProperties: - $ref: '#/components/schemas/TransferTypeInfo' - example: - cbit: - currencies: - - USD - createDate: - $ref: '#/components/schemas/UtcTimestamp' - updateDate: - $ref: '#/components/schemas/UtcTimestamp' - CbitFiatAccountCreationRequest: - type: object - required: - - idempotencyKey - - walletAddress - properties: - idempotencyKey: - $ref: '#/components/schemas/IdempotencyKey' - walletAddress: - type: string - description: CBIT wallet address. - example: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - CbitInstruction: - type: object - properties: - trackingRef: - type: string - description: Circle tracking reference that needs to be set in the CBIT - public description field. - example: CIR25XSXT8 - walletAddress: - type: string - description: Circle wallet address that needs to be set in the CBIT recipient - wallet field. - example: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' CubixFiatAccountResponse: type: object required: @@ -2603,7 +2375,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -2611,8 +2382,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS TransferSourceBlockchainLocation: description: A source blockchain address. type: object diff --git a/openapi/yaml/circle-apis.yaml b/openapi/yaml/circle-apis.yaml index 69941d7..d450eaa 100644 --- a/openapi/yaml/circle-apis.yaml +++ b/openapi/yaml/circle-apis.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 servers: - url: https://api-sandbox.circle.com info: - version: 2.14.0 + version: 2.15.0 title: All Circle APIs description: Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification. @@ -41,8 +41,6 @@ tags: description: Create and get information on address book payouts. - name: Settlements description: Get information on settlement batches. -- name: CBIT - description: Create and get information on CBIT accounts. - name: CUBIX description: Create and get information on CUBIX accounts. - name: PIX @@ -906,165 +904,6 @@ paths: $ref: '#/components/responses/NotAuthorized' '404': $ref: '#/components/responses/NotFound' - /v1/businessAccount/banks/cbit: - post: - security: - - bearerAuth: [] - summary: Create a CBIT bank account - operationId: createBusinessCbitAccount - tags: - - CBIT - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CbitFiatAccountCreationRequest' - responses: - '201': - description: Successfully created a bank account for CBIT transfers. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: CreateBusinessCbitAccountResponse - properties: - data: - $ref: '#/components/schemas/CbitFiatAccountResponse' - examples: - response: - value: - data: - id: b8627ae8-732b-4d25-b947-1df8f4007a29 - status: pending - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - cbit: - currencies: - - USD - createDate: '2020-04-10T02:13:30.000Z' - updateDate: '2020-04-10T02:13:30.000Z' - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/NotAuthorized' - get: - security: - - bearerAuth: [] - summary: List all CBIT bank accounts. - operationId: listBusinessCbitAccounts - tags: - - CBIT - responses: - '200': - description: Successfully retrieved all bank accounts for CBIT transfers. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: ListBusinessCbitAccountsResponse - properties: - data: - type: array - items: - $ref: '#/components/schemas/CbitFiatAccountResponse' - examples: - response: - value: - data: - - id: b8627ae8-732b-4d25-b947-1df8f4007a29 - status: pending - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - cbit: - currencies: - - USD - createDate: '2020-04-10T02:13:30.000Z' - updateDate: '2020-04-10T02:13:30.000Z' - '401': - $ref: '#/components/responses/NotAuthorized' - /v1/businessAccount/banks/cbit/{id}: - get: - parameters: - - $ref: '#/components/parameters/IdPath' - security: - - bearerAuth: [] - summary: Get a CBIT bank account - operationId: getBusinessCbitAccount - tags: - - CBIT - responses: - '200': - description: Successfully retrieved a bank account for CBIT transfers. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: GetBusinessCbitAccountResponse - properties: - data: - $ref: '#/components/schemas/CbitFiatAccountResponse' - examples: - response: - value: - data: - id: b8627ae8-732b-4d25-b947-1df8f4007a29 - status: pending - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - cbit: - currencies: - - USD - createDate: '2020-04-10T02:13:30.000Z' - updateDate: '2020-04-10T02:13:30.000Z' - '401': - $ref: '#/components/responses/NotAuthorized' - '404': - $ref: '#/components/responses/NotFound' - /v1/businessAccount/banks/cbit/{id}/instructions: - get: - parameters: - - $ref: '#/components/parameters/IdPath' - security: - - bearerAuth: [] - summary: Get CBIT instructions - description: Get the CBIT transfer instructions into the Circle bank account - given your bank account id. - operationId: getBusinessCbitAccountInstructions - tags: - - CBIT - responses: - '200': - description: Successfully retrieved CBIT transfer instructions for the bank - account. - headers: - X-Request-Id: - $ref: '#/components/headers/XRequestId' - content: - application/json: - schema: - title: ListBusinessCbitAccountInstructionsResponse - properties: - data: - $ref: '#/components/schemas/CbitInstruction' - examples: - response: - value: - data: - trackingRef: CIR25XSXT8 - walletAddress: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - '401': - $ref: '#/components/responses/NotAuthorized' - '404': - $ref: '#/components/responses/NotFound' /v1/businessAccount/banks/cubix: post: security: @@ -1483,13 +1322,13 @@ paths: security: - bearerAuth: [] 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. - - ' + 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\n**For France customers:**\n\nCircle Mint France customers must verify\ + \ all transfer recipients using the UI in the Circle Console, as transfers\ + \ from unverified addresses will be held in pending status. Please see Help\ + \ Center articles below for details:\n- [Circle Mint France Travel Rule](https://help.circle.com/s/article/Circle-Mint-France-Travel-Rule)\n\ + - [Circle Mint France wallet verification](https://help.circle.com/s/article/Circle-Mint-France-wallet-verification)\n" operationId: createBusinessRecipientAddress tags: - Addresses @@ -3409,7 +3248,6 @@ paths: type: string enum: - wire - - cbit - cubix - name: status description: Queries items with the specified status. Matches any status if @@ -4848,7 +4686,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -4856,8 +4693,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS TokenAmount: type: object required: @@ -5958,71 +5796,6 @@ components: $ref: '#/components/schemas/WireInstructionBeneficiary' beneficiaryBank: $ref: '#/components/schemas/WireInstructionBeneficiaryBank' - CbitFiatAccountResponse: - type: object - required: - - id - - status - - trackingRef - - walletAddress - - createDate - - updateDate - - transferTypesInfo - properties: - id: - $ref: '#/components/schemas/Id' - status: - $ref: '#/components/schemas/ExternalFiatAccountStatus' - trackingRef: - type: string - description: Tracking ref that needs to be set in the public description - field when you send the funds to Circle CBIT wallet. - example: CIR25XSXT8 - walletAddress: - type: string - description: Your CBIT wallet address. - example: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - transferTypesInfo: - type: object - description: A map which shows transfer - types supported on this account as well as additional information for - each. For CBIT accounts this will always only show information for CBIT - transfers. - additionalProperties: - $ref: '#/components/schemas/TransferTypeInfo' - example: - cbit: - currencies: - - USD - createDate: - $ref: '#/components/schemas/UtcTimestamp' - updateDate: - $ref: '#/components/schemas/UtcTimestamp' - CbitFiatAccountCreationRequest: - type: object - required: - - idempotencyKey - - walletAddress - properties: - idempotencyKey: - $ref: '#/components/schemas/IdempotencyKey' - walletAddress: - type: string - description: CBIT wallet address. - example: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' - CbitInstruction: - type: object - properties: - trackingRef: - type: string - description: Circle tracking reference that needs to be set in the CBIT - public description field. - example: CIR25XSXT8 - walletAddress: - type: string - description: Circle wallet address that needs to be set in the CBIT recipient - wallet field. - example: '0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e' CubixFiatAccountResponse: type: object required: @@ -7893,7 +7666,6 @@ components: description: The destination bank account type. enum: - wire - - cbit - cubix BankDestination: type: object @@ -8008,6 +7780,7 @@ components: status: $ref: '#/components/schemas/PayoutStatus' trackingRef: + type: string description: A payout tracking reference. Will be present once known. nullable: true example: CIR-6ESOQANEP3NAO @@ -8034,7 +7807,6 @@ components: type: string enum: - wire - - cbit - cubix - pix - sepa @@ -9242,7 +9014,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -9250,8 +9021,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS PaymentId: name: paymentId description: The payment ID associated with the chargeback. diff --git a/openapi/yaml/general.yaml b/openapi/yaml/general.yaml index b4ecd99..f4009e2 100644 --- a/openapi/yaml/general.yaml +++ b/openapi/yaml/general.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 servers: - url: https://api-sandbox.circle.com info: - version: 2.14.0 + version: 2.15.0 title: API Overview description: Common endpoints shared across all Circle APIs. tags: @@ -401,7 +401,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -409,8 +408,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS TokenAmount: type: object required: diff --git a/openapi/yaml/payments.yaml b/openapi/yaml/payments.yaml index e2c76c3..fe932db 100644 --- a/openapi/yaml/payments.yaml +++ b/openapi/yaml/payments.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 servers: - url: https://api-sandbox.circle.com info: - version: 2.14.0 + version: 2.15.0 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 @@ -2799,7 +2799,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -2807,8 +2806,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS Address: type: string description: An alphanumeric string representing a blockchain address. Will diff --git a/openapi/yaml/payouts.yaml b/openapi/yaml/payouts.yaml index 6e24941..c981649 100644 --- a/openapi/yaml/payouts.yaml +++ b/openapi/yaml/payouts.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 servers: - url: https://api-sandbox.circle.com info: - version: 2.14.0 + version: 2.15.0 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. @@ -837,7 +837,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -845,8 +844,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS Address: type: string description: An alphanumeric string representing a blockchain address. Will @@ -965,7 +965,6 @@ components: - BTC - CELO - ETH - - FLOW - HBAR - NEAR - NOBLE @@ -973,8 +972,9 @@ components: - PAH - POLY - SOL - - TRX + - SUI - XLM + - ZKS From: name: from description: Queries items created since the specified date-time (inclusive).