@circle-fin/circle-sdk

{ "openapi": "3.0.2", "servers": [ { "url": "https://api-sandbox.circle.com" } ], "info": { "version": "2.9.0", "title": "All Circle APIs", "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, "tags": [ { "name": "Addresses", "description": "Generate and get information on blockchain addresses." }, { "name": "Crypto Address Book", "description": "Manage blockchain addresses with metadata." }, { "name": "Balances", "description": "Get information on settled and unsettled balances." }, { "name": "Cards", "description": "Link, update, and get information on debit/credit cards." }, { "name": "Payment Tokens", "description": "Create Apple Pay and Google Pay payment tokens." }, { "name": "Channels", "description": "View a list of channels." }, { "name": "Chargebacks", "description": "Get information on card chargebacks." }, { "name": "Crypto Payment Intents", "description": "Create and track intent for end user to pay via crypto." }, { "name": "Deposits", "description": "Get information on 1st party deposits." }, { "name": "Encryption", "description": "Encrypt sensitive data." }, { "name": "Crypto Exchange Rates", "description": "Pull estimated exchange rate for crypto currencies." }, { "name": "Health", "description": "Inspect the health of the API." }, { "name": "Management", "description": "General account and management information." }, { "name": "Payments", "description": "Get updates on whether user's crypto payment was received." }, { "name": "Pull Crypto Payments", "description": "Create pull crypto payments and generate typed messages for signing." }, { "name": "Payouts", "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": "Stablecoins", "description": "Retrieve stablecoins and their respective names, symbols, circulating total and per-chain amounts." }, { "name": "Subscriptions", "description": "Manage subscriptions to notifications." }, { "name": "Transfers", "description": "Create transfers to another wallet or blockchain address, and get information on those transfers." }, { "name": "Wallets", "description": "Create digital wallets and get information on their activity." }, { "name": "Wires", "description": "Create, get instructions, and get information on bank accounts for wire transfers." }, { "name": "Checkout Sessions", "description": "Create, get, extend a checkout session." } ], "paths": { "/ping": { "get": { "summary": "Ping", "description": "Checks that the service is running.", "operationId": "ping", "tags": ["Health"], "responses": { "200": { "description": "Successful ping.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ping" }, "examples": { "response": { "value": { "message": "pong" } } } } } } } } }, "/v1/configuration": { "get": { "security": [ { "bearerAuth": [] } ], "summary": "Get configuration info", "description": "Retrieves general configuration information.", "operationId": "getAccountConfig", "tags": ["Management"], "responses": { "200": { "description": "Successfully retrieved configuration information.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "GetConfigResponse", "properties": { "data": { "$ref": "#/components/schemas/AccountConfiguration" } } }, "examples": { "response": { "value": { "data": { "payments": { "masterWalletId": "212000" } } } } } } } } } } }, "/v1/encryption/public": { "get": { "security": [ { "bearerAuth": [] } ], "summary": "Get public key", "description": "Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more.", "operationId": "getPublicKey", "tags": ["Encryption"], "responses": { "200": { "description": "Successfully retrieved the RSA public key.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "GetPublicKeyResponse", "properties": { "data": { "$ref": "#/components/schemas/PublicKey" } } }, "examples": { "response": { "value": { "data": { "keyId": "key1", "publicKey": "LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DSy0tLS0tClZlcnNpb246IEJDUEcgdjEuNTQKCm1RRU5CRjAxdmk0QkNBQ3JzMDNLS1Y0Qk9SRkYyT0Z4bUdvb0UyaTZMbnNneE5UL1dsV2s1ZTl2RDd2NENkSm0KcGJJbENmZ0U4WFlnYmhKUTE4YStaTzlPM0RFYUp2dGhJSEtjL0l1UEIvZmdEYUJUT285NkJzL2pVRFp6ZGxaVApQazNFUjliNFZPeGVwMFNPSHFMcmxTVFY4ZXB3M1R3SEdaL3NpSWdBYXEwRGdJdlZxUTY4TGVaMnorUFJWZm04CmhhSnJpb05SRU5Ja2ZNTWY5aFdySlowSW1zUk1aVmpDMVVrd2FSSHdrTTMwQUlia1dYcFJ5R205SXhQaXdGa08Kb1RnWlpwUFpsdVczckdkWER0NHZqL24za09hczV1dFdoNFovMlhjWHBiSUUyU0FPK0hycUdIclRnK1ZmZ05JNwpZcVZqYW5MOEN1bm83UkxmcDhKZlZDNXBLUm5ySVNCTnphN1ZBQkVCQUFHMEJrTnBjbU5zWllrQkhBUVFBUWtBCkJnVUNYVFcrTGdBS0NSQ3EzaHNwWjBMeGEwdnpCLzQvQTJpdk1CWW1aZXV2bEJZMm5ZZnNXek9Sb28vU3BIYkQKY2Y0UmtxZzZ0RERJSkUzNHhDVit0MzJydmJkM0ZOdVZseWs1MDVZRkpESnI4cVc2S0tkQVRXdU16eW5mMVVoUAo1M25hTlc0cXdrdSt3b0RWWjJpci9lUVI1WUc4L0RGcnd3bXdaa0dRd0Ftc3h5ZHd5anBnLzBrQ3lpZHkxdVBkCmVVWGgwdWt4dS9Dais4UFl5cHcwdit5V2tzbjdSZ2dVbkJFMWhiQ2pEV3FweHZjMEpDNVAxdmx6L2xRcWQrR3oKRC9Td1FJTVdRVElnV3BHRVVvQTRDc3drbU5PdHhsRVF1U0tueXNtTG02S0ExUmRhTzd6V2IrdWNLN21FZ2VoSwpXU2hHZExqRVNNZlVRUTczemNqMXg2amxLUFNhRlJyLzhXcHhrVXYzVHYvQzZMb0JpejRLCj1WSWg3Ci0tLS0tRU5EIFBHUCBQVUJMSUMgS0VZIEJMT0NLLS0tLS0K" } } } } } } } } } }, "/v1/notifications/subscriptions": { "post": { "security": [ { "bearerAuth": [] } ], "summary": "Create a notification subscription", "description": "Subscribe to receiving notifications at a given endpoint. The endpoint should be able to handle AWS SNS subscription requests. For more details see https://docs.aws.amazon.com/mobile/sdkforxamarin/developerguide/sns-send-http.html. Note, the sandbox environment allows a maximum of 3 active subscriptions; otherwise, this is limited to 1 active subscription and subsequent create requests will be rejected with a Limit Exceeded error.\n", "operationId": "createSubscription", "tags": ["Subscriptions"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRequest" } } } }, "responses": { "200": { "description": "Successfully created a notification subscription.", "content": { "application/json": { "schema": { "title": "CreateSubscriptionResponse", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "examples": { "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "endpoint": "https://example.org/handler/for/notifications", "subscriptionDetails": [ { "url": "arn:aws:sns:us-east-1:<...>:fcb4a2c9-9c4f-4706-b312-6b22650f5d17", "status": "confirmed" } ] } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/NotAuthorized" }, "429": { "$ref": "#/components/responses/LimitExceeded" } } }, "get": { "security": [ { "bearerAuth": [] } ], "summary": "List all notification subscriptions", "description": "Retrieve a list of existing notification subscriptions with details.", "parameters": [], "operationId": "listSubscriptions", "tags": ["Subscriptions"], "responses": { "200": { "description": "Successfully retrieved a list of notification subscriptions.", "content": { "application/json": { "schema": { "title": "ListSubscriptionsResponse", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "examples": { "response": { "value": { "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "endpoint": "https://example.org/handler/for/notifications", "subscriptionDetails": [ { "url": "arn:aws:sns:us-east-1:<...>:fcb4a2c9-9c4f-4706-b312-6b22650f5d17", "status": "confirmed" } ] } ] } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, "/v1/notifications/subscriptions/{id}": { "delete": { "parameters": [ { "$ref": "#/components/parameters/IdPath" } ], "security": [ { "bearerAuth": [] } ], "summary": "Remove a notification subscription", "description": "To remove a subscription, all its subscription requests' statuses must be either 'confirmed', 'deleted' or a combination of those. A subscription with at least one 'pending' subscription request cannot be removed.", "operationId": "deleteSubscription", "tags": ["Subscriptions"], "responses": { "200": { "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "description": "Successfully removed a subscription.", "content": { "application/json": { "schema": { "title": "DeleteSubscriptionResponse", "properties": { "data": { "$ref": "#/components/schemas/UnsubscribeResponse" } } }, "examples": { "response": { "value": { "data": {} } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/NotAuthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/v1/channels": { "get": { "security": [ { "bearerAuth": [] } ], "summary": "List all channels", "description": "Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.).", "parameters": [], "operationId": "listChannels", "tags": ["Channels"], "responses": { "200": { "description": "Successfully retrieved a list of channels.", "content": { "application/json": { "schema": { "title": "ListChannelsResponse", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelResponse" } } } }, "examples": { "response": { "value": { "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "default": true, "cardDescriptor": "CIRCLE LLC.", "achDescriptor": "CIRCLE LLC." } ] } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, "/v1/stablecoins": { "get": { "summary": "List all stablecoins", "description": "Retrieves total circulating supply for supported stablecoins across all chains. This endpoint is rate limited to one call per minute (based on IP).", "operationId": "listStablecoins", "tags": ["Stablecoins"], "responses": { "200": { "description": "Successfully retrieved all stablecoin supplies across all chains.", "content": { "application/json": { "schema": { "title": "ListStablecoinsResponse", "properties": { "data": { "$ref": "#/components/schemas/Stablecoins" } } }, "examples": { "response": { "value": { "data": [ { "name": "USD Coin", "symbol": "USDC", "totalAmount": "132.584192", "chains": [ { "amount": "132.584192", "chain": "ALGO" } ] } ] } } } } } }, "429": { "$ref": "#/components/responses/LimitExceeded" } } } }, "/v1/businessAccount/balances": { "get": { "security": [ { "bearerAuth": [] } ], "summary": "List all balances", "description": "Retrieves the balance of funds that are available for use.", "operationId": "listBusinessBalances", "tags": ["Balances"], "responses": { "200": { "description": "Successfully retrieved balances.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "ListBusinessBalancesResponse", "properties": { "data": { "$ref": "#/components/schemas/Balances" } } }, "examples": { "response": { "value": { "data": { "available": [ { "amount": "3.14", "currency": "USD" } ], "unsettled": [ { "amount": "3.14", "currency": "USD" } ] } } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, "/v1/balances": { "get": { "security": [ { "bearerAuth": [] } ], "summary": "List all balances", "description": "Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled.", "operationId": "listBalances", "tags": ["Balances"], "responses": { "200": { "description": "Successfully retrieved balances.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "ListBalancesResponse", "properties": { "data": { "$ref": "#/components/schemas/Balances" } } }, "examples": { "response": { "value": { "data": { "available": [ { "amount": "3.14", "currency": "USD" } ], "unsettled": [ { "amount": "3.14", "currency": "USD" } ] } } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, "/v1/cards": { "post": { "security": [ { "bearerAuth": [] } ], "summary": "Create a card", "operationId": "createCard", "tags": ["Cards"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCreationRequest" } } } }, "responses": { "201": { "description": "Successfully created a card.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "CreateCardResponse", "properties": { "data": { "$ref": "#/components/schemas/Card" } } }, "examples": { "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "MA", "postalCode": "01234" }, "expMonth": 1, "expYear": 2020, "network": "VISA", "last4": "0123", "bin": "401230", "issuerCountry": "US", "fundingType": "credit", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "errorCode": "verification_failed", "verification": { "avs": "D", "cvv": "not_requested" }, "riskEvaluation": { "decision": "approved", "reason": "3000" }, "metadata": { "email": "satoshi@circle.com", "phoneNumber": "+14155555555" }, "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 cards", "operationId": "listCards", "tags": ["Cards"], "parameters": [ { "$ref": "#/components/parameters/PageBefore" }, { "$ref": "#/components/parameters/PageAfter" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "description": "Successfully retrieved a list of cards.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "ListCardsResponse", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleCard" } } } }, "examples": { "response": { "value": { "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "billingDetails": { "country": "US", "district": "MA" }, "expMonth": 1, "expYear": 2020, "network": "VISA", "bin": "401230", "issuerCountry": "US", "fundingType": "credit", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "verification": { "avs": "D", "cvv": "not_requested" }, "riskEvaluation": { "decision": "approved", "reason": "3000" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } ] } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, "/v1/cards/{id}": { "get": { "parameters": [ { "$ref": "#/components/parameters/IdPath" } ], "security": [ { "bearerAuth": [] } ], "summary": "Get a card", "operationId": "getCard", "tags": ["Cards"], "responses": { "200": { "description": "Successfully retrieved a card.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "GetCardResponse", "properties": { "data": { "$ref": "#/components/schemas/Card" } } }, "examples": { "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "MA", "postalCode": "01234" }, "expMonth": 1, "expYear": 2020, "network": "VISA", "last4": "0123", "bin": "401230", "issuerCountry": "US", "fundingType": "credit", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "errorCode": "verification_failed", "verification": { "avs": "D", "cvv": "not_requested" }, "riskEvaluation": { "decision": "approved", "reason": "3000" }, "metadata": { "email": "satoshi@circle.com", "phoneNumber": "+14155555555" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "parameters": [ { "$ref": "#/components/parameters/IdPath" } ], "security": [ { "bearerAuth": [] } ], "summary": "Update a card", "operationId": "updateCard", "tags": ["Cards"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardUpdate" } } } }, "responses": { "200": { "description": "Succesfully modified a card.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "UpdateCardResponse", "properties": { "data": { "$ref": "#/components/schemas/Card" } } }, "examples": { "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "MA", "postalCode": "01234" }, "expMonth": 1, "expYear": 2020, "network": "VISA", "last4": "0123", "bin": "401230", "issuerCountry": "US", "fundingType": "credit", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "errorCode": "verification_failed", "verification": { "avs": "D", "cvv": "not_requested" }, "riskEvaluation": { "decision": "approved", "reason": "3000" }, "metadata": { "email": "satoshi@circle.com", "phoneNumber": "+14155555555" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } } } } } } } } } }, "/v1/paymentTokens": { "post": { "security": [ { "bearerAuth": [] } ], "summary": "Create a payment token", "description": "Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token.", "operationId": "createPaymentToken", "tags": ["Payment Tokens"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTokenRequest" } } } }, "responses": { "201": { "description": "Successfully converted a digital token to a Circle token account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "CreatePaymentTokenResponse", "properties": { "data": { "$ref": "#/components/schemas/PaymentToken" } } }, "examples": { "response": { "value": { "data": { "id": "gc988ed5-c189-4f70-a074-e5beb7eb8e32", "type": "applepay", "expiresOn": "2022-01-18T19:20:00Z", "cardDetails": { "expMonth": 1, "expYear": 2020, "network": "VISA", "last4": "0123", "bin": "401230", "fundingType": "credit", "issuerCountry": "US" }, "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/banks/wires": { "post": { "security": [ { "bearerAuth": [] } ], "summary": "Create a Wire bank account", "operationId": "createBusinessWireAccount", "tags": ["Wires"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WireCreationRequest" } } } }, "responses": { "201": { "description": "Successfully created a bank account for wire transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "CreateBusinessWireAccountResponse", "properties": { "data": { "$ref": "#/components/schemas/Wire" } } }, "examples": { "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "description": "WELLS FARGO BANK, NA ****0010", "trackingRef": "CIR13FB13A", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "MA", "postalCode": "01234" }, "bankAddress": { "bankName": "SAN FRANCISCO", "city": "SAN FRANCISCO", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "CA" }, "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 Wire bank accounts", "operationId": "listBusinessWireAccounts", "tags": ["Wires"], "responses": { "200": { "description": "Successfully retrieved a list of bank accounts.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "ListBusinessWireAccountsResponse", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Wire" } } } }, "examples": { "response": { "value": { "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "description": "WELLS FARGO BANK, NA ****0010", "trackingRef": "CIR13FB13A", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "MA", "postalCode": "01234" }, "bankAddress": { "bankName": "SAN FRANCISCO", "city": "SAN FRANCISCO", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "CA" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } ] } } } } } }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, "/v1/businessAccount/banks/wires/{id}": { "get": { "parameters": [ { "$ref": "#/components/parameters/IdPath" } ], "security": [ { "bearerAuth": [] } ], "summary": "Get a Wire bank account", "operationId": "getBusinessWireAccount", "tags": ["Wires"], "responses": { "200": { "description": "Successfully retrieved a bank account for wire transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "GetBusinessWireAccountResponse", "properties": { "data": { "$ref": "#/components/schemas/Wire" } } }, "examples": { "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", "description": "WELLS FARGO BANK, NA ****0010", "trackingRef": "CIR13FB13A", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "MA", "postalCode": "01234" }, "bankAddress": { "bankName": "SAN FRANCISCO", "city": "SAN FRANCISCO", "country": "US", "line1": "100 Money Street", "line2": "Suite 1", "district": "CA" }, "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/wires/{id}/instructions": { "get": { "parameters": [ { "$ref": "#/components/parameters/IdPath" }, { "$ref": "#/components/parameters/Currency" } ], "security": [ { "bearerAuth": [] } ], "summary": "Get Wire instructions", "description": "Get the wire transfer instructions into the Circle bank account given your bank account id.", "operationId": "getBusinessWireAccountInstructions", "tags": ["Wires"], "responses": { "200": { "description": "Successfully retrieved wire transfer instructions for the bank account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "title": "GetBusinessWireAccountInstructionsResponse", "properties": { "data": { "$ref": "#/components/schemas/WireInstruction" } } }, "examples": { "response": { "value": { "data": { "trackingRef": "CIR13FB13A", "beneficiary": { "name": "CIRCLE INTERNET FINANCIAL INC", "address1": "99 HIGH STREET", "address2": "BOSTON MA 02110" }, "beneficiaryBank": { "name": "SILVERGATE BANK", "swiftCode": "SIVGUS66XXX", "routingNumber": "322286803", "accountNumber": "****7427", "currency": "USD", "address": "4250 EXECUTIVE SQUARE SUITE 300", "city": "LA JOLLA", "postalCode": "02110", "country": "US" } } } } } } } }, "401": { "$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", "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", "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": "CIR