Skip to content

Commit

Permalink
Update OpenAPI docs to v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@circle-github-action-bot
circle-github-action-bot committed Nov 17, 2022
1 parent f0f7902 commit a1c9d60
Show file tree
Hide file tree
Showing 16 changed files with 7,307 additions and 8,299 deletions.
28 changes: 28 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# Changelog

## [1.1.0](https://github.com/circlefin/openapi-internal/compare/v1.0.3...v1.1.0) (2022-11-17)


### New Features

* add address book endpoints
* add exchange rates endpoint
* add google pay and apple payment tokens
* crypto payouts refactor
* refactor crypto and fiat payout models


### Fixes

* add chargeback status to GET chargebacks API response
* add fundingType field to get cards endpoint
* add openapi tag descriptions
* add signet as a destination type for payouts
* add signet as business destination req type
* add toAmount to fiat payouts
* fix incorrect list all payouts source param description
* model name typos and duplicates
* move payment intents into payments doc
* move transfers endpt out of payments and payouts
* rm crypto payments doc
* rm instances of readOnly
* rm on-chain payments and payouts

## [1.0.3](https://github.com/circlefin/openapi-internal/compare/v1.0.2...v1.0.3) (2022-09-26)


Expand Down
2 changes: 1 addition & 1 deletion VERSION
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.3
1.1.0
257 changes: 133 additions & 124 deletions openapi/json/account.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,46 @@
"openapi": "3.0.2",
"servers": [
{
"url": "api-sandbox.circle.com"
"url": "https://api-sandbox.circle.com"
}
],
"info": {
"version": "1.0.3",
"version": "1.1.0",
"title": "Core Functionality",
"description": "APIs for managing your account balance. These endpoints are available with all Circle APIs."
"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"
},
"tags": [
{
"name": "Balances"
"name": "Balances",
"description": "Get information on settled and unsettled balances."
},
{
"name": "Payouts"
"name": "Payouts",
"description": "Create and get information on 1st party payouts."
},
{
"name": "Wires"
"name": "Wires",
"description": "Create, get instructions, and get information on 1st party bank accounts for wire transfers."
},
{
"name": "Signet"
"name": "Signet",
"description": "Create and get information on Signet accounts."
},
{
"name": "SEN"
"name": "SEN",
"description": "Create and get information on SEN accounts."
},
{
"name": "Transfers"
"name": "Transfers",
"description": "Create and get information on 1st party transfers."
},
{
"name": "Addresses"
"name": "Addresses",
"description": "Generate and get information on blockchain addresses."
},
{
"name": "Deposits"
"name": "Deposits",
"description": "Get information on 1st party deposits."
}
],
"paths": {
Expand Down Expand Up @@ -98,6 +106,113 @@
}
},
"/v1/businessAccount/payouts": {
"post": {
"security": [
{
"bearerAuth": []
}
],
"summary": "Create a payout",
"operationId": "createBusinessPayout",
"tags": [
"Payouts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayoutCreationRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successfully created a payout.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "CreateBusinessPayoutResponse",
"properties": {
"data": {
"$ref": "#/components/schemas/BusinessPayout"
}
}
},
"examples": {
"response": {
"value": {
"data": {
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"sourceWalletId": "53535335",
"destination": {
"type": "wire",
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"name": "COMMERZBANK AG ****3000"
},
"amount": {
"amount": "3.14",
"currency": "USD"
},
"fees": {
"amount": "3.14",
"currency": "USD"
},
"status": "pending",
"trackingRef": "CIR-6ESOQANEP3NAO",
"errorCode": "insufficient_funds",
"riskEvaluation": {
"decision": "approved",
"reason": "3000"
},
"adjustments": {
"fxCredit": {
"amount": "3.14",
"currency": "USD"
},
"fxDebit": {
"amount": "3.14",
"currency": "USD"
}
},
"return": {
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
"amount": {
"amount": "3.14",
"currency": "USD"
},
"fees": {
"amount": "3.14",
"currency": "USD"
},
"reason": "payout_returned",
"status": "pending",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z"
},
"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": [
{
Expand Down Expand Up @@ -127,6 +242,7 @@
"required": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/PayoutStatus"
}
Expand Down Expand Up @@ -241,113 +357,6 @@
"$ref": "#/components/responses/NotAuthorized"
}
}
},
"post": {
"security": [
{
"bearerAuth": []
}
],
"summary": "Create a payout",
"operationId": "createBusinessPayout",
"tags": [
"Payouts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessPayoutCreationRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successfully created a payout.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "CreateBusinessPayoutResponse",
"properties": {
"data": {
"$ref": "#/components/schemas/BusinessPayout"
}
}
},
"examples": {
"response": {
"value": {
"data": {
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"sourceWalletId": "53535335",
"destination": {
"type": "wire",
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"name": "COMMERZBANK AG ****3000"
},
"amount": {
"amount": "3.14",
"currency": "USD"
},
"fees": {
"amount": "3.14",
"currency": "USD"
},
"status": "pending",
"trackingRef": "CIR-6ESOQANEP3NAO",
"errorCode": "insufficient_funds",
"riskEvaluation": {
"decision": "approved",
"reason": "3000"
},
"adjustments": {
"fxCredit": {
"amount": "3.14",
"currency": "USD"
},
"fxDebit": {
"amount": "3.14",
"currency": "USD"
}
},
"return": {
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
"amount": {
"amount": "3.14",
"currency": "USD"
},
"fees": {
"amount": "3.14",
"currency": "USD"
},
"reason": "payout_returned",
"status": "pending",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z"
},
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z"
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/NotAuthorized"
}
}
}
},
"/v1/businessAccount/payouts/{id}": {
Expand Down Expand Up @@ -2059,13 +2068,14 @@
"format": "uuid",
"example": "b8627ae8-732b-4d25-b947-1df8f4007a29"
},
"PayoutDestinationType": {
"BusinessAccountPayoutDestinationType": {
"type": "string",
"description": "The destination bank account type.",
"enum": [
"wire",
"ach",
"sepa"
"sepa",
"signet"
]
},
"BankDestination": {
Expand All @@ -2077,15 +2087,14 @@
],
"properties": {
"type": {
"$ref": "#/components/schemas/PayoutDestinationType"
"$ref": "#/components/schemas/BusinessAccountPayoutDestinationType"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"name": {
"type": "string",
"description": "Bank name plus last four digits of the bank account number or IBAN.",
"readOnly": true,
"example": "COMMERZBANK AG ****3000"
}
}
Expand Down Expand Up @@ -2301,7 +2310,8 @@
"type": "string",
"enum": [
"wire",
"sen"
"sen",
"signet"
]
},
"id": {
Expand Down Expand Up @@ -3233,7 +3243,6 @@
},
"fees": {
"description": "An array of fees applied to a transaction. This is only available when there is at least one non-zero fee.",
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Fee"
Expand Down
Loading

0 comments on commit a1c9d60

Please sign in to comment.