diff --git a/CHANGELOG.md b/CHANGELOG.md index 9148b1d..f1b79da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [2.1.0](https://github.com/circlefin/openapi-internal/compare/v2.0.1...v2.1.0) (2023-07-17) + + +### New Features + +* [BANK-713] Add billing details to Update a card page + ## [2.0.1](https://github.com/circlefin/openapi-internal/compare/v2.0.0...v2.0.1) (2023-07-10) diff --git a/VERSION b/VERSION index 38f77a6..7ec1d6d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.0.1 +2.1.0 diff --git a/openapi/json/account.json b/openapi/json/account.json index 7183f3f..38f01c8 100644 --- a/openapi/json/account.json +++ b/openapi/json/account.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.0.1", + "version": "2.1.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" }, diff --git a/openapi/json/accounts.json b/openapi/json/accounts.json index 1e2d83e..cb6870d 100644 --- a/openapi/json/accounts.json +++ b/openapi/json/accounts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.0.1", + "version": "2.1.0", "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." }, diff --git a/openapi/json/circle-apis.json b/openapi/json/circle-apis.json index e4294cc..2fbf51f 100644 --- a/openapi/json/circle-apis.json +++ b/openapi/json/circle-apis.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.0.1", + "version": "2.1.0", "title": "All Circle APIs", "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, @@ -7833,13 +7833,70 @@ } } }, + "UpdateBillingDetails": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name of the card or bank account holder.", + "maxLength": 1024, + "example": "Satoshi" + }, + "lastName": { + "type": "string", + "description": "Last name of the card or bank account holder.", + "maxLength": 1024, + "example": "Nakamoto" + }, + "line1": { + "type": "string", + "description": "Line one of the street address.", + "maxLength": 1024, + "example": "100 Money Street" + }, + "line2": { + "type": "string", + "description": "Line two of the street address.", + "maxLength": 1024, + "example": "Suite 1" + }, + "city": { + "type": "string", + "description": "City portion of the address.", + "maxLength": 1024, + "example": "Boston" + }, + "district": { + "description": "State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.", + "type": "string", + "maxLength": 16, + "example": "MA" + }, + "postalCode": { + "type": "string", + "description": "Postal / ZIP code of the address.", + "maxLength": 16, + "example": "01234" + }, + "country": { + "type": "string", + "description": "Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "maxLength": 2, + "example": "US" + }, + "phone": { + "$ref": "#/components/schemas/PhoneNumber" + }, + "email": { + "$ref": "#/components/schemas/Email" + } + } + }, "CardUpdate": { "type": "object", "required": [ "keyId", - "encryptedData", - "expMonth", - "expYear" + "encryptedData" ], "properties": { "keyId": { @@ -7856,6 +7913,9 @@ }, "expYear": { "$ref": "#/components/schemas/CardExpYear" + }, + "billingDetails": { + "$ref": "#/components/schemas/UpdateBillingDetails" } } }, diff --git a/openapi/json/general.json b/openapi/json/general.json index 5c08c80..7298a94 100644 --- a/openapi/json/general.json +++ b/openapi/json/general.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.0.1", + "version": "2.1.0", "title": "API Overview", "description": "Common endpoints shared across all Circle APIs." }, diff --git a/openapi/json/payments.json b/openapi/json/payments.json index 645581d..8824c31 100644 --- a/openapi/json/payments.json +++ b/openapi/json/payments.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.0.1", + "version": "2.1.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" }, @@ -5957,13 +5957,70 @@ } } }, + "UpdateBillingDetails": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name of the card or bank account holder.", + "maxLength": 1024, + "example": "Satoshi" + }, + "lastName": { + "type": "string", + "description": "Last name of the card or bank account holder.", + "maxLength": 1024, + "example": "Nakamoto" + }, + "line1": { + "type": "string", + "description": "Line one of the street address.", + "maxLength": 1024, + "example": "100 Money Street" + }, + "line2": { + "type": "string", + "description": "Line two of the street address.", + "maxLength": 1024, + "example": "Suite 1" + }, + "city": { + "type": "string", + "description": "City portion of the address.", + "maxLength": 1024, + "example": "Boston" + }, + "district": { + "description": "State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.", + "type": "string", + "maxLength": 16, + "example": "MA" + }, + "postalCode": { + "type": "string", + "description": "Postal / ZIP code of the address.", + "maxLength": 16, + "example": "01234" + }, + "country": { + "type": "string", + "description": "Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "maxLength": 2, + "example": "US" + }, + "phone": { + "$ref": "#/components/schemas/PhoneNumber" + }, + "email": { + "$ref": "#/components/schemas/Email" + } + } + }, "CardUpdate": { "type": "object", "required": [ "keyId", - "encryptedData", - "expMonth", - "expYear" + "encryptedData" ], "properties": { "keyId": { @@ -5980,6 +6037,9 @@ }, "expYear": { "$ref": "#/components/schemas/CardExpYear" + }, + "billingDetails": { + "$ref": "#/components/schemas/UpdateBillingDetails" } } }, diff --git a/openapi/json/payouts.json b/openapi/json/payouts.json index 619fbc6..de7f0c8 100644 --- a/openapi/json/payouts.json +++ b/openapi/json/payouts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.0.1", + "version": "2.1.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." }, diff --git a/openapi/yaml/account.yaml b/openapi/yaml/account.yaml index 547d9bc..ceed07b 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.0.1 + version: 2.1.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. diff --git a/openapi/yaml/accounts.yaml b/openapi/yaml/accounts.yaml index 559372c..41957da 100644 --- a/openapi/yaml/accounts.yaml +++ b/openapi/yaml/accounts.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 servers: - url: https://api-sandbox.circle.com info: - version: 2.0.1 + version: 2.1.0 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 diff --git a/openapi/yaml/circle-apis.yaml b/openapi/yaml/circle-apis.yaml index 1f9ff02..93c9df7 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.0.1 + version: 2.1.0 title: All Circle APIs description: Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification. @@ -5237,13 +5237,61 @@ components: $ref: '#/components/schemas/UtcTimestamp' updateDate: $ref: '#/components/schemas/UtcTimestamp' + UpdateBillingDetails: + type: object + properties: + firstName: + type: string + description: First name of the card or bank account holder. + maxLength: 1024 + example: Satoshi + lastName: + type: string + description: Last name of the card or bank account holder. + maxLength: 1024 + example: Nakamoto + line1: + type: string + description: Line one of the street address. + maxLength: 1024 + example: 100 Money Street + line2: + type: string + description: Line two of the street address. + maxLength: 1024 + example: Suite 1 + city: + type: string + description: City portion of the address. + maxLength: 1024 + example: Boston + district: + description: State / County / Province / Region portion of the address. + If the country is US or Canada, then district is required and should use + the two-letter code for the subdivision. + type: string + maxLength: 16 + example: MA + postalCode: + type: string + description: Postal / ZIP code of the address. + maxLength: 16 + example: '01234' + country: + type: string + description: Country portion of the address. Formatted as a two-letter country + code specified in ISO 3166-1 alpha-2. + maxLength: 2 + example: US + phone: + $ref: '#/components/schemas/PhoneNumber' + email: + $ref: '#/components/schemas/Email' CardUpdate: type: object required: - keyId - encryptedData - - expMonth - - expYear properties: keyId: $ref: '#/components/schemas/IdKey' @@ -5261,6 +5309,8 @@ components: $ref: '#/components/schemas/CardExpMonth' expYear: $ref: '#/components/schemas/CardExpYear' + billingDetails: + $ref: '#/components/schemas/UpdateBillingDetails' ApplePayTokenEcHeader: type: object required: diff --git a/openapi/yaml/general.yaml b/openapi/yaml/general.yaml index 742530c..66d200f 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.0.1 + version: 2.1.0 title: API Overview description: Common endpoints shared across all Circle APIs. tags: diff --git a/openapi/yaml/payments.yaml b/openapi/yaml/payments.yaml index 2affbe0..812f502 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.0.1 + version: 2.1.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 @@ -4315,13 +4315,61 @@ components: $ref: '#/components/schemas/UtcTimestamp' updateDate: $ref: '#/components/schemas/UtcTimestamp' + UpdateBillingDetails: + type: object + properties: + firstName: + type: string + description: First name of the card or bank account holder. + maxLength: 1024 + example: Satoshi + lastName: + type: string + description: Last name of the card or bank account holder. + maxLength: 1024 + example: Nakamoto + line1: + type: string + description: Line one of the street address. + maxLength: 1024 + example: 100 Money Street + line2: + type: string + description: Line two of the street address. + maxLength: 1024 + example: Suite 1 + city: + type: string + description: City portion of the address. + maxLength: 1024 + example: Boston + district: + description: State / County / Province / Region portion of the address. + If the country is US or Canada, then district is required and should use + the two-letter code for the subdivision. + type: string + maxLength: 16 + example: MA + postalCode: + type: string + description: Postal / ZIP code of the address. + maxLength: 16 + example: '01234' + country: + type: string + description: Country portion of the address. Formatted as a two-letter country + code specified in ISO 3166-1 alpha-2. + maxLength: 2 + example: US + phone: + $ref: '#/components/schemas/PhoneNumber' + email: + $ref: '#/components/schemas/Email' CardUpdate: type: object required: - keyId - encryptedData - - expMonth - - expYear properties: keyId: $ref: '#/components/schemas/IdKey' @@ -4339,6 +4387,8 @@ components: $ref: '#/components/schemas/CardExpMonth' expYear: $ref: '#/components/schemas/CardExpYear' + billingDetails: + $ref: '#/components/schemas/UpdateBillingDetails' ApplePayTokenEcHeader: type: object required: diff --git a/openapi/yaml/payouts.yaml b/openapi/yaml/payouts.yaml index eea54e3..287dec5 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.0.1 + version: 2.1.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.