diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 27f9cd3..227cea2 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -1.8.0 +2.0.0 diff --git a/sdk.json b/sdk.json index 73d9e33..9d448d6 100644 --- a/sdk.json +++ b/sdk.json @@ -6,15 +6,11 @@ } ], "info": { - "version": "1.8.0", + "version": "2.0.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": "ACH", - "description": "Link and get information on bank account for ACH payments." - }, { "name": "Addresses", "description": "Generate and get information on blockchain addresses." @@ -77,32 +73,12 @@ }, { "name": "Payouts", - "description": "Create and get information on wire, ACH, SEPA and address book payouts." - }, - { - "name": "Returns", - "description": "Get information on returned payouts." - }, - { - "name": "Reversals", - "description": "Get information on ACH reversals." - }, - { - "name": "SEN", - "description": "Create and get information on SEN accounts." - }, - { - "name": "SEPA", - "description": "Create and get information on SEPA accounts." + "description": "Create and get information on address book payouts." }, { "name": "Settlements", "description": "Get information on settlement batches." }, - { - "name": "Signet", - "description": "Create and get information on Signet accounts." - }, { "name": "CBIT", "description": "Create and get information on CBIT accounts." @@ -1362,28 +1338,28 @@ } } }, - "/v1/banks/wires": { + "/v1/businessAccount/banks/cbit": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a Wire bank account", - "operationId": "createWireAccount", - "tags": ["Wires"], + "summary": "Create a CBIT bank account", + "operationId": "createBusinessCbitAccount", + "tags": ["CBIT"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WireCreationRequest" + "$ref": "#/components/schemas/CbitFiatAccountCreationRequest" } } } }, "responses": { "201": { - "description": "Successfully created a bank account for wire transfers.", + "description": "Successfully created a bank account for CBIT transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1392,10 +1368,10 @@ "content": { "application/json": { "schema": { - "title": "CreateWireAccountResponse", + "title": "CreateBusinessCbitAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/Wire" + "$ref": "#/components/schemas/CbitFiatAccountResponse" } } }, @@ -1405,26 +1381,8 @@ "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" - }, + "trackingRef": "CIR25XSXT8", + "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1441,9 +1399,63 @@ "$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/banks/wires/{id}": { + "/v1/businessAccount/banks/cbit/{id}": { "get": { "parameters": [ { @@ -1455,12 +1467,12 @@ "bearerAuth": [] } ], - "summary": "Get a Wire bank account", - "operationId": "getWireAccount", - "tags": ["Wires"], + "summary": "Get a CBIT bank account", + "operationId": "getBusinessCbitAccount", + "tags": ["CBIT"], "responses": { "200": { - "description": "Successfully retrieved a bank account for wire transfers.", + "description": "Successfully retrieved a bank account for CBIT transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1469,10 +1481,10 @@ "content": { "application/json": { "schema": { - "title": "GetWireAccountResponse", + "title": "GetBusinessCbitAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/Wire" + "$ref": "#/components/schemas/CbitFiatAccountResponse" } } }, @@ -1482,26 +1494,8 @@ "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" - }, + "trackingRef": "CIR25XSXT8", + "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1520,7 +1514,7 @@ } } }, - "/v1/banks/wires/{id}/instructions": { + "/v1/businessAccount/banks/cbit/{id}/instructions": { "get": { "parameters": [ { @@ -1532,13 +1526,13 @@ "bearerAuth": [] } ], - "summary": "Get Wire instructions", - "description": "Get the wire transfer instructions into the Circle bank account given your bank account id", - "operationId": "getWireAccountInstructions", - "tags": ["Wires"], + "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 wire transfer instructions for the bank account.", + "description": "Successfully retrieved CBIT transfer instructions for the bank account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1547,10 +1541,10 @@ "content": { "application/json": { "schema": { - "title": "GetWireAccountInstructionsResponse", + "title": "ListBusinessCbitAccountInstructionsResponse", "properties": { "data": { - "$ref": "#/components/schemas/WireInstruction" + "$ref": "#/components/schemas/CbitInstruction" } } }, @@ -1558,23 +1552,8 @@ "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" - } + "trackingRef": "CIR25XSXT8", + "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" } } } @@ -1591,28 +1570,29 @@ } } }, - "/v1/businessAccount/banks/sen": { + "/v1/businessAccount/wallets/addresses/deposit": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a Silvergate SEN bank account (BETA)", - "operationId": "createBusinessSenAccount", - "tags": ["SEN"], + "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", + "operationId": "createBusinessDepositAddress", + "tags": ["Addresses"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SenFiatAccountCreationRequest" + "$ref": "#/components/schemas/BusinessGenerateAddressRequest" } } } }, "responses": { "201": { - "description": "Successfully created a bank account for Silvergate SEN transfers.", + "description": "Successfully generated a new deposit address.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1621,10 +1601,10 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessSenAccountResponse", + "title": "CreateBusinessDepositAddressResponse", "properties": { "data": { - "$ref": "#/components/schemas/SenFiatAccountResponse" + "$ref": "#/components/schemas/AddressObject" } } }, @@ -1632,13 +1612,10 @@ "response": { "value": { "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "SILVERGATE BANK ****1111", - "trackingRef": "CIR13FB14A", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z", - "currency": "USD" + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "currency": "USD", + "chain": "ALGO" } } } @@ -1660,12 +1637,12 @@ "bearerAuth": [] } ], - "summary": "List all Silvergate SEN bank accounts (BETA).", - "operationId": "listBusinessSenAccounts", - "tags": ["SEN"], + "summary": "List all deposit addresses", + "operationId": "getBusinessDepositAddress", + "tags": ["Addresses"], "responses": { "200": { - "description": "Successfully retrieved all bank accounts for Silvergate SEN transfers.", + "description": "Successfully retrieved a list of deposit addresses.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1674,12 +1651,12 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessSenAccountsResponse", + "title": "GetBusinessDepositAddressResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SenFiatAccountResponse" + "$ref": "#/components/schemas/AddressObject" } } } @@ -1689,13 +1666,10 @@ "value": { "data": [ { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "SILVERGATE BANK ****1111", - "trackingRef": "CIR13FB14A", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z", - "currency": "USD" + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "currency": "USD", + "chain": "ALGO" } ] } @@ -1710,24 +1684,29 @@ } } }, - "/v1/businessAccount/banks/sen/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], + "/v1/businessAccount/wallets/addresses/recipient": { + "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Get a Silvergate SEN bank account (BETA)", - "operationId": "getBusinessSenAccount", - "tags": ["SEN"], + "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", + "operationId": "createBusinessRecipientAddress", + "tags": ["Addresses"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BusinessRecipientAddressCreationRequest" + } + } + } + }, "responses": { "200": { - "description": "Successfully retrieved a bank account for Silvergate SEN transfers.", + "description": "Successfully added a recipient address.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1736,10 +1715,10 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessSenAccountResponse", + "title": "CreateBusinessRecipientAddressResponse", "properties": { "data": { - "$ref": "#/components/schemas/SenFiatAccountResponse" + "$ref": "#/components/schemas/BusinessRecipientAddressObject" } } }, @@ -1748,12 +1727,11 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "SILVERGATE BANK ****1111", - "trackingRef": "CIR13FB14A", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z", - "currency": "USD" + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "chain": "ALGO", + "currency": "USD", + "description": "My USDC address at a cryptocurrency exchange" } } } @@ -1761,94 +1739,44 @@ } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/businessAccount/banks/sen/{id}/instructions": { + }, "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], "security": [ { "bearerAuth": [] } ], - "summary": "Get Silvergate SEN instructions (BETA)", - "description": "Get the Silvergate SEN transfer instructions into the Circle bank account given your bank account id (BETA).", - "operationId": "getBusinessSenAccountInstructions", - "tags": ["SEN"], - "responses": { - "200": { - "description": "Successfully retrieved Sen transfer instructions for the bank account.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetBusinessSenAccountInstructionsResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/SenInstruction" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "trackingRef": "CIR13FB14A", - "accountNumber": "11111111", - "currency": "USD" - } - } - } - } - } - } + "parameters": [ + { + "$ref": "#/components/parameters/From" }, - "401": { - "$ref": "#/components/responses/NotAuthorized" + { + "$ref": "#/components/parameters/To" }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/banks/ach": { - "post": { - "security": [ { - "bearerAuth": [] + "$ref": "#/components/parameters/PageBefore" + }, + { + "$ref": "#/components/parameters/PageAfter" + }, + { + "$ref": "#/components/parameters/PageSize" } ], - "summary": "Create a ACH bank account", - "operationId": "createAchAccount", - "tags": ["ACH"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AchCreationRequest" - } - } - } - }, + "summary": "List all recipient addresses", + "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response.\n", + "operationId": "listBusinessRecipientAddresses", + "tags": ["Addresses"], "responses": { - "201": { - "description": "Successfully created a bank account for ACH transfers.", + "200": { + "description": "Successfully retrieved a list of recipient addresses.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1857,85 +1785,81 @@ "content": { "application/json": { "schema": { - "title": "CreateAchAccountResponse", + "title": "listBusinessRecipientAddressesResponse", "properties": { "data": { - "$ref": "#/components/schemas/Ach" + "type": "array", + "items": { + "$ref": "#/components/schemas/BusinessRecipientAddressObject" + } } } }, "examples": { "response": { "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "accountNumber": "****6789", - "routingNumber": "613334455", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" - }, - "bankAccountType": "retail", - "bankAddress": { - "bankName": "SAN FRANCISCO", - "city": "SAN FRANCISCO", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "CA" - }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "errorCode": "bank_account_authorization_expired", - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z", - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" + "data": [ + { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "chain": "ALGO", + "currency": "USD", + "description": "My USDC address at a cryptocurrency exchange" } - } + ] } } } } } }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, "401": { "$ref": "#/components/responses/NotAuthorized" } } } }, - "/v1/banks/ach/{id}": { + "/v1/businessAccount/deposits": { "get": { - "parameters": [ + "security": [ { - "$ref": "#/components/parameters/IdPath" + "bearerAuth": [] } ], - "security": [ + "parameters": [ { - "bearerAuth": [] + "name": "type", + "description": "Unique identifier for the deposit type. Filters results to fetch deposits made by this specific type.", + "in": "query", + "schema": { + "type": "string", + "enum": ["wire"] + } + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/PageBefore" + }, + { + "$ref": "#/components/parameters/PageAfter" + }, + { + "$ref": "#/components/parameters/PageSize" } ], - "summary": "Get a ACH bank account", - "operationId": "getAchAccount", - "tags": ["ACH"], + "summary": "List all deposits", + "description": "Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided.", + "operationId": "listBusinessDeposits", + "tags": ["Deposits"], "responses": { "200": { - "description": "Successfully retrieved a bank account for ACH transfers.", + "description": "Successfully retrieved a list of deposits.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1944,52 +1868,44 @@ "content": { "application/json": { "schema": { - "title": "GetAchAccountResponse", + "title": "ListBusinessDepositsResponse", "properties": { "data": { - "$ref": "#/components/schemas/Ach" + "type": "array", + "items": { + "$ref": "#/components/schemas/BusinessDeposit" + } } } }, "examples": { "response": { "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "accountNumber": "****6789", - "routingNumber": "613334455", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" - }, - "bankAccountType": "retail", - "bankAddress": { - "bankName": "SAN FRANCISCO", - "city": "SAN FRANCISCO", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "CA" - }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "errorCode": "bank_account_authorization_expired", - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z", - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" + "data": [ + { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "sourceWalletId": "9b57048d-2365-4ff5-956b-0199170d1035", + "destination": { + "type": "wallet", + "id": "12345" + }, + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "fee": { + "amount": "3.14", + "currency": "USD" + }, + "status": "pending", + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" } - } + ] } } } @@ -1998,35 +1914,40 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } } }, - "/v1/banks/sepa": { + "/v1/paymentIntents": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a SEPA bank account", - "operationId": "createSepaAccount", - "tags": ["SEPA"], + "summary": "Create a payment intent", + "description": "Create a transient or continuous payment intent", + "operationId": "createPaymentIntent", + "tags": ["Crypto Payment Intents"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SepaCreationRequest" + "oneOf": [ + { + "$ref": "#/components/schemas/PaymentIntentCreationRequest" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntentCreationRequest" + } + ] } } } }, "responses": { "201": { - "description": "Successfully created a bank account for SEPA transfers.", + "description": "Successfully created a payment intent.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2035,110 +1956,77 @@ "content": { "application/json": { "schema": { - "title": "CreateSepaAccountResponse", + "title": "CreatePaymentIntentResponse", "properties": { "data": { - "$ref": "#/components/schemas/Sepa" + "oneOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, "examples": { - "response": { + "Transient Payment Intent": { "value": { "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "Bank of Ireland ****0010", - "trackingRef": "CIR13FB13A", - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "riskEvaluation": { - "decision": "approved", - "reason": "3000" + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "amount": { + "amount": "3.14", + "currency": "USD" }, - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" + "amountPaid": { + "amount": "0.00", + "currency": "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" - } - } - } - }, - "/v1/banks/sepa/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a SEPA bank account", - "operationId": "getSepaAccount", - "tags": ["SEPA"], - "responses": { - "200": { - "description": "Successfully retrieved a bank account for SEPA transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetSepaAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/Sepa" + "settlementCurrency": "USD", + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "paymentIds": [], + "timeline": [ + { + "status": "created", + "time": "2022-07-21T20:13:35.579331Z" + } + ], + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" + } } - } - }, - "examples": { - "response": { + }, + "Continuous Payment Intent": { "value": { "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "Bank of Ireland ****0010", - "trackingRef": "CIR13FB13A", - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" + "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", + "currency": "USD", + "settlementCurrency": "USD", + "amountPaid": { + "amount": "0.00", + "currency": "USD" }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "timeline": [ + { + "status": "created", + "time": "2023-01-21T20:13:35.579331Z" + } + ], + "type": "continuous", + "createDate": "2023-01-21T20:13:35.578678Z", + "updateDate": "2023-01-21T20:13:35.578678Z" } } } @@ -2146,34 +2034,69 @@ } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, "404": { "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/banks/sepa/{id}/instructions": { + }, "get": { - "parameters": [ + "security": [ { - "$ref": "#/components/parameters/IdPath" + "bearerAuth": [] } ], - "security": [ + "summary": "List all payment intents", + "operationId": "listPaymentIntents", + "tags": ["Crypto Payment Intents"], + "parameters": [ { - "bearerAuth": [] + "name": "status", + "description": "Filters by the most recent `timeline.status` within the payment intent.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "pending", "complete", "expired", "failed"] + } + }, + { + "name": "context", + "description": "Filters by the most recent `timeline.context` within the payment intent.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["underpaid", "paid", "overpaid"] + } + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/PageBefore" + }, + { + "$ref": "#/components/parameters/PageAfter" + }, + { + "$ref": "#/components/parameters/PageSize" } ], - "summary": "Get SEPA instructions", - "description": "Get the SEPA transfer instructions into the Circle bank account given your bank account id.", - "operationId": "getSepaAccountInstructions", - "tags": ["SEPA"], "responses": { "200": { - "description": "Successfully retrieved SEPA transfer instructions for the bank account.", + "description": "Successfully retrieved a list of payment intents.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2182,33 +2105,85 @@ "content": { "application/json": { "schema": { - "title": "GetSepaAccountInstructionsResponse", + "title": "ListPaymentIntentsResponse", "properties": { "data": { - "$ref": "#/components/schemas/SepaInstruction" + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] + } } } }, "examples": { - "response": { + "Transient Payment Intent": { "value": { - "data": { - "trackingRef": "CIR13FB13A", - "beneficiary": { - "name": "CIRCLE INTERNET FINANCIAL INC", - "address1": "99 HIGH STREET", - "address2": "BOSTON MA 02110" - }, - "beneficiaryBank": { - "name": "LHV Bank", - "bic": "LHVBEE22XXX", - "iban": "****6789", - "address": "Tartu mnt 2, 10145 Tallinn", - "city": "Tallinn", - "postalCode": "10017", - "country": "EE" + "data": [ + { + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "settlementCurrency": "USD", + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "paymentIds": [], + "timeline": [ + { + "status": "created", + "time": "2022-07-21T20:13:35.579331Z" + } + ], + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" } - } + ] + } + }, + "Continuous Payment Intent": { + "value": { + "data": [ + { + "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", + "currency": "USD", + "settlementCurrency": "USD", + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "timeline": [ + { + "status": "created", + "time": "2023-01-21T20:13:35.579331Z" + } + ], + "type": "continuous", + "createDate": "2023-01-21T20:13:35.578678Z", + "updateDate": "2023-01-21T20:13:35.578678Z" + } + ] } } } @@ -2217,35 +2192,28 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } } }, - "/v1/businessAccount/banks/signet": { - "post": { + "/v1/paymentIntents/{id}": { + "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a Signet bank account (Production Only)", - "operationId": "createBusinessSignetAccount", - "tags": ["Signet"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SignetFiatAccountCreationRequest" - } - } + "summary": "Get a payment intent", + "operationId": "getPaymentIntent", + "tags": ["Crypto Payment Intents"], + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" } - }, + ], "responses": { - "201": { - "description": "Successfully created a bank account for Signet transfers.", + "200": { + "description": "Successfully retrieved a payment intent.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2254,23 +2222,77 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessSignetAccountResponse", + "title": "GetPaymentIntentResponse", "properties": { "data": { - "$ref": "#/components/schemas/SignetFiatAccountResponse" + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, "examples": { - "response": { + "Transient Payment Intent": { "value": { "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR13FB14A", - "walletAddress": "0xcac04f0069e4ac9314ac4e608e99278a3bebabcd", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "settlementCurrency": "USD", + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "paymentIds": [], + "timeline": [ + { + "status": "created", + "time": "2022-07-21T20:13:35.579331Z" + } + ], + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" + } + } + }, + "Continuous Payment Intent": { + "value": { + "data": { + "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", + "currency": "USD", + "settlementCurrency": "USD", + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "timeline": [ + { + "status": "created", + "time": "2023-01-21T20:13:35.579331Z" + } + ], + "type": "continuous", + "createDate": "2023-01-21T20:13:35.578678Z", + "updateDate": "2023-01-21T20:13:35.578678Z" } } } @@ -2278,26 +2300,42 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } - }, - "get": { + } + }, + "/v1/paymentIntents/{id}/expire": { + "post": { "security": [ { "bearerAuth": [] } ], - "summary": "List all Signet bank accounts (Production Only).", - "operationId": "listBusinessSignetAccounts", - "tags": ["Signet"], + "summary": "Expire a payment intent", + "operationId": "expirePaymentIntent", + "tags": ["Crypto Payment Intents"], + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, "responses": { - "200": { - "description": "Successfully retrieved all bank accounts for Signet transfers.", + "201": { + "description": "Successfully expired a payment intent.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2306,59 +2344,123 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessSignetAccountsResponse", + "title": "ExpirePaymentIntentResponse", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SignetFiatAccountResponse" - } + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, "examples": { - "response": { + "Transient Payment Intent": { "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "trackingRef": "CIR13FB14A", - "walletAddress": "0xcac04f0069e4ac9314ac4e608e99278a3bebabcd", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - ] + "data": { + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "settlementCurrency": "USD", + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "paymentIds": [], + "timeline": [ + { + "status": "created", + "time": "2022-07-21T20:13:35.579331Z" + } + ], + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" + } + } + }, + "Continuous Payment Intent": { + "value": { + "data": { + "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", + "currency": "USD", + "settlementCurrency": "USD", + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "timeline": [ + { + "status": "created", + "time": "2023-01-21T20:13:35.579331Z" + } + ], + "type": "continuous", + "createDate": "2023-01-21T20:13:35.578678Z", + "updateDate": "2023-01-21T20:13:35.578678Z" + } } } } } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/businessAccount/banks/signet/{id}": { - "get": { - "parameters": [ + "/v1/paymentIntents/{id}/refund": { + "post": { + "security": [ { - "$ref": "#/components/parameters/IdPath" + "bearerAuth": [] } ], - "security": [ + "summary": "Refund a payment intent", + "operationId": "refundPaymentIntent", + "tags": ["Crypto Payment Intents"], + "parameters": [ { - "bearerAuth": [] + "$ref": "#/components/parameters/IdPath" } ], - "summary": "Get a Signet bank account (Production Only)", - "operationId": "getBusinessSignetAccount", - "tags": ["Signet"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CryptoRefundCreationRequest" + } + } + } + }, "responses": { - "200": { - "description": "Successfully retrieved a bank account for Signet transfers.", + "201": { + "description": "Crypto refund successfully created for the given payment intent.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2367,10 +2469,10 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessSignetAccountResponse", + "title": "CreateCryptoRefundResponse", "properties": { "data": { - "$ref": "#/components/schemas/SignetFiatAccountResponse" + "$ref": "#/components/schemas/CryptoPayment" } } }, @@ -2378,12 +2480,31 @@ "response": { "value": { "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "id": "3389f4ba-aafd-4eef-aaa2-3292df8f62e6", + "type": "refund", "status": "pending", - "trackingRef": "CIR13FB14A", - "walletAddress": "0xcac04f0069e4ac9314ac4e608e99278a3bebabcd", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "amount": { + "currency": "USD" + }, + "merchantId": "5ffea093-d210-44b4-a7ca-ad33b9498188", + "merchantWalletId": "1000999922", + "paymentIntentId": "77c91fe9-e603-4e7b-9672-1ef8ac502cf6", + "settlementAmount": { + "amount": "1.00", + "currency": "ETH" + }, + "fromAddresses": { + "chain": "ETH", + "addresses": [ + "0x0d4344cFF68F72A5B9Abded37CA5862941a62050" + ] + }, + "depositAddress": { + "chain": "ETH", + "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f" + }, + "createDate": "2022-07-21T20:16:35.092852Z", + "updateDate": "2022-07-21T20:19:24.719313Z" } } } @@ -2391,6 +2512,9 @@ } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" }, @@ -2400,25 +2524,28 @@ } } }, - "/v1/businessAccount/banks/signet/{id}/instructions": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], + "/v1/addressBook/recipients": { + "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Get Signet instructions (Production Only)", - "description": "Get the Signet transfer instructions into the Circle bank account given your bank account id (only available on Production now).", - "operationId": "getBusinessSignetAccountInstructions", - "tags": ["Signet"], + "summary": "Create a recipient", + "operationId": "createAddressBookRecipient", + "tags": ["Crypto Address Book"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddressBookRecipientRequest" + } + } + } + }, "responses": { - "200": { - "description": "Successfully retrieved Signet transfer instructions for the bank account.", + "201": { + "description": "Successfully created an address book recipient.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2427,10 +2554,10 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessSignetAccountInstructionsResponse", + "title": "CreateAddressBookRecipientResponse", "properties": { "data": { - "$ref": "#/components/schemas/SignetInstruction" + "$ref": "#/components/schemas/AddressBookRecipient" } } }, @@ -2438,8 +2565,17 @@ "response": { "value": { "data": { - "trackingRef": "CIR13FB14A", - "walletAddress": "0x7e4f4fe03243ac7b291ebaee90b2bb27025a1234" + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "chain": "ETH", + "address": "0x45bfcf1a6289a0b77b4d3f7d12005a05949fd8c3", + "metadata": { + "nickname": "sample nickname", + "email": "satoshi@circle.com", + "bns": "sample.circle" + }, + "status": "pending", + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" } } } @@ -2447,89 +2583,80 @@ } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/businessAccount/banks/cbit": { - "post": { + }, + "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a CBIT bank account", - "operationId": "createBusinessCbitAccount", - "tags": ["CBIT"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CbitFiatAccountCreationRequest" - } + "summary": "List all recipients", + "operationId": "listAddressBookRecipients", + "tags": ["Crypto Address Book"], + "parameters": [ + { + "name": "address", + "description": "Filters results to fetch only address book recipients with the provided address.", + "in": "query", + "required": false, + "schema": { + "type": "string" } - } - }, - "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" - } - } - } - } - } + }, + { + "name": "chain", + "description": "Filters results to fetch only address book recipients with the provided chain.", + "in": "query", + "required": false, + "schema": { + "type": "string" } }, - "400": { - "$ref": "#/components/responses/BadRequest" + { + "name": "email", + "description": "Filters results to fetch only address book recipients that have the provided email in their metadata.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - }, - "get": { - "security": [ { - "bearerAuth": [] + "name": "status", + "description": "Filters results to fetch only address book recipients that have the provided status.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["pending", "inactive", "active", "denied"] + } + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/PageBefore" + }, + { + "$ref": "#/components/parameters/PageAfter" + }, + { + "$ref": "#/components/parameters/PageSize" } ], - "summary": "List all CBIT bank accounts.", - "operationId": "listBusinessCbitAccounts", - "tags": ["CBIT"], "responses": { "200": { - "description": "Successfully retrieved all bank accounts for CBIT transfers.", + "description": "Successfully retrieved a list of address book recipients.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2538,12 +2665,12 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessCbitAccountsResponse", + "title": "ListAddressBookRecipientsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" + "$ref": "#/components/schemas/AddressBookRecipient" } } } @@ -2554,9 +2681,15 @@ "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "chain": "ALGO", + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "metadata": { + "nickname": "sample nickname", + "email": "satoshi@circle.com", + "bns": "sample.circle" + }, "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -2573,7 +2706,7 @@ } } }, - "/v1/businessAccount/banks/cbit/{id}": { + "/v1/addressBook/recipients/{id}": { "get": { "parameters": [ { @@ -2585,12 +2718,12 @@ "bearerAuth": [] } ], - "summary": "Get a CBIT bank account", - "operationId": "getBusinessCbitAccount", - "tags": ["CBIT"], + "summary": "Get a recipient", + "operationId": "getAddressBookRecipient", + "tags": ["Crypto Address Book"], "responses": { "200": { - "description": "Successfully retrieved a bank account for CBIT transfers.", + "description": "Successfully retrieved an address book recipient.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2599,10 +2732,10 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessCbitAccountResponse", + "title": "GetAddressBookRecipientResponse", "properties": { "data": { - "$ref": "#/components/schemas/CbitFiatAccountResponse" + "$ref": "#/components/schemas/AddressBookRecipient" } } }, @@ -2611,9 +2744,15 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "chain": "ALGO", + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "metadata": { + "nickname": "sample nickname", + "email": "satoshi@circle.com", + "bns": "sample.circle" + }, "status": "pending", - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -2630,10 +2769,8 @@ "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/businessAccount/banks/cbit/{id}/instructions": { - "get": { + }, + "patch": { "parameters": [ { "$ref": "#/components/parameters/IdPath" @@ -2644,13 +2781,21 @@ "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"], + "summary": "Modify a recipient", + "operationId": "modifyAddressBookRecipient", + "tags": ["Crypto Address Book"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddressBookRecipientModifyRequest" + } + } + } + }, "responses": { "200": { - "description": "Successfully retrieved CBIT transfer instructions for the bank account.", + "description": "Successfully updated the address book recipient.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2659,10 +2804,10 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessCbitAccountInstructionsResponse", + "title": "ModifyAddressBookRecipientResponse", "properties": { "data": { - "$ref": "#/components/schemas/CbitInstruction" + "$ref": "#/components/schemas/AddressBookRecipient" } } }, @@ -2670,8 +2815,17 @@ "response": { "value": { "data": { - "trackingRef": "CIR25XSXT8", - "walletAddress": "0x7d8da35e03ef3a5ec5d5edbb961ef399dfb42d1e" + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "chain": "ETH", + "address": "0x45bfcf1a6289a0b77b4d3f7d12005a05949fd8c3", + "metadata": { + "nickname": "sample nickname", + "email": "satoshi@circle.com", + "bns": "sample.circle" + }, + "status": "pending", + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" } } } @@ -2679,6 +2833,9 @@ } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" }, @@ -2686,145 +2843,64 @@ "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/businessAccount/wallets/addresses/deposit": { - "post": { + }, + "delete": { + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" + } + ], "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.\n", - "operationId": "createBusinessDepositAddress", - "tags": ["Addresses"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BusinessGenerateAddressRequest" - } - } - } - }, + "summary": "Delete a recipient", + "operationId": "deleteAddressBookRecipient", + "tags": ["Crypto Address Book"], "responses": { - "201": { - "description": "Successfully generated a new deposit address.", + "200": { "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, - "content": { - "application/json": { - "schema": { - "title": "CreateBusinessDepositAddressResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/AddressObject" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "currency": "USD", - "chain": "ALGO" - } - } - } - } - } - } + "description": "Successfully removed the address book recipient." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/NotAuthorized" - } - } - }, - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List all deposit addresses", - "operationId": "getBusinessDepositAddress", - "tags": ["Addresses"], - "responses": { - "200": { - "description": "Successfully retrieved a list of deposit addresses.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetBusinessDepositAddressResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AddressObject" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "currency": "USD", - "chain": "ALGO" - } - ] - } - } - } - } - } }, - "401": { - "$ref": "#/components/responses/NotAuthorized" + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/businessAccount/wallets/addresses/recipient": { + "/v1/payments": { "post": { "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.\n", - "operationId": "createBusinessRecipientAddress", - "tags": ["Addresses"], + "summary": "Create a payment", + "operationId": "createPayment", + "tags": ["Payments"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BusinessRecipientAddressCreationRequest" + "$ref": "#/components/schemas/PaymentCreationRequest" } } } }, "responses": { - "200": { - "description": "Successfully added a recipient address.", + "201": { + "description": "Successfully created a payment.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -2833,10 +2909,10 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessRecipientAddressResponse", + "title": "CreatePaymentResponse", "properties": { "data": { - "$ref": "#/components/schemas/BusinessRecipientAddressObject" + "$ref": "#/components/schemas/DetailedPayment" } } }, @@ -2845,11 +2921,145 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "chain": "ALGO", - "currency": "USD", - "description": "My USDC address at a cryptocurrency exchange" + "type": "payment", + "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", + "merchantWalletId": "212000", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "source": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "card" + }, + "description": "Payment", + "status": "pending", + "captured": false, + "captureAmount": { + "amount": "3.14", + "currency": "USD" + }, + "captureDate": "2020-04-10T02:13:30.000Z", + "requiredAction": { + "type": "three_d_secure_required", + "redirectUrl": "https://example.org" + }, + "verification": { + "avs": "D", + "cvv": "not_requested", + "threeDSecure": "pass", + "eci": "00" + }, + "cancel": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "cancel", + "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", + "merchantWalletId": "212000", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "source": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "card" + }, + "description": "Payment", + "status": "pending", + "originalPayment": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payment", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "description": "Payment", + "status": "pending", + "requiredAction": { + "type": "three_d_secure_required", + "redirectUrl": "https://example.org" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "createDate": "2020-04-10T02:13:30.000Z" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" + }, + "refunds": [ + { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "refund", + "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", + "merchantWalletId": "212000", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "source": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "card" + }, + "description": "Payment", + "status": "pending", + "originalPayment": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payment", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "description": "Payment", + "status": "pending", + "requiredAction": { + "type": "three_d_secure_required", + "redirectUrl": "https://example.org" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "createDate": "2020-04-10T02:13:30.000Z" + }, + "cancel": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "cancel", + "description": "Payment", + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" + } + ], + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "trackingRef": "24910599141085313498894", + "errorCode": "payment_failed", + "metadata": { + "email": "satoshi@circle.com", + "phoneNumber": "+14155555555" + }, + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" } } } @@ -2862,6 +3072,9 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } }, @@ -2872,6 +3085,21 @@ } ], "parameters": [ + { + "$ref": "#/components/parameters/Source" + }, + { + "$ref": "#/components/parameters/SettlementId" + }, + { + "$ref": "#/components/parameters/PaymentIntentId" + }, + { + "$ref": "#/components/parameters/PaymentSourceType" + }, + { + "$ref": "#/components/parameters/PaymentStatus" + }, { "$ref": "#/components/parameters/From" }, @@ -2888,1358 +3116,12 @@ "$ref": "#/components/parameters/PageSize" } ], - "summary": "List all recipient addresses", - "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response.\n", - "operationId": "listBusinessRecipientAddresses", - "tags": ["Addresses"], + "summary": "List all payments", + "operationId": "listPayments", + "tags": ["Payments"], "responses": { "200": { - "description": "Successfully retrieved a list of recipient addresses.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "listBusinessRecipientAddressesResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BusinessRecipientAddressObject" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "chain": "ALGO", - "currency": "USD", - "description": "My USDC address at a cryptocurrency exchange" - } - ] - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/businessAccount/deposits": { - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "parameters": [ - { - "name": "type", - "description": "Unique identifier for the deposit type. Filters results to fetch deposits made by this specific type.", - "in": "query", - "schema": { - "type": "string", - "enum": ["wire"] - } - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], - "summary": "List all deposits", - "description": "Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided.", - "operationId": "listBusinessDeposits", - "tags": ["Deposits"], - "responses": { - "200": { - "description": "Successfully retrieved a list of deposits.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListBusinessDepositsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BusinessDeposit" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "sourceWalletId": "9b57048d-2365-4ff5-956b-0199170d1035", - "destination": { - "type": "wallet", - "id": "12345" - }, - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "fee": { - "amount": "3.14", - "currency": "USD" - }, - "status": "pending", - "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/paymentIntents": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a payment intent", - "description": "Create a transient or continuous payment intent", - "operationId": "createPaymentIntent", - "tags": ["Crypto Payment Intents"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/PaymentIntentCreationRequest" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntentCreationRequest" - } - ] - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a payment intent.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreatePaymentIntentResponse", - "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } - } - }, - "examples": { - "Transient Payment Intent": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "settlementCurrency": "USD", - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "paymentIds": [], - "timeline": [ - { - "status": "created", - "time": "2022-07-21T20:13:35.579331Z" - } - ], - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } - } - }, - "Continuous Payment Intent": { - "value": { - "data": { - "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", - "currency": "USD", - "settlementCurrency": "USD", - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "timeline": [ - { - "status": "created", - "time": "2023-01-21T20:13:35.579331Z" - } - ], - "type": "continuous", - "createDate": "2023-01-21T20:13:35.578678Z", - "updateDate": "2023-01-21T20:13:35.578678Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - }, - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List all payment intents", - "operationId": "listPaymentIntents", - "tags": ["Crypto Payment Intents"], - "parameters": [ - { - "name": "status", - "description": "Filters by the most recent `timeline.status` within the payment intent.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": ["created", "pending", "complete", "expired", "failed"] - } - }, - { - "name": "context", - "description": "Filters by the most recent `timeline.context` within the payment intent.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": ["underpaid", "paid", "overpaid"] - } - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a list of payment intents.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListPaymentIntentsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } - } - } - }, - "examples": { - "Transient Payment Intent": { - "value": { - "data": [ - { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "settlementCurrency": "USD", - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "paymentIds": [], - "timeline": [ - { - "status": "created", - "time": "2022-07-21T20:13:35.579331Z" - } - ], - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } - ] - } - }, - "Continuous Payment Intent": { - "value": { - "data": [ - { - "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", - "currency": "USD", - "settlementCurrency": "USD", - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "timeline": [ - { - "status": "created", - "time": "2023-01-21T20:13:35.579331Z" - } - ], - "type": "continuous", - "createDate": "2023-01-21T20:13:35.578678Z", - "updateDate": "2023-01-21T20:13:35.578678Z" - } - ] - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/paymentIntents/{id}": { - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a payment intent", - "operationId": "getPaymentIntent", - "tags": ["Crypto Payment Intents"], - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a payment intent.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetPaymentIntentResponse", - "properties": { - "data": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } - } - }, - "examples": { - "Transient Payment Intent": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "settlementCurrency": "USD", - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "paymentIds": [], - "timeline": [ - { - "status": "created", - "time": "2022-07-21T20:13:35.579331Z" - } - ], - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } - } - }, - "Continuous Payment Intent": { - "value": { - "data": { - "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", - "currency": "USD", - "settlementCurrency": "USD", - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "timeline": [ - { - "status": "created", - "time": "2023-01-21T20:13:35.579331Z" - } - ], - "type": "continuous", - "createDate": "2023-01-21T20:13:35.578678Z", - "updateDate": "2023-01-21T20:13:35.578678Z" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/paymentIntents/{id}/expire": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Expire a payment intent", - "operationId": "expirePaymentIntent", - "tags": ["Crypto Payment Intents"], - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully expired a payment intent.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ExpirePaymentIntentResponse", - "properties": { - "data": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } - } - }, - "examples": { - "Transient Payment Intent": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "settlementCurrency": "USD", - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "paymentIds": [], - "timeline": [ - { - "status": "created", - "time": "2022-07-21T20:13:35.579331Z" - } - ], - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } - } - }, - "Continuous Payment Intent": { - "value": { - "data": { - "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", - "currency": "USD", - "settlementCurrency": "USD", - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "timeline": [ - { - "status": "created", - "time": "2023-01-21T20:13:35.579331Z" - } - ], - "type": "continuous", - "createDate": "2023-01-21T20:13:35.578678Z", - "updateDate": "2023-01-21T20:13:35.578678Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/paymentIntents/{id}/refund": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Refund a payment intent", - "operationId": "refundPaymentIntent", - "tags": ["Crypto Payment Intents"], - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CryptoRefundCreationRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Crypto refund successfully created for the given payment intent.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateCryptoRefundResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CryptoPayment" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "3389f4ba-aafd-4eef-aaa2-3292df8f62e6", - "type": "refund", - "status": "pending", - "amount": { - "currency": "USD" - }, - "merchantId": "5ffea093-d210-44b4-a7ca-ad33b9498188", - "merchantWalletId": "1000999922", - "paymentIntentId": "77c91fe9-e603-4e7b-9672-1ef8ac502cf6", - "settlementAmount": { - "amount": "1.00", - "currency": "ETH" - }, - "fromAddresses": { - "chain": "ETH", - "addresses": [ - "0x0d4344cFF68F72A5B9Abded37CA5862941a62050" - ] - }, - "depositAddress": { - "chain": "ETH", - "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f" - }, - "createDate": "2022-07-21T20:16:35.092852Z", - "updateDate": "2022-07-21T20:19:24.719313Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/addressBook/recipients": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a recipient", - "operationId": "createAddressBookRecipient", - "tags": ["Crypto Address Book"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddressBookRecipientRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created an address book recipient.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateAddressBookRecipientResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/AddressBookRecipient" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "chain": "ETH", - "address": "0x45bfcf1a6289a0b77b4d3f7d12005a05949fd8c3", - "metadata": { - "nickname": "sample nickname", - "email": "satoshi@circle.com", - "bns": "sample.circle" - }, - "status": "pending", - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - }, - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List all recipients", - "operationId": "listAddressBookRecipients", - "tags": ["Crypto Address Book"], - "parameters": [ - { - "name": "address", - "description": "Filters results to fetch only address book recipients with the provided address.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "chain", - "description": "Filters results to fetch only address book recipients with the provided chain.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "email", - "description": "Filters results to fetch only address book recipients that have the provided email in their metadata.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "Filters results to fetch only address book recipients that have the provided status.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": ["pending", "inactive", "active", "denied"] - } - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved a list of address book recipients.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListAddressBookRecipientsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AddressBookRecipient" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "chain": "ALGO", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "metadata": { - "nickname": "sample nickname", - "email": "satoshi@circle.com", - "bns": "sample.circle" - }, - "status": "pending", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - ] - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/addressBook/recipients/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a recipient", - "operationId": "getAddressBookRecipient", - "tags": ["Crypto Address Book"], - "responses": { - "200": { - "description": "Successfully retrieved an address book recipient.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetAddressBookRecipientResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/AddressBookRecipient" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "chain": "ALGO", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "metadata": { - "nickname": "sample nickname", - "email": "satoshi@circle.com", - "bns": "sample.circle" - }, - "status": "pending", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - }, - "patch": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Modify a recipient", - "operationId": "modifyAddressBookRecipient", - "tags": ["Crypto Address Book"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddressBookRecipientModifyRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Successfully updated the address book recipient.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ModifyAddressBookRecipientResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/AddressBookRecipient" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "chain": "ETH", - "address": "0x45bfcf1a6289a0b77b4d3f7d12005a05949fd8c3", - "metadata": { - "nickname": "sample nickname", - "email": "satoshi@circle.com", - "bns": "sample.circle" - }, - "status": "pending", - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a recipient", - "operationId": "deleteAddressBookRecipient", - "tags": ["Crypto Address Book"], - "responses": { - "200": { - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "description": "Successfully removed the address book recipient." - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/payments": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a payment", - "operationId": "createPayment", - "tags": ["Payments"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentCreationRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a payment.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreatePaymentResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/DetailedPayment" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, - "description": "Payment", - "status": "pending", - "captured": false, - "captureAmount": { - "amount": "3.14", - "currency": "USD" - }, - "captureDate": "2020-04-10T02:13:30.000Z", - "requiredAction": { - "type": "three_d_secure_required", - "redirectUrl": "https://example.org" - }, - "verification": { - "avs": "D", - "cvv": "not_requested", - "threeDSecure": "pass", - "eci": "00" - }, - "cancel": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "cancel", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, - "description": "Payment", - "status": "pending", - "originalPayment": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "description": "Payment", - "status": "pending", - "requiredAction": { - "type": "three_d_secure_required", - "redirectUrl": "https://example.org" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "createDate": "2020-04-10T02:13:30.000Z" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - }, - "refunds": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "refund", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, - "description": "Payment", - "status": "pending", - "originalPayment": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "description": "Payment", - "status": "pending", - "requiredAction": { - "type": "three_d_secure_required", - "redirectUrl": "https://example.org" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "createDate": "2020-04-10T02:13:30.000Z" - }, - "cancel": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "cancel", - "description": "Payment", - "status": "pending", - "createDate": "2020-04-10T02:13:30.000Z" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - ], - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "trackingRef": "24910599141085313498894", - "errorCode": "payment_failed", - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - }, - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "parameters": [ - { - "$ref": "#/components/parameters/Source" - }, - { - "$ref": "#/components/parameters/SettlementId" - }, - { - "$ref": "#/components/parameters/PaymentIntentId" - }, - { - "$ref": "#/components/parameters/PaymentSourceType" - }, - { - "$ref": "#/components/parameters/PaymentStatus" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], - "summary": "List all payments", - "operationId": "listPayments", - "tags": ["Payments"], - "responses": { - "200": { - "description": "Successfully retrieved a list of payments.", + "description": "Successfully retrieved a list of payments.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -4596,110 +3478,152 @@ { "$ref": "#/components/schemas/FiatPaymentPolymorphic" }, - { - "$ref": "#/components/schemas/CryptoPayment" - } - ] - } - } - }, - "examples": { - "Fiat Payment": { - "value": { - "data": { - "data": { + { + "$ref": "#/components/schemas/CryptoPayment" + } + ] + } + } + }, + "examples": { + "Fiat Payment": { + "value": { + "data": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payment", + "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", + "merchantWalletId": "212000", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "fromAmount": { + "amount": "3.14", + "currency": "EUR" + }, + "source": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "card" + }, + "description": "Payment", + "status": "pending", + "requiredAction": { + "type": "three_d_secure_required", + "redirectUrl": "https://example.org" + }, + "verification": { + "avs": "D", + "cvv": "not_requested", + "threeDSecure": "pass", + "eci": "00" + }, + "originalPayment": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payment", + "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", + "merchantWalletId": "212000", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "source": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "card" + }, + "description": "Payment", + "status": "pending", + "captured": false, + "captureAmount": { + "amount": "3.14", + "currency": "USD" + }, + "captureDate": "2020-04-10T02:13:30.000Z", + "requiredAction": { + "type": "three_d_secure_required", + "redirectUrl": "https://example.org" + }, + "cancel": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "cancel", + "description": "Payment", + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z" + }, + "refunds": [ + { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payment", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "description": "Payment", + "status": "pending", + "requiredAction": { + "type": "three_d_secure_required", + "redirectUrl": "https://example.org" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "createDate": "2020-04-10T02:13:30.000Z" + } + ], + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" + }, + "cancel": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", + "type": "cancel", "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", "merchantWalletId": "212000", "amount": { "amount": "3.14", "currency": "USD" }, - "fromAmount": { - "amount": "3.14", - "currency": "EUR" - }, "source": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "type": "card" }, "description": "Payment", "status": "pending", - "requiredAction": { - "type": "three_d_secure_required", - "redirectUrl": "https://example.org" - }, - "verification": { - "avs": "D", - "cvv": "not_requested", - "threeDSecure": "pass", - "eci": "00" - }, "originalPayment": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "type": "payment", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", "amount": { "amount": "3.14", "currency": "USD" }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, "description": "Payment", "status": "pending", - "captured": false, - "captureAmount": { - "amount": "3.14", - "currency": "USD" - }, - "captureDate": "2020-04-10T02:13:30.000Z", "requiredAction": { "type": "three_d_secure_required", "redirectUrl": "https://example.org" }, - "cancel": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "cancel", - "description": "Payment", - "status": "pending", - "createDate": "2020-04-10T02:13:30.000Z" - }, - "refunds": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "description": "Payment", - "status": "pending", - "requiredAction": { - "type": "three_d_secure_required", - "redirectUrl": "https://example.org" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "createDate": "2020-04-10T02:13:30.000Z" - } - ], "fees": { "amount": "3.14", "currency": "USD" }, - "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "createDate": "2020-04-10T02:13:30.000Z" }, - "cancel": { + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" + }, + "refunds": [ + { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "cancel", + "type": "refund", "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", "merchantWalletId": "212000", "amount": { @@ -4731,6 +3655,13 @@ }, "createDate": "2020-04-10T02:13:30.000Z" }, + "cancel": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "cancel", + "description": "Payment", + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z" + }, "fees": { "amount": "3.14", "currency": "USD" @@ -4738,77 +3669,26 @@ "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" - }, - "refunds": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "refund", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, - "description": "Payment", - "status": "pending", - "originalPayment": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "description": "Payment", - "status": "pending", - "requiredAction": { - "type": "three_d_secure_required", - "redirectUrl": "https://example.org" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "createDate": "2020-04-10T02:13:30.000Z" - }, - "cancel": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "cancel", - "description": "Payment", - "status": "pending", - "createDate": "2020-04-10T02:13:30.000Z" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - ], - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "trackingRef": "24910599141085313498894", - "externalRef": "YYYYMMDDXXXXXXXX012345", - "errorCode": "payment_failed", - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" - }, - "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } + } + ], + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "trackingRef": "24910599141085313498894", + "externalRef": "YYYYMMDDXXXXXXXX012345", + "errorCode": "payment_failed", + "metadata": { + "email": "satoshi@circle.com", + "phoneNumber": "+14155555555" + }, + "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" } } }, @@ -5560,7 +4440,7 @@ "required": false, "schema": { "type": "string", - "enum": ["wire"] + "enum": ["wire", "cbit"] } }, { @@ -5781,128 +4661,52 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/payouts": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a payout", - "description": "\nCreate a wire, ACH, SEPA or crypto payout. \n\nThe following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts:\n\n| amount.currency | toAmount.currency |\n| ---------------- | ------------ |\n| USD | USD |\n| USD | BTC |\n| USD | ETH |\n| USD | MTC |\n| EUR | EUR |\n| BTC | USD |\n| BTC | BTC |\n| ETH | USD |\n| ETH | ETH |\n", - "operationId": "createPayout", - "tags": ["Payouts"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/FiatPayoutCreationRequest" - }, - { - "$ref": "#/components/schemas/CryptoPayoutCreationRequest" - } - ] - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a payout.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreatePayoutResponse", - "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/FiatPayout" - }, - { - "$ref": "#/components/schemas/CryptoPayout" - } - ] - } - } - }, - "examples": { - "Fiat Payout": { - "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" - }, - "toAmount": { - "amount": "3.14", - "currency": "EUR" - }, - "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" - } - ] + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + } + }, + "/v1/payouts": { + "post": { + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Create a payout", + "description": "\nCreate a crypto payout. \n\nThe following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts:\n\n| amount.currency | toAmount.currency |\n| ---------------- | ------------ |\n| USD | USD |\n| USD | BTC |\n| USD | ETH |\n| USD | MTC |\n| EUR | EUR |\n| BTC | USD |\n| BTC | BTC |\n| ETH | USD |\n| ETH | ETH |\n", + "operationId": "createPayout", + "tags": ["Payouts"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CryptoPayoutCreationRequest" + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created a payout.", + "headers": { + "X-Request-Id": { + "$ref": "#/components/headers/XRequestId" + } + }, + "content": { + "application/json": { + "schema": { + "title": "CreatePayoutResponse", + "properties": { + "data": { + "$ref": "#/components/schemas/CryptoPayout" } - }, + } + }, + "examples": { "Crypto Payout": { "value": { "data": { @@ -6063,79 +4867,12 @@ "data": { "type": "array", "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/FiatPayout" - }, - { - "$ref": "#/components/schemas/CryptoPayout" - } - ] + "$ref": "#/components/schemas/CryptoPayout" } } } }, "examples": { - "Fiat Payout": { - "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" - }, - "toAmount": { - "amount": "3.14", - "currency": "EUR" - }, - "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" - } - } - }, "Crypto Payout": { "value": { "data": [ @@ -6213,79 +4950,11 @@ "title": "GetPayoutResponse", "properties": { "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/FiatDetailedPayout" - }, - { - "$ref": "#/components/schemas/CryptoPayout" - } - ] + "$ref": "#/components/schemas/CryptoPayout" } } }, "examples": { - "Fiat Payout": { - "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" - }, - "toAmount": { - "amount": "3.14", - "currency": "EUR" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "status": "pending", - "trackingRef": "CIR-6ESOQANEP3NAO", - "externalRef": "YYYYMMDDXXXXXXXX012345", - "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" - } - } - }, "Crypto Payout": { "value": { "data": { @@ -6323,99 +4992,14 @@ } } } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/returns": { - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "parameters": [ - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], - "summary": "List all payout returns", - "description": "Retrieve a list of Wire and ACH payout returns. Results will be sorted by create date descending; more recent returns will be at the beginning of the list.", - "operationId": "listReturns", - "tags": ["Returns"], - "responses": { - "200": { - "description": "Successfully retrieved a list of payout returns.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListReturnsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UnwithdrawalObject" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "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" - } - ] - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" + } + } }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } @@ -6816,95 +5400,6 @@ } } }, - "/v1/reversals": { - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "parameters": [ - { - "$ref": "#/components/parameters/PaymentStatus" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], - "summary": "List all ACH payment reversals.", - "description": "Retrieve a list of ACH payment reversals. Results will be sorted by create date descending; more recent reversals will be at the beginning of the list", - "operationId": "listReversals", - "tags": ["Reversals"], - "responses": { - "200": { - "description": "Successfully retrieved a list of ACH payment reversals.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListReversalsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reversal" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "key1", - "paymentId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "description": "Merchant Payment Reversal", - "status": "pending", - "reason": "duplicate", - "fees": { - "amount": "3.14", - "currency": "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" - } - } - } - }, "/v1/wallets": { "post": { "security": [ @@ -8030,141 +6525,6 @@ } } }, - "/v1/mocks/payments/sen": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a mock Silvergate SEN payment", - "description": "In the sandbox environment, initiate a mock SEN transfer that mimics the behavior of funds sent through the Silvergate SEN account linked to master wallet.", - "operationId": "createMockSenPayment", - "tags": ["Deposits"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MockSenPaymentRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a mock SEN transfer.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateSenPaymentResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/MockSenPaymentResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "trackingRef": "CIR13FB13A", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "beneficiaryBank": { - "accountNumber": "11111111" - }, - "status": "pending" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/mocks/ach/accounts": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a mock ACH bank account", - "description": "In the sandbox environment, create a mock ACH account and retrieve a processor token that can be used to link an ACH account.", - "operationId": "createMockAchAccount", - "tags": ["ACH"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MockAchAccountCreationRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a mock ach payment.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateMockAchAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/MockAchAccountResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "processorToken": "processor-sandbox-circle-82cf95bb-43f8-4191-8d30-2c9f42853621", - "balance": { - "amount": "3.14", - "currency": "USD" - }, - "account": { - "accountNumber": "123456789", - "routingNumber": "011000028", - "description": "My ACH account" - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, "/v1/mocks/payments/wire": { "post": { "security": [ @@ -8212,79 +6572,8 @@ "amount": "3.14", "currency": "USD" }, - "beneficiaryBank": { - "accountNumber": "11111111" - }, - "status": "pending" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/mocks/payments/sepa": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a mock SEPA payment", - "description": "In the sandbox environment, initiate a mock SEPA payment that mimics the behavior of funds sent through the bank (SEPA) account linked to master wallet.", - "operationId": "createMockSepaPayment", - "tags": ["Payments"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MockSepaPaymentRequest" - }, - "example": { - "trackingRef": "CIR13FB13A", - "amount": { - "amount": 3.14, - "currency": "EUR" - } - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a mock SEPA payment.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateSepaPaymentResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/MockSepaPaymentResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "trackingRef": "CIR13FB13A", - "amount": { - "amount": "3.14", - "currency": "USD" + "beneficiaryBank": { + "accountNumber": "11111111" }, "status": "pending" } @@ -8943,273 +7232,17 @@ "description": "ISO-8601 UTC date/time format.", "example": "2020-04-10T02:13:30.000Z" }, - "SimpleCard": { - "type": "object", - "required": [ - "id", - "status", - "fingerprint", - "billingDetails", - "expMonth", - "expYear", - "network", - "verification", - "createDate", - "updateDate" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" - }, - "billingDetails": { - "$ref": "#/components/schemas/SimpleBillingDetails" - }, - "expMonth": { - "type": "integer", - "description": "Two digit number representing the card's expiration month.", - "example": 1 - }, - "expYear": { - "type": "integer", - "description": "Four digit number representing the card's expiration year.", - "example": 2020 - }, - "network": { - "type": "string", - "description": "The network of the card.", - "enum": ["VISA", "MASTERCARD", "AMEX", "UNKNOWN"] - }, - "bin": { - "type": "string", - "description": "The bank identification number (BIN), the first 6 digits of the card.", - "example": "401230" - }, - "issuerCountry": { - "type": "string", - "description": "The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.", - "example": "US" - }, - "fundingType": { - "description": "The funding type of the card. Possible values are `credit`, `debit`, `prepaid`, and `unknown`.", - "type": "string", - "enum": ["credit", "debit", "prepaid", "unknown"] - }, - "fingerprint": { - "$ref": "#/components/schemas/Fingerprint" - }, - "verification": { - "$ref": "#/components/schemas/CardVerificationResponse" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "IdempotencyKey": { - "type": "string", - "description": "Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.", - "format": "uuid", - "example": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7" - }, - "BillingDetails": { - "type": "object", - "required": ["name", "city", "country", "line1", "postalCode"], - "properties": { - "name": { - "type": "string", - "description": "Full name of the card or bank account holder.", - "maxLength": 1024, - "example": "Satoshi Nakamoto" - }, - "city": { - "type": "string", - "description": "City portion of the address.", - "maxLength": 1024, - "example": "Boston" - }, - "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" - }, - "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" - }, - "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" - } - } - }, - "CardExpMonth": { - "type": "integer", - "description": "Two digit number representing the card's expiration month.", - "minimum": 1, - "maximum": 12, - "example": 1 - }, - "CardExpYear": { - "type": "integer", - "description": "Four digit number representing the card's expiration year.", - "minimum": 1, - "maximum": 9999, - "example": 2020 - }, - "Email": { - "type": "string", - "description": "Email of the user.", - "maxLength": 1024, - "example": "satoshi@circle.com" - }, - "PhoneNumber": { - "type": "string", - "description": "Phone number of the user in E.164 format. We recommend using a library such as [libphonenumber](https://github.com/google/libphonenumber) to parse and validate phone numbers.", - "maxLength": 16, - "pattern": "/\\+?[1-9]\\d{1,14}/", - "example": "+14155555555" - }, - "SessionId": { - "description": "Hash of the session identifier; typically of the end user. This helps us make risk decisions and prevent fraud. IMPORTANT: Please hash the session identifier to prevent sending us actual session identifiers.\n", - "type": "string", - "maxLength": 50, - "example": "DE6FA86F60BB47B379307F851E238617" - }, - "IpAddress": { - "type": "string", - "description": "Single IPv4 or IPv6 address of user'", - "example": "244.28.239.130" - }, - "MetadataCardAndAch": { - "type": "object", - "required": ["email", "sessionId", "ipAddress"], - "properties": { - "email": { - "$ref": "#/components/schemas/Email" - }, - "phoneNumber": { - "$ref": "#/components/schemas/PhoneNumber" - }, - "sessionId": { - "$ref": "#/components/schemas/SessionId" - }, - "ipAddress": { - "$ref": "#/components/schemas/IpAddress" - } - } - }, - "CardCreationRequest": { - "type": "object", - "required": [ - "idempotencyKey", - "expMonth", - "expYear", - "encryptedData", - "billingDetails", - "metadata" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "keyId": { - "$ref": "#/components/schemas/IdKey" - }, - "encryptedData": { - "type": "string", - "format": "byte", - "description": "PGP encrypted base64 encoded string. Contains Number and CVV.\n* **Number**: Card number. No spaces or other separators. REQUIRED\n* **CVV (Card Verification Number)**: Three or four digit security code. REQUIRED'\n", - "example": "LS0tLS1CRUdJTiBQR1AgTUVTU0FHRS0tLS0tCgp3Y0JNQTBYV1NGbEZScFZoQVFmL2J2bVVkNG5LZ3dkbExKVTlEdEFEK0p5c0VOTUxuOUlRUWVGWnZJUWEKMGgzQklpRFNRU0RMZmI0NEs2SXZMeTZRbm54bmFLcWx0MjNUSmtPd2hGWFIrdnNSMU5IbnVHN0lUNWJECmZzeVdleXlNK1JLNUVHV0thZ3NmQ2tWamh2NGloY29xUnlTTGtJbWVmRzVaR0tMRkJTTTBsTFNPWFRURQpiMy91eU1zMVJNb3ZiclNvbXkxa3BybzUveWxabWVtV2ZsU1pWQlhNcTc1dGc1YjVSRVIraXM5ckc0cS8KMXl0M0FOYXA3UDhKekFhZVlyTnVNZGhGZFhvK0NFMC9CQnN3L0NIZXdhTDk4SmRVUEV0NjA5WFRHTG9kCjZtamY0YUtMQ01xd0RFMkNVb3dPdE8vMzVIMitnVDZKS3FoMmtjQUQyaXFlb3luNWcralRHaFNyd3NKWgpIdEphQWVZZXpGQUVOaFo3Q01IOGNsdnhZVWNORnJuNXlMRXVGTkwwZkczZy95S3loclhxQ0o3UFo5b3UKMFVxQjkzQURKWDlJZjRBeVQ2bU9MZm9wUytpT2lLall4bG1NLzhlVWc3OGp1OVJ5T1BXelhyTzdLWTNHClFSWm8KPXc1dEYKLS0tLS1FTkQgUEdQIE1FU1NBR0UtLS0tLQo" - }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" - }, - "expMonth": { - "$ref": "#/components/schemas/CardExpMonth" - }, - "expYear": { - "$ref": "#/components/schemas/CardExpYear" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataCardAndAch" - } - } - }, - "VerificationErrorCode": { - "type": "string", - "description": "Indicates the failure reason of the card verification. Only present on cards with failed verification. Possible values are [verification_failed, verification_fraud_detected, verification_denied, verification_not_supported_by_issuer, verification_stopped_by_issuer, card_failed, card_invalid, card_address_mismatch, card_zip_mismatch, card_cvv_invalid, card_expired, card_limit_violated, card_not_honored, card_cvv_required, credit_card_not_allowed, card_account_ineligible, card_network_unsupported]'", - "nullable": true, - "enum": [ - "verification_failed", - "verification_fraud_detected", - "verification_denied", - "verification_not_supported_by_issuer", - "verification_stopped_by_issuer", - "card_failed", - "card_invalid", - "card_address_mismatch", - "card_zip_mismatch", - "card_cvv_invalid", - "card_expired", - "card_limit_violated", - "card_not_honored", - "card_cvv_required", - "credit_card_not_allowed", - "card_account_ineligible", - "card_network_unsupported" - ] - }, - "MetadataPhoneEmail": { - "type": "object", - "required": ["email"], - "properties": { - "email": { - "$ref": "#/components/schemas/Email" - }, - "phoneNumber": { - "$ref": "#/components/schemas/PhoneNumber" - } - } - }, - "Card": { + "SimpleCard": { "type": "object", "required": [ "id", "status", + "fingerprint", "billingDetails", "expMonth", "expYear", "network", - "last4", - "fingerprint", "verification", - "metadata", "createDate", "updateDate" ], @@ -9221,24 +7254,23 @@ "$ref": "#/components/schemas/ExternalFiatAccountStatus" }, "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "$ref": "#/components/schemas/SimpleBillingDetails" }, "expMonth": { - "$ref": "#/components/schemas/CardExpMonth" + "type": "integer", + "description": "Two digit number representing the card's expiration month.", + "example": 1 }, "expYear": { - "$ref": "#/components/schemas/CardExpYear" + "type": "integer", + "description": "Four digit number representing the card's expiration year.", + "example": 2020 }, "network": { "type": "string", "description": "The network of the card.", "enum": ["VISA", "MASTERCARD", "AMEX", "UNKNOWN"] }, - "last4": { - "type": "string", - "description": "The last 4 digits of the card.", - "example": "0123" - }, "bin": { "type": "string", "description": "The bank identification number (BIN), the first 6 digits of the card.", @@ -9257,18 +7289,12 @@ "fingerprint": { "$ref": "#/components/schemas/Fingerprint" }, - "errorCode": { - "$ref": "#/components/schemas/VerificationErrorCode" - }, "verification": { "$ref": "#/components/schemas/CardVerificationResponse" }, "riskEvaluation": { "$ref": "#/components/schemas/RiskEvaluation" }, - "metadata": { - "$ref": "#/components/schemas/MetadataPhoneEmail" - }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, @@ -9277,282 +7303,202 @@ } } }, - "CardUpdate": { - "type": "object", - "required": ["keyId", "encryptedData", "expMonth", "expYear"], - "properties": { - "keyId": { - "$ref": "#/components/schemas/IdKey" - }, - "encryptedData": { - "type": "string", - "format": "byte", - "description": "PGP encrypted base64 encoded string. Contains CVV.\n* **CVV (Card Verification Number)**: Three or four digit security code. REQUIRED'\n", - "example": "UHVibGljS2V5QmFzZTY0RW5jb2RlZA==" - }, - "expMonth": { - "$ref": "#/components/schemas/CardExpMonth" - }, - "expYear": { - "$ref": "#/components/schemas/CardExpYear" - } - } + "IdempotencyKey": { + "type": "string", + "description": "Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.", + "format": "uuid", + "example": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7" }, - "ApplePayTokenEcHeader": { + "BillingDetails": { "type": "object", - "required": ["ephemeralPublicKey", "publicKeyHash", "transactionId"], + "required": ["name", "city", "country", "line1", "postalCode"], "properties": { - "applicationData": { - "description": "Optional. Hash of the applicationData property of the original PKPaymentRequest object. If the value of that property is null, this key is omitted.", + "name": { "type": "string", - "example": "" + "description": "Full name of the card or bank account holder.", + "maxLength": 1024, + "example": "Satoshi Nakamoto" }, - "ephemeralPublicKey": { - "description": "Ephemeral public key bytes.", + "city": { "type": "string", - "example": "MFkwEwYHKoZIzj.../zlsw==" + "description": "City portion of the address.", + "maxLength": 1024, + "example": "Boston" }, - "publicKeyHash": { - "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate.", + "country": { "type": "string", - "example": "tqYV+tmG9aMh+l/K6cicUnPqkb1gUiLjSTM9gEz6Nl0=" + "description": "Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "maxLength": 2, + "example": "US" }, - "transactionId": { - "description": "Transaction identifier, generated on the device.", + "line1": { "type": "string", - "example": "3cee89679130a4b2617c76118a1c62fd400cd45b49dc0916d5b951b560cd17b4" - } - } - }, - "ApplePayTokenRsaHeader": { - "type": "object", - "required": ["wrappedKey", "publicKeyHash", "transactionId"], - "properties": { - "applicationData": { - "description": "Optional. Hash of the applicationData property of the original PKPaymentRequest object. If the value of that property is null, this key is omitted.", - "type": "string" - }, - "wrappedKey": { - "description": "The symmetric key wrapped using your RSA public key.", - "type": "string" - }, - "publicKeyHash": { - "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate.", - "type": "string" + "description": "Line one of the street address.", + "maxLength": 1024, + "example": "100 Money Street" }, - "transactionId": { - "description": "Transaction identifier, generated on the device.", - "type": "string" - } - } - }, - "ApplePayToken": { - "type": "object", - "required": ["version", "data", "signature", "header"], - "properties": { - "version": { - "description": "ApplePay token version information.", + "line2": { "type": "string", - "enum": ["EC_v1", "RSA_v1"] + "description": "Line two of the street address.", + "maxLength": 1024, + "example": "Suite 1" }, - "data": { - "description": "Encrypted payment data. Base64 encoded as a string.", + "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", - "example": "t7GeajLB9skXB6QSWfEpPA4WPhDqB7ekdd+...T6Ms7PhiNZpuGEE2QE=" + "maxLength": 16, + "example": "MA" }, - "signature": { - "description": "Signature of the payment and header data. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm.", + "postalCode": { "type": "string", - "example": "MIAGCSqGSIb3DQEHAqCAMIACAQEx.../WIDkHWiFuSm5a3NVox7DlyIf0AAAAAAAA=" - }, - "header": { - "description": "Additional version-dependent information used to decrypt and verify the payment.", - "oneOf": [ - { - "$ref": "#/components/schemas/ApplePayTokenEcHeader" - }, - { - "$ref": "#/components/schemas/ApplePayTokenRsaHeader" - } - ] + "description": "Postal / ZIP code of the address.", + "maxLength": 16, + "example": "01234" } } }, - "GooglePayToken": { - "type": "object", - "required": ["signature", "protocolVersion", "signedMessage"], - "properties": { - "signature": { - "description": "Verifies the message came from Google. The signature is created using ECDSA.", - "type": "string" - }, - "protocolVersion": { - "description": "Identifies which encryption/signing scheme created this message. In this way, the protocol can evolve over time if needed. If it is not set, assume ECv0.", - "type": "string" - }, - "signedMessage": { - "description": "A serialized JSON string containing the encryptedMessage, ephemeralPublicKey, and tag. To simplify the signature verification process, this value is serialized.", - "type": "string" - } - } + "CardExpMonth": { + "type": "integer", + "description": "Two digit number representing the card's expiration month.", + "minimum": 1, + "maximum": 12, + "example": 1 }, - "PaymentTokenRequest": { - "type": "object", - "required": ["idempotencyKey", "type", "tokenData"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "type": { - "description": "Type of the digital wallet token.", - "type": "string", - "enum": ["applepay", "googlepay"] - }, - "tokenData": { - "description": "The token data", - "oneOf": [ - { - "$ref": "#/components/schemas/ApplePayToken" - }, - { - "$ref": "#/components/schemas/GooglePayToken" - } - ] - } - } + "CardExpYear": { + "type": "integer", + "description": "Four digit number representing the card's expiration year.", + "minimum": 1, + "maximum": 9999, + "example": 2020 }, - "TokenizedCardDetails": { + "Email": { + "type": "string", + "description": "Email of the user.", + "maxLength": 1024, + "example": "satoshi@circle.com" + }, + "PhoneNumber": { + "type": "string", + "description": "Phone number of the user in E.164 format. We recommend using a library such as [libphonenumber](https://github.com/google/libphonenumber) to parse and validate phone numbers.", + "maxLength": 16, + "pattern": "/\\+?[1-9]\\d{1,14}/", + "example": "+14155555555" + }, + "SessionId": { + "description": "Hash of the session identifier; typically of the end user. This helps us make risk decisions and prevent fraud. IMPORTANT: Please hash the session identifier to prevent sending us actual session identifiers.\n", + "type": "string", + "maxLength": 50, + "example": "DE6FA86F60BB47B379307F851E238617" + }, + "IpAddress": { + "type": "string", + "description": "Single IPv4 or IPv6 address of user'", + "example": "244.28.239.130" + }, + "MetadataCardAndAch": { "type": "object", - "required": ["expMonth", "expYear", "last4", "bin"], + "required": ["email", "sessionId", "ipAddress"], "properties": { - "expMonth": { - "description": "The card's expiration month.", - "type": "integer", - "example": 1 - }, - "expYear": { - "description": "Four digit number representing the card's expiration year.", - "type": "integer", - "example": 2020 - }, - "network": { - "description": "The network of the card.", - "type": "string", - "enum": ["VISA", "MASTERCARD", "AMEX", "UNKNOWN"] - }, - "last4": { - "description": "The last 4 digits of the card.", - "type": "string", - "example": "0123" - }, - "bin": { - "description": "The bank identification number (BIN), the first 6 digits of the card.", - "type": "string", - "example": "401230" + "email": { + "$ref": "#/components/schemas/Email" }, - "fundingType": { - "description": "The funding type of the card.", - "type": "string", - "enum": ["credit", "debit", "prepaid", "unknown"] + "phoneNumber": { + "$ref": "#/components/schemas/PhoneNumber" }, - "issuerCountry": { - "description": "The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.", - "type": "string", - "example": "US" + "sessionId": { + "$ref": "#/components/schemas/SessionId" + }, + "ipAddress": { + "$ref": "#/components/schemas/IpAddress" } } }, - "PaymentToken": { + "CardCreationRequest": { "type": "object", "required": [ - "id", - "type", - "expiresOn", - "cardDetails", - "createDate", - "updateDate" + "idempotencyKey", + "expMonth", + "expYear", + "encryptedData", + "billingDetails", + "metadata" ], "properties": { - "id": { - "description": "Unique system generated identifier for the digital wallet token.", - "type": "string", - "format": "uuid", - "example": "gc988ed5-c189-4f70-a074-e5beb7eb8e32" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "type": { - "description": "Type of the digital wallet token.", - "type": "string", - "enum": ["applepay", "googlepay"] + "keyId": { + "$ref": "#/components/schemas/IdKey" }, - "expiresOn": { - "description": "Datetime when the digital token expires. ISO-8601.", + "encryptedData": { "type": "string", - "format": "date-time", - "example": "2022-01-18T19:20:00Z" + "format": "byte", + "description": "PGP encrypted base64 encoded string. Contains Number and CVV.\n* **Number**: Card number. No spaces or other separators. REQUIRED\n* **CVV (Card Verification Number)**: Three or four digit security code. REQUIRED'\n", + "example": "LS0tLS1CRUdJTiBQR1AgTUVTU0FHRS0tLS0tCgp3Y0JNQTBYV1NGbEZScFZoQVFmL2J2bVVkNG5LZ3dkbExKVTlEdEFEK0p5c0VOTUxuOUlRUWVGWnZJUWEKMGgzQklpRFNRU0RMZmI0NEs2SXZMeTZRbm54bmFLcWx0MjNUSmtPd2hGWFIrdnNSMU5IbnVHN0lUNWJECmZzeVdleXlNK1JLNUVHV0thZ3NmQ2tWamh2NGloY29xUnlTTGtJbWVmRzVaR0tMRkJTTTBsTFNPWFRURQpiMy91eU1zMVJNb3ZiclNvbXkxa3BybzUveWxabWVtV2ZsU1pWQlhNcTc1dGc1YjVSRVIraXM5ckc0cS8KMXl0M0FOYXA3UDhKekFhZVlyTnVNZGhGZFhvK0NFMC9CQnN3L0NIZXdhTDk4SmRVUEV0NjA5WFRHTG9kCjZtamY0YUtMQ01xd0RFMkNVb3dPdE8vMzVIMitnVDZKS3FoMmtjQUQyaXFlb3luNWcralRHaFNyd3NKWgpIdEphQWVZZXpGQUVOaFo3Q01IOGNsdnhZVWNORnJuNXlMRXVGTkwwZkczZy95S3loclhxQ0o3UFo5b3UKMFVxQjkzQURKWDlJZjRBeVQ2bU9MZm9wUytpT2lLall4bG1NLzhlVWc3OGp1OVJ5T1BXelhyTzdLWTNHClFSWm8KPXc1dEYKLS0tLS1FTkQgUEdQIE1FU1NBR0UtLS0tLQo" }, - "cardDetails": { - "$ref": "#/components/schemas/TokenizedCardDetails" + "billingDetails": { + "$ref": "#/components/schemas/BillingDetails" }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "expMonth": { + "$ref": "#/components/schemas/CardExpMonth" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "expYear": { + "$ref": "#/components/schemas/CardExpYear" + }, + "metadata": { + "$ref": "#/components/schemas/MetadataCardAndAch" } } }, - "BankAddress": { + "VerificationErrorCode": { + "type": "string", + "description": "Indicates the failure reason of the card verification. Only present on cards with failed verification. Possible values are [verification_failed, verification_fraud_detected, verification_denied, verification_not_supported_by_issuer, verification_stopped_by_issuer, card_failed, card_invalid, card_address_mismatch, card_zip_mismatch, card_cvv_invalid, card_expired, card_limit_violated, card_not_honored, card_cvv_required, credit_card_not_allowed, card_account_ineligible, card_network_unsupported]'", + "nullable": true, + "enum": [ + "verification_failed", + "verification_fraud_detected", + "verification_denied", + "verification_not_supported_by_issuer", + "verification_stopped_by_issuer", + "card_failed", + "card_invalid", + "card_address_mismatch", + "card_zip_mismatch", + "card_cvv_invalid", + "card_expired", + "card_limit_violated", + "card_not_honored", + "card_cvv_required", + "credit_card_not_allowed", + "card_account_ineligible", + "card_network_unsupported" + ] + }, + "MetadataPhoneEmail": { "type": "object", - "description": "The address details for the bank, as provided during bank account creation.", - "required": ["country"], + "required": ["email"], "properties": { - "bankName": { - "type": "string", - "description": "Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'", - "maxLength": 35, - "example": "SAN FRANCISCO" - }, - "city": { - "type": "string", - "description": "City portion of the address. This property is required for bank accounts outside of the US.", - "maxLength": 35, - "example": "SAN FRANCISCO" - }, - "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" - }, - "line1": { - "type": "string", - "description": "Line one of the street address.", - "maxLength": 35, - "example": "100 Money Street" - }, - "line2": { - "type": "string", - "description": "Line two of the street address.", - "maxLength": 35, - "example": "Suite 1" + "email": { + "$ref": "#/components/schemas/Email" }, - "district": { - "type": "string", - "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", - "maxLength": 16, - "example": "CA" + "phoneNumber": { + "$ref": "#/components/schemas/PhoneNumber" } } }, - "Wire": { + "Card": { "type": "object", "required": [ "id", "status", - "description", - "trackingRef", - "fingerprint", "billingDetails", + "expMonth", + "expYear", + "network", + "last4", + "fingerprint", + "verification", + "metadata", "createDate", "updateDate" ], @@ -9563,319 +7509,339 @@ "status": { "$ref": "#/components/schemas/ExternalFiatAccountStatus" }, - "description": { - "type": "string", - "description": "Bank name plus last four digits of the bank account number or IBAN.", - "example": "WELLS FARGO BANK, NA ****0010" - }, - "trackingRef": { - "type": "string", - "description": "Wire tracking ref that needs to be set in the wire reference to beneficiary field.", - "example": "CIR13FB13A" - }, - "fingerprint": { - "$ref": "#/components/schemas/Fingerprint" - }, "billingDetails": { "$ref": "#/components/schemas/BillingDetails" }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddress" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "WireCreationRequestUs": { - "type": "object", - "title": "US Bank Account", - "description": "Relevant fields for U.S. bank accounts.", - "required": [ - "idempotencyKey", - "accountNumber", - "routingNumber", - "billingDetails", - "bankAddress" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "expMonth": { + "$ref": "#/components/schemas/CardExpMonth" }, - "accountNumber": { - "description": "Account number that identifies the bank account.", - "type": "string", - "example": "12340010", - "minLength": 6, - "maxLength": 35 + "expYear": { + "$ref": "#/components/schemas/CardExpYear" }, - "routingNumber": { - "description": "ABA routing number for the bank account. Note this has to be specific for bank wire transfers.", + "network": { "type": "string", - "example": "121000248" - }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "description": "The network of the card.", + "enum": ["VISA", "MASTERCARD", "AMEX", "UNKNOWN"] }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddress" - } - } - }, - "BankAddressIbanSupported": { - "type": "object", - "description": "The address of the bank. City and country fields are required.", - "required": ["city", "country"], - "properties": { - "bankName": { + "last4": { "type": "string", - "description": "Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'", - "maxLength": 35, - "example": "SAN FRANCISCO" + "description": "The last 4 digits of the card.", + "example": "0123" }, - "city": { + "bin": { "type": "string", - "description": "City portion of the address. This property is required for bank accounts outside of the US.", - "maxLength": 1024, - "example": "SAN FRANCISCO" + "description": "The bank identification number (BIN), the first 6 digits of the card.", + "example": "401230" }, - "country": { + "issuerCountry": { "type": "string", - "description": "Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", - "maxLength": 2, + "description": "The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.", "example": "US" }, - "line1": { + "fundingType": { + "description": "The funding type of the card. Possible values are `credit`, `debit`, `prepaid`, and `unknown`.", "type": "string", - "description": "Line one of the street address.", - "maxLength": 35, - "example": "100 Money Street" + "enum": ["credit", "debit", "prepaid", "unknown"] }, - "line2": { - "type": "string", - "description": "Line two of the street address.", - "maxLength": 35, - "example": "Suite 1" + "fingerprint": { + "$ref": "#/components/schemas/Fingerprint" }, - "district": { - "type": "string", - "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", - "maxLength": 16, - "example": "CA" + "errorCode": { + "$ref": "#/components/schemas/VerificationErrorCode" + }, + "verification": { + "$ref": "#/components/schemas/CardVerificationResponse" + }, + "riskEvaluation": { + "$ref": "#/components/schemas/RiskEvaluation" + }, + "metadata": { + "$ref": "#/components/schemas/MetadataPhoneEmail" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" } } }, - "WireCreationRequestIban": { + "CardUpdate": { "type": "object", - "title": "Non US Bank Account - IBAN Supported", - "description": "Relevant fields for non-U.S. bank accounts that support IBAN.", - "required": ["idempotencyKey", "iban", "billingDetails", "bankAddress"], + "required": ["keyId", "encryptedData", "expMonth", "expYear"], "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "keyId": { + "$ref": "#/components/schemas/IdKey" }, - "iban": { - "description": "International Bank Account Number (IBAN) for the bank account.", + "encryptedData": { "type": "string", - "example": "DE31100400480532013000" + "format": "byte", + "description": "PGP encrypted base64 encoded string. Contains CVV.\n* **CVV (Card Verification Number)**: Three or four digit security code. REQUIRED'\n", + "example": "UHVibGljS2V5QmFzZTY0RW5jb2RlZA==" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "expMonth": { + "$ref": "#/components/schemas/CardExpMonth" }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddressIbanSupported" + "expYear": { + "$ref": "#/components/schemas/CardExpYear" } } }, - "BankAddressNonIban": { + "ApplePayTokenEcHeader": { "type": "object", - "description": "The address of the bank. BankName, City and Country fields are required.", - "required": ["bankName", "city", "country"], + "required": ["ephemeralPublicKey", "publicKeyHash", "transactionId"], "properties": { - "bankName": { + "applicationData": { + "description": "Optional. Hash of the applicationData property of the original PKPaymentRequest object. If the value of that property is null, this key is omitted.", "type": "string", - "description": "Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'", - "maxLength": 35, - "example": "SAN FRANCISCO" + "example": "" }, - "city": { + "ephemeralPublicKey": { + "description": "Ephemeral public key bytes.", "type": "string", - "description": "City portion of the address. This property is required for bank accounts outside of the US.", - "maxLength": 1024, - "example": "SAN FRANCISCO" + "example": "MFkwEwYHKoZIzj.../zlsw==" }, - "country": { + "publicKeyHash": { + "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate.", "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" + "example": "tqYV+tmG9aMh+l/K6cicUnPqkb1gUiLjSTM9gEz6Nl0=" }, - "line1": { + "transactionId": { + "description": "Transaction identifier, generated on the device.", "type": "string", - "description": "Line one of the street address.", - "maxLength": 35, - "example": "100 Money Street" + "example": "3cee89679130a4b2617c76118a1c62fd400cd45b49dc0916d5b951b560cd17b4" + } + } + }, + "ApplePayTokenRsaHeader": { + "type": "object", + "required": ["wrappedKey", "publicKeyHash", "transactionId"], + "properties": { + "applicationData": { + "description": "Optional. Hash of the applicationData property of the original PKPaymentRequest object. If the value of that property is null, this key is omitted.", + "type": "string" }, - "line2": { - "type": "string", - "description": "Line two of the street address.", - "maxLength": 35, - "example": "Suite 1" + "wrappedKey": { + "description": "The symmetric key wrapped using your RSA public key.", + "type": "string" }, - "district": { - "type": "string", - "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", - "maxLength": 16, - "example": "CA" + "publicKeyHash": { + "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate.", + "type": "string" + }, + "transactionId": { + "description": "Transaction identifier, generated on the device.", + "type": "string" } } }, - "WireCreationRequestAccountNumber": { + "ApplePayToken": { "type": "object", - "title": "Non US Bank Account - IBAN Not Supported", - "description": "Relevant fields for non-U.S. banks that do NOT support IBAN.", - "required": [ - "idempotencyKey", - "accountNumber", - "routingNumber", - "billingDetails", - "bankAddress" - ], + "required": ["version", "data", "signature", "header"], "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "accountNumber": { - "description": "Account number that identifies the bank account.", + "version": { + "description": "ApplePay token version information.", "type": "string", - "example": "0321800123", - "minLength": 6, - "maxLength": 35 + "enum": ["EC_v1", "RSA_v1"] }, - "routingNumber": { - "description": "The bank's SWIFT / BIC code.", + "data": { + "description": "Encrypted payment data. Base64 encoded as a string.", "type": "string", - "example": "SBININBB354" + "example": "t7GeajLB9skXB6QSWfEpPA4WPhDqB7ekdd+...T6Ms7PhiNZpuGEE2QE=" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "signature": { + "description": "Signature of the payment and header data. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm.", + "type": "string", + "example": "MIAGCSqGSIb3DQEHAqCAMIACAQEx.../WIDkHWiFuSm5a3NVox7DlyIf0AAAAAAAA=" }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddressNonIban" + "header": { + "description": "Additional version-dependent information used to decrypt and verify the payment.", + "oneOf": [ + { + "$ref": "#/components/schemas/ApplePayTokenEcHeader" + }, + { + "$ref": "#/components/schemas/ApplePayTokenRsaHeader" + } + ] } } }, - "WireCreationRequest": { + "GooglePayToken": { "type": "object", - "description": "Request object used to create a bank account (wires). Different fields are required depending on the bank country, see the guide documentation for the list of supported bank countries along with which ones support IBAN.", - "oneOf": [ - { - "$ref": "#/components/schemas/WireCreationRequestUs" + "required": ["signature", "protocolVersion", "signedMessage"], + "properties": { + "signature": { + "description": "Verifies the message came from Google. The signature is created using ECDSA.", + "type": "string" }, - { - "$ref": "#/components/schemas/WireCreationRequestIban" + "protocolVersion": { + "description": "Identifies which encryption/signing scheme created this message. In this way, the protocol can evolve over time if needed. If it is not set, assume ECv0.", + "type": "string" }, - { - "$ref": "#/components/schemas/WireCreationRequestAccountNumber" + "signedMessage": { + "description": "A serialized JSON string containing the encryptedMessage, ephemeralPublicKey, and tag. To simplify the signature verification process, this value is serialized.", + "type": "string" } - ] + } }, - "WireInstructionBeneficiary": { + "PaymentTokenRequest": { "type": "object", + "required": ["idempotencyKey", "type", "tokenData"], "properties": { - "name": { - "type": "string", - "description": "Name of the beneficiary.", - "example": "CIRCLE INTERNET FINANCIAL INC" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "address1": { + "type": { + "description": "Type of the digital wallet token.", "type": "string", - "description": "Address line 1 of the beneficiary's address.", - "example": "99 HIGH STREET" + "enum": ["applepay", "googlepay"] }, - "address2": { - "type": "string", - "description": "Address line 2 of the beneficiary's address.", - "example": "BOSTON MA 02110" + "tokenData": { + "description": "The token data", + "oneOf": [ + { + "$ref": "#/components/schemas/ApplePayToken" + }, + { + "$ref": "#/components/schemas/GooglePayToken" + } + ] } } }, - "WireInstructionBeneficiaryBank": { + "TokenizedCardDetails": { "type": "object", + "required": ["expMonth", "expYear", "last4", "bin"], "properties": { - "name": { - "type": "string", - "description": "Name of the beneficiary's bank.", - "example": "SILVERGATE BANK" + "expMonth": { + "description": "The card's expiration month.", + "type": "integer", + "example": 1 }, - "swiftCode": { - "type": "string", - "description": "SWIFT code of the beneficiary's bank account.", - "example": "SIVGUS66XXX" + "expYear": { + "description": "Four digit number representing the card's expiration year.", + "type": "integer", + "example": 2020 }, - "routingNumber": { + "network": { + "description": "The network of the card.", "type": "string", - "description": "ABA Routing number of the beneficiary's bank account.", - "example": "322286803" + "enum": ["VISA", "MASTERCARD", "AMEX", "UNKNOWN"] }, - "accountNumber": { + "last4": { + "description": "The last 4 digits of the card.", "type": "string", - "description": "Account number of the beneficiary's bank account.", - "example": "****7427" + "example": "0123" }, - "currency": { + "bin": { + "description": "The bank identification number (BIN), the first 6 digits of the card.", "type": "string", - "description": "Currency of the beneficiary's bank account.", - "example": "USD" + "example": "401230" }, - "address": { + "fundingType": { + "description": "The funding type of the card.", "type": "string", - "description": "Address of the beneficiary's bank.", - "example": "4250 EXECUTIVE SQUARE SUITE 300" + "enum": ["credit", "debit", "prepaid", "unknown"] }, - "city": { + "issuerCountry": { + "description": "The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.", + "type": "string", + "example": "US" + } + } + }, + "PaymentToken": { + "type": "object", + "required": [ + "id", + "type", + "expiresOn", + "cardDetails", + "createDate", + "updateDate" + ], + "properties": { + "id": { + "description": "Unique system generated identifier for the digital wallet token.", "type": "string", - "description": "City of the beneficiary's bank.", - "example": "LA JOLLA" + "format": "uuid", + "example": "gc988ed5-c189-4f70-a074-e5beb7eb8e32" }, - "postalCode": { + "type": { + "description": "Type of the digital wallet token.", "type": "string", - "description": "Postal code of the beneficiary's bank.", - "example": "02110" + "enum": ["applepay", "googlepay"] }, - "country": { + "expiresOn": { + "description": "Datetime when the digital token expires. ISO-8601.", "type": "string", - "description": "Country code of the beneficiary's bank. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", - "example": "US" + "format": "date-time", + "example": "2022-01-18T19:20:00Z" + }, + "cardDetails": { + "$ref": "#/components/schemas/TokenizedCardDetails" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" } } }, - "WireInstruction": { + "BankAddress": { "type": "object", + "description": "The address details for the bank, as provided during bank account creation.", + "required": ["country"], "properties": { - "trackingRef": { + "bankName": { "type": "string", - "description": "Circle tracking reference that needs to be set in the wire reference field.", - "example": "CIR13FB13A" + "description": "Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'", + "maxLength": 35, + "example": "SAN FRANCISCO" }, - "beneficiary": { - "$ref": "#/components/schemas/WireInstructionBeneficiary" + "city": { + "type": "string", + "description": "City portion of the address. This property is required for bank accounts outside of the US.", + "maxLength": 35, + "example": "SAN FRANCISCO" }, - "beneficiaryBank": { - "$ref": "#/components/schemas/WireInstructionBeneficiaryBank" + "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" + }, + "line1": { + "type": "string", + "description": "Line one of the street address.", + "maxLength": 35, + "example": "100 Money Street" + }, + "line2": { + "type": "string", + "description": "Line two of the street address.", + "maxLength": 35, + "example": "Suite 1" + }, + "district": { + "type": "string", + "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", + "maxLength": 16, + "example": "CA" } } }, - "SenFiatAccountResponse": { + "Wire": { "type": "object", "required": [ "id", "status", "description", "trackingRef", + "fingerprint", + "billingDetails", "createDate", "updateDate" ], @@ -9888,82 +7854,82 @@ }, "description": { "type": "string", - "description": "Bank name plus last four digits of the bank account number.", - "example": "SILVERGATE BANK ****1111" + "description": "Bank name plus last four digits of the bank account number or IBAN.", + "example": "WELLS FARGO BANK, NA ****0010" }, "trackingRef": { "type": "string", - "description": "Circle tracking reference that needs to be set in the memo field..", - "example": "CIR13FB14A" + "description": "Wire tracking ref that needs to be set in the wire reference to beneficiary field.", + "example": "CIR13FB13A" + }, + "fingerprint": { + "$ref": "#/components/schemas/Fingerprint" + }, + "billingDetails": { + "$ref": "#/components/schemas/BillingDetails" + }, + "bankAddress": { + "$ref": "#/components/schemas/BankAddress" }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, "updateDate": { "$ref": "#/components/schemas/UtcTimestamp" - }, - "currency": { - "type": "string", - "description": "Currency of the fiat account.", - "example": "USD" } } }, - "SenFiatAccountCreationRequest": { + "WireCreationRequestUs": { "type": "object", - "required": ["idempotencyKey", "accountNumber"], + "title": "US Bank Account", + "description": "Relevant fields for U.S. bank accounts.", + "required": [ + "idempotencyKey", + "accountNumber", + "routingNumber", + "billingDetails", + "bankAddress" + ], "properties": { "idempotencyKey": { "$ref": "#/components/schemas/IdempotencyKey" }, "accountNumber": { + "description": "Account number that identifies the bank account.", "type": "string", - "description": "Silvergate SEN account number.", - "example": "12345678" + "example": "12340010", + "minLength": 6, + "maxLength": 35 }, - "currency": { - "type": "string", - "description": "Currency of the Silvergate SEN account.", - "example": "USD" - } - } - }, - "SenInstruction": { - "type": "object", - "properties": { - "trackingRef": { + "routingNumber": { + "description": "ABA routing number for the bank account. Note this has to be specific for bank wire transfers.", "type": "string", - "description": "Circle tracking reference that needs to be set in the memo field.", - "example": "CIR13FB14A" + "example": "121000248" }, - "accountNumber": { - "type": "string", - "description": "Circle corporate Silvergate SEN account number that needs to be set as destination.", - "example": "11111111" + "billingDetails": { + "$ref": "#/components/schemas/BillingDetails" }, - "currency": { - "type": "string", - "description": "Currency of Circle corporate Silvergate SEN account.", - "example": "USD" + "bankAddress": { + "$ref": "#/components/schemas/BankAddress" } } }, - "AchBillingDetails": { + "BankAddressIbanSupported": { "type": "object", - "description": "Billing details of the account holder.", - "required": ["name"], + "description": "The address of the bank. City and country fields are required.", + "required": ["city", "country"], "properties": { - "name": { + "bankName": { "type": "string", - "description": "Full name of the card or bank account holder.", - "maxLength": 1024, - "example": "Satoshi Nakamoto" + "description": "Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'", + "maxLength": 35, + "example": "SAN FRANCISCO" }, "city": { "type": "string", - "description": "City portion of the address.", + "description": "City portion of the address. This property is required for bank accounts outside of the US.", "maxLength": 1024, - "example": "Boston" + "example": "SAN FRANCISCO" }, "country": { "type": "string", @@ -9974,207 +7940,139 @@ "line1": { "type": "string", "description": "Line one of the street address.", - "maxLength": 1024, + "maxLength": 35, "example": "100 Money Street" }, "line2": { "type": "string", "description": "Line two of the street address.", - "maxLength": 1024, + "maxLength": 35, "example": "Suite 1" }, "district": { "type": "string", - "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.", - "maxLength": 16, - "example": "MA" - }, - "postalCode": { - "type": "string", - "description": "Postal / ZIP code of the address.", + "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", "maxLength": 16, - "example": "01234" + "example": "CA" } } }, - "AchAccountType": { - "type": "string", - "description": "Retail account (individual consumer account) or Business account (e.g. sole prop, LLC, corporation).", - "nullable": true, - "enum": ["retail", "business"] - }, - "AchCreationRequest": { + "WireCreationRequestIban": { "type": "object", - "required": [ - "idempotencyKey", - "plaidProcessorToken", - "billingDetails", - "metadata" - ], + "title": "Non US Bank Account - IBAN Supported", + "description": "Relevant fields for non-U.S. bank accounts that support IBAN.", + "required": ["idempotencyKey", "iban", "billingDetails", "bankAddress"], "properties": { "idempotencyKey": { "$ref": "#/components/schemas/IdempotencyKey" }, - "plaidProcessorToken": { + "iban": { + "description": "International Bank Account Number (IBAN) for the bank account.", "type": "string", - "description": "The token for the ACH account provided by the processor (Plaid).", - "example": "processor-sandbox-circle-82cf95bb-43f8-4191-8d30-2c9f42853621" + "example": "DE31100400480532013000" }, "billingDetails": { - "$ref": "#/components/schemas/AchBillingDetails" - }, - "bankAccountType": { - "$ref": "#/components/schemas/AchAccountType" + "$ref": "#/components/schemas/BillingDetails" }, - "metadata": { - "$ref": "#/components/schemas/MetadataCardAndAch" + "bankAddress": { + "$ref": "#/components/schemas/BankAddressIbanSupported" } } }, - "AccountNumberMasked": { - "type": "string", - "description": "The redacted account number of the ACH account.", - "example": "****6789" - }, - "RoutingNumber": { - "type": "string", - "description": "The routing number of the ACH account.", - "example": "613334455" - }, - "AchVerificationErrorCodes": { - "type": "string", - "description": "Indicates the failure reason of the ACH account. Only present on failed accounts. Possible values are [bank_account_authorization_expired, bank_account_error, bank_account_ineligible, bank_account_not_found, bank_account_unauthorized, unsupported_routing_number, verification_failed].", - "nullable": true, - "enum": [ - "bank_account_authorization_expired", - "bank_account_error", - "bank_account_ineligible", - "bank_account_not_found", - "bank_account_unauthorized", - "unsupported_routing_number", - "verification_failed" - ] - }, - "Ach": { + "BankAddressNonIban": { "type": "object", - "required": [ - "id", - "accountNumber", - "routingNumber", - "description", - "billingDetails", - "bankAddress", - "fingerprint", - "metadata", - "createDate", - "updateDate" - ], + "description": "The address of the bank. BankName, City and Country fields are required.", + "required": ["bankName", "city", "country"], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" - }, - "accountNumber": { - "$ref": "#/components/schemas/AccountNumberMasked" - }, - "routingNumber": { - "$ref": "#/components/schemas/RoutingNumber" - }, - "billingDetails": { - "$ref": "#/components/schemas/AchBillingDetails" - }, - "bankAccountType": { - "$ref": "#/components/schemas/AchAccountType" - }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddress" - }, - "fingerprint": { - "$ref": "#/components/schemas/Fingerprint" - }, - "errorCode": { - "$ref": "#/components/schemas/AchVerificationErrorCodes" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" + "bankName": { + "type": "string", + "description": "Name of the bank. This property is required for bank accounts outside of the US that do not support IBAN'", + "maxLength": 35, + "example": "SAN FRANCISCO" }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "city": { + "type": "string", + "description": "City portion of the address. This property is required for bank accounts outside of the US.", + "maxLength": 1024, + "example": "SAN FRANCISCO" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "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" }, - "metadata": { - "$ref": "#/components/schemas/MetadataPhoneEmail" - } - } - }, - "SepaCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "accountName", "iban", "billingDetails"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "line1": { + "type": "string", + "description": "Line one of the street address.", + "maxLength": 35, + "example": "100 Money Street" }, - "iban": { + "line2": { "type": "string", - "description": "International Bank Account Number (IBAN) for the bank account.", - "example": "DE31100400480532013000" + "description": "Line two of the street address.", + "maxLength": 35, + "example": "Suite 1" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "district": { + "type": "string", + "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", + "maxLength": 16, + "example": "CA" } } }, - "Sepa": { + "WireCreationRequestAccountNumber": { "type": "object", + "title": "Non US Bank Account - IBAN Not Supported", + "description": "Relevant fields for non-U.S. banks that do NOT support IBAN.", "required": [ - "id", - "status", - "description", - "trackingRef", - "fingerprint", + "idempotencyKey", + "accountNumber", + "routingNumber", "billingDetails", - "createDate", - "updateDate" + "bankAddress" ], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "description": { + "accountNumber": { + "description": "Account number that identifies the bank account.", "type": "string", - "description": "Bank name plus last four digits of the IBAN.", - "example": "Bank of Ireland ****0010" + "example": "0321800123", + "minLength": 6, + "maxLength": 35 }, - "trackingRef": { + "routingNumber": { + "description": "The bank's SWIFT / BIC code.", "type": "string", - "description": "Tracking reference that needs to be set in the payment details or description.", - "example": "CIR13FB13A" - }, - "fingerprint": { - "$ref": "#/components/schemas/Fingerprint" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" + "example": "SBININBB354" }, "billingDetails": { "$ref": "#/components/schemas/BillingDetails" }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "bankAddress": { + "$ref": "#/components/schemas/BankAddressNonIban" } } }, - "SepaInstructionBeneficiary": { + "WireCreationRequest": { + "type": "object", + "description": "Request object used to create a bank account (wires). Different fields are required depending on the bank country, see the guide documentation for the list of supported bank countries along with which ones support IBAN.", + "oneOf": [ + { + "$ref": "#/components/schemas/WireCreationRequestUs" + }, + { + "$ref": "#/components/schemas/WireCreationRequestIban" + }, + { + "$ref": "#/components/schemas/WireCreationRequestAccountNumber" + } + ] + }, + "WireInstructionBeneficiary": { "type": "object", "properties": { "name": { @@ -10194,123 +8092,69 @@ } } }, - "SepaInstructionBeneficiaryBank": { + "WireInstructionBeneficiaryBank": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the beneficiary's bank.", - "example": "LHV Bank" + "example": "SILVERGATE BANK" }, - "bic": { + "swiftCode": { "type": "string", - "description": "BIC code of the beneficiary's bank account.", - "example": "LHVBEE22XXX" + "description": "SWIFT code of the beneficiary's bank account.", + "example": "SIVGUS66XXX" }, - "iban": { - "description": "IBAN of the beneficiary's bank account.", + "routingNumber": { + "type": "string", + "description": "ABA Routing number of the beneficiary's bank account.", + "example": "322286803" + }, + "accountNumber": { + "type": "string", + "description": "Account number of the beneficiary's bank account.", + "example": "****7427" + }, + "currency": { "type": "string", - "example": "****6789" + "description": "Currency of the beneficiary's bank account.", + "example": "USD" }, "address": { - "description": "Address of the beneficiary's bank.", "type": "string", - "example": "Tartu mnt 2, 10145 Tallinn" + "description": "Address of the beneficiary's bank.", + "example": "4250 EXECUTIVE SQUARE SUITE 300" }, "city": { - "description": "City of the beneficiary's bank.", "type": "string", - "example": "Tallinn" + "description": "City of the beneficiary's bank.", + "example": "LA JOLLA" }, "postalCode": { - "description": "Postal code of the beneficiary's bank.", "type": "string", - "example": "10017" + "description": "Postal code of the beneficiary's bank.", + "example": "02110" }, "country": { - "description": "Country code of the beneficiary's bank. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", "type": "string", - "example": "EE" + "description": "Country code of the beneficiary's bank. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "example": "US" } } }, - "SepaInstruction": { + "WireInstruction": { "type": "object", "properties": { "trackingRef": { "type": "string", - "description": "Circle tracking reference that needs to be set in the SEPA transfer reference field.", + "description": "Circle tracking reference that needs to be set in the wire reference field.", "example": "CIR13FB13A" }, "beneficiary": { - "$ref": "#/components/schemas/SepaInstructionBeneficiary" + "$ref": "#/components/schemas/WireInstructionBeneficiary" }, "beneficiaryBank": { - "$ref": "#/components/schemas/SepaInstructionBeneficiaryBank" - } - } - }, - "SignetFiatAccountResponse": { - "type": "object", - "required": [ - "id", - "status", - "trackingRef", - "walletAddress", - "createDate", - "updateDate" - ], - "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 Signet wallet.", - "example": "CIR13FB14A" - }, - "walletAddress": { - "type": "string", - "description": "Your signet wallet address.", - "example": "0xcac04f0069e4ac9314ac4e608e99278a3bebabcd" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "SignetFiatAccountCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "walletAddress"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "walletAddress": { - "type": "string", - "description": "Signet wallet address.", - "example": "0xcac04f0069e4ac9314ac4e608e99278a3bebabcd" - } - } - }, - "SignetInstruction": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the signet public description field.", - "example": "CIR13FB14A" - }, - "walletAddress": { - "type": "string", - "description": "Circle wallet address that needs to be set in the signet recipient wallet field.", - "example": "0x7e4f4fe03243ac7b291ebaee90b2bb27025a1234" + "$ref": "#/components/schemas/WireInstructionBeneficiaryBank" } } }, @@ -11430,7 +9274,7 @@ "type": { "type": "string", "description": "Type of the source.", - "enum": ["card", "ach"] + "enum": ["card"] } } }, @@ -12265,7 +10109,7 @@ "BusinessAccountPayoutDestinationType": { "type": "string", "description": "The destination bank account type.", - "enum": ["wire", "ach", "sepa", "signet"] + "enum": ["wire", "cbit"] }, "BankDestination": { "type": "object", @@ -12411,123 +10255,33 @@ "properties": { "type": { "type": "string", - "enum": ["wire", "sen", "signet"] - }, - "id": { - "$ref": "#/components/schemas/Id" - } - } - }, - "BusinessPayoutCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "destination", "amount"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "destination": { - "$ref": "#/components/schemas/BusinessDestinationRequest" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoney" - } - } - }, - "PayoutDestinationType": { - "type": "string", - "description": "The destination type.", - "enum": ["wire", "ach", "sepa", "address_book"] - }, - "FiatPayoutDestinationType": { - "type": "string", - "description": "The destination type.", - "enum": ["wire", "ach", "sepa"] - }, - "FiatPayoutDestination": { - "type": "object", - "description": "The destination.", - "required": ["type", "id"], - "properties": { - "type": { - "$ref": "#/components/schemas/FiatPayoutDestinationType" + "enum": ["wire", "cbit"] }, "id": { "$ref": "#/components/schemas/Id" - }, - "name": { - "type": "string", - "description": "Bank name plus last four digits of the bank account number or IBAN.", - "example": "COMMERZBANK AG ****3000" - } - } - }, - "PayoutMoney": { - "type": "object", - "required": ["amount", "currency"], - "properties": { - "amount": { - "type": "string", - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "example": "3.14" - }, - "currency": { - "type": "string", - "description": "Currency code for the amount.", - "enum": ["USD", "EUR", "BTC", "ETH", "MTC", "FLW", "MAN"] } - } - }, - "FiatPayout": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "sourceWalletId": { - "type": "string", - "description": "The identifier of the source wallet used to fund a payout.", - "example": "53535335" - }, - "destination": { - "$ref": "#/components/schemas/FiatPayoutDestination" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "toAmount": { - "$ref": "#/components/schemas/PayoutMoney" - }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "status": { - "$ref": "#/components/schemas/PayoutStatus" - }, - "trackingRef": { - "description": "A payout tracking reference. Will be present once known.", - "nullable": true, - "example": "CIR-6ESOQANEP3NAO" - }, - "errorCode": { - "$ref": "#/components/schemas/PayoutErrorCode" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "adjustments": { - "$ref": "#/components/schemas/FinalAdjustments" - }, - "return": { - "$ref": "#/components/schemas/UnwithdrawalObject" + } + }, + "BusinessPayoutCreationRequest": { + "type": "object", + "required": ["idempotencyKey", "destination", "amount"], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "destination": { + "$ref": "#/components/schemas/BusinessDestinationRequest" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "amount": { + "$ref": "#/components/schemas/FiatMoney" } } }, + "PayoutDestinationType": { + "type": "string", + "description": "The destination type.", + "enum": ["address_book"] + }, "CryptoPayoutDestinationType": { "type": "string", "description": "The destination type.", @@ -12546,6 +10300,22 @@ } } }, + "PayoutMoney": { + "type": "object", + "required": ["amount", "currency"], + "properties": { + "amount": { + "type": "string", + "description": "Magnitude of the amount, in units of the currency, with a `.`.", + "example": "3.14" + }, + "currency": { + "type": "string", + "description": "Currency code for the amount.", + "enum": ["USD", "EUR", "BTC", "ETH", "MTC", "FLW", "MAN"] + } + } + }, "CryptoPayout": { "type": "object", "properties": { @@ -12589,47 +10359,6 @@ } } }, - "MetadataPayout": { - "type": "object", - "description": "Additional properties related to the payout beneficiary.", - "required": ["beneficiaryEmail"], - "properties": { - "beneficiaryEmail": { - "$ref": "#/components/schemas/Email" - } - } - }, - "FiatPayoutCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "destination", "amount", "metadata"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "source": { - "$ref": "#/components/schemas/WalletLocation" - }, - "destination": { - "type": "object", - "description": "The destination.", - "required": ["type", "id"], - "properties": { - "type": { - "$ref": "#/components/schemas/FiatPayoutDestinationType" - }, - "id": { - "$ref": "#/components/schemas/Id" - } - } - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataPayout" - } - } - }, "IdentityAddress": { "type": "object", "required": ["line1", "city", "district", "postalCode", "country"], @@ -12750,62 +10479,6 @@ } } }, - "FiatDetailedPayout": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "sourceWalletId": { - "description": "The identifier of the source wallet used to fund a payout.", - "type": "string", - "example": "53535335" - }, - "destination": { - "$ref": "#/components/schemas/FiatPayoutDestination" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "toAmount": { - "$ref": "#/components/schemas/PayoutMoney" - }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "status": { - "description": "Status of the payout. Status `pending` indicates that the payout is in process; `complete` indicates it finished successfully; `failed` indicates it failed.", - "type": "string", - "enum": ["pending", "complete", "failed"] - }, - "trackingRef": { - "description": "A payout tracking reference. Will be present once known.", - "nullable": true, - "example": "CIR-6ESOQANEP3NAO" - }, - "externalRef": { - "$ref": "#/components/schemas/ExternalRef" - }, - "errorCode": { - "$ref": "#/components/schemas/PayoutErrorCode" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "adjustments": { - "$ref": "#/components/schemas/FinalAdjustments" - }, - "return": { - "$ref": "#/components/schemas/UnwithdrawalObject" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, "Rate": { "type": "object", "required": ["buy", "sell", "createDate"], @@ -12972,51 +10645,6 @@ } } }, - "Reversal": { - "type": "object", - "required": [ - "id", - "paymentId", - "amount", - "description", - "status", - "reason", - "fees", - "createDate", - "updateDate" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/IdKey" - }, - "paymentId": { - "$ref": "#/components/schemas/IdPayment" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "description": { - "type": "string", - "description": "Enumerated description of the payment.", - "example": "Merchant Payment Reversal" - }, - "status": { - "$ref": "#/components/schemas/CancelRefundReversalStatus" - }, - "reason": { - "$ref": "#/components/schemas/ReversalReason" - }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, "Wallet": { "type": "object", "properties": { @@ -13401,104 +11029,6 @@ "type": "object", "properties": {} }, - "MockSenPaymentBeneficiaryBankInstruction": { - "type": "object", - "required": ["accountNumber"], - "properties": { - "accountNumber": { - "type": "string", - "description": "Circle corporate Silvergate SEN account number that needs to be set as destination.", - "example": "11111111" - } - } - }, - "MockSenPaymentRequest": { - "type": "object", - "required": ["trackingRef", "amount", "beneficiaryBank"], - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the memo filed. This field is retrievable through the response during SEN account creation or via the bank instruction endpoint.", - "example": "CIR13FB13A" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoney" - }, - "beneficiaryBank": { - "$ref": "#/components/schemas/MockSenPaymentBeneficiaryBankInstruction" - } - } - }, - "MockSenPaymentResponse": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Wire tracking reference that needs to be set in the wire reference to beneficiary field. This field is retrievable through the response during wire creation or via the bank instruction endpoint.", - "example": "CIR13FB13A" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "beneficiaryBank": { - "$ref": "#/components/schemas/MockSenPaymentBeneficiaryBankInstruction" - }, - "status": { - "type": "string", - "description": "Enumerated status of the wire payment. Status `pending` indicates that the wire payment is in process; `processed` indicates it finished successfully; `failed` indicates it failed.", - "enum": ["pending", "processed", "failed"] - } - } - }, - "MockAchAccount": { - "type": "object", - "required": ["accountNumber", "routingNumber", "description"], - "properties": { - "accountNumber": { - "type": "string", - "description": "The account number of the ACH account.", - "example": "123456789" - }, - "routingNumber": { - "type": "string", - "description": "The routing number of the ACH account.\n\nFor sandbox testing, valid routing numbers include `011000028`, `011201762`, `011500120`, `021214862`, `121000248`, `121140399`, `211073473`, `221172610`, and `011000138`.\n", - "example": "011000028" - }, - "description": { - "type": "string", - "description": "A description for the ACH account.", - "example": "My ACH account" - } - } - }, - "MockAchAccountCreationRequest": { - "type": "object", - "required": ["account", "balance"], - "properties": { - "account": { - "$ref": "#/components/schemas/MockAchAccount" - }, - "balance": { - "$ref": "#/components/schemas/FiatMoneyUsd" - } - } - }, - "MockAchAccountResponse": { - "type": "object", - "properties": { - "processorToken": { - "type": "string", - "description": "The processor token needs to be provided when linking an ACH account against this mock.", - "example": "processor-sandbox-circle-82cf95bb-43f8-4191-8d30-2c9f42853621" - }, - "balance": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "account": { - "$ref": "#/components/schemas/MockAchAccount" - } - } - }, "MockWirePaymentBeneficiaryBankInstruction": { "type": "object", "required": ["accountNumber"], @@ -13548,38 +11078,6 @@ } } }, - "MockSepaPaymentRequest": { - "type": "object", - "required": ["trackingRef", "amount"], - "properties": { - "trackingRef": { - "type": "string", - "description": "SEPA tracking reference that needs to be set in the payment details or description.", - "example": "CIR13FB13A" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - } - } - }, - "MockSepaPaymentResponse": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "SEPA tracking reference that needs to be set in the payment details or description.", - "example": "CIR13FB13A" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "status": { - "type": "string", - "description": "Enumerated status of the SEPA payment. Status `pending` indicates that the SEPA payment is in process; `processed` indicates it finished successfully; `failed` indicates it failed.", - "enum": ["pending", "processed", "failed"] - } - } - }, "SuccessUrl": { "type": "string", "description": "The URL returned to you through client-side callback when the payment is completed.", @@ -14053,7 +11551,7 @@ "uniqueItems": true, "items": { "type": "string", - "enum": ["card", "wire", "ach", "sepa"] + "enum": ["card"] } } }, diff --git a/src/generated/.openapi-generator/FILES b/src/generated/.openapi-generator/FILES index f0a3dba..0f1a3f8 100644 --- a/src/generated/.openapi-generator/FILES +++ b/src/generated/.openapi-generator/FILES @@ -1,5 +1,4 @@ api.ts -apis/achapi.ts apis/addresses-api.ts apis/balances-api.ts apis/cards-api.ts @@ -18,12 +17,7 @@ apis/payment-tokens-api.ts apis/payments-api.ts apis/payouts-api.ts apis/pull-crypto-payments-api.ts -apis/returns-api.ts -apis/reversals-api.ts -apis/senapi.ts -apis/sepaapi.ts apis/settlements-api.ts -apis/signet-api.ts apis/stablecoins-api.ts apis/subscriptions-api.ts apis/transfers-api.ts @@ -34,11 +28,6 @@ common.ts configuration.ts index.ts models/account-configuration.ts -models/ach-account-type.ts -models/ach-billing-details.ts -models/ach-creation-request.ts -models/ach-verification-error-codes.ts -models/ach.ts models/address-book-recipient-metadata.ts models/address-book-recipient-modify-request.ts models/address-book-recipient-request.ts @@ -88,14 +77,11 @@ models/checkout-session.ts models/conflict.ts models/continuous-payment-intent-creation-request.ts models/continuous-payment-intent.ts -models/create-ach-account-response.ts models/create-address-book-recipient-response.ts models/create-business-cbit-account-response.ts models/create-business-deposit-address-response.ts models/create-business-payout-response.ts models/create-business-recipient-address-response.ts -models/create-business-sen-account-response.ts -models/create-business-signet-account-response.ts models/create-business-transfer-response.ts models/create-business-wire-account-response.ts models/create-card-response.ts @@ -103,23 +89,16 @@ models/create-checkout-session-response.ts models/create-crypto-payment-response.ts models/create-crypto-payment-response1.ts models/create-crypto-refund-response.ts -models/create-mock-ach-account-response.ts models/create-mock-chargeback-response.ts models/create-payment-intent-request.ts models/create-payment-intent-response-data.ts models/create-payment-intent-response.ts models/create-payment-response.ts models/create-payment-token-response.ts -models/create-payout-request.ts -models/create-payout-response-data.ts models/create-payout-response.ts -models/create-sen-payment-response.ts -models/create-sepa-account-response.ts -models/create-sepa-payment-response.ts models/create-subscription-response.ts models/create-transfer-response.ts models/create-wallet-response.ts -models/create-wire-account-response.ts models/create-wire-payment-response.ts models/crypto-payment-creation-request.ts models/crypto-payment-deposit-address.ts @@ -151,29 +130,19 @@ models/extend-checkout-session-response.ts models/external-fiat-account-status.ts models/fee.ts models/fiat-cancel.ts -models/fiat-detailed-payout.ts models/fiat-money-usd.ts models/fiat-money.ts models/fiat-payment-polymorphic.ts models/fiat-payment.ts -models/fiat-payout-creation-request-destination.ts -models/fiat-payout-creation-request.ts -models/fiat-payout-destination-type.ts -models/fiat-payout-destination.ts -models/fiat-payout.ts models/fiat-refund.ts models/final-adjustments.ts models/forbidden.ts models/generate-address-request.ts models/generate-address-response.ts -models/get-ach-account-response.ts models/get-address-book-recipient-response.ts models/get-business-cbit-account-response.ts models/get-business-deposit-address-response.ts models/get-business-payout-response.ts -models/get-business-sen-account-instructions-response.ts -models/get-business-sen-account-response.ts -models/get-business-signet-account-response.ts models/get-business-transfer-response.ts models/get-business-wire-account-instructions-response.ts models/get-business-wire-account-response.ts @@ -185,17 +154,12 @@ models/get-exchange-rates-response.ts models/get-payment-intent-response.ts models/get-payment-response-data.ts models/get-payment-response.ts -models/get-payout-response-data.ts models/get-payout-response.ts models/get-public-key-response.ts -models/get-sepa-account-instructions-response.ts -models/get-sepa-account-response.ts models/get-settlement-response.ts models/get-settlements-response.ts models/get-transfer-response.ts models/get-wallet-response.ts -models/get-wire-account-instructions-response.ts -models/get-wire-account-response.ts models/google-pay-token.ts models/identity-address.ts models/identity.ts @@ -210,9 +174,6 @@ models/list-business-cbit-accounts-response.ts models/list-business-deposits-response.ts models/list-business-payouts-response.ts models/list-business-recipient-addresses-response.ts -models/list-business-sen-accounts-response.ts -models/list-business-signet-account-instructions-response.ts -models/list-business-signet-accounts-response.ts models/list-business-transfers-response.ts models/list-business-wire-accounts-response.ts models/list-cards-response.ts @@ -223,10 +184,7 @@ models/list-payment-intents-response-data-inner.ts models/list-payment-intents-response.ts models/list-payments-response-data-inner.ts models/list-payments-response.ts -models/list-payouts-response-data-inner.ts models/list-payouts-response.ts -models/list-returns-response.ts -models/list-reversals-response.ts models/list-stablecoins-response.ts models/list-subscriptions-response.ts models/list-transfers-response.ts @@ -234,17 +192,8 @@ models/list-wallets-response.ts models/metadata-card-and-ach.ts models/metadata-crypto-payment.ts models/metadata-payment.ts -models/metadata-payout.ts models/metadata-phone-email.ts -models/mock-ach-account-creation-request.ts -models/mock-ach-account-response.ts -models/mock-ach-account.ts models/mock-chargeback-creation-request.ts -models/mock-sen-payment-beneficiary-bank-instruction.ts -models/mock-sen-payment-request.ts -models/mock-sen-payment-response.ts -models/mock-sepa-payment-request.ts -models/mock-sepa-payment-response.ts models/mock-wire-payment-beneficiary-bank-instruction.ts models/mock-wire-payment-request.ts models/mock-wire-payment-response.ts @@ -283,20 +232,8 @@ models/refund-creation-request.ts models/refund-payment-response.ts models/required-action.ts models/reversal-reason.ts -models/reversal.ts models/risk-evaluation.ts -models/sen-fiat-account-creation-request.ts -models/sen-fiat-account-response.ts -models/sen-instruction.ts -models/sepa-creation-request.ts -models/sepa-instruction-beneficiary-bank.ts -models/sepa-instruction-beneficiary.ts -models/sepa-instruction.ts -models/sepa.ts models/settlement.ts -models/signet-fiat-account-creation-request.ts -models/signet-fiat-account-response.ts -models/signet-instruction.ts models/simple-billing-details.ts models/simple-card.ts models/source-response.ts diff --git a/src/generated/api.ts b/src/generated/api.ts index c7252c3..1353e1b 100644 --- a/src/generated/api.ts +++ b/src/generated/api.ts @@ -6,7 +6,6 @@ * Do not edit the class manually. */ -export * from "./apis/achapi"; export * from "./apis/addresses-api"; export * from "./apis/balances-api"; export * from "./apis/cbitapi"; @@ -25,12 +24,7 @@ export * from "./apis/payment-tokens-api"; export * from "./apis/payments-api"; export * from "./apis/payouts-api"; export * from "./apis/pull-crypto-payments-api"; -export * from "./apis/returns-api"; -export * from "./apis/reversals-api"; -export * from "./apis/senapi"; -export * from "./apis/sepaapi"; export * from "./apis/settlements-api"; -export * from "./apis/signet-api"; export * from "./apis/stablecoins-api"; export * from "./apis/subscriptions-api"; export * from "./apis/transfers-api"; diff --git a/src/generated/apis/achapi.ts b/src/generated/apis/achapi.ts deleted file mode 100644 index 00050dd..0000000 --- a/src/generated/apis/achapi.ts +++ /dev/null @@ -1,421 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import globalAxios, { - AxiosPromise, - AxiosInstance, - AxiosRequestConfig -} from "axios"; -import { Configuration } from "../configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import { - DUMMY_BASE_URL, - assertParamExists, - setBearerAuthToObject, - setSearchParams, - serializeDataIfNeeded, - toPathString, - createRequestFunction -} from "../common"; -// @ts-ignore -import { - BASE_PATH, - COLLECTION_FORMATS, - RequestArgs, - BaseAPI, - RequiredError -} from "../base"; -// @ts-ignore -import { AchCreationRequest } from "../models"; -// @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { CreateAchAccountResponse } from "../models"; -// @ts-ignore -import { CreateMockAchAccountResponse } from "../models"; -// @ts-ignore -import { GetAchAccountResponse } from "../models"; -// @ts-ignore -import { MockAchAccountCreationRequest } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -/** - * ACHApi - axios parameter creator - * @export - */ -export const ACHApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a ACH bank account - * @param {AchCreationRequest} [achCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createAchAccount: async ( - achCreationRequest?: AchCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/banks/ach`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - achCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * In the sandbox environment, create a mock ACH account and retrieve a processor token that can be used to link an ACH account. - * @summary Create a mock ACH bank account - * @param {MockAchAccountCreationRequest} [mockAchAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockAchAccount: async ( - mockAchAccountCreationRequest?: MockAchAccountCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/mocks/ach/accounts`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - mockAchAccountCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a ACH bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAchAccount: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getAchAccount", "id", id); - const localVarPath = `/v1/banks/ach/{id}`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * ACHApi - functional programming interface - * @export - */ -export const ACHApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = ACHApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a ACH bank account - * @param {AchCreationRequest} [achCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createAchAccount( - achCreationRequest?: AchCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createAchAccount( - achCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * In the sandbox environment, create a mock ACH account and retrieve a processor token that can be used to link an ACH account. - * @summary Create a mock ACH bank account - * @param {MockAchAccountCreationRequest} [mockAchAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createMockAchAccount( - mockAchAccountCreationRequest?: MockAchAccountCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createMockAchAccount( - mockAchAccountCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a ACH bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getAchAccount( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAchAccount( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * ACHApi - factory interface - * @export - */ -export const ACHApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = ACHApiFp(configuration); - return { - /** - * - * @summary Create a ACH bank account - * @param {AchCreationRequest} [achCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createAchAccount( - achCreationRequest?: AchCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createAchAccount(achCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * In the sandbox environment, create a mock ACH account and retrieve a processor token that can be used to link an ACH account. - * @summary Create a mock ACH bank account - * @param {MockAchAccountCreationRequest} [mockAchAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockAchAccount( - mockAchAccountCreationRequest?: MockAchAccountCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createMockAchAccount(mockAchAccountCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a ACH bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAchAccount( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getAchAccount(id, options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * ACHApi - object-oriented interface - * @export - * @class ACHApi - * @extends {BaseAPI} - */ -export class ACHApi extends BaseAPI { - /** - * - * @summary Create a ACH bank account - * @param {AchCreationRequest} [achCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ACHApi - */ - public createAchAccount( - achCreationRequest?: AchCreationRequest, - options?: AxiosRequestConfig - ) { - return ACHApiFp(this.configuration) - .createAchAccount(achCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * In the sandbox environment, create a mock ACH account and retrieve a processor token that can be used to link an ACH account. - * @summary Create a mock ACH bank account - * @param {MockAchAccountCreationRequest} [mockAchAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ACHApi - */ - public createMockAchAccount( - mockAchAccountCreationRequest?: MockAchAccountCreationRequest, - options?: AxiosRequestConfig - ) { - return ACHApiFp(this.configuration) - .createMockAchAccount(mockAchAccountCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a ACH bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ACHApi - */ - public getAchAccount(id: string, options?: AxiosRequestConfig) { - return ACHApiFp(this.configuration) - .getAchAccount(id, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/deposits-api.ts b/src/generated/apis/deposits-api.ts index 1ea8c9d..d3e9b89 100644 --- a/src/generated/apis/deposits-api.ts +++ b/src/generated/apis/deposits-api.ts @@ -32,14 +32,8 @@ import { RequiredError } from "../base"; // @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { CreateSenPaymentResponse } from "../models"; -// @ts-ignore import { ListBusinessDepositsResponse } from "../models"; // @ts-ignore -import { MockSenPaymentRequest } from "../models"; -// @ts-ignore import { NotAuthorized } from "../models"; /** * DepositsApi - axios parameter creator @@ -49,58 +43,6 @@ export const DepositsApiAxiosParamCreator = function ( configuration?: Configuration ) { return { - /** - * In the sandbox environment, initiate a mock SEN transfer that mimics the behavior of funds sent through the Silvergate SEN account linked to master wallet. - * @summary Create a mock Silvergate SEN payment - * @param {MockSenPaymentRequest} [mockSenPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockSenPayment: async ( - mockSenPaymentRequest?: MockSenPaymentRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/mocks/payments/sen`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - mockSenPaymentRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, /** * Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided. * @summary List all deposits @@ -192,34 +134,6 @@ export const DepositsApiAxiosParamCreator = function ( export const DepositsApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = DepositsApiAxiosParamCreator(configuration); return { - /** - * In the sandbox environment, initiate a mock SEN transfer that mimics the behavior of funds sent through the Silvergate SEN account linked to master wallet. - * @summary Create a mock Silvergate SEN payment - * @param {MockSenPaymentRequest} [mockSenPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createMockSenPayment( - mockSenPaymentRequest?: MockSenPaymentRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createMockSenPayment( - mockSenPaymentRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, /** * Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided. * @summary List all deposits @@ -277,21 +191,6 @@ export const DepositsApiFactory = function ( ) { const localVarFp = DepositsApiFp(configuration); return { - /** - * In the sandbox environment, initiate a mock SEN transfer that mimics the behavior of funds sent through the Silvergate SEN account linked to master wallet. - * @summary Create a mock Silvergate SEN payment - * @param {MockSenPaymentRequest} [mockSenPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockSenPayment( - mockSenPaymentRequest?: MockSenPaymentRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createMockSenPayment(mockSenPaymentRequest, options) - .then((request) => request(axios, basePath)); - }, /** * Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided. * @summary List all deposits @@ -335,23 +234,6 @@ export const DepositsApiFactory = function ( * @extends {BaseAPI} */ export class DepositsApi extends BaseAPI { - /** - * In the sandbox environment, initiate a mock SEN transfer that mimics the behavior of funds sent through the Silvergate SEN account linked to master wallet. - * @summary Create a mock Silvergate SEN payment - * @param {MockSenPaymentRequest} [mockSenPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DepositsApi - */ - public createMockSenPayment( - mockSenPaymentRequest?: MockSenPaymentRequest, - options?: AxiosRequestConfig - ) { - return DepositsApiFp(this.configuration) - .createMockSenPayment(mockSenPaymentRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - /** * Searches for deposits sent to your business account. If the date parameters are omitted, returns the most recent deposits. This endpoint returns up to 50 deposits in descending chronological order or pageSize, if provided. * @summary List all deposits diff --git a/src/generated/apis/payments-api.ts b/src/generated/apis/payments-api.ts index d42ce76..d0c4c17 100644 --- a/src/generated/apis/payments-api.ts +++ b/src/generated/apis/payments-api.ts @@ -42,16 +42,12 @@ import { CaptureCreationRequest } from "../models"; // @ts-ignore import { CreatePaymentResponse } from "../models"; // @ts-ignore -import { CreateSepaPaymentResponse } from "../models"; -// @ts-ignore import { CreateWirePaymentResponse } from "../models"; // @ts-ignore import { GetPaymentResponse } from "../models"; // @ts-ignore import { ListPaymentsResponse } from "../models"; // @ts-ignore -import { MockSepaPaymentRequest } from "../models"; -// @ts-ignore import { MockWirePaymentRequest } from "../models"; // @ts-ignore import { NotAuthorized } from "../models"; @@ -189,58 +185,6 @@ export const PaymentsApiAxiosParamCreator = function ( options: localVarRequestOptions }; }, - /** - * In the sandbox environment, initiate a mock SEPA payment that mimics the behavior of funds sent through the bank (SEPA) account linked to master wallet. - * @summary Create a mock SEPA payment - * @param {MockSepaPaymentRequest} [mockSepaPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockSepaPayment: async ( - mockSepaPaymentRequest?: MockSepaPaymentRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/mocks/payments/sepa`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - mockSepaPaymentRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, /** * In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet. * @summary Create a mock Wire payment @@ -401,7 +345,7 @@ export const PaymentsApiAxiosParamCreator = function ( * @param {string} [source] Universally unique identifier (UUID v4) for the source. Filters results to fetch only payments made from the provdided source. * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. * @param {string} [paymentIntentId] Queries items with the specified payment intent id. - * @param {Set<'card' | 'wire' | 'ach' | 'sepa'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. + * @param {Set<'card'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -415,7 +359,7 @@ export const PaymentsApiAxiosParamCreator = function ( source?: string, settlementId?: string, paymentIntentId?: string, - type?: Set<"card" | "wire" | "ach" | "sepa">, + type?: Set<"card">, status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", from?: string, to?: string, @@ -626,34 +570,6 @@ export const PaymentsApiFp = function (configuration?: Configuration) { configuration ); }, - /** - * In the sandbox environment, initiate a mock SEPA payment that mimics the behavior of funds sent through the bank (SEPA) account linked to master wallet. - * @summary Create a mock SEPA payment - * @param {MockSepaPaymentRequest} [mockSepaPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createMockSepaPayment( - mockSepaPaymentRequest?: MockSepaPaymentRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createMockSepaPayment( - mockSepaPaymentRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, /** * In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet. * @summary Create a mock Wire payment @@ -742,7 +658,7 @@ export const PaymentsApiFp = function (configuration?: Configuration) { * @param {string} [source] Universally unique identifier (UUID v4) for the source. Filters results to fetch only payments made from the provdided source. * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. * @param {string} [paymentIntentId] Queries items with the specified payment intent id. - * @param {Set<'card' | 'wire' | 'ach' | 'sepa'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. + * @param {Set<'card'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -756,7 +672,7 @@ export const PaymentsApiFp = function (configuration?: Configuration) { source?: string, settlementId?: string, paymentIntentId?: string, - type?: Set<"card" | "wire" | "ach" | "sepa">, + type?: Set<"card">, status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", from?: string, to?: string, @@ -868,21 +784,6 @@ export const PaymentsApiFactory = function ( .capturePayment(id, captureCreationRequest, options) .then((request) => request(axios, basePath)); }, - /** - * In the sandbox environment, initiate a mock SEPA payment that mimics the behavior of funds sent through the bank (SEPA) account linked to master wallet. - * @summary Create a mock SEPA payment - * @param {MockSepaPaymentRequest} [mockSepaPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockSepaPayment( - mockSepaPaymentRequest?: MockSepaPaymentRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createMockSepaPayment(mockSepaPaymentRequest, options) - .then((request) => request(axios, basePath)); - }, /** * In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet. * @summary Create a mock Wire payment @@ -931,7 +832,7 @@ export const PaymentsApiFactory = function ( * @param {string} [source] Universally unique identifier (UUID v4) for the source. Filters results to fetch only payments made from the provdided source. * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. * @param {string} [paymentIntentId] Queries items with the specified payment intent id. - * @param {Set<'card' | 'wire' | 'ach' | 'sepa'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. + * @param {Set<'card'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -945,7 +846,7 @@ export const PaymentsApiFactory = function ( source?: string, settlementId?: string, paymentIntentId?: string, - type?: Set<"card" | "wire" | "ach" | "sepa">, + type?: Set<"card">, status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", from?: string, to?: string, @@ -1035,23 +936,6 @@ export class PaymentsApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } - /** - * In the sandbox environment, initiate a mock SEPA payment that mimics the behavior of funds sent through the bank (SEPA) account linked to master wallet. - * @summary Create a mock SEPA payment - * @param {MockSepaPaymentRequest} [mockSepaPaymentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PaymentsApi - */ - public createMockSepaPayment( - mockSepaPaymentRequest?: MockSepaPaymentRequest, - options?: AxiosRequestConfig - ) { - return PaymentsApiFp(this.configuration) - .createMockSepaPayment(mockSepaPaymentRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - /** * In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet. * @summary Create a mock Wire payment @@ -1106,7 +990,7 @@ export class PaymentsApi extends BaseAPI { * @param {string} [source] Universally unique identifier (UUID v4) for the source. Filters results to fetch only payments made from the provdided source. * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. * @param {string} [paymentIntentId] Queries items with the specified payment intent id. - * @param {Set<'card' | 'wire' | 'ach' | 'sepa'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. + * @param {Set<'card'>} [type] Source account type. Filters the results to fetch all payments made from a specified account type. Matches any source type if unspecified. * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -1121,7 +1005,7 @@ export class PaymentsApi extends BaseAPI { source?: string, settlementId?: string, paymentIntentId?: string, - type?: Set<"card" | "wire" | "ach" | "sepa">, + type?: Set<"card">, status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", from?: string, to?: string, diff --git a/src/generated/apis/payouts-api.ts b/src/generated/apis/payouts-api.ts index 1984000..c4bb6ca 100644 --- a/src/generated/apis/payouts-api.ts +++ b/src/generated/apis/payouts-api.ts @@ -38,10 +38,10 @@ import { BusinessPayoutCreationRequest } from "../models"; // @ts-ignore import { CreateBusinessPayoutResponse } from "../models"; // @ts-ignore -import { CreatePayoutRequest } from "../models"; -// @ts-ignore import { CreatePayoutResponse } from "../models"; // @ts-ignore +import { CryptoPayoutCreationRequest } from "../models"; +// @ts-ignore import { GetBusinessPayoutResponse } from "../models"; // @ts-ignore import { GetPayoutResponse } from "../models"; @@ -118,14 +118,14 @@ export const PayoutsApiAxiosParamCreator = function ( }; }, /** - * Create a wire, ACH, SEPA or crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | + * Create a crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | * @summary Create a payout - * @param {CreatePayoutRequest} [createPayoutRequest] + * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPayout: async ( - createPayoutRequest?: CreatePayoutRequest, + cryptoPayoutCreationRequest?: CryptoPayoutCreationRequest, options: AxiosRequestConfig = {} ): Promise => { const localVarPath = `/v1/payouts`; @@ -159,7 +159,7 @@ export const PayoutsApiAxiosParamCreator = function ( ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded( - createPayoutRequest, + cryptoPayoutCreationRequest, localVarRequestOptions, configuration ); @@ -273,7 +273,7 @@ export const PayoutsApiAxiosParamCreator = function ( * * @summary List all payouts * @param {string} [destination] Universally unique identifier (UUID v4) for the destination bank account. Filters the results to fetch all payouts made to a destination bank account. - * @param {'wire'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. + * @param {'wire' | 'cbit'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -285,7 +285,7 @@ export const PayoutsApiAxiosParamCreator = function ( */ listBusinessPayouts: async ( destination?: string, - type?: "wire", + type?: "wire" | "cbit", status?: Set, from?: string, to?: string, @@ -535,14 +535,14 @@ export const PayoutsApiFp = function (configuration?: Configuration) { ); }, /** - * Create a wire, ACH, SEPA or crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | + * Create a crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | * @summary Create a payout - * @param {CreatePayoutRequest} [createPayoutRequest] + * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async createPayout( - createPayoutRequest?: CreatePayoutRequest, + cryptoPayoutCreationRequest?: CryptoPayoutCreationRequest, options?: AxiosRequestConfig ): Promise< ( @@ -551,7 +551,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { ) => AxiosPromise > { const localVarAxiosArgs = await localVarAxiosParamCreator.createPayout( - createPayoutRequest, + cryptoPayoutCreationRequest, options ); return createRequestFunction( @@ -617,7 +617,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { * * @summary List all payouts * @param {string} [destination] Universally unique identifier (UUID v4) for the destination bank account. Filters the results to fetch all payouts made to a destination bank account. - * @param {'wire'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. + * @param {'wire' | 'cbit'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -629,7 +629,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { */ async listBusinessPayouts( destination?: string, - type?: "wire", + type?: "wire" | "cbit", status?: Set, from?: string, to?: string, @@ -769,18 +769,18 @@ export const PayoutsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Create a wire, ACH, SEPA or crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | + * Create a crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | * @summary Create a payout - * @param {CreatePayoutRequest} [createPayoutRequest] + * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPayout( - createPayoutRequest?: CreatePayoutRequest, + cryptoPayoutCreationRequest?: CryptoPayoutCreationRequest, options?: any ): AxiosPromise { return localVarFp - .createPayout(createPayoutRequest, options) + .createPayout(cryptoPayoutCreationRequest, options) .then((request) => request(axios, basePath)); }, /** @@ -814,7 +814,7 @@ export const PayoutsApiFactory = function ( * * @summary List all payouts * @param {string} [destination] Universally unique identifier (UUID v4) for the destination bank account. Filters the results to fetch all payouts made to a destination bank account. - * @param {'wire'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. + * @param {'wire' | 'cbit'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -826,7 +826,7 @@ export const PayoutsApiFactory = function ( */ listBusinessPayouts( destination?: string, - type?: "wire", + type?: "wire" | "cbit", status?: Set, from?: string, to?: string, @@ -945,19 +945,19 @@ export class PayoutsApi extends BaseAPI { } /** - * Create a wire, ACH, SEPA or crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | + * Create a crypto payout. The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | USD | | USD | BTC | | USD | ETH | | USD | MTC | | EUR | EUR | | BTC | USD | | BTC | BTC | | ETH | USD | | ETH | ETH | * @summary Create a payout - * @param {CreatePayoutRequest} [createPayoutRequest] + * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PayoutsApi */ public createPayout( - createPayoutRequest?: CreatePayoutRequest, + cryptoPayoutCreationRequest?: CryptoPayoutCreationRequest, options?: AxiosRequestConfig ) { return PayoutsApiFp(this.configuration) - .createPayout(createPayoutRequest, options) + .createPayout(cryptoPayoutCreationRequest, options) .then((request) => request(this.axios, this.basePath)); } @@ -993,7 +993,7 @@ export class PayoutsApi extends BaseAPI { * * @summary List all payouts * @param {string} [destination] Universally unique identifier (UUID v4) for the destination bank account. Filters the results to fetch all payouts made to a destination bank account. - * @param {'wire'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. + * @param {'wire' | 'cbit'} [type] Destination bank account type. Filters the results to fetch all payouts made to a specified destination bank account type. This query parameter can be passed multiple times to fetch results matching multiple destination bank account types. * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -1006,7 +1006,7 @@ export class PayoutsApi extends BaseAPI { */ public listBusinessPayouts( destination?: string, - type?: "wire", + type?: "wire" | "cbit", status?: Set, from?: string, to?: string, diff --git a/src/generated/apis/returns-api.ts b/src/generated/apis/returns-api.ts deleted file mode 100644 index 47910de..0000000 --- a/src/generated/apis/returns-api.ts +++ /dev/null @@ -1,243 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import globalAxios, { - AxiosPromise, - AxiosInstance, - AxiosRequestConfig -} from "axios"; -import { Configuration } from "../configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import { - DUMMY_BASE_URL, - assertParamExists, - setBearerAuthToObject, - setSearchParams, - serializeDataIfNeeded, - toPathString, - createRequestFunction -} from "../common"; -// @ts-ignore -import { - BASE_PATH, - COLLECTION_FORMATS, - RequestArgs, - BaseAPI, - RequiredError -} from "../base"; -// @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { ListReturnsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -/** - * ReturnsApi - axios parameter creator - * @export - */ -export const ReturnsApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * Retrieve a list of Wire and ACH payout returns. Results will be sorted by create date descending; more recent returns will be at the beginning of the list. - * @summary List all payout returns - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listReturns: async ( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/returns`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - if (from !== undefined) { - localVarQueryParameter["from"] = - (from as any) instanceof Date ? (from as any).toISOString() : from; - } - - if (to !== undefined) { - localVarQueryParameter["to"] = - (to as any) instanceof Date ? (to as any).toISOString() : to; - } - - if (pageBefore !== undefined) { - localVarQueryParameter["pageBefore"] = pageBefore; - } - - if (pageAfter !== undefined) { - localVarQueryParameter["pageAfter"] = pageAfter; - } - - if (pageSize !== undefined) { - localVarQueryParameter["pageSize"] = pageSize; - } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * ReturnsApi - functional programming interface - * @export - */ -export const ReturnsApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = ReturnsApiAxiosParamCreator(configuration); - return { - /** - * Retrieve a list of Wire and ACH payout returns. Results will be sorted by create date descending; more recent returns will be at the beginning of the list. - * @summary List all payout returns - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listReturns( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listReturns( - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * ReturnsApi - factory interface - * @export - */ -export const ReturnsApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = ReturnsApiFp(configuration); - return { - /** - * Retrieve a list of Wire and ACH payout returns. Results will be sorted by create date descending; more recent returns will be at the beginning of the list. - * @summary List all payout returns - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listReturns( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: any - ): AxiosPromise { - return localVarFp - .listReturns(from, to, pageBefore, pageAfter, pageSize, options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * ReturnsApi - object-oriented interface - * @export - * @class ReturnsApi - * @extends {BaseAPI} - */ -export class ReturnsApi extends BaseAPI { - /** - * Retrieve a list of Wire and ACH payout returns. Results will be sorted by create date descending; more recent returns will be at the beginning of the list. - * @summary List all payout returns - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ReturnsApi - */ - public listReturns( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ) { - return ReturnsApiFp(this.configuration) - .listReturns(from, to, pageBefore, pageAfter, pageSize, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/reversals-api.ts b/src/generated/apis/reversals-api.ts deleted file mode 100644 index 4d3f16e..0000000 --- a/src/generated/apis/reversals-api.ts +++ /dev/null @@ -1,265 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import globalAxios, { - AxiosPromise, - AxiosInstance, - AxiosRequestConfig -} from "axios"; -import { Configuration } from "../configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import { - DUMMY_BASE_URL, - assertParamExists, - setBearerAuthToObject, - setSearchParams, - serializeDataIfNeeded, - toPathString, - createRequestFunction -} from "../common"; -// @ts-ignore -import { - BASE_PATH, - COLLECTION_FORMATS, - RequestArgs, - BaseAPI, - RequiredError -} from "../base"; -// @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { ListReversalsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -/** - * ReversalsApi - axios parameter creator - * @export - */ -export const ReversalsApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * Retrieve a list of ACH payment reversals. Results will be sorted by create date descending; more recent reversals will be at the beginning of the list - * @summary List all ACH payment reversals. - * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listReversals: async ( - status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/reversals`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - if (status !== undefined) { - localVarQueryParameter["status"] = status; - } - - if (from !== undefined) { - localVarQueryParameter["from"] = - (from as any) instanceof Date ? (from as any).toISOString() : from; - } - - if (to !== undefined) { - localVarQueryParameter["to"] = - (to as any) instanceof Date ? (to as any).toISOString() : to; - } - - if (pageBefore !== undefined) { - localVarQueryParameter["pageBefore"] = pageBefore; - } - - if (pageAfter !== undefined) { - localVarQueryParameter["pageAfter"] = pageAfter; - } - - if (pageSize !== undefined) { - localVarQueryParameter["pageSize"] = pageSize; - } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * ReversalsApi - functional programming interface - * @export - */ -export const ReversalsApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = - ReversalsApiAxiosParamCreator(configuration); - return { - /** - * Retrieve a list of ACH payment reversals. Results will be sorted by create date descending; more recent reversals will be at the beginning of the list - * @summary List all ACH payment reversals. - * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listReversals( - status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listReversals( - status, - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * ReversalsApi - factory interface - * @export - */ -export const ReversalsApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = ReversalsApiFp(configuration); - return { - /** - * Retrieve a list of ACH payment reversals. Results will be sorted by create date descending; more recent reversals will be at the beginning of the list - * @summary List all ACH payment reversals. - * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listReversals( - status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: any - ): AxiosPromise { - return localVarFp - .listReversals( - status, - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * ReversalsApi - object-oriented interface - * @export - * @class ReversalsApi - * @extends {BaseAPI} - */ -export class ReversalsApi extends BaseAPI { - /** - * Retrieve a list of ACH payment reversals. Results will be sorted by create date descending; more recent reversals will be at the beginning of the list - * @summary List all ACH payment reversals. - * @param {'pending' | 'confirmed' | 'paid' | 'failed' | 'action_required'} [status] Queries items with the specified status. Matches any status if unspecified. - * @param {string} [from] Queries items created since the specified date-time (inclusive). - * @param {string} [to] Queries items created before the specified date-time (inclusive). - * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. - * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. - * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ReversalsApi - */ - public listReversals( - status?: "pending" | "confirmed" | "paid" | "failed" | "action_required", - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ) { - return ReversalsApiFp(this.configuration) - .listReversals(status, from, to, pageBefore, pageAfter, pageSize, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/senapi.ts b/src/generated/apis/senapi.ts deleted file mode 100644 index c91840a..0000000 --- a/src/generated/apis/senapi.ts +++ /dev/null @@ -1,510 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import globalAxios, { - AxiosPromise, - AxiosInstance, - AxiosRequestConfig -} from "axios"; -import { Configuration } from "../configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import { - DUMMY_BASE_URL, - assertParamExists, - setBearerAuthToObject, - setSearchParams, - serializeDataIfNeeded, - toPathString, - createRequestFunction -} from "../common"; -// @ts-ignore -import { - BASE_PATH, - COLLECTION_FORMATS, - RequestArgs, - BaseAPI, - RequiredError -} from "../base"; -// @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { CreateBusinessSenAccountResponse } from "../models"; -// @ts-ignore -import { GetBusinessSenAccountInstructionsResponse } from "../models"; -// @ts-ignore -import { GetBusinessSenAccountResponse } from "../models"; -// @ts-ignore -import { ListBusinessSenAccountsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -// @ts-ignore -import { SenFiatAccountCreationRequest } from "../models"; -/** - * SENApi - axios parameter creator - * @export - */ -export const SENApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a Silvergate SEN bank account (BETA) - * @param {SenFiatAccountCreationRequest} [senFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createBusinessSenAccount: async ( - senFiatAccountCreationRequest?: SenFiatAccountCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/businessAccount/banks/sen`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - senFiatAccountCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a Silvergate SEN bank account (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSenAccount: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getBusinessSenAccount", "id", id); - const localVarPath = `/v1/businessAccount/banks/sen/{id}`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * Get the Silvergate SEN transfer instructions into the Circle bank account given your bank account id (BETA). - * @summary Get Silvergate SEN instructions (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSenAccountInstructions: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getBusinessSenAccountInstructions", "id", id); - const localVarPath = - `/v1/businessAccount/banks/sen/{id}/instructions`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary List all Silvergate SEN bank accounts (BETA). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listBusinessSenAccounts: async ( - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/businessAccount/banks/sen`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * SENApi - functional programming interface - * @export - */ -export const SENApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = SENApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a Silvergate SEN bank account (BETA) - * @param {SenFiatAccountCreationRequest} [senFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createBusinessSenAccount( - senFiatAccountCreationRequest?: SenFiatAccountCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createBusinessSenAccount( - senFiatAccountCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a Silvergate SEN bank account (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getBusinessSenAccount( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getBusinessSenAccount(id, options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Get the Silvergate SEN transfer instructions into the Circle bank account given your bank account id (BETA). - * @summary Get Silvergate SEN instructions (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getBusinessSenAccountInstructions( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getBusinessSenAccountInstructions( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary List all Silvergate SEN bank accounts (BETA). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listBusinessSenAccounts( - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.listBusinessSenAccounts(options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * SENApi - factory interface - * @export - */ -export const SENApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = SENApiFp(configuration); - return { - /** - * - * @summary Create a Silvergate SEN bank account (BETA) - * @param {SenFiatAccountCreationRequest} [senFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createBusinessSenAccount( - senFiatAccountCreationRequest?: SenFiatAccountCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createBusinessSenAccount(senFiatAccountCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a Silvergate SEN bank account (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSenAccount( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getBusinessSenAccount(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * Get the Silvergate SEN transfer instructions into the Circle bank account given your bank account id (BETA). - * @summary Get Silvergate SEN instructions (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSenAccountInstructions( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getBusinessSenAccountInstructions(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary List all Silvergate SEN bank accounts (BETA). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listBusinessSenAccounts( - options?: any - ): AxiosPromise { - return localVarFp - .listBusinessSenAccounts(options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * SENApi - object-oriented interface - * @export - * @class SENApi - * @extends {BaseAPI} - */ -export class SENApi extends BaseAPI { - /** - * - * @summary Create a Silvergate SEN bank account (BETA) - * @param {SenFiatAccountCreationRequest} [senFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SENApi - */ - public createBusinessSenAccount( - senFiatAccountCreationRequest?: SenFiatAccountCreationRequest, - options?: AxiosRequestConfig - ) { - return SENApiFp(this.configuration) - .createBusinessSenAccount(senFiatAccountCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a Silvergate SEN bank account (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SENApi - */ - public getBusinessSenAccount(id: string, options?: AxiosRequestConfig) { - return SENApiFp(this.configuration) - .getBusinessSenAccount(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Silvergate SEN transfer instructions into the Circle bank account given your bank account id (BETA). - * @summary Get Silvergate SEN instructions (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SENApi - */ - public getBusinessSenAccountInstructions( - id: string, - options?: AxiosRequestConfig - ) { - return SENApiFp(this.configuration) - .getBusinessSenAccountInstructions(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List all Silvergate SEN bank accounts (BETA). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SENApi - */ - public listBusinessSenAccounts(options?: AxiosRequestConfig) { - return SENApiFp(this.configuration) - .listBusinessSenAccounts(options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/sepaapi.ts b/src/generated/apis/sepaapi.ts deleted file mode 100644 index e5f4a1c..0000000 --- a/src/generated/apis/sepaapi.ts +++ /dev/null @@ -1,411 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import globalAxios, { - AxiosPromise, - AxiosInstance, - AxiosRequestConfig -} from "axios"; -import { Configuration } from "../configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import { - DUMMY_BASE_URL, - assertParamExists, - setBearerAuthToObject, - setSearchParams, - serializeDataIfNeeded, - toPathString, - createRequestFunction -} from "../common"; -// @ts-ignore -import { - BASE_PATH, - COLLECTION_FORMATS, - RequestArgs, - BaseAPI, - RequiredError -} from "../base"; -// @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { CreateSepaAccountResponse } from "../models"; -// @ts-ignore -import { GetSepaAccountInstructionsResponse } from "../models"; -// @ts-ignore -import { GetSepaAccountResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -// @ts-ignore -import { SepaCreationRequest } from "../models"; -/** - * SEPAApi - axios parameter creator - * @export - */ -export const SEPAApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a SEPA bank account - * @param {SepaCreationRequest} [sepaCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createSepaAccount: async ( - sepaCreationRequest?: SepaCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/banks/sepa`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - sepaCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a SEPA bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSepaAccount: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getSepaAccount", "id", id); - const localVarPath = `/v1/banks/sepa/{id}`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * Get the SEPA transfer instructions into the Circle bank account given your bank account id. - * @summary Get SEPA instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSepaAccountInstructions: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getSepaAccountInstructions", "id", id); - const localVarPath = `/v1/banks/sepa/{id}/instructions`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * SEPAApi - functional programming interface - * @export - */ -export const SEPAApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = SEPAApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a SEPA bank account - * @param {SepaCreationRequest} [sepaCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createSepaAccount( - sepaCreationRequest?: SepaCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createSepaAccount( - sepaCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a SEPA bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getSepaAccount( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSepaAccount( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Get the SEPA transfer instructions into the Circle bank account given your bank account id. - * @summary Get SEPA instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getSepaAccountInstructions( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getSepaAccountInstructions(id, options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * SEPAApi - factory interface - * @export - */ -export const SEPAApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = SEPAApiFp(configuration); - return { - /** - * - * @summary Create a SEPA bank account - * @param {SepaCreationRequest} [sepaCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createSepaAccount( - sepaCreationRequest?: SepaCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createSepaAccount(sepaCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a SEPA bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSepaAccount( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getSepaAccount(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * Get the SEPA transfer instructions into the Circle bank account given your bank account id. - * @summary Get SEPA instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSepaAccountInstructions( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getSepaAccountInstructions(id, options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * SEPAApi - object-oriented interface - * @export - * @class SEPAApi - * @extends {BaseAPI} - */ -export class SEPAApi extends BaseAPI { - /** - * - * @summary Create a SEPA bank account - * @param {SepaCreationRequest} [sepaCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SEPAApi - */ - public createSepaAccount( - sepaCreationRequest?: SepaCreationRequest, - options?: AxiosRequestConfig - ) { - return SEPAApiFp(this.configuration) - .createSepaAccount(sepaCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a SEPA bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SEPAApi - */ - public getSepaAccount(id: string, options?: AxiosRequestConfig) { - return SEPAApiFp(this.configuration) - .getSepaAccount(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the SEPA transfer instructions into the Circle bank account given your bank account id. - * @summary Get SEPA instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SEPAApi - */ - public getSepaAccountInstructions(id: string, options?: AxiosRequestConfig) { - return SEPAApiFp(this.configuration) - .getSepaAccountInstructions(id, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/signet-api.ts b/src/generated/apis/signet-api.ts deleted file mode 100644 index e1a4c77..0000000 --- a/src/generated/apis/signet-api.ts +++ /dev/null @@ -1,510 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import globalAxios, { - AxiosPromise, - AxiosInstance, - AxiosRequestConfig -} from "axios"; -import { Configuration } from "../configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import { - DUMMY_BASE_URL, - assertParamExists, - setBearerAuthToObject, - setSearchParams, - serializeDataIfNeeded, - toPathString, - createRequestFunction -} from "../common"; -// @ts-ignore -import { - BASE_PATH, - COLLECTION_FORMATS, - RequestArgs, - BaseAPI, - RequiredError -} from "../base"; -// @ts-ignore -import { BadRequest } from "../models"; -// @ts-ignore -import { CreateBusinessSignetAccountResponse } from "../models"; -// @ts-ignore -import { GetBusinessSignetAccountResponse } from "../models"; -// @ts-ignore -import { ListBusinessSignetAccountInstructionsResponse } from "../models"; -// @ts-ignore -import { ListBusinessSignetAccountsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -// @ts-ignore -import { SignetFiatAccountCreationRequest } from "../models"; -/** - * SignetApi - axios parameter creator - * @export - */ -export const SignetApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a Signet bank account (Production Only) - * @param {SignetFiatAccountCreationRequest} [signetFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createBusinessSignetAccount: async ( - signetFiatAccountCreationRequest?: SignetFiatAccountCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/businessAccount/banks/signet`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - signetFiatAccountCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a Signet bank account (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSignetAccount: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getBusinessSignetAccount", "id", id); - const localVarPath = `/v1/businessAccount/banks/signet/{id}`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * Get the Signet transfer instructions into the Circle bank account given your bank account id (only available on Production now). - * @summary Get Signet instructions (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSignetAccountInstructions: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getBusinessSignetAccountInstructions", "id", id); - const localVarPath = - `/v1/businessAccount/banks/signet/{id}/instructions`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary List all Signet bank accounts (Production Only). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listBusinessSignetAccounts: async ( - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/businessAccount/banks/signet`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * SignetApi - functional programming interface - * @export - */ -export const SignetApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = SignetApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a Signet bank account (Production Only) - * @param {SignetFiatAccountCreationRequest} [signetFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createBusinessSignetAccount( - signetFiatAccountCreationRequest?: SignetFiatAccountCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createBusinessSignetAccount( - signetFiatAccountCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a Signet bank account (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getBusinessSignetAccount( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getBusinessSignetAccount(id, options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Get the Signet transfer instructions into the Circle bank account given your bank account id (only available on Production now). - * @summary Get Signet instructions (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getBusinessSignetAccountInstructions( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getBusinessSignetAccountInstructions( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary List all Signet bank accounts (Production Only). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listBusinessSignetAccounts( - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.listBusinessSignetAccounts(options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * SignetApi - factory interface - * @export - */ -export const SignetApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = SignetApiFp(configuration); - return { - /** - * - * @summary Create a Signet bank account (Production Only) - * @param {SignetFiatAccountCreationRequest} [signetFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createBusinessSignetAccount( - signetFiatAccountCreationRequest?: SignetFiatAccountCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createBusinessSignetAccount(signetFiatAccountCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a Signet bank account (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSignetAccount( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getBusinessSignetAccount(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * Get the Signet transfer instructions into the Circle bank account given your bank account id (only available on Production now). - * @summary Get Signet instructions (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBusinessSignetAccountInstructions( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getBusinessSignetAccountInstructions(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary List all Signet bank accounts (Production Only). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listBusinessSignetAccounts( - options?: any - ): AxiosPromise { - return localVarFp - .listBusinessSignetAccounts(options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * SignetApi - object-oriented interface - * @export - * @class SignetApi - * @extends {BaseAPI} - */ -export class SignetApi extends BaseAPI { - /** - * - * @summary Create a Signet bank account (Production Only) - * @param {SignetFiatAccountCreationRequest} [signetFiatAccountCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SignetApi - */ - public createBusinessSignetAccount( - signetFiatAccountCreationRequest?: SignetFiatAccountCreationRequest, - options?: AxiosRequestConfig - ) { - return SignetApiFp(this.configuration) - .createBusinessSignetAccount(signetFiatAccountCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a Signet bank account (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SignetApi - */ - public getBusinessSignetAccount(id: string, options?: AxiosRequestConfig) { - return SignetApiFp(this.configuration) - .getBusinessSignetAccount(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the Signet transfer instructions into the Circle bank account given your bank account id (only available on Production now). - * @summary Get Signet instructions (Production Only) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SignetApi - */ - public getBusinessSignetAccountInstructions( - id: string, - options?: AxiosRequestConfig - ) { - return SignetApiFp(this.configuration) - .getBusinessSignetAccountInstructions(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List all Signet bank accounts (Production Only). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SignetApi - */ - public listBusinessSignetAccounts(options?: AxiosRequestConfig) { - return SignetApiFp(this.configuration) - .listBusinessSignetAccounts(options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/wires-api.ts b/src/generated/apis/wires-api.ts index 85eed99..a8af1af 100644 --- a/src/generated/apis/wires-api.ts +++ b/src/generated/apis/wires-api.ts @@ -36,16 +36,10 @@ import { BadRequest } from "../models"; // @ts-ignore import { CreateBusinessWireAccountResponse } from "../models"; // @ts-ignore -import { CreateWireAccountResponse } from "../models"; -// @ts-ignore import { GetBusinessWireAccountInstructionsResponse } from "../models"; // @ts-ignore import { GetBusinessWireAccountResponse } from "../models"; // @ts-ignore -import { GetWireAccountInstructionsResponse } from "../models"; -// @ts-ignore -import { GetWireAccountResponse } from "../models"; -// @ts-ignore import { ListBusinessWireAccountsResponse } from "../models"; // @ts-ignore import { NotAuthorized } from "../models"; @@ -113,58 +107,6 @@ export const WiresApiAxiosParamCreator = function ( options: localVarRequestOptions }; }, - /** - * - * @summary Create a Wire bank account - * @param {WireCreationRequest} [wireCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createWireAccount: async ( - wireCreationRequest?: WireCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/banks/wires`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "POST", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - localVarHeaderParameter["Content-Type"] = "application/json"; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - localVarRequestOptions.data = serializeDataIfNeeded( - wireCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, /** * * @summary Get a Wire bank account @@ -272,106 +214,6 @@ export const WiresApiAxiosParamCreator = function ( options: localVarRequestOptions }; }, - /** - * - * @summary Get a Wire bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getWireAccount: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getWireAccount", "id", id); - const localVarPath = `/v1/banks/wires/{id}`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * Get the wire transfer instructions into the Circle bank account given your bank account id - * @summary Get Wire instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getWireAccountInstructions: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getWireAccountInstructions", "id", id); - const localVarPath = `/v1/banks/wires/{id}/instructions`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { - method: "GET", - ...baseOptions, - ...options - }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication bearerAuth required - // http bearer authentication required - await setBearerAuthToObject(localVarHeaderParameter, configuration); - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, /** * * @summary List all Wire bank accounts @@ -453,34 +295,6 @@ export const WiresApiFp = function (configuration?: Configuration) { configuration ); }, - /** - * - * @summary Create a Wire bank account - * @param {WireCreationRequest} [wireCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createWireAccount( - wireCreationRequest?: WireCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createWireAccount( - wireCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, /** * * @summary Get a Wire bank account @@ -537,58 +351,6 @@ export const WiresApiFp = function (configuration?: Configuration) { configuration ); }, - /** - * - * @summary Get a Wire bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getWireAccount( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getWireAccount( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Get the wire transfer instructions into the Circle bank account given your bank account id - * @summary Get Wire instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getWireAccountInstructions( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getWireAccountInstructions(id, options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, /** * * @summary List all Wire bank accounts @@ -641,21 +403,6 @@ export const WiresApiFactory = function ( .createBusinessWireAccount(wireCreationRequest, options) .then((request) => request(axios, basePath)); }, - /** - * - * @summary Create a Wire bank account - * @param {WireCreationRequest} [wireCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createWireAccount( - wireCreationRequest?: WireCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createWireAccount(wireCreationRequest, options) - .then((request) => request(axios, basePath)); - }, /** * * @summary Get a Wire bank account @@ -688,36 +435,6 @@ export const WiresApiFactory = function ( .getBusinessWireAccountInstructions(id, currency, options) .then((request) => request(axios, basePath)); }, - /** - * - * @summary Get a Wire bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getWireAccount( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getWireAccount(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * Get the wire transfer instructions into the Circle bank account given your bank account id - * @summary Get Wire instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getWireAccountInstructions( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getWireAccountInstructions(id, options) - .then((request) => request(axios, basePath)); - }, /** * * @summary List all Wire bank accounts @@ -758,23 +475,6 @@ export class WiresApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Create a Wire bank account - * @param {WireCreationRequest} [wireCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WiresApi - */ - public createWireAccount( - wireCreationRequest?: WireCreationRequest, - options?: AxiosRequestConfig - ) { - return WiresApiFp(this.configuration) - .createWireAccount(wireCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Get a Wire bank account @@ -808,34 +508,6 @@ export class WiresApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Get a Wire bank account - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WiresApi - */ - public getWireAccount(id: string, options?: AxiosRequestConfig) { - return WiresApiFp(this.configuration) - .getWireAccount(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Get the wire transfer instructions into the Circle bank account given your bank account id - * @summary Get Wire instructions - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WiresApi - */ - public getWireAccountInstructions(id: string, options?: AxiosRequestConfig) { - return WiresApiFp(this.configuration) - .getWireAccountInstructions(id, options) - .then((request) => request(this.axios, this.basePath)); - } - /** * * @summary List all Wire bank accounts diff --git a/src/generated/index.ts b/src/generated/index.ts index eabf90b..c0d8ca9 100644 --- a/src/generated/index.ts +++ b/src/generated/index.ts @@ -7,7 +7,6 @@ */ import { - ACHApi, AddressesApi, BalancesApi, CBITApi, @@ -26,12 +25,7 @@ import { PaymentsApi, PayoutsApi, PullCryptoPaymentsApi, - ReturnsApi, - ReversalsApi, - SENApi, - SEPAApi, SettlementsApi, - SignetApi, StablecoinsApi, SubscriptionsApi, TransfersApi, @@ -43,7 +37,6 @@ import { Configuration } from "./configuration"; export * from "./models"; export class Circle { - public ach: ACHApi; public addresses: AddressesApi; public balances: BalancesApi; public cbit: CBITApi; @@ -62,12 +55,7 @@ export class Circle { public payments: PaymentsApi; public payouts: PayoutsApi; public pullCryptoPayments: PullCryptoPaymentsApi; - public returns: ReturnsApi; - public reversals: ReversalsApi; - public sen: SENApi; - public sepa: SEPAApi; public settlements: SettlementsApi; - public signet: SignetApi; public stablecoins: StablecoinsApi; public subscriptions: SubscriptionsApi; public transfers: TransfersApi; @@ -76,7 +64,6 @@ export class Circle { constructor(apiKey: string, baseUrl: string) { const configuration = new Configuration({ basePath: baseUrl, apiKey }); - this.ach = new ACHApi(configuration); this.addresses = new AddressesApi(configuration); this.balances = new BalancesApi(configuration); this.cbit = new CBITApi(configuration); @@ -95,12 +82,7 @@ export class Circle { this.payments = new PaymentsApi(configuration); this.payouts = new PayoutsApi(configuration); this.pullCryptoPayments = new PullCryptoPaymentsApi(configuration); - this.returns = new ReturnsApi(configuration); - this.reversals = new ReversalsApi(configuration); - this.sen = new SENApi(configuration); - this.sepa = new SEPAApi(configuration); this.settlements = new SettlementsApi(configuration); - this.signet = new SignetApi(configuration); this.stablecoins = new StablecoinsApi(configuration); this.subscriptions = new SubscriptionsApi(configuration); this.transfers = new TransfersApi(configuration); diff --git a/src/generated/models/ach-account-type.ts b/src/generated/models/ach-account-type.ts deleted file mode 100644 index a7bb080..0000000 --- a/src/generated/models/ach-account-type.ts +++ /dev/null @@ -1,20 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Retail account (individual consumer account) or Business account (e.g. sole prop, LLC, corporation). - * @export - * @enum {string} - */ - -export const AchAccountType = { - Retail: "retail", - Business: "business" -} as const; - -export type AchAccountType = typeof AchAccountType[keyof typeof AchAccountType]; diff --git a/src/generated/models/ach-billing-details.ts b/src/generated/models/ach-billing-details.ts deleted file mode 100644 index 2d0adbc..0000000 --- a/src/generated/models/ach-billing-details.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Billing details of the account holder. - * @export - * @interface AchBillingDetails - */ -export interface AchBillingDetails { - /** - * Full name of the card or bank account holder. - * @type {string} - * @memberof AchBillingDetails - */ - name: string; - /** - * City portion of the address. - * @type {string} - * @memberof AchBillingDetails - */ - city?: string; - /** - * Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. - * @type {string} - * @memberof AchBillingDetails - */ - country?: string; - /** - * Line one of the street address. - * @type {string} - * @memberof AchBillingDetails - */ - line1?: string; - /** - * Line two of the street address. - * @type {string} - * @memberof AchBillingDetails - */ - line2?: string; - /** - * 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} - * @memberof AchBillingDetails - */ - district?: string; - /** - * Postal / ZIP code of the address. - * @type {string} - * @memberof AchBillingDetails - */ - postalCode?: string; -} diff --git a/src/generated/models/ach-creation-request.ts b/src/generated/models/ach-creation-request.ts deleted file mode 100644 index 3e3127d..0000000 --- a/src/generated/models/ach-creation-request.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { AchAccountType } from "./ach-account-type"; -// May contain unused imports in some cases -// @ts-ignore -import { AchBillingDetails } from "./ach-billing-details"; -// May contain unused imports in some cases -// @ts-ignore -import { MetadataCardAndAch } from "./metadata-card-and-ach"; - -/** - * - * @export - * @interface AchCreationRequest - */ -export interface AchCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof AchCreationRequest - */ - idempotencyKey: string; - /** - * The token for the ACH account provided by the processor (Plaid). - * @type {string} - * @memberof AchCreationRequest - */ - plaidProcessorToken: string; - /** - * - * @type {AchBillingDetails} - * @memberof AchCreationRequest - */ - billingDetails: AchBillingDetails; - /** - * - * @type {AchAccountType} - * @memberof AchCreationRequest - */ - bankAccountType?: AchAccountType | null; - /** - * - * @type {MetadataCardAndAch} - * @memberof AchCreationRequest - */ - metadata: MetadataCardAndAch; -} diff --git a/src/generated/models/ach-verification-error-codes.ts b/src/generated/models/ach-verification-error-codes.ts deleted file mode 100644 index f9e0e9b..0000000 --- a/src/generated/models/ach-verification-error-codes.ts +++ /dev/null @@ -1,26 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Indicates the failure reason of the ACH account. Only present on failed accounts. Possible values are [bank_account_authorization_expired, bank_account_error, bank_account_ineligible, bank_account_not_found, bank_account_unauthorized, unsupported_routing_number, verification_failed]. - * @export - * @enum {string} - */ - -export const AchVerificationErrorCodes = { - BankAccountAuthorizationExpired: "bank_account_authorization_expired", - BankAccountError: "bank_account_error", - BankAccountIneligible: "bank_account_ineligible", - BankAccountNotFound: "bank_account_not_found", - BankAccountUnauthorized: "bank_account_unauthorized", - UnsupportedRoutingNumber: "unsupported_routing_number", - VerificationFailed: "verification_failed" -} as const; - -export type AchVerificationErrorCodes = - typeof AchVerificationErrorCodes[keyof typeof AchVerificationErrorCodes]; diff --git a/src/generated/models/ach.ts b/src/generated/models/ach.ts deleted file mode 100644 index 1c3c72e..0000000 --- a/src/generated/models/ach.ts +++ /dev/null @@ -1,115 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { AchAccountType } from "./ach-account-type"; -// May contain unused imports in some cases -// @ts-ignore -import { AchBillingDetails } from "./ach-billing-details"; -// May contain unused imports in some cases -// @ts-ignore -import { AchVerificationErrorCodes } from "./ach-verification-error-codes"; -// May contain unused imports in some cases -// @ts-ignore -import { BankAddress } from "./bank-address"; -// May contain unused imports in some cases -// @ts-ignore -import { ExternalFiatAccountStatus } from "./external-fiat-account-status"; -// May contain unused imports in some cases -// @ts-ignore -import { MetadataPhoneEmail } from "./metadata-phone-email"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; - -/** - * - * @export - * @interface Ach - */ -export interface Ach { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof Ach - */ - id: string; - /** - * - * @type {ExternalFiatAccountStatus} - * @memberof Ach - */ - status?: ExternalFiatAccountStatus; - /** - * The redacted account number of the ACH account. - * @type {string} - * @memberof Ach - */ - accountNumber: string; - /** - * The routing number of the ACH account. - * @type {string} - * @memberof Ach - */ - routingNumber: string; - /** - * - * @type {AchBillingDetails} - * @memberof Ach - */ - billingDetails: AchBillingDetails; - /** - * - * @type {AchAccountType} - * @memberof Ach - */ - bankAccountType?: AchAccountType | null; - /** - * - * @type {BankAddress} - * @memberof Ach - */ - bankAddress: BankAddress; - /** - * A UUID that uniquely identifies the account number. If the same account is used more than once, each card object will have a different id, but the fingerprint will stay the same. - * @type {string} - * @memberof Ach - */ - fingerprint: string; - /** - * - * @type {AchVerificationErrorCodes} - * @memberof Ach - */ - errorCode?: AchVerificationErrorCodes | null; - /** - * - * @type {RiskEvaluation} - * @memberof Ach - */ - riskEvaluation?: RiskEvaluation | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Ach - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Ach - */ - updateDate: string; - /** - * - * @type {MetadataPhoneEmail} - * @memberof Ach - */ - metadata: MetadataPhoneEmail; -} diff --git a/src/generated/models/business-account-payout-destination-type.ts b/src/generated/models/business-account-payout-destination-type.ts index bc54485..5689f61 100644 --- a/src/generated/models/business-account-payout-destination-type.ts +++ b/src/generated/models/business-account-payout-destination-type.ts @@ -14,9 +14,7 @@ export const BusinessAccountPayoutDestinationType = { Wire: "wire", - Ach: "ach", - Sepa: "sepa", - Signet: "signet" + Cbit: "cbit" } as const; export type BusinessAccountPayoutDestinationType = diff --git a/src/generated/models/business-destination-request.ts b/src/generated/models/business-destination-request.ts index df2ec2f..67ffefb 100644 --- a/src/generated/models/business-destination-request.ts +++ b/src/generated/models/business-destination-request.ts @@ -28,8 +28,7 @@ export interface BusinessDestinationRequest { export const BusinessDestinationRequestTypeEnum = { Wire: "wire", - Sen: "sen", - Signet: "signet" + Cbit: "cbit" } as const; export type BusinessDestinationRequestTypeEnum = diff --git a/src/generated/models/create-ach-account-response.ts b/src/generated/models/create-ach-account-response.ts deleted file mode 100644 index 7f5dbcd..0000000 --- a/src/generated/models/create-ach-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Ach } from "./ach"; - -/** - * - * @export - * @interface CreateAchAccountResponse - */ -export interface CreateAchAccountResponse { - /** - * - * @type {Ach} - * @memberof CreateAchAccountResponse - */ - data?: Ach; -} diff --git a/src/generated/models/create-business-sen-account-response.ts b/src/generated/models/create-business-sen-account-response.ts deleted file mode 100644 index 1bd38c5..0000000 --- a/src/generated/models/create-business-sen-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SenFiatAccountResponse } from "./sen-fiat-account-response"; - -/** - * - * @export - * @interface CreateBusinessSenAccountResponse - */ -export interface CreateBusinessSenAccountResponse { - /** - * - * @type {SenFiatAccountResponse} - * @memberof CreateBusinessSenAccountResponse - */ - data?: SenFiatAccountResponse; -} diff --git a/src/generated/models/create-business-signet-account-response.ts b/src/generated/models/create-business-signet-account-response.ts deleted file mode 100644 index 14ab89a..0000000 --- a/src/generated/models/create-business-signet-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SignetFiatAccountResponse } from "./signet-fiat-account-response"; - -/** - * - * @export - * @interface CreateBusinessSignetAccountResponse - */ -export interface CreateBusinessSignetAccountResponse { - /** - * - * @type {SignetFiatAccountResponse} - * @memberof CreateBusinessSignetAccountResponse - */ - data?: SignetFiatAccountResponse; -} diff --git a/src/generated/models/create-mock-ach-account-response.ts b/src/generated/models/create-mock-ach-account-response.ts deleted file mode 100644 index 5e827e3..0000000 --- a/src/generated/models/create-mock-ach-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { MockAchAccountResponse } from "./mock-ach-account-response"; - -/** - * - * @export - * @interface CreateMockAchAccountResponse - */ -export interface CreateMockAchAccountResponse { - /** - * - * @type {MockAchAccountResponse} - * @memberof CreateMockAchAccountResponse - */ - data?: MockAchAccountResponse; -} diff --git a/src/generated/models/create-payout-request.ts b/src/generated/models/create-payout-request.ts deleted file mode 100644 index 32705f5..0000000 --- a/src/generated/models/create-payout-request.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayoutCreationRequest } from "./crypto-payout-creation-request"; -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayoutDestination } from "./crypto-payout-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayoutCreationRequest } from "./fiat-payout-creation-request"; -// May contain unused imports in some cases -// @ts-ignore -import { MetadataPayout } from "./metadata-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { Money } from "./money"; -// May contain unused imports in some cases -// @ts-ignore -import { ToAmount } from "./to-amount"; -// May contain unused imports in some cases -// @ts-ignore -import { TransferSourceWalletLocation } from "./transfer-source-wallet-location"; - -/** - * @type CreatePayoutRequest - * @export - */ -export type CreatePayoutRequest = - | CryptoPayoutCreationRequest - | FiatPayoutCreationRequest; diff --git a/src/generated/models/create-payout-response-data.ts b/src/generated/models/create-payout-response-data.ts deleted file mode 100644 index 71e0b73..0000000 --- a/src/generated/models/create-payout-response-data.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayout } from "./crypto-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayoutDestination } from "./crypto-payout-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayout } from "./fiat-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { FinalAdjustments } from "./final-adjustments"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutErrorCode } from "./payout-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutMoney } from "./payout-money"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutStatus } from "./payout-status"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { UnwithdrawalObject } from "./unwithdrawal-object"; - -/** - * @type CreatePayoutResponseData - * @export - */ -export type CreatePayoutResponseData = CryptoPayout | FiatPayout; diff --git a/src/generated/models/create-payout-response.ts b/src/generated/models/create-payout-response.ts index 2582bae..74656ca 100644 --- a/src/generated/models/create-payout-response.ts +++ b/src/generated/models/create-payout-response.ts @@ -8,7 +8,7 @@ // May contain unused imports in some cases // @ts-ignore -import { CreatePayoutResponseData } from "./create-payout-response-data"; +import { CryptoPayout } from "./crypto-payout"; /** * @@ -18,8 +18,8 @@ import { CreatePayoutResponseData } from "./create-payout-response-data"; export interface CreatePayoutResponse { /** * - * @type {CreatePayoutResponseData} + * @type {CryptoPayout} * @memberof CreatePayoutResponse */ - data?: CreatePayoutResponseData; + data?: CryptoPayout; } diff --git a/src/generated/models/create-sen-payment-response.ts b/src/generated/models/create-sen-payment-response.ts deleted file mode 100644 index ceb473c..0000000 --- a/src/generated/models/create-sen-payment-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { MockSenPaymentResponse } from "./mock-sen-payment-response"; - -/** - * - * @export - * @interface CreateSenPaymentResponse - */ -export interface CreateSenPaymentResponse { - /** - * - * @type {MockSenPaymentResponse} - * @memberof CreateSenPaymentResponse - */ - data?: MockSenPaymentResponse; -} diff --git a/src/generated/models/create-sepa-account-response.ts b/src/generated/models/create-sepa-account-response.ts deleted file mode 100644 index 6118019..0000000 --- a/src/generated/models/create-sepa-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Sepa } from "./sepa"; - -/** - * - * @export - * @interface CreateSepaAccountResponse - */ -export interface CreateSepaAccountResponse { - /** - * - * @type {Sepa} - * @memberof CreateSepaAccountResponse - */ - data?: Sepa; -} diff --git a/src/generated/models/create-sepa-payment-response.ts b/src/generated/models/create-sepa-payment-response.ts deleted file mode 100644 index 3225976..0000000 --- a/src/generated/models/create-sepa-payment-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { MockSepaPaymentResponse } from "./mock-sepa-payment-response"; - -/** - * - * @export - * @interface CreateSepaPaymentResponse - */ -export interface CreateSepaPaymentResponse { - /** - * - * @type {MockSepaPaymentResponse} - * @memberof CreateSepaPaymentResponse - */ - data?: MockSepaPaymentResponse; -} diff --git a/src/generated/models/create-wire-account-response.ts b/src/generated/models/create-wire-account-response.ts deleted file mode 100644 index fa825c3..0000000 --- a/src/generated/models/create-wire-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Wire } from "./wire"; - -/** - * - * @export - * @interface CreateWireAccountResponse - */ -export interface CreateWireAccountResponse { - /** - * - * @type {Wire} - * @memberof CreateWireAccountResponse - */ - data?: Wire; -} diff --git a/src/generated/models/fiat-detailed-payout.ts b/src/generated/models/fiat-detailed-payout.ts deleted file mode 100644 index 15c999c..0000000 --- a/src/generated/models/fiat-detailed-payout.ts +++ /dev/null @@ -1,136 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayoutDestination } from "./fiat-payout-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { FinalAdjustments } from "./final-adjustments"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutErrorCode } from "./payout-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutMoney } from "./payout-money"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { UnwithdrawalObject } from "./unwithdrawal-object"; - -/** - * - * @export - * @interface FiatDetailedPayout - */ -export interface FiatDetailedPayout { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof FiatDetailedPayout - */ - id?: string; - /** - * The identifier of the source wallet used to fund a payout. - * @type {string} - * @memberof FiatDetailedPayout - */ - sourceWalletId?: string; - /** - * - * @type {FiatPayoutDestination} - * @memberof FiatDetailedPayout - */ - destination?: FiatPayoutDestination; - /** - * - * @type {FiatMoneyUsd} - * @memberof FiatDetailedPayout - */ - amount?: FiatMoneyUsd; - /** - * - * @type {PayoutMoney} - * @memberof FiatDetailedPayout - */ - toAmount?: PayoutMoney; - /** - * - * @type {FiatMoneyUsd} - * @memberof FiatDetailedPayout - */ - fees?: FiatMoneyUsd; - /** - * Status of the payout. Status `pending` indicates that the payout is in process; `complete` indicates it finished successfully; `failed` indicates it failed. - * @type {string} - * @memberof FiatDetailedPayout - */ - status?: FiatDetailedPayoutStatusEnum; - /** - * A payout tracking reference. Will be present once known. - * @type {any} - * @memberof FiatDetailedPayout - */ - trackingRef?: any | null; - /** - * External network identifier which will be present once provided from the applicable network. Examples: * **Input/Output Message Accountability Data (IMAD/OMAD)**: unique number given to each FedWire payment when using the Federal Reserve Bank Service which can be used to investigate and track wire transfers. - * @type {string} - * @memberof FiatDetailedPayout - */ - externalRef?: string; - /** - * - * @type {PayoutErrorCode} - * @memberof FiatDetailedPayout - */ - errorCode?: PayoutErrorCode | null; - /** - * - * @type {RiskEvaluation} - * @memberof FiatDetailedPayout - */ - riskEvaluation?: RiskEvaluation | null; - /** - * - * @type {FinalAdjustments} - * @memberof FiatDetailedPayout - */ - adjustments?: FinalAdjustments | null; - /** - * - * @type {UnwithdrawalObject} - * @memberof FiatDetailedPayout - */ - return?: UnwithdrawalObject | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof FiatDetailedPayout - */ - createDate?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof FiatDetailedPayout - */ - updateDate?: string; -} - -export const FiatDetailedPayoutStatusEnum = { - Pending: "pending", - Complete: "complete", - Failed: "failed" -} as const; - -export type FiatDetailedPayoutStatusEnum = - typeof FiatDetailedPayoutStatusEnum[keyof typeof FiatDetailedPayoutStatusEnum]; diff --git a/src/generated/models/fiat-payout-creation-request-destination.ts b/src/generated/models/fiat-payout-creation-request-destination.ts deleted file mode 100644 index bcaf3ad..0000000 --- a/src/generated/models/fiat-payout-creation-request-destination.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayoutDestinationType } from "./fiat-payout-destination-type"; - -/** - * The destination. - * @export - * @interface FiatPayoutCreationRequestDestination - */ -export interface FiatPayoutCreationRequestDestination { - /** - * - * @type {FiatPayoutDestinationType} - * @memberof FiatPayoutCreationRequestDestination - */ - type: FiatPayoutDestinationType; - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof FiatPayoutCreationRequestDestination - */ - id: string; -} diff --git a/src/generated/models/fiat-payout-creation-request.ts b/src/generated/models/fiat-payout-creation-request.ts deleted file mode 100644 index 9fead9e..0000000 --- a/src/generated/models/fiat-payout-creation-request.ts +++ /dev/null @@ -1,58 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayoutCreationRequestDestination } from "./fiat-payout-creation-request-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { MetadataPayout } from "./metadata-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { WalletLocation } from "./wallet-location"; - -/** - * - * @export - * @interface FiatPayoutCreationRequest - */ -export interface FiatPayoutCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof FiatPayoutCreationRequest - */ - idempotencyKey: string; - /** - * - * @type {WalletLocation} - * @memberof FiatPayoutCreationRequest - */ - source?: WalletLocation; - /** - * - * @type {FiatPayoutCreationRequestDestination} - * @memberof FiatPayoutCreationRequest - */ - destination: FiatPayoutCreationRequestDestination; - /** - * - * @type {FiatMoneyUsd} - * @memberof FiatPayoutCreationRequest - */ - amount: FiatMoneyUsd; - /** - * - * @type {MetadataPayout} - * @memberof FiatPayoutCreationRequest - */ - metadata: MetadataPayout; -} diff --git a/src/generated/models/fiat-payout-destination-type.ts b/src/generated/models/fiat-payout-destination-type.ts deleted file mode 100644 index 27c15b9..0000000 --- a/src/generated/models/fiat-payout-destination-type.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * The destination type. - * @export - * @enum {string} - */ - -export const FiatPayoutDestinationType = { - Wire: "wire", - Ach: "ach", - Sepa: "sepa" -} as const; - -export type FiatPayoutDestinationType = - typeof FiatPayoutDestinationType[keyof typeof FiatPayoutDestinationType]; diff --git a/src/generated/models/fiat-payout-destination.ts b/src/generated/models/fiat-payout-destination.ts deleted file mode 100644 index e285788..0000000 --- a/src/generated/models/fiat-payout-destination.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayoutDestinationType } from "./fiat-payout-destination-type"; - -/** - * The destination. - * @export - * @interface FiatPayoutDestination - */ -export interface FiatPayoutDestination { - /** - * - * @type {FiatPayoutDestinationType} - * @memberof FiatPayoutDestination - */ - type: FiatPayoutDestinationType; - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof FiatPayoutDestination - */ - id: string; - /** - * Bank name plus last four digits of the bank account number or IBAN. - * @type {string} - * @memberof FiatPayoutDestination - */ - name?: string; -} diff --git a/src/generated/models/fiat-payout.ts b/src/generated/models/fiat-payout.ts deleted file mode 100644 index 9812350..0000000 --- a/src/generated/models/fiat-payout.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayoutDestination } from "./fiat-payout-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { FinalAdjustments } from "./final-adjustments"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutErrorCode } from "./payout-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutMoney } from "./payout-money"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutStatus } from "./payout-status"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { UnwithdrawalObject } from "./unwithdrawal-object"; - -/** - * - * @export - * @interface FiatPayout - */ -export interface FiatPayout { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof FiatPayout - */ - id?: string; - /** - * The identifier of the source wallet used to fund a payout. - * @type {string} - * @memberof FiatPayout - */ - sourceWalletId?: string; - /** - * - * @type {FiatPayoutDestination} - * @memberof FiatPayout - */ - destination?: FiatPayoutDestination; - /** - * - * @type {FiatMoneyUsd} - * @memberof FiatPayout - */ - amount?: FiatMoneyUsd; - /** - * - * @type {PayoutMoney} - * @memberof FiatPayout - */ - toAmount?: PayoutMoney; - /** - * - * @type {FiatMoneyUsd} - * @memberof FiatPayout - */ - fees?: FiatMoneyUsd; - /** - * - * @type {PayoutStatus} - * @memberof FiatPayout - */ - status?: PayoutStatus; - /** - * A payout tracking reference. Will be present once known. - * @type {any} - * @memberof FiatPayout - */ - trackingRef?: any | null; - /** - * - * @type {PayoutErrorCode} - * @memberof FiatPayout - */ - errorCode?: PayoutErrorCode | null; - /** - * - * @type {RiskEvaluation} - * @memberof FiatPayout - */ - riskEvaluation?: RiskEvaluation | null; - /** - * - * @type {FinalAdjustments} - * @memberof FiatPayout - */ - adjustments?: FinalAdjustments | null; - /** - * - * @type {UnwithdrawalObject} - * @memberof FiatPayout - */ - return?: UnwithdrawalObject | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof FiatPayout - */ - createDate?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof FiatPayout - */ - updateDate?: string; -} diff --git a/src/generated/models/get-ach-account-response.ts b/src/generated/models/get-ach-account-response.ts deleted file mode 100644 index a40217d..0000000 --- a/src/generated/models/get-ach-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Ach } from "./ach"; - -/** - * - * @export - * @interface GetAchAccountResponse - */ -export interface GetAchAccountResponse { - /** - * - * @type {Ach} - * @memberof GetAchAccountResponse - */ - data?: Ach; -} diff --git a/src/generated/models/get-business-sen-account-instructions-response.ts b/src/generated/models/get-business-sen-account-instructions-response.ts deleted file mode 100644 index 9a582e6..0000000 --- a/src/generated/models/get-business-sen-account-instructions-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SenInstruction } from "./sen-instruction"; - -/** - * - * @export - * @interface GetBusinessSenAccountInstructionsResponse - */ -export interface GetBusinessSenAccountInstructionsResponse { - /** - * - * @type {SenInstruction} - * @memberof GetBusinessSenAccountInstructionsResponse - */ - data?: SenInstruction; -} diff --git a/src/generated/models/get-business-sen-account-response.ts b/src/generated/models/get-business-sen-account-response.ts deleted file mode 100644 index ac37891..0000000 --- a/src/generated/models/get-business-sen-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SenFiatAccountResponse } from "./sen-fiat-account-response"; - -/** - * - * @export - * @interface GetBusinessSenAccountResponse - */ -export interface GetBusinessSenAccountResponse { - /** - * - * @type {SenFiatAccountResponse} - * @memberof GetBusinessSenAccountResponse - */ - data?: SenFiatAccountResponse; -} diff --git a/src/generated/models/get-business-signet-account-response.ts b/src/generated/models/get-business-signet-account-response.ts deleted file mode 100644 index 10c7551..0000000 --- a/src/generated/models/get-business-signet-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SignetFiatAccountResponse } from "./signet-fiat-account-response"; - -/** - * - * @export - * @interface GetBusinessSignetAccountResponse - */ -export interface GetBusinessSignetAccountResponse { - /** - * - * @type {SignetFiatAccountResponse} - * @memberof GetBusinessSignetAccountResponse - */ - data?: SignetFiatAccountResponse; -} diff --git a/src/generated/models/get-payout-response-data.ts b/src/generated/models/get-payout-response-data.ts deleted file mode 100644 index abb4eb5..0000000 --- a/src/generated/models/get-payout-response-data.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayout } from "./crypto-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayoutDestination } from "./crypto-payout-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatDetailedPayout } from "./fiat-detailed-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { FinalAdjustments } from "./final-adjustments"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutErrorCode } from "./payout-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutMoney } from "./payout-money"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutStatus } from "./payout-status"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { UnwithdrawalObject } from "./unwithdrawal-object"; - -/** - * @type GetPayoutResponseData - * @export - */ -export type GetPayoutResponseData = CryptoPayout | FiatDetailedPayout; diff --git a/src/generated/models/get-payout-response.ts b/src/generated/models/get-payout-response.ts index 494cb84..7dc5baa 100644 --- a/src/generated/models/get-payout-response.ts +++ b/src/generated/models/get-payout-response.ts @@ -8,7 +8,7 @@ // May contain unused imports in some cases // @ts-ignore -import { GetPayoutResponseData } from "./get-payout-response-data"; +import { CryptoPayout } from "./crypto-payout"; /** * @@ -18,8 +18,8 @@ import { GetPayoutResponseData } from "./get-payout-response-data"; export interface GetPayoutResponse { /** * - * @type {GetPayoutResponseData} + * @type {CryptoPayout} * @memberof GetPayoutResponse */ - data?: GetPayoutResponseData; + data?: CryptoPayout; } diff --git a/src/generated/models/get-sepa-account-instructions-response.ts b/src/generated/models/get-sepa-account-instructions-response.ts deleted file mode 100644 index 2d858d9..0000000 --- a/src/generated/models/get-sepa-account-instructions-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SepaInstruction } from "./sepa-instruction"; - -/** - * - * @export - * @interface GetSepaAccountInstructionsResponse - */ -export interface GetSepaAccountInstructionsResponse { - /** - * - * @type {SepaInstruction} - * @memberof GetSepaAccountInstructionsResponse - */ - data?: SepaInstruction; -} diff --git a/src/generated/models/get-sepa-account-response.ts b/src/generated/models/get-sepa-account-response.ts deleted file mode 100644 index 60c55cd..0000000 --- a/src/generated/models/get-sepa-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Sepa } from "./sepa"; - -/** - * - * @export - * @interface GetSepaAccountResponse - */ -export interface GetSepaAccountResponse { - /** - * - * @type {Sepa} - * @memberof GetSepaAccountResponse - */ - data?: Sepa; -} diff --git a/src/generated/models/get-wire-account-instructions-response.ts b/src/generated/models/get-wire-account-instructions-response.ts deleted file mode 100644 index fcb998f..0000000 --- a/src/generated/models/get-wire-account-instructions-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { WireInstruction } from "./wire-instruction"; - -/** - * - * @export - * @interface GetWireAccountInstructionsResponse - */ -export interface GetWireAccountInstructionsResponse { - /** - * - * @type {WireInstruction} - * @memberof GetWireAccountInstructionsResponse - */ - data?: WireInstruction; -} diff --git a/src/generated/models/get-wire-account-response.ts b/src/generated/models/get-wire-account-response.ts deleted file mode 100644 index f9b4325..0000000 --- a/src/generated/models/get-wire-account-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Wire } from "./wire"; - -/** - * - * @export - * @interface GetWireAccountResponse - */ -export interface GetWireAccountResponse { - /** - * - * @type {Wire} - * @memberof GetWireAccountResponse - */ - data?: Wire; -} diff --git a/src/generated/models/index.ts b/src/generated/models/index.ts index f56a788..26c4f38 100644 --- a/src/generated/models/index.ts +++ b/src/generated/models/index.ts @@ -1,9 +1,4 @@ export * from "./account-configuration"; -export * from "./ach"; -export * from "./ach-account-type"; -export * from "./ach-billing-details"; -export * from "./ach-creation-request"; -export * from "./ach-verification-error-codes"; export * from "./address-book-recipient"; export * from "./address-book-recipient-metadata"; export * from "./address-book-recipient-modify-request"; @@ -53,14 +48,11 @@ export * from "./checkout-session-status"; export * from "./conflict"; export * from "./continuous-payment-intent"; export * from "./continuous-payment-intent-creation-request"; -export * from "./create-ach-account-response"; export * from "./create-address-book-recipient-response"; export * from "./create-business-cbit-account-response"; export * from "./create-business-deposit-address-response"; export * from "./create-business-payout-response"; export * from "./create-business-recipient-address-response"; -export * from "./create-business-sen-account-response"; -export * from "./create-business-signet-account-response"; export * from "./create-business-transfer-response"; export * from "./create-business-wire-account-response"; export * from "./create-card-response"; @@ -68,23 +60,16 @@ export * from "./create-checkout-session-response"; export * from "./create-crypto-payment-response"; export * from "./create-crypto-payment-response1"; export * from "./create-crypto-refund-response"; -export * from "./create-mock-ach-account-response"; export * from "./create-mock-chargeback-response"; export * from "./create-payment-intent-request"; export * from "./create-payment-intent-response"; export * from "./create-payment-intent-response-data"; export * from "./create-payment-response"; export * from "./create-payment-token-response"; -export * from "./create-payout-request"; export * from "./create-payout-response"; -export * from "./create-payout-response-data"; -export * from "./create-sen-payment-response"; -export * from "./create-sepa-account-response"; -export * from "./create-sepa-payment-response"; export * from "./create-subscription-response"; export * from "./create-transfer-response"; export * from "./create-wallet-response"; -export * from "./create-wire-account-response"; export * from "./create-wire-payment-response"; export * from "./crypto-payment"; export * from "./crypto-payment-creation-request"; @@ -116,29 +101,19 @@ export * from "./extend-checkout-session-response"; export * from "./external-fiat-account-status"; export * from "./fee"; export * from "./fiat-cancel"; -export * from "./fiat-detailed-payout"; export * from "./fiat-money"; export * from "./fiat-money-usd"; export * from "./fiat-payment"; export * from "./fiat-payment-polymorphic"; -export * from "./fiat-payout"; -export * from "./fiat-payout-creation-request"; -export * from "./fiat-payout-creation-request-destination"; -export * from "./fiat-payout-destination"; -export * from "./fiat-payout-destination-type"; export * from "./fiat-refund"; export * from "./final-adjustments"; export * from "./forbidden"; export * from "./generate-address-request"; export * from "./generate-address-response"; -export * from "./get-ach-account-response"; export * from "./get-address-book-recipient-response"; export * from "./get-business-cbit-account-response"; export * from "./get-business-deposit-address-response"; export * from "./get-business-payout-response"; -export * from "./get-business-sen-account-instructions-response"; -export * from "./get-business-sen-account-response"; -export * from "./get-business-signet-account-response"; export * from "./get-business-transfer-response"; export * from "./get-business-wire-account-instructions-response"; export * from "./get-business-wire-account-response"; @@ -151,16 +126,11 @@ export * from "./get-payment-intent-response"; export * from "./get-payment-response"; export * from "./get-payment-response-data"; export * from "./get-payout-response"; -export * from "./get-payout-response-data"; export * from "./get-public-key-response"; -export * from "./get-sepa-account-instructions-response"; -export * from "./get-sepa-account-response"; export * from "./get-settlement-response"; export * from "./get-settlements-response"; export * from "./get-transfer-response"; export * from "./get-wallet-response"; -export * from "./get-wire-account-instructions-response"; -export * from "./get-wire-account-response"; export * from "./google-pay-token"; export * from "./identity"; export * from "./identity-address"; @@ -174,9 +144,6 @@ export * from "./list-business-cbit-accounts-response"; export * from "./list-business-deposits-response"; export * from "./list-business-payouts-response"; export * from "./list-business-recipient-addresses-response"; -export * from "./list-business-sen-accounts-response"; -export * from "./list-business-signet-account-instructions-response"; -export * from "./list-business-signet-accounts-response"; export * from "./list-business-transfers-response"; export * from "./list-business-wire-accounts-response"; export * from "./list-cards-response"; @@ -188,9 +155,6 @@ export * from "./list-payment-intents-response-data-inner"; export * from "./list-payments-response"; export * from "./list-payments-response-data-inner"; export * from "./list-payouts-response"; -export * from "./list-payouts-response-data-inner"; -export * from "./list-returns-response"; -export * from "./list-reversals-response"; export * from "./list-stablecoins-response"; export * from "./list-subscriptions-response"; export * from "./list-transfers-response"; @@ -198,17 +162,8 @@ export * from "./list-wallets-response"; export * from "./metadata-card-and-ach"; export * from "./metadata-crypto-payment"; export * from "./metadata-payment"; -export * from "./metadata-payout"; export * from "./metadata-phone-email"; -export * from "./mock-ach-account"; -export * from "./mock-ach-account-creation-request"; -export * from "./mock-ach-account-response"; export * from "./mock-chargeback-creation-request"; -export * from "./mock-sen-payment-beneficiary-bank-instruction"; -export * from "./mock-sen-payment-request"; -export * from "./mock-sen-payment-response"; -export * from "./mock-sepa-payment-request"; -export * from "./mock-sepa-payment-response"; export * from "./mock-wire-payment-beneficiary-bank-instruction"; export * from "./mock-wire-payment-request"; export * from "./mock-wire-payment-response"; @@ -246,21 +201,9 @@ export * from "./rate"; export * from "./refund-creation-request"; export * from "./refund-payment-response"; export * from "./required-action"; -export * from "./reversal"; export * from "./reversal-reason"; export * from "./risk-evaluation"; -export * from "./sen-fiat-account-creation-request"; -export * from "./sen-fiat-account-response"; -export * from "./sen-instruction"; -export * from "./sepa"; -export * from "./sepa-creation-request"; -export * from "./sepa-instruction"; -export * from "./sepa-instruction-beneficiary"; -export * from "./sepa-instruction-beneficiary-bank"; export * from "./settlement"; -export * from "./signet-fiat-account-creation-request"; -export * from "./signet-fiat-account-response"; -export * from "./signet-instruction"; export * from "./simple-billing-details"; export * from "./simple-card"; export * from "./source"; diff --git a/src/generated/models/list-business-sen-accounts-response.ts b/src/generated/models/list-business-sen-accounts-response.ts deleted file mode 100644 index 04b095b..0000000 --- a/src/generated/models/list-business-sen-accounts-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SenFiatAccountResponse } from "./sen-fiat-account-response"; - -/** - * - * @export - * @interface ListBusinessSenAccountsResponse - */ -export interface ListBusinessSenAccountsResponse { - /** - * - * @type {Array} - * @memberof ListBusinessSenAccountsResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-business-signet-account-instructions-response.ts b/src/generated/models/list-business-signet-account-instructions-response.ts deleted file mode 100644 index a1e01ca..0000000 --- a/src/generated/models/list-business-signet-account-instructions-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SignetInstruction } from "./signet-instruction"; - -/** - * - * @export - * @interface ListBusinessSignetAccountInstructionsResponse - */ -export interface ListBusinessSignetAccountInstructionsResponse { - /** - * - * @type {SignetInstruction} - * @memberof ListBusinessSignetAccountInstructionsResponse - */ - data?: SignetInstruction; -} diff --git a/src/generated/models/list-business-signet-accounts-response.ts b/src/generated/models/list-business-signet-accounts-response.ts deleted file mode 100644 index f0a1bfe..0000000 --- a/src/generated/models/list-business-signet-accounts-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SignetFiatAccountResponse } from "./signet-fiat-account-response"; - -/** - * - * @export - * @interface ListBusinessSignetAccountsResponse - */ -export interface ListBusinessSignetAccountsResponse { - /** - * - * @type {Array} - * @memberof ListBusinessSignetAccountsResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-payouts-response-data-inner.ts b/src/generated/models/list-payouts-response-data-inner.ts deleted file mode 100644 index eae0593..0000000 --- a/src/generated/models/list-payouts-response-data-inner.ts +++ /dev/null @@ -1,133 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayout } from "./crypto-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPayoutDestination } from "./crypto-payout-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatPayout } from "./fiat-payout"; -// May contain unused imports in some cases -// @ts-ignore -import { FinalAdjustments } from "./final-adjustments"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutErrorCode } from "./payout-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutMoney } from "./payout-money"; -// May contain unused imports in some cases -// @ts-ignore -import { PayoutStatus } from "./payout-status"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { UnwithdrawalObject } from "./unwithdrawal-object"; - -/** - * - * @export - * @interface ListPayoutsResponseDataInner - */ -export interface ListPayoutsResponseDataInner { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof ListPayoutsResponseDataInner - */ - id?: string; - /** - * The identifier of the source wallet used to fund a payout. - * @type {string} - * @memberof ListPayoutsResponseDataInner - */ - sourceWalletId?: string; - /** - * - * @type {CryptoPayoutDestination} - * @memberof ListPayoutsResponseDataInner - */ - destination?: CryptoPayoutDestination; - /** - * - * @type {PayoutMoney} - * @memberof ListPayoutsResponseDataInner - */ - amount?: PayoutMoney; - /** - * - * @type {PayoutMoney} - * @memberof ListPayoutsResponseDataInner - */ - toAmount?: PayoutMoney; - /** - * - * @type {PayoutMoney} - * @memberof ListPayoutsResponseDataInner - */ - fees?: PayoutMoney; - /** - * - * @type {PayoutStatus} - * @memberof ListPayoutsResponseDataInner - */ - status?: PayoutStatus; - /** - * A payout tracking reference. Will be present once known. - * @type {any} - * @memberof ListPayoutsResponseDataInner - */ - trackingRef?: any | null; - /** - * - * @type {PayoutErrorCode} - * @memberof ListPayoutsResponseDataInner - */ - errorCode?: PayoutErrorCode | null; - /** - * - * @type {RiskEvaluation} - * @memberof ListPayoutsResponseDataInner - */ - riskEvaluation?: RiskEvaluation | null; - /** - * - * @type {FinalAdjustments} - * @memberof ListPayoutsResponseDataInner - */ - adjustments?: FinalAdjustments | null; - /** - * - * @type {UnwithdrawalObject} - * @memberof ListPayoutsResponseDataInner - */ - return?: UnwithdrawalObject | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof ListPayoutsResponseDataInner - */ - createDate?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof ListPayoutsResponseDataInner - */ - updateDate?: string; - /** - * - * @type {PayoutMoney} - * @memberof ListPayoutsResponseDataInner - */ - networkFees?: PayoutMoney; -} diff --git a/src/generated/models/list-payouts-response.ts b/src/generated/models/list-payouts-response.ts index 195fb8b..7d393bc 100644 --- a/src/generated/models/list-payouts-response.ts +++ b/src/generated/models/list-payouts-response.ts @@ -8,7 +8,7 @@ // May contain unused imports in some cases // @ts-ignore -import { ListPayoutsResponseDataInner } from "./list-payouts-response-data-inner"; +import { CryptoPayout } from "./crypto-payout"; /** * @@ -18,8 +18,8 @@ import { ListPayoutsResponseDataInner } from "./list-payouts-response-data-inner export interface ListPayoutsResponse { /** * - * @type {Array} + * @type {Array} * @memberof ListPayoutsResponse */ - data?: Array; + data?: Array; } diff --git a/src/generated/models/list-returns-response.ts b/src/generated/models/list-returns-response.ts deleted file mode 100644 index 5d08a44..0000000 --- a/src/generated/models/list-returns-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { UnwithdrawalObject } from "./unwithdrawal-object"; - -/** - * - * @export - * @interface ListReturnsResponse - */ -export interface ListReturnsResponse { - /** - * - * @type {Array} - * @memberof ListReturnsResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-reversals-response.ts b/src/generated/models/list-reversals-response.ts deleted file mode 100644 index 7a9f0f8..0000000 --- a/src/generated/models/list-reversals-response.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { Reversal } from "./reversal"; - -/** - * - * @export - * @interface ListReversalsResponse - */ -export interface ListReversalsResponse { - /** - * - * @type {Array} - * @memberof ListReversalsResponse - */ - data?: Array; -} diff --git a/src/generated/models/metadata-payout.ts b/src/generated/models/metadata-payout.ts deleted file mode 100644 index cd734c3..0000000 --- a/src/generated/models/metadata-payout.ts +++ /dev/null @@ -1,21 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Additional properties related to the payout beneficiary. - * @export - * @interface MetadataPayout - */ -export interface MetadataPayout { - /** - * Email of the user. - * @type {string} - * @memberof MetadataPayout - */ - beneficiaryEmail: string; -} diff --git a/src/generated/models/mock-ach-account-creation-request.ts b/src/generated/models/mock-ach-account-creation-request.ts deleted file mode 100644 index ed8c329..0000000 --- a/src/generated/models/mock-ach-account-creation-request.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { MockAchAccount } from "./mock-ach-account"; - -/** - * - * @export - * @interface MockAchAccountCreationRequest - */ -export interface MockAchAccountCreationRequest { - /** - * - * @type {MockAchAccount} - * @memberof MockAchAccountCreationRequest - */ - account: MockAchAccount; - /** - * - * @type {FiatMoneyUsd} - * @memberof MockAchAccountCreationRequest - */ - balance: FiatMoneyUsd; -} diff --git a/src/generated/models/mock-ach-account-response.ts b/src/generated/models/mock-ach-account-response.ts deleted file mode 100644 index 3677cd6..0000000 --- a/src/generated/models/mock-ach-account-response.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { MockAchAccount } from "./mock-ach-account"; - -/** - * - * @export - * @interface MockAchAccountResponse - */ -export interface MockAchAccountResponse { - /** - * The processor token needs to be provided when linking an ACH account against this mock. - * @type {string} - * @memberof MockAchAccountResponse - */ - processorToken?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof MockAchAccountResponse - */ - balance?: FiatMoneyUsd; - /** - * - * @type {MockAchAccount} - * @memberof MockAchAccountResponse - */ - account?: MockAchAccount; -} diff --git a/src/generated/models/mock-ach-account.ts b/src/generated/models/mock-ach-account.ts deleted file mode 100644 index e3c4d90..0000000 --- a/src/generated/models/mock-ach-account.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface MockAchAccount - */ -export interface MockAchAccount { - /** - * The account number of the ACH account. - * @type {string} - * @memberof MockAchAccount - */ - accountNumber: string; - /** - * The routing number of the ACH account. For sandbox testing, valid routing numbers include `011000028`, `011201762`, `011500120`, `021214862`, `121000248`, `121140399`, `211073473`, `221172610`, and `011000138`. - * @type {string} - * @memberof MockAchAccount - */ - routingNumber: string; - /** - * A description for the ACH account. - * @type {string} - * @memberof MockAchAccount - */ - description: string; -} diff --git a/src/generated/models/mock-sen-payment-beneficiary-bank-instruction.ts b/src/generated/models/mock-sen-payment-beneficiary-bank-instruction.ts deleted file mode 100644 index 0e2eefe..0000000 --- a/src/generated/models/mock-sen-payment-beneficiary-bank-instruction.ts +++ /dev/null @@ -1,21 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface MockSenPaymentBeneficiaryBankInstruction - */ -export interface MockSenPaymentBeneficiaryBankInstruction { - /** - * Circle corporate Silvergate SEN account number that needs to be set as destination. - * @type {string} - * @memberof MockSenPaymentBeneficiaryBankInstruction - */ - accountNumber: string; -} diff --git a/src/generated/models/mock-sen-payment-request.ts b/src/generated/models/mock-sen-payment-request.ts deleted file mode 100644 index b551753..0000000 --- a/src/generated/models/mock-sen-payment-request.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoney } from "./fiat-money"; -// May contain unused imports in some cases -// @ts-ignore -import { MockSenPaymentBeneficiaryBankInstruction } from "./mock-sen-payment-beneficiary-bank-instruction"; - -/** - * - * @export - * @interface MockSenPaymentRequest - */ -export interface MockSenPaymentRequest { - /** - * Circle tracking reference that needs to be set in the memo filed. This field is retrievable through the response during SEN account creation or via the bank instruction endpoint. - * @type {string} - * @memberof MockSenPaymentRequest - */ - trackingRef: string; - /** - * - * @type {FiatMoney} - * @memberof MockSenPaymentRequest - */ - amount: FiatMoney; - /** - * - * @type {MockSenPaymentBeneficiaryBankInstruction} - * @memberof MockSenPaymentRequest - */ - beneficiaryBank: MockSenPaymentBeneficiaryBankInstruction; -} diff --git a/src/generated/models/mock-sen-payment-response.ts b/src/generated/models/mock-sen-payment-response.ts deleted file mode 100644 index bee90b3..0000000 --- a/src/generated/models/mock-sen-payment-response.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { MockSenPaymentBeneficiaryBankInstruction } from "./mock-sen-payment-beneficiary-bank-instruction"; - -/** - * - * @export - * @interface MockSenPaymentResponse - */ -export interface MockSenPaymentResponse { - /** - * Wire tracking reference that needs to be set in the wire reference to beneficiary field. This field is retrievable through the response during wire creation or via the bank instruction endpoint. - * @type {string} - * @memberof MockSenPaymentResponse - */ - trackingRef?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof MockSenPaymentResponse - */ - amount?: FiatMoneyUsd; - /** - * - * @type {MockSenPaymentBeneficiaryBankInstruction} - * @memberof MockSenPaymentResponse - */ - beneficiaryBank?: MockSenPaymentBeneficiaryBankInstruction; - /** - * Enumerated status of the wire payment. Status `pending` indicates that the wire payment is in process; `processed` indicates it finished successfully; `failed` indicates it failed. - * @type {string} - * @memberof MockSenPaymentResponse - */ - status?: MockSenPaymentResponseStatusEnum; -} - -export const MockSenPaymentResponseStatusEnum = { - Pending: "pending", - Processed: "processed", - Failed: "failed" -} as const; - -export type MockSenPaymentResponseStatusEnum = - typeof MockSenPaymentResponseStatusEnum[keyof typeof MockSenPaymentResponseStatusEnum]; diff --git a/src/generated/models/mock-sepa-payment-request.ts b/src/generated/models/mock-sepa-payment-request.ts deleted file mode 100644 index ce7f0c1..0000000 --- a/src/generated/models/mock-sepa-payment-request.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; - -/** - * - * @export - * @interface MockSepaPaymentRequest - */ -export interface MockSepaPaymentRequest { - /** - * SEPA tracking reference that needs to be set in the payment details or description. - * @type {string} - * @memberof MockSepaPaymentRequest - */ - trackingRef: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof MockSepaPaymentRequest - */ - amount: FiatMoneyUsd; -} diff --git a/src/generated/models/mock-sepa-payment-response.ts b/src/generated/models/mock-sepa-payment-response.ts deleted file mode 100644 index 412e79c..0000000 --- a/src/generated/models/mock-sepa-payment-response.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; - -/** - * - * @export - * @interface MockSepaPaymentResponse - */ -export interface MockSepaPaymentResponse { - /** - * SEPA tracking reference that needs to be set in the payment details or description. - * @type {string} - * @memberof MockSepaPaymentResponse - */ - trackingRef?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof MockSepaPaymentResponse - */ - amount?: FiatMoneyUsd; - /** - * Enumerated status of the SEPA payment. Status `pending` indicates that the SEPA payment is in process; `processed` indicates it finished successfully; `failed` indicates it failed. - * @type {string} - * @memberof MockSepaPaymentResponse - */ - status?: MockSepaPaymentResponseStatusEnum; -} - -export const MockSepaPaymentResponseStatusEnum = { - Pending: "pending", - Processed: "processed", - Failed: "failed" -} as const; - -export type MockSepaPaymentResponseStatusEnum = - typeof MockSepaPaymentResponseStatusEnum[keyof typeof MockSepaPaymentResponseStatusEnum]; diff --git a/src/generated/models/payout-destination-type.ts b/src/generated/models/payout-destination-type.ts index a8fa832..b67486a 100644 --- a/src/generated/models/payout-destination-type.ts +++ b/src/generated/models/payout-destination-type.ts @@ -13,9 +13,6 @@ */ export const PayoutDestinationType = { - Wire: "wire", - Ach: "ach", - Sepa: "sepa", AddressBook: "address_book" } as const; diff --git a/src/generated/models/reversal.ts b/src/generated/models/reversal.ts deleted file mode 100644 index e860d20..0000000 --- a/src/generated/models/reversal.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { CancelRefundReversalStatus } from "./cancel-refund-reversal-status"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { ReversalReason } from "./reversal-reason"; - -/** - * - * @export - * @interface Reversal - */ -export interface Reversal { - /** - * Universally unique identifier (UUID v4) of the public key used in encryption. NOTE the sandbox environment uses the default value of `key1`. For this reason the example supplied is `key1` rather than a UUID. - * @type {string} - * @memberof Reversal - */ - id: string; - /** - * Unique system generated identifier for the payment that is associated to the chargeback item. - * @type {string} - * @memberof Reversal - */ - paymentId: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof Reversal - */ - amount: FiatMoneyUsd; - /** - * Enumerated description of the payment. - * @type {string} - * @memberof Reversal - */ - description: string; - /** - * - * @type {CancelRefundReversalStatus} - * @memberof Reversal - */ - status: CancelRefundReversalStatus; - /** - * - * @type {ReversalReason} - * @memberof Reversal - */ - reason: ReversalReason; - /** - * - * @type {FiatMoneyUsd} - * @memberof Reversal - */ - fees: FiatMoneyUsd; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Reversal - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Reversal - */ - updateDate: string; -} diff --git a/src/generated/models/sen-fiat-account-creation-request.ts b/src/generated/models/sen-fiat-account-creation-request.ts deleted file mode 100644 index df66478..0000000 --- a/src/generated/models/sen-fiat-account-creation-request.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface SenFiatAccountCreationRequest - */ -export interface SenFiatAccountCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof SenFiatAccountCreationRequest - */ - idempotencyKey: string; - /** - * Silvergate SEN account number. - * @type {string} - * @memberof SenFiatAccountCreationRequest - */ - accountNumber: string; - /** - * Currency of the Silvergate SEN account. - * @type {string} - * @memberof SenFiatAccountCreationRequest - */ - currency?: string; -} diff --git a/src/generated/models/sen-fiat-account-response.ts b/src/generated/models/sen-fiat-account-response.ts deleted file mode 100644 index 30caae0..0000000 --- a/src/generated/models/sen-fiat-account-response.ts +++ /dev/null @@ -1,61 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { ExternalFiatAccountStatus } from "./external-fiat-account-status"; - -/** - * - * @export - * @interface SenFiatAccountResponse - */ -export interface SenFiatAccountResponse { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof SenFiatAccountResponse - */ - id: string; - /** - * - * @type {ExternalFiatAccountStatus} - * @memberof SenFiatAccountResponse - */ - status: ExternalFiatAccountStatus; - /** - * Bank name plus last four digits of the bank account number. - * @type {string} - * @memberof SenFiatAccountResponse - */ - description: string; - /** - * Circle tracking reference that needs to be set in the memo field.. - * @type {string} - * @memberof SenFiatAccountResponse - */ - trackingRef: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof SenFiatAccountResponse - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof SenFiatAccountResponse - */ - updateDate: string; - /** - * Currency of the fiat account. - * @type {string} - * @memberof SenFiatAccountResponse - */ - currency?: string; -} diff --git a/src/generated/models/sen-instruction.ts b/src/generated/models/sen-instruction.ts deleted file mode 100644 index af65325..0000000 --- a/src/generated/models/sen-instruction.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface SenInstruction - */ -export interface SenInstruction { - /** - * Circle tracking reference that needs to be set in the memo field. - * @type {string} - * @memberof SenInstruction - */ - trackingRef?: string; - /** - * Circle corporate Silvergate SEN account number that needs to be set as destination. - * @type {string} - * @memberof SenInstruction - */ - accountNumber?: string; - /** - * Currency of Circle corporate Silvergate SEN account. - * @type {string} - * @memberof SenInstruction - */ - currency?: string; -} diff --git a/src/generated/models/sepa-creation-request.ts b/src/generated/models/sepa-creation-request.ts deleted file mode 100644 index 9004405..0000000 --- a/src/generated/models/sepa-creation-request.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { BillingDetails } from "./billing-details"; - -/** - * - * @export - * @interface SepaCreationRequest - */ -export interface SepaCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof SepaCreationRequest - */ - idempotencyKey: string; - /** - * International Bank Account Number (IBAN) for the bank account. - * @type {string} - * @memberof SepaCreationRequest - */ - iban: string; - /** - * - * @type {BillingDetails} - * @memberof SepaCreationRequest - */ - billingDetails: BillingDetails; -} diff --git a/src/generated/models/sepa-instruction-beneficiary-bank.ts b/src/generated/models/sepa-instruction-beneficiary-bank.ts deleted file mode 100644 index 17d36ff..0000000 --- a/src/generated/models/sepa-instruction-beneficiary-bank.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface SepaInstructionBeneficiaryBank - */ -export interface SepaInstructionBeneficiaryBank { - /** - * Name of the beneficiary\'s bank. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - name?: string; - /** - * BIC code of the beneficiary\'s bank account. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - bic?: string; - /** - * IBAN of the beneficiary\'s bank account. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - iban?: string; - /** - * Address of the beneficiary\'s bank. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - address?: string; - /** - * City of the beneficiary\'s bank. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - city?: string; - /** - * Postal code of the beneficiary\'s bank. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - postalCode?: string; - /** - * Country code of the beneficiary\'s bank. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. - * @type {string} - * @memberof SepaInstructionBeneficiaryBank - */ - country?: string; -} diff --git a/src/generated/models/sepa-instruction-beneficiary.ts b/src/generated/models/sepa-instruction-beneficiary.ts deleted file mode 100644 index c34afbe..0000000 --- a/src/generated/models/sepa-instruction-beneficiary.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface SepaInstructionBeneficiary - */ -export interface SepaInstructionBeneficiary { - /** - * Name of the beneficiary. - * @type {string} - * @memberof SepaInstructionBeneficiary - */ - name?: string; - /** - * Address line 1 of the beneficiary\'s address. - * @type {string} - * @memberof SepaInstructionBeneficiary - */ - address1?: string; - /** - * Address line 2 of the beneficiary\'s address. - * @type {string} - * @memberof SepaInstructionBeneficiary - */ - address2?: string; -} diff --git a/src/generated/models/sepa-instruction.ts b/src/generated/models/sepa-instruction.ts deleted file mode 100644 index c958b1b..0000000 --- a/src/generated/models/sepa-instruction.ts +++ /dev/null @@ -1,40 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { SepaInstructionBeneficiary } from "./sepa-instruction-beneficiary"; -// May contain unused imports in some cases -// @ts-ignore -import { SepaInstructionBeneficiaryBank } from "./sepa-instruction-beneficiary-bank"; - -/** - * - * @export - * @interface SepaInstruction - */ -export interface SepaInstruction { - /** - * Circle tracking reference that needs to be set in the SEPA transfer reference field. - * @type {string} - * @memberof SepaInstruction - */ - trackingRef?: string; - /** - * - * @type {SepaInstructionBeneficiary} - * @memberof SepaInstruction - */ - beneficiary?: SepaInstructionBeneficiary; - /** - * - * @type {SepaInstructionBeneficiaryBank} - * @memberof SepaInstruction - */ - beneficiaryBank?: SepaInstructionBeneficiaryBank; -} diff --git a/src/generated/models/sepa.ts b/src/generated/models/sepa.ts deleted file mode 100644 index 047c863..0000000 --- a/src/generated/models/sepa.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { BillingDetails } from "./billing-details"; -// May contain unused imports in some cases -// @ts-ignore -import { ExternalFiatAccountStatus } from "./external-fiat-account-status"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; - -/** - * - * @export - * @interface Sepa - */ -export interface Sepa { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof Sepa - */ - id: string; - /** - * - * @type {ExternalFiatAccountStatus} - * @memberof Sepa - */ - status: ExternalFiatAccountStatus; - /** - * Bank name plus last four digits of the IBAN. - * @type {string} - * @memberof Sepa - */ - description: string; - /** - * Tracking reference that needs to be set in the payment details or description. - * @type {string} - * @memberof Sepa - */ - trackingRef: string; - /** - * A UUID that uniquely identifies the account number. If the same account is used more than once, each card object will have a different id, but the fingerprint will stay the same. - * @type {string} - * @memberof Sepa - */ - fingerprint: string; - /** - * - * @type {RiskEvaluation} - * @memberof Sepa - */ - riskEvaluation?: RiskEvaluation | null; - /** - * - * @type {BillingDetails} - * @memberof Sepa - */ - billingDetails: BillingDetails; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Sepa - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Sepa - */ - updateDate: string; -} diff --git a/src/generated/models/signet-fiat-account-creation-request.ts b/src/generated/models/signet-fiat-account-creation-request.ts deleted file mode 100644 index b3e88cd..0000000 --- a/src/generated/models/signet-fiat-account-creation-request.ts +++ /dev/null @@ -1,27 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface SignetFiatAccountCreationRequest - */ -export interface SignetFiatAccountCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof SignetFiatAccountCreationRequest - */ - idempotencyKey: string; - /** - * Signet wallet address. - * @type {string} - * @memberof SignetFiatAccountCreationRequest - */ - walletAddress: string; -} diff --git a/src/generated/models/signet-fiat-account-response.ts b/src/generated/models/signet-fiat-account-response.ts deleted file mode 100644 index c6dbeaa..0000000 --- a/src/generated/models/signet-fiat-account-response.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { ExternalFiatAccountStatus } from "./external-fiat-account-status"; - -/** - * - * @export - * @interface SignetFiatAccountResponse - */ -export interface SignetFiatAccountResponse { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof SignetFiatAccountResponse - */ - id: string; - /** - * - * @type {ExternalFiatAccountStatus} - * @memberof SignetFiatAccountResponse - */ - status: ExternalFiatAccountStatus; - /** - * Tracking ref that needs to be set in the public description field when you send the funds to Circle Signet wallet. - * @type {string} - * @memberof SignetFiatAccountResponse - */ - trackingRef: string; - /** - * Your signet wallet address. - * @type {string} - * @memberof SignetFiatAccountResponse - */ - walletAddress: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof SignetFiatAccountResponse - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof SignetFiatAccountResponse - */ - updateDate: string; -} diff --git a/src/generated/models/signet-instruction.ts b/src/generated/models/signet-instruction.ts deleted file mode 100644 index 3b675c1..0000000 --- a/src/generated/models/signet-instruction.ts +++ /dev/null @@ -1,27 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * - * @export - * @interface SignetInstruction - */ -export interface SignetInstruction { - /** - * Circle tracking reference that needs to be set in the signet public description field. - * @type {string} - * @memberof SignetInstruction - */ - trackingRef?: string; - /** - * Circle wallet address that needs to be set in the signet recipient wallet field. - * @type {string} - * @memberof SignetInstruction - */ - walletAddress?: string; -} diff --git a/src/generated/models/source.ts b/src/generated/models/source.ts index e7e23c2..7947a75 100644 --- a/src/generated/models/source.ts +++ b/src/generated/models/source.ts @@ -27,8 +27,7 @@ export interface Source { } export const SourceTypeEnum = { - Card: "card", - Ach: "ach" + Card: "card" } as const; export type SourceTypeEnum = typeof SourceTypeEnum[keyof typeof SourceTypeEnum];