From 3e0bb5bc895609d9a7d1e43ffb3b3d87ca011069 Mon Sep 17 00:00:00 2001 From: Github Actions Bot Date: Wed, 18 Mar 2026 21:07:03 +0000 Subject: [PATCH] feat: sync SDK to OpenAPI doc v2.16.0 --- OPENAPI_VERSION | 2 +- sdk.json | 9057 +++++++---------- src/generated/.openapi-generator/FILES | 138 +- src/generated/api.ts | 11 +- src/generated/apis/addresses-api.ts | 58 +- src/generated/apis/balances-api.ts | 112 +- src/generated/apis/cards-api.ts | 566 - src/generated/apis/channels-api.ts | 170 - src/generated/apis/chargebacks-api.ts | 501 - src/generated/apis/checkout-sessions-api.ts | 606 -- .../apis/crypto-exchange-rates-api.ts | 191 - src/generated/apis/deposits-api.ts | 155 + src/generated/apis/encryption-api.ts | 169 - src/generated/apis/external-entities-api.ts | 436 + src/generated/apis/payments-api.ts | 564 +- src/generated/apis/payouts-api.ts | 156 +- .../apis/pull-crypto-payments-api.ts | 353 - ...okens-api.ts => reserve-management-api.ts} | 94 +- src/generated/apis/settlements-api.ts | 246 +- src/generated/apis/trades-api.ts | 733 ++ src/generated/apis/transfers-api.ts | 54 +- src/generated/apis/wires-api.ts | 57 +- src/generated/index.ts | 33 +- .../models/address-book-recipient-request.ts | 36 +- .../models/address-book-recipient.ts | 2 +- src/generated/models/address-object.ts | 14 +- .../models/apple-pay-token-ec-header.ts | 39 - .../models/apple-pay-token-header.ts | 23 - .../models/apple-pay-token-rsa-header.ts | 39 - src/generated/models/apple-pay-token.ts | 51 - .../models/basic-chargeback-history.ts | 66 - src/generated/models/basic-chargeback.ts | 67 - .../brlsettlement-instructions-instruction.ts | 55 + .../models/brlsettlement-instructions.ts | 50 + src/generated/models/business-deposit.ts | 39 + ...business-payout-creation-request-source.ts | 34 + .../business-payout-creation-request.ts | 9 + ...ness-recipient-address-creation-request.ts | 2 +- .../business-recipient-address-object.ts | 2 +- ...siness-transfer-creation-request-source.ts | 34 + .../business-transfer-creation-request.ts | 9 + .../models/cancel-creation-request.ts | 31 - src/generated/models/card-creation-request.ts | 64 - src/generated/models/card-update.ts | 49 - .../models/card-verification-response.ts | 31 - src/generated/models/card.ts | 155 - src/generated/models/chain.ts | 15 +- src/generated/models/channel-response.ts | 39 - src/generated/models/chargeback-categories.ts | 25 - src/generated/models/chargeback-status.ts | 26 - .../checkout-session-creation-request.ts | 31 - .../models/checkout-session-money.ts | 36 - .../models/checkout-session-status.ts | 22 - src/generated/models/checkout-session.ts | 101 - ...tinuous-payment-intent-creation-request.ts | 12 +- .../models/create-crypto-payment-response1.ts | 25 - .../models/create-fx-account-request.ts | 31 + .../models/create-fx-account-response.ts | 43 + .../models/create-fx-account-response1.ts | 25 + .../models/create-fx-trade-response-data.ts | 64 + .../models/create-fx-trade-response.ts | 25 + .../models/create-payment-intent-request.ts | 2 +- .../models/create-payment-token-response.ts | 25 - ...onse.ts => create-pix-payment-response.ts} | 12 +- .../models/crypto-payment-creation-request.ts | 70 - .../models/crypto-payment-destination.ts | 34 - src/generated/models/crypto-payment-source.ts | 34 - src/generated/models/crypto-payments-money.ts | 1 + .../models/crypto-payout-creation-request.ts | 13 +- src/generated/models/crypto-payout-money.ts | 35 + ...tody-balances-request-additional-fields.ts | 33 + .../models/daily-custody-balances-request.ts | 70 + ...ody-balances-response-additional-fields.ts | 33 + .../models/daily-custody-balances-response.ts | 82 + src/generated/models/daily-fx-limits.ts | 43 + src/generated/models/detailed-cancel.ts | 152 - src/generated/models/detailed-payment.ts | 197 - src/generated/models/detailed-refund.ts | 155 - src/generated/models/duplicate-request.ts | 25 + .../exchange-rate-optional-amount-money.ts | 42 + .../models/exchange-rate-request-from.ts | 21 - .../models/exchange-rate-request-to.ts | 21 - src/generated/models/exchange-rate-request.ts | 24 +- .../models/exchange-rate-response.ts | 17 +- src/generated/models/exchange-type.ts | 20 + .../models/extend-checkout-session-request.ts | 21 - .../extend-checkout-session-response.ts | 25 - .../external-entity-creation-request.ts | 43 + src/generated/models/external-entity.ts | 54 + ...ge-types-items.ts => fx-currency-limit.ts} | 22 +- ...-chargeback-response.ts => fx-currency.ts} | 19 +- src/generated/models/fx-fiat-currency.ts | 20 + src/generated/models/fx-money.ts | 31 + ...reation-request.ts => fx-trade-request.ts} | 18 +- .../models/get-chargeback-response.ts | 25 - .../models/get-checkout-session-response.ts | 25 - .../models/get-exchange-rates-response.ts | 25 - ...onse.ts => get-fx-limits-response-data.ts} | 12 +- ...-response.ts => get-fx-limits-response.ts} | 12 +- ...-response.ts => get-fx-trades-response.ts} | 12 +- ...response.ts => get-fx-trades-response1.ts} | 12 +- .../models/get-public-key-response.ts | 25 - ...ponse.ts => get-settlement-id-response.ts} | 6 +- ...-settlement-instructions-response-data.ts} | 13 +- .../get-settlement-instructions-response.ts | 25 + src/generated/models/google-pay-token.ts | 33 - src/generated/models/index.ts | 127 +- src/generated/models/institutional-address.ts | 51 + .../models/list-balances-response.ts | 25 - .../models/list-business-payout-data-inner.ts | 121 + src/generated/models/list-business-payout.ts | 25 + .../models/list-business-payouts-response.ts | 25 - src/generated/models/list-cards-response.ts | 25 - .../models/list-channels-response.ts | 25 - .../models/list-chargebacks-response.ts | 25 - .../models/list-checkout-sessions-response.ts | 25 - ....ts => list-external-entities-response.ts} | 12 +- src/generated/models/metadata-card-and-ach.ts | 39 - .../models/metadata-crypto-payment.ts | 52 - src/generated/models/metadata-payment.ts | 39 - .../mock-chargeback-creation-request.ts | 21 - .../models/mock-pix-payment-request-amount.ts | 34 + .../models/mock-pix-payment-request.ts | 37 + .../models/mock-pix-payment-response.ts | 52 + ...re-payment-beneficiary-bank-instruction.ts | 2 +- .../models/mxnsettlement-instructions.ts | 47 + src/generated/models/network-fee-quote.ts | 37 - src/generated/models/new-report-success.ts | 25 + .../models/payment-creation-request.ts | 106 - .../models/payment-intent-creation-request.ts | 3 +- .../payment-method-blockchain-request.ts | 38 + .../models/payment-method-blockchain.ts | 28 +- src/generated/models/payment-token-request.ts | 45 - src/generated/models/payment-token.ts | 63 - src/generated/models/presign-domain.ts | 39 - src/generated/models/presign-message-types.ts | 31 - src/generated/models/presign-message.ts | 51 - .../models/presign-response-typed-data.ts | 88 - src/generated/models/presign-response.ts | 25 - src/generated/models/public-key.ts | 27 - src/generated/models/rate.ts | 33 - .../models/redemption-fee-calculation.ts | 17 +- .../models/refund-creation-request.ts | 40 - .../models/refund-payment-response.ts | 25 - src/generated/models/reversal-reason.ts | 30 - .../models/settlement-detail-status.ts | 21 + .../models/settlement-details-inner.ts | 72 + src/generated/models/settlement-status.ts | 21 + src/generated/models/settlement.ts | 43 +- .../models/simple-billing-details.ts | 27 - src/generated/models/simple-card.ts | 131 - src/generated/models/source.ts | 33 - src/generated/models/to-amount.ts | 32 - .../models/tokenized-card-details.ts | 76 - src/generated/models/trade-status.ts | 23 + src/generated/models/trade.ts | 82 + ...ransfer-destination-blockchain-location.ts | 2 +- .../models/update-billing-details.ts | 75 - src/generated/models/update-card-response.ts | 25 - .../models/verification-error-code.ts | 36 - .../models/wire-destination-response.ts | 40 + src/generated/models/wire.ts | 14 +- 162 files changed, 7526 insertions(+), 12309 deletions(-) delete mode 100644 src/generated/apis/cards-api.ts delete mode 100644 src/generated/apis/channels-api.ts delete mode 100644 src/generated/apis/chargebacks-api.ts delete mode 100644 src/generated/apis/checkout-sessions-api.ts delete mode 100644 src/generated/apis/crypto-exchange-rates-api.ts delete mode 100644 src/generated/apis/encryption-api.ts create mode 100644 src/generated/apis/external-entities-api.ts delete mode 100644 src/generated/apis/pull-crypto-payments-api.ts rename src/generated/apis/{payment-tokens-api.ts => reserve-management-api.ts} (54%) create mode 100644 src/generated/apis/trades-api.ts delete mode 100644 src/generated/models/apple-pay-token-ec-header.ts delete mode 100644 src/generated/models/apple-pay-token-header.ts delete mode 100644 src/generated/models/apple-pay-token-rsa-header.ts delete mode 100644 src/generated/models/apple-pay-token.ts delete mode 100644 src/generated/models/basic-chargeback-history.ts delete mode 100644 src/generated/models/basic-chargeback.ts create mode 100644 src/generated/models/brlsettlement-instructions-instruction.ts create mode 100644 src/generated/models/brlsettlement-instructions.ts create mode 100644 src/generated/models/business-payout-creation-request-source.ts create mode 100644 src/generated/models/business-transfer-creation-request-source.ts delete mode 100644 src/generated/models/cancel-creation-request.ts delete mode 100644 src/generated/models/card-creation-request.ts delete mode 100644 src/generated/models/card-update.ts delete mode 100644 src/generated/models/card-verification-response.ts delete mode 100644 src/generated/models/card.ts delete mode 100644 src/generated/models/channel-response.ts delete mode 100644 src/generated/models/chargeback-categories.ts delete mode 100644 src/generated/models/chargeback-status.ts delete mode 100644 src/generated/models/checkout-session-creation-request.ts delete mode 100644 src/generated/models/checkout-session-money.ts delete mode 100644 src/generated/models/checkout-session-status.ts delete mode 100644 src/generated/models/checkout-session.ts delete mode 100644 src/generated/models/create-crypto-payment-response1.ts create mode 100644 src/generated/models/create-fx-account-request.ts create mode 100644 src/generated/models/create-fx-account-response.ts create mode 100644 src/generated/models/create-fx-account-response1.ts create mode 100644 src/generated/models/create-fx-trade-response-data.ts create mode 100644 src/generated/models/create-fx-trade-response.ts delete mode 100644 src/generated/models/create-payment-token-response.ts rename src/generated/models/{cancel-payment-response.ts => create-pix-payment-response.ts} (54%) delete mode 100644 src/generated/models/crypto-payment-creation-request.ts delete mode 100644 src/generated/models/crypto-payment-destination.ts delete mode 100644 src/generated/models/crypto-payment-source.ts create mode 100644 src/generated/models/crypto-payout-money.ts create mode 100644 src/generated/models/daily-custody-balances-request-additional-fields.ts create mode 100644 src/generated/models/daily-custody-balances-request.ts create mode 100644 src/generated/models/daily-custody-balances-response-additional-fields.ts create mode 100644 src/generated/models/daily-custody-balances-response.ts create mode 100644 src/generated/models/daily-fx-limits.ts delete mode 100644 src/generated/models/detailed-cancel.ts delete mode 100644 src/generated/models/detailed-payment.ts delete mode 100644 src/generated/models/detailed-refund.ts create mode 100644 src/generated/models/duplicate-request.ts create mode 100644 src/generated/models/exchange-rate-optional-amount-money.ts delete mode 100644 src/generated/models/exchange-rate-request-from.ts delete mode 100644 src/generated/models/exchange-rate-request-to.ts create mode 100644 src/generated/models/exchange-type.ts delete mode 100644 src/generated/models/extend-checkout-session-request.ts delete mode 100644 src/generated/models/extend-checkout-session-response.ts create mode 100644 src/generated/models/external-entity-creation-request.ts create mode 100644 src/generated/models/external-entity.ts rename src/generated/models/{presign-message-types-items.ts => fx-currency-limit.ts} (53%) rename src/generated/models/{create-mock-chargeback-response.ts => fx-currency.ts} (55%) create mode 100644 src/generated/models/fx-fiat-currency.ts create mode 100644 src/generated/models/fx-money.ts rename src/generated/models/{capture-creation-request.ts => fx-trade-request.ts} (58%) delete mode 100644 src/generated/models/get-chargeback-response.ts delete mode 100644 src/generated/models/get-checkout-session-response.ts delete mode 100644 src/generated/models/get-exchange-rates-response.ts rename src/generated/models/{create-payment-response.ts => get-fx-limits-response-data.ts} (57%) rename src/generated/models/{create-checkout-session-response.ts => get-fx-limits-response.ts} (55%) rename src/generated/models/{create-card-response.ts => get-fx-trades-response.ts} (62%) rename src/generated/models/{get-card-response.ts => get-fx-trades-response1.ts} (63%) delete mode 100644 src/generated/models/get-public-key-response.ts rename src/generated/models/{get-settlement-response.ts => get-settlement-id-response.ts} (76%) rename src/generated/models/{payment-token-request-token-data.ts => get-settlement-instructions-response-data.ts} (50%) create mode 100644 src/generated/models/get-settlement-instructions-response.ts delete mode 100644 src/generated/models/google-pay-token.ts create mode 100644 src/generated/models/institutional-address.ts delete mode 100644 src/generated/models/list-balances-response.ts create mode 100644 src/generated/models/list-business-payout-data-inner.ts create mode 100644 src/generated/models/list-business-payout.ts delete mode 100644 src/generated/models/list-business-payouts-response.ts delete mode 100644 src/generated/models/list-cards-response.ts delete mode 100644 src/generated/models/list-channels-response.ts delete mode 100644 src/generated/models/list-chargebacks-response.ts delete mode 100644 src/generated/models/list-checkout-sessions-response.ts rename src/generated/models/{create-crypto-payment-response.ts => list-external-entities-response.ts} (55%) delete mode 100644 src/generated/models/metadata-card-and-ach.ts delete mode 100644 src/generated/models/metadata-crypto-payment.ts delete mode 100644 src/generated/models/metadata-payment.ts delete mode 100644 src/generated/models/mock-chargeback-creation-request.ts create mode 100644 src/generated/models/mock-pix-payment-request-amount.ts create mode 100644 src/generated/models/mock-pix-payment-request.ts create mode 100644 src/generated/models/mock-pix-payment-response.ts create mode 100644 src/generated/models/mxnsettlement-instructions.ts delete mode 100644 src/generated/models/network-fee-quote.ts create mode 100644 src/generated/models/new-report-success.ts delete mode 100644 src/generated/models/payment-creation-request.ts create mode 100644 src/generated/models/payment-method-blockchain-request.ts delete mode 100644 src/generated/models/payment-token-request.ts delete mode 100644 src/generated/models/payment-token.ts delete mode 100644 src/generated/models/presign-domain.ts delete mode 100644 src/generated/models/presign-message-types.ts delete mode 100644 src/generated/models/presign-message.ts delete mode 100644 src/generated/models/presign-response-typed-data.ts delete mode 100644 src/generated/models/presign-response.ts delete mode 100644 src/generated/models/public-key.ts delete mode 100644 src/generated/models/rate.ts delete mode 100644 src/generated/models/refund-creation-request.ts delete mode 100644 src/generated/models/refund-payment-response.ts delete mode 100644 src/generated/models/reversal-reason.ts create mode 100644 src/generated/models/settlement-detail-status.ts create mode 100644 src/generated/models/settlement-details-inner.ts create mode 100644 src/generated/models/settlement-status.ts delete mode 100644 src/generated/models/simple-billing-details.ts delete mode 100644 src/generated/models/simple-card.ts delete mode 100644 src/generated/models/source.ts delete mode 100644 src/generated/models/to-amount.ts delete mode 100644 src/generated/models/tokenized-card-details.ts create mode 100644 src/generated/models/trade-status.ts create mode 100644 src/generated/models/trade.ts delete mode 100644 src/generated/models/update-billing-details.ts delete mode 100644 src/generated/models/update-card-response.ts delete mode 100644 src/generated/models/verification-error-code.ts create mode 100644 src/generated/models/wire-destination-response.ts diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 68e69e40..75249069 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -2.15.0 +2.16.0 diff --git a/sdk.json b/sdk.json index a48dff87..2a8f7b17 100644 --- a/sdk.json +++ b/sdk.json @@ -3,12 +3,15 @@ "servers": [ { "url": "https://api-sandbox.circle.com" + }, + { + "url": "https://api.circle.com" } ], "info": { - "version": "2.15.0", + "version": "2.16.0", "title": "All Circle APIs", - "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." + "description": "Circle's General, Core Functionality, Crypto Deposits, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, "tags": [ { @@ -23,22 +26,6 @@ "name": "Balances", "description": "Get information on settled and unsettled balances." }, - { - "name": "Cards", - "description": "Link, update, and get information on debit/credit cards." - }, - { - "name": "Payment Tokens", - "description": "Create Apple Pay and Google Pay payment tokens." - }, - { - "name": "Channels", - "description": "View a list of channels." - }, - { - "name": "Chargebacks", - "description": "Get information on card chargebacks." - }, { "name": "Crypto Payment Intents", "description": "Create and track intent for end user to pay via crypto." @@ -48,11 +35,7 @@ "description": "Get information on 1st party deposits." }, { - "name": "Encryption", - "description": "Encrypt sensitive data." - }, - { - "name": "Crypto Exchange Rates", + "name": "Exchange Rates", "description": "Pull estimated exchange rate for crypto currencies." }, { @@ -67,18 +50,10 @@ "name": "Payments", "description": "Get updates on whether user's crypto payment was received." }, - { - "name": "Pull Crypto Payments", - "description": "Create pull crypto payments and generate typed messages for signing." - }, { "name": "Payouts", "description": "Create and get information on address book payouts." }, - { - "name": "Settlements", - "description": "Get information on settlement batches." - }, { "name": "CUBIX", "description": "Create and get information on CUBIX accounts." @@ -108,8 +83,20 @@ "description": "Create, get instructions, and get information on bank accounts for wire transfers." }, { - "name": "Checkout Sessions", - "description": "Create, get, extend a checkout session." + "name": "Trades", + "description": "Execute currency exchange trades." + }, + { + "name": "Settlements", + "description": "Settlement endpoints" + }, + { + "name": "Reserve Management", + "description": "Report daily stablecoin balances to Circle." + }, + { + "name": "External Entities", + "description": "Manage your external entities." } ], "paths": { @@ -186,51 +173,6 @@ } } }, - "/v1/encryption/public": { - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get public key", - "description": "Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more.", - "operationId": "getPublicKey", - "tags": ["Encryption"], - "responses": { - "200": { - "description": "Successfully retrieved the RSA public key.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetPublicKeyResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/PublicKey" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "keyId": "key1", - "publicKey": "LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DSy0tLS0tClZlcnNpb246IEJDUEcgdjEuNTQKCm1RRU5CRjAxdmk0QkNBQ3JzMDNLS1Y0Qk9SRkYyT0Z4bUdvb0UyaTZMbnNneE5UL1dsV2s1ZTl2RDd2NENkSm0KcGJJbENmZ0U4WFlnYmhKUTE4YStaTzlPM0RFYUp2dGhJSEtjL0l1UEIvZmdEYUJUT285NkJzL2pVRFp6ZGxaVApQazNFUjliNFZPeGVwMFNPSHFMcmxTVFY4ZXB3M1R3SEdaL3NpSWdBYXEwRGdJdlZxUTY4TGVaMnorUFJWZm04CmhhSnJpb05SRU5Ja2ZNTWY5aFdySlowSW1zUk1aVmpDMVVrd2FSSHdrTTMwQUlia1dYcFJ5R205SXhQaXdGa08Kb1RnWlpwUFpsdVczckdkWER0NHZqL24za09hczV1dFdoNFovMlhjWHBiSUUyU0FPK0hycUdIclRnK1ZmZ05JNwpZcVZqYW5MOEN1bm83UkxmcDhKZlZDNXBLUm5ySVNCTnphN1ZBQkVCQUFHMEJrTnBjbU5zWllrQkhBUVFBUWtBCkJnVUNYVFcrTGdBS0NSQ3EzaHNwWjBMeGEwdnpCLzQvQTJpdk1CWW1aZXV2bEJZMm5ZZnNXek9Sb28vU3BIYkQKY2Y0UmtxZzZ0RERJSkUzNHhDVit0MzJydmJkM0ZOdVZseWs1MDVZRkpESnI4cVc2S0tkQVRXdU16eW5mMVVoUAo1M25hTlc0cXdrdSt3b0RWWjJpci9lUVI1WUc4L0RGcnd3bXdaa0dRd0Ftc3h5ZHd5anBnLzBrQ3lpZHkxdVBkCmVVWGgwdWt4dS9Dais4UFl5cHcwdit5V2tzbjdSZ2dVbkJFMWhiQ2pEV3FweHZjMEpDNVAxdmx6L2xRcWQrR3oKRC9Td1FJTVdRVElnV3BHRVVvQTRDc3drbU5PdHhsRVF1U0tueXNtTG02S0ExUmRhTzd6V2IrdWNLN21FZ2VoSwpXU2hHZExqRVNNZlVRUTczemNqMXg2amxLUFNhRlJyLzhXcHhrVXYzVHYvQzZMb0JpejRLCj1WSWg3Ci0tLS0tRU5EIFBHUCBQVUJMSUMgS0VZIEJMT0NLLS0tLS0K" - } - } - } - } - } - } - } - } - } - }, "/v1/notifications/subscriptions": { "post": { "security": [ @@ -404,57 +346,6 @@ } } }, - "/v1/channels": { - "get": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List all channels", - "description": "Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.).", - "parameters": [], - "operationId": "listChannels", - "tags": ["Channels"], - "responses": { - "200": { - "description": "Successfully retrieved a list of channels.", - "content": { - "application/json": { - "schema": { - "title": "ListChannelsResponse", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ChannelResponse" - } - } - } - }, - "examples": { - "response": { - "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "default": true, - "cardDescriptor": "CIRCLE LLC.", - "achDescriptor": "CIRCLE LLC." - } - ] - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, "/v1/stablecoins": { "get": { "summary": "List all stablecoins", @@ -513,64 +404,17 @@ "description": "Retrieves the balance of funds that are available for use.", "operationId": "listBusinessBalances", "tags": ["Balances"], - "responses": { - "200": { - "description": "Successfully retrieved balances.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "ListBusinessBalancesResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/Balances" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "available": [ - { - "amount": "3.14", - "currency": "USD" - } - ], - "unsettled": [ - { - "amount": "3.14", - "currency": "USD" - } - ] - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/balances": { - "get": { - "security": [ + "parameters": [ { - "bearerAuth": [] + "name": "walletId", + "description": "The wallet ID of the wallet for which to retrieve the balances. If not provided, the default is the main wallet of the account.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], - "summary": "List all balances", - "description": "Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled.", - "operationId": "listBalances", - "tags": ["Balances"], "responses": { "200": { "description": "Successfully retrieved balances.", @@ -582,7 +426,7 @@ "content": { "application/json": { "schema": { - "title": "ListBalancesResponse", + "title": "ListBusinessBalancesResponse", "properties": { "data": { "$ref": "#/components/schemas/Balances" @@ -618,28 +462,28 @@ } } }, - "/v1/cards": { + "/v1/businessAccount/banks/wires": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a card", - "operationId": "createCard", - "tags": ["Cards"], + "summary": "Create a wire bank account", + "operationId": "createBusinessWireAccount", + "tags": ["Wires"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CardCreationRequest" + "$ref": "#/components/schemas/WireCreationRequest" } } } }, "responses": { "201": { - "description": "Successfully created a card.", + "description": "Successfully created a bank account for wire transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -648,10 +492,10 @@ "content": { "application/json": { "schema": { - "title": "CreateCardResponse", + "title": "CreateBusinessWireAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/Card" + "$ref": "#/components/schemas/Wire" } } }, @@ -660,7 +504,19 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "wire", "status": "pending", + "description": "WELLS FARGO BANK, NA ****0010", + "trackingRef": "CIR13FB13A", + "transferTypesInfo": { + "wire": { + "currencies": ["USD", "EUR"] + }, + "rtgs": { + "currencies": ["USD"] + } + }, + "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "billingDetails": { "name": "Satoshi Nakamoto", "city": "Boston", @@ -670,29 +526,17 @@ "district": "MA", "postalCode": "01234" }, - "expMonth": 1, - "expYear": 2020, - "network": "VISA", - "last4": "0123", - "bin": "401230", - "issuerCountry": "US", - "fundingType": "credit", - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "errorCode": "verification_failed", - "verification": { - "avs": "D", - "cvv": "not_requested" - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" + "bankAddress": { + "bankName": "SAN FRANCISCO", + "city": "SAN FRANCISCO", + "country": "US", + "line1": "100 Money Street", + "line2": "Suite 1", + "district": "CA" }, "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "updateDate": "2020-04-10T02:13:30.000Z", + "virtualAccountEnabled": false } } } @@ -714,23 +558,12 @@ "bearerAuth": [] } ], - "summary": "List all cards", - "operationId": "listCards", - "tags": ["Cards"], - "parameters": [ - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" - } - ], + "summary": "List all wire bank accounts", + "operationId": "listBusinessWireAccounts", + "tags": ["Wires"], "responses": { "200": { - "description": "Successfully retrieved a list of cards.", + "description": "Successfully retrieved a list of bank accounts.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -739,12 +572,12 @@ "content": { "application/json": { "schema": { - "title": "ListCardsResponse", + "title": "ListBusinessWireAccountsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SimpleCard" + "$ref": "#/components/schemas/Wire" } } } @@ -755,28 +588,39 @@ "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "wire", "status": "pending", - "billingDetails": { - "country": "US", - "district": "MA" + "description": "WELLS FARGO BANK, NA ****0010", + "trackingRef": "CIR13FB13A", + "transferTypesInfo": { + "wire": { + "currencies": ["USD", "EUR"] + }, + "rtgs": { + "currencies": ["USD"] + } }, - "expMonth": 1, - "expYear": 2020, - "network": "VISA", - "bin": "401230", - "issuerCountry": "US", - "fundingType": "credit", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "verification": { - "avs": "D", - "cvv": "not_requested" + "billingDetails": { + "name": "Satoshi Nakamoto", + "city": "Boston", + "country": "US", + "line1": "100 Money Street", + "line2": "Suite 1", + "district": "MA", + "postalCode": "01234" }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" + "bankAddress": { + "bankName": "SAN FRANCISCO", + "city": "SAN FRANCISCO", + "country": "US", + "line1": "100 Money Street", + "line2": "Suite 1", + "district": "CA" }, "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "updateDate": "2020-04-10T02:13:30.000Z", + "virtualAccountEnabled": false } ] } @@ -791,7 +635,7 @@ } } }, - "/v1/cards/{id}": { + "/v1/businessAccount/banks/wires/{id}": { "get": { "parameters": [ { @@ -803,12 +647,12 @@ "bearerAuth": [] } ], - "summary": "Get a card", - "operationId": "getCard", - "tags": ["Cards"], + "summary": "Get a wire bank account", + "operationId": "getBusinessWireAccount", + "tags": ["Wires"], "responses": { "200": { - "description": "Successfully retrieved a card.", + "description": "Successfully retrieved a bank account for wire transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -817,10 +661,10 @@ "content": { "application/json": { "schema": { - "title": "GetCardResponse", + "title": "GetBusinessWireAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/Card" + "$ref": "#/components/schemas/Wire" } } }, @@ -829,39 +673,39 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "wire", "status": "pending", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" + "description": "WELLS FARGO BANK, NA ****0010", + "trackingRef": "CIR13FB13A", + "transferTypesInfo": { + "wire": { + "currencies": ["USD", "EUR"] + }, + "rtgs": { + "currencies": ["USD"] + } }, - "expMonth": 1, - "expYear": 2020, - "network": "VISA", - "last4": "0123", - "bin": "401230", - "issuerCountry": "US", - "fundingType": "credit", "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "errorCode": "verification_failed", - "verification": { - "avs": "D", - "cvv": "not_requested" - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" + "billingDetails": { + "name": "Satoshi Nakamoto", + "city": "Boston", + "country": "US", + "line1": "100 Money Street", + "line2": "Suite 1", + "district": "MA", + "postalCode": "01234" }, - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" + "bankAddress": { + "bankName": "SAN FRANCISCO", + "city": "SAN FRANCISCO", + "country": "US", + "line1": "100 Money Street", + "line2": "Suite 1", + "district": "CA" }, "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "updateDate": "2020-04-10T02:13:30.000Z", + "virtualAccountEnabled": false } } } @@ -876,119 +720,39 @@ "$ref": "#/components/responses/NotFound" } } - }, - "put": { + } + }, + "/v1/businessAccount/banks/wires/{id}/instructions": { + "get": { "parameters": [ { "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ + }, { - "bearerAuth": [] - } - ], - "summary": "Update a card", - "operationId": "updateCard", - "tags": ["Cards"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CardUpdate" - } - } - } - }, - "responses": { - "200": { - "description": "Succesfully modified a card.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "UpdateCardResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/Card" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" - }, - "expMonth": 1, - "expYear": 2020, - "network": "VISA", - "last4": "0123", - "bin": "401230", - "issuerCountry": "US", - "fundingType": "credit", - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "errorCode": "verification_failed", - "verification": { - "avs": "D", - "cvv": "not_requested" - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "metadata": { - "email": "satoshi@circle.com", - "phoneNumber": "+14155555555" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } + "$ref": "#/components/parameters/Currency" + }, + { + "name": "walletId", + "description": "The wallet ID of the external entity. If not provided, the instructions will be for your default wallet.\n\nYou can create additional wallets using the [Core API for Institutions](/api-reference/circle-mint/institutional/create-external-entity).\n", + "in": "query", + "required": false, + "schema": { + "type": "string" } } - } - } - }, - "/v1/paymentTokens": { - "post": { + ], "security": [ { "bearerAuth": [] } ], - "summary": "Create a payment token", - "description": "Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token.", - "operationId": "createPaymentToken", - "tags": ["Payment Tokens"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentTokenRequest" - } - } - } - }, + "summary": "Get wire instructions", + "description": "Get the wire transfer instructions into the Circle bank account given your bank account ID.", + "operationId": "getBusinessWireAccountInstructions", + "tags": ["Wires"], "responses": { - "201": { - "description": "Successfully converted a digital token to a Circle token account.", + "200": { + "description": "Successfully retrieved wire transfer instructions for the bank account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -997,10 +761,10 @@ "content": { "application/json": { "schema": { - "title": "CreatePaymentTokenResponse", + "title": "GetBusinessWireAccountInstructionsResponse", "properties": { "data": { - "$ref": "#/components/schemas/PaymentToken" + "$ref": "#/components/schemas/WireInstruction" } } }, @@ -1008,20 +772,23 @@ "response": { "value": { "data": { - "id": "gc988ed5-c189-4f70-a074-e5beb7eb8e32", - "type": "applepay", - "expiresOn": "2022-01-18T19:20:00Z", - "cardDetails": { - "expMonth": 1, - "expYear": 2020, - "network": "VISA", - "last4": "0123", - "bin": "401230", - "fundingType": "credit", - "issuerCountry": "US" + "trackingRef": "CIR13FB13A", + "beneficiary": { + "name": "CIRCLE INTERNET FINANCIAL INC", + "address1": "99 HIGH STREET", + "address2": "BOSTON MA 02110" }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "beneficiaryBank": { + "name": "WELLS FARGO BANK", + "swiftCode": "WFBIUS6SXXX", + "routingNumber": "121000248", + "accountNumber": "****7427", + "currency": "USD", + "address": "4250 EXECUTIVE SQUARE SUITE 300", + "city": "LA JOLLA", + "postalCode": "02110", + "country": "US" + } } } } @@ -1029,37 +796,37 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/businessAccount/banks/wires": { + "/v1/businessAccount/banks/cubix": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a Wire bank account", - "operationId": "createBusinessWireAccount", - "tags": ["Wires"], + "summary": "Create a CUBIX bank account", + "operationId": "createBusinessCubixAccount", + "tags": ["CUBIX"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WireCreationRequest" + "$ref": "#/components/schemas/CubixFiatAccountCreationRequest" } } } }, "responses": { "201": { - "description": "Successfully created a bank account for wire transfers.", + "description": "Successfully created a bank account for CUBIX transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1068,10 +835,10 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessWireAccountResponse", + "title": "CreateBusinessCubixAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/Wire" + "$ref": "#/components/schemas/CubixFiatAccountResponse" } } }, @@ -1081,34 +848,13 @@ "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", - "description": "WELLS FARGO BANK, NA ****0010", - "trackingRef": "CIR13FB13A", + "trackingRef": "CIR25XSXT8", + "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54", "transferTypesInfo": { - "wire": { - "currencies": ["USD", "EUR"] - }, - "rtgs": { + "cubix": { "currencies": ["USD"] } }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" - }, - "bankAddress": { - "bankName": "SAN FRANCISCO", - "city": "SAN FRANCISCO", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "CA" - }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1132,12 +878,12 @@ "bearerAuth": [] } ], - "summary": "List all Wire bank accounts", - "operationId": "listBusinessWireAccounts", - "tags": ["Wires"], + "summary": "List all CUBIX bank accounts.", + "operationId": "listBusinessCubixAccounts", + "tags": ["CUBIX"], "responses": { "200": { - "description": "Successfully retrieved a list of bank accounts.", + "description": "Successfully retrieved all bank accounts for CUBIX transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1146,12 +892,12 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessWireAccountsResponse", + "title": "ListBusinessCubixAccountsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Wire" + "$ref": "#/components/schemas/CubixFiatAccountResponse" } } } @@ -1163,34 +909,13 @@ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", - "description": "WELLS FARGO BANK, NA ****0010", - "trackingRef": "CIR13FB13A", + "trackingRef": "CIR25XSXT8", + "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54", "transferTypesInfo": { - "wire": { - "currencies": ["USD", "EUR"] - }, - "rtgs": { + "cubix": { "currencies": ["USD"] } }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" - }, - "bankAddress": { - "bankName": "SAN FRANCISCO", - "city": "SAN FRANCISCO", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "CA" - }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1207,7 +932,7 @@ } } }, - "/v1/businessAccount/banks/wires/{id}": { + "/v1/businessAccount/banks/cubix/{id}": { "get": { "parameters": [ { @@ -1219,12 +944,12 @@ "bearerAuth": [] } ], - "summary": "Get a Wire bank account", - "operationId": "getBusinessWireAccount", - "tags": ["Wires"], + "summary": "Get a CUBIX bank account", + "operationId": "getBusinessCubixAccount", + "tags": ["CUBIX"], "responses": { "200": { - "description": "Successfully retrieved a bank account for wire transfers.", + "description": "Successfully retrieved a bank account for CUBIX transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1233,10 +958,10 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessWireAccountResponse", + "title": "GetBusinessCubixAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/Wire" + "$ref": "#/components/schemas/CubixFiatAccountResponse" } } }, @@ -1246,34 +971,13 @@ "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", - "description": "WELLS FARGO BANK, NA ****0010", - "trackingRef": "CIR13FB13A", + "trackingRef": "CIR25XSXT8", + "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54", "transferTypesInfo": { - "wire": { - "currencies": ["USD", "EUR"] - }, - "rtgs": { + "cubix": { "currencies": ["USD"] } }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "billingDetails": { - "name": "Satoshi Nakamoto", - "city": "Boston", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "MA", - "postalCode": "01234" - }, - "bankAddress": { - "bankName": "SAN FRANCISCO", - "city": "SAN FRANCISCO", - "country": "US", - "line1": "100 Money Street", - "line2": "Suite 1", - "district": "CA" - }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1292,14 +996,11 @@ } } }, - "/v1/businessAccount/banks/wires/{id}/instructions": { + "/v1/businessAccount/banks/cubix/{id}/instructions": { "get": { "parameters": [ { "$ref": "#/components/parameters/IdPath" - }, - { - "$ref": "#/components/parameters/Currency" } ], "security": [ @@ -1307,13 +1008,13 @@ "bearerAuth": [] } ], - "summary": "Get Wire instructions", - "description": "Get the wire transfer instructions into the Circle bank account given your bank account id.", - "operationId": "getBusinessWireAccountInstructions", - "tags": ["Wires"], + "summary": "Get CUBIX instructions", + "description": "Get the CUBIX transfer instructions into the Circle bank account given your fiat account id.", + "operationId": "getBusinessCubixAccountInstructions", + "tags": ["CUBIX"], "responses": { "200": { - "description": "Successfully retrieved wire transfer instructions for the bank account.", + "description": "Successfully retrieved CUBIX transfer instructions for the fiat account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1322,10 +1023,10 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessWireAccountInstructionsResponse", + "title": "ListBusinessCubixAccountInstructionsResponse", "properties": { "data": { - "$ref": "#/components/schemas/WireInstruction" + "$ref": "#/components/schemas/CubixInstruction" } } }, @@ -1333,23 +1034,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", + "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" } } } @@ -1366,28 +1052,28 @@ } } }, - "/v1/businessAccount/banks/cubix": { + "/v1/businessAccount/banks/pix": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a CUBIX bank account", - "operationId": "createBusinessCubixAccount", - "tags": ["CUBIX"], + "summary": "Create a PIX bank account", + "operationId": "createBusinessPixAccount", + "tags": ["PIX"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CubixFiatAccountCreationRequest" + "$ref": "#/components/schemas/PixFiatAccountCreationRequest" } } } }, "responses": { "201": { - "description": "Successfully created a bank account for CUBIX transfers.", + "description": "Successfully created a bank account for PIX transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1396,10 +1082,10 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessCubixAccountResponse", + "title": "CreateBusinessPixAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/CubixFiatAccountResponse" + "$ref": "#/components/schemas/PixFiatAccountResponse" } } }, @@ -1409,13 +1095,18 @@ "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", - "trackingRef": "CIR25XSXT8", - "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54", + "description": "BTG Pactual ****0010", + "trackingRef": "CIR13FB13A", "transferTypesInfo": { - "cubix": { - "currencies": ["USD"] + "pix": { + "currencies": ["BRL"] } }, + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1439,12 +1130,12 @@ "bearerAuth": [] } ], - "summary": "List all CUBIX bank accounts.", - "operationId": "listBusinessCubixAccounts", - "tags": ["CUBIX"], + "summary": "List all PIX bank accounts.", + "operationId": "listBusinessPixAccounts", + "tags": ["PIX"], "responses": { "200": { - "description": "Successfully retrieved all bank accounts for CUBIX transfers.", + "description": "Successfully retrieved all bank accounts for PIX transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1453,12 +1144,12 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessCubixAccountsResponse", + "title": "ListBusinessPixAccountsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CubixFiatAccountResponse" + "$ref": "#/components/schemas/PixFiatAccountResponse" } } } @@ -1470,13 +1161,18 @@ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", - "trackingRef": "CIR25XSXT8", - "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54", + "description": "BTG Pactual ****0010", + "trackingRef": "CIR13FB13A", "transferTypesInfo": { - "cubix": { - "currencies": ["USD"] + "pix": { + "currencies": ["BRL"] } }, + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1493,7 +1189,7 @@ } } }, - "/v1/businessAccount/banks/cubix/{id}": { + "/v1/businessAccount/banks/pix/{id}": { "get": { "parameters": [ { @@ -1505,12 +1201,12 @@ "bearerAuth": [] } ], - "summary": "Get a CUBIX bank account", - "operationId": "getBusinessCubixAccount", - "tags": ["CUBIX"], + "summary": "Get a PIX bank account", + "operationId": "getBusinessPixAccount", + "tags": ["PIX"], "responses": { "200": { - "description": "Successfully retrieved a bank account for CUBIX transfers.", + "description": "Successfully retrieved a bank account for PIX transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1519,10 +1215,10 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessCubixAccountResponse", + "title": "GetBusinessPixAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/CubixFiatAccountResponse" + "$ref": "#/components/schemas/PixFiatAccountResponse" } } }, @@ -1532,13 +1228,18 @@ "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "status": "pending", - "trackingRef": "CIR25XSXT8", - "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54", + "description": "BTG Pactual ****0010", + "trackingRef": "CIR13FB13A", "transferTypesInfo": { - "cubix": { - "currencies": ["USD"] + "pix": { + "currencies": ["BRL"] } }, + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -1557,7 +1258,7 @@ } } }, - "/v1/businessAccount/banks/cubix/{id}/instructions": { + "/v1/businessAccount/banks/pix/{id}/instructions": { "get": { "parameters": [ { @@ -1569,13 +1270,13 @@ "bearerAuth": [] } ], - "summary": "Get CUBIX instructions", - "description": "Get the CUBIX transfer instructions into the Circle bank account given your fiat account id.", - "operationId": "getBusinessCubixAccountInstructions", - "tags": ["CUBIX"], + "summary": "Get PIX instructions", + "description": "Get the PIX transfer instructions into the Circle bank account given your bank account id.", + "operationId": "getBusinessPixAccountInstructions", + "tags": ["PIX"], "responses": { "200": { - "description": "Successfully retrieved CUBIX transfer instructions for the fiat account.", + "description": "Successfully retrieved PIX transfer instructions for the bank account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1584,10 +1285,10 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessCubixAccountInstructionsResponse", + "title": "BusinessPixAccountInstructionsResponse", "properties": { "data": { - "$ref": "#/components/schemas/CubixInstruction" + "$ref": "#/components/schemas/PixInstruction" } } }, @@ -1596,7 +1297,12 @@ "value": { "data": { "trackingRef": "CIR25XSXT8", - "accountId": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" + "ispb": "68033222", + "branchCode": "123", + "accountNumber": "322286803", + "accountType": "checking", + "taxId": "57112345675712", + "name": "CIRCLE INTERNET FINANCIAL INC" } } } @@ -1613,28 +1319,40 @@ } } }, - "/v1/businessAccount/banks/pix": { + "/v1/businessAccount/wallets/addresses/deposit": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a PIX bank account", - "operationId": "createBusinessPixAccount", - "tags": ["PIX"], + "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. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. \n", + "operationId": "createBusinessDepositAddress", + "parameters": [ + { + "name": "walletId", + "description": "The wallet ID to be credited when deposits are made to this address. If not provided, deposits default to the main wallet of the account.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "tags": ["Addresses"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PixFiatAccountCreationRequest" + "$ref": "#/components/schemas/BusinessGenerateAddressRequest" } } } }, "responses": { "201": { - "description": "Successfully created a bank account for PIX transfers.", + "description": "Successfully generated a new deposit address.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1643,10 +1361,10 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessPixAccountResponse", + "title": "CreateBusinessDepositAddressResponse", "properties": { "data": { - "$ref": "#/components/schemas/PixFiatAccountResponse" + "$ref": "#/components/schemas/AddressObject" } } }, @@ -1654,22 +1372,12 @@ "response": { "value": { "data": { + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "currency": "USD", + "chain": "ALGO", "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "BTG Pactual ****0010", - "trackingRef": "CIR13FB13A", - "transferTypesInfo": { - "pix": { - "currencies": ["BRL"] - } - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "walletId": "1000999922" } } } @@ -1691,12 +1399,24 @@ "bearerAuth": [] } ], - "summary": "List all PIX bank accounts.", - "operationId": "listBusinessPixAccounts", - "tags": ["PIX"], + "summary": "List all deposit addresses", + "description": "Returns a list of deposit addresses for a given wallet.", + "parameters": [ + { + "name": "walletId", + "description": "The wallet ID for which the deposit addresses were generated. If not provided, the default is the main wallet of the account.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "operationId": "getBusinessDepositAddress", + "tags": ["Addresses"], "responses": { "200": { - "description": "Successfully retrieved all bank accounts for PIX transfers.", + "description": "Successfully retrieved a list of deposit addresses.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -1705,12 +1425,12 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessPixAccountsResponse", + "title": "GetBusinessDepositAddressResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PixFiatAccountResponse" + "$ref": "#/components/schemas/AddressObject" } } } @@ -1720,22 +1440,12 @@ "value": { "data": [ { + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "currency": "USD", + "chain": "ALGO", "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "BTG Pactual ****0010", - "trackingRef": "CIR13FB13A", - "transferTypesInfo": { - "pix": { - "currencies": ["BRL"] - } - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "walletId": "1000999922" } ] } @@ -1750,252 +1460,8 @@ } } }, - "/v1/businessAccount/banks/pix/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a PIX bank account", - "operationId": "getBusinessPixAccount", - "tags": ["PIX"], - "responses": { - "200": { - "description": "Successfully retrieved a bank account for PIX transfers.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetBusinessPixAccountResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/PixFiatAccountResponse" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "status": "pending", - "description": "BTG Pactual ****0010", - "trackingRef": "CIR13FB13A", - "transferTypesInfo": { - "pix": { - "currencies": ["BRL"] - } - }, - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - }, - "fingerprint": "eb170539-9e1c-4e92-bf4f-1d09534fdca2", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/businessAccount/banks/pix/{id}/instructions": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get PIX instructions", - "description": "Get the PIX transfer instructions into the Circle bank account given your bank account id.", - "operationId": "getBusinessPixAccountInstructions", - "tags": ["PIX"], - "responses": { - "200": { - "description": "Successfully retrieved PIX transfer instructions for the bank account.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "BusinessPixAccountInstructionsResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/PixInstruction" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "trackingRef": "CIR25XSXT8", - "ispb": "68033222", - "branchCode": "123", - "accountNumber": "322286803", - "accountType": "checking", - "taxId": "57112345675712", - "name": "CIRCLE INTERNET FINANCIAL INC" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/businessAccount/wallets/addresses/deposit": { - "post": { - "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. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. \n", - "operationId": "createBusinessDepositAddress", - "tags": ["Addresses"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BusinessGenerateAddressRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully generated a new deposit address.", - "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" - } - } - } - } - } - } - }, - "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" - } - } - } - }, - "/v1/businessAccount/wallets/addresses/recipient": { - "post": { + "/v1/businessAccount/wallets/addresses/recipient": { + "post": { "security": [ { "bearerAuth": [] @@ -2186,6 +1652,15 @@ "enum": ["wire"] } }, + { + "name": "walletId", + "description": "The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/From" }, @@ -2251,8 +1726,24 @@ "decision": "approved", "reason": "3000" }, + "customerExternalRef": "EXT01ABSJKDKASJHDS922", "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "updateDate": "2020-04-10T02:13:30.000Z", + "source": { + "type": "wire", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "name": "COMMERZBANK AG ****3000" + }, + "fromAmount": { + "amount": "3.14", + "currency": "USD" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "externalRef": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "trackingRef": "CIR37N5FXJ" } ] } @@ -2267,14 +1758,116 @@ } } }, - "/v1/paymentIntents": { - "post": { + "/v1/businessAccount/deposits/{id}": { + "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a payment intent", + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" + }, + { + "name": "type", + "description": "Filters results to get only deposits made by this specific type.", + "in": "query", + "schema": { + "type": "string", + "enum": ["wire"] + } + }, + { + "name": "walletId", + "description": "The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "summary": "Get a deposit by ID", + "description": "Returns a deposit by ID.", + "operationId": "getBusinessDepositById", + "tags": ["Deposits"], + "responses": { + "200": { + "description": "Successfully retrieved a deposit.", + "headers": { + "X-Request-Id": { + "$ref": "#/components/headers/XRequestId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BusinessDeposit" + }, + "examples": { + "response": { + "value": { + "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" + }, + "customerExternalRef": "EXT01ABSJKDKASJHDS922", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z", + "source": { + "type": "wire", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "name": "COMMERZBANK AG ****3000" + }, + "fromAmount": { + "amount": "3.14", + "currency": "USD" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "externalRef": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "trackingRef": "CIR37N5FXJ" + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + } + }, + "/v1/paymentIntents": { + "post": { + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Create a payment intent", "description": "Create a transient or continuous payment intent", "operationId": "createPaymentIntent", "tags": ["Crypto Payment Intents"], @@ -3229,204 +2822,6 @@ } }, "/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": [ { @@ -3696,111 +3091,13 @@ } } }, - "/v1/payments/crypto": { - "post": { - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a crypto payment", - "operationId": "createCryptoPayment", - "tags": ["Pull Crypto Payments"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CryptoPaymentCreationRequest" - } - } - } - }, - "responses": { - "201": { - "description": "Successfully created a crypto payment.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "CreateCryptoPaymentResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CryptoPayment" - } - } - }, - "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" - }, - "status": "pending", - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "networkFees": { - "amount": "3.14", - "currency": "USD", - "feePayer": "endUser" - }, - "paymentIntentId": "6e4d4047-db14-4c09-b238-1215aee50d03", - "settlementAmount": { - "amount": "3.14", - "currency": "USD" - }, - "fromAddresses": { - "chain": "ALGO", - "addresses": [ - "0x8381470ED67C3802402dbbFa0058E8871F017A6F" - ] - }, - "depositAddress": { - "chain": "ALGO", - "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f", - "addressTag": "123456789" - }, - "transactionHash": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906", - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z", - "riskEvaluation": { - "decision": "approved", - "reason": "3000" - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/payments/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], + "/v1/payments/{id}": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" + } + ], "security": [ { "bearerAuth": [] @@ -4096,92 +3393,41 @@ } } }, - "/v1/payments/{id}/capture": { - "post": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CaptureCreationRequest" - } - } - } - }, - "summary": "Capture a payment (BETA)", - "description": "Warning: Please contact Circle support if you are planning on using this feature.\n\nThe given amount will be captured for the authorized payment if possible. If no amount is specified, the full amount\nwill be captured. You can only capture once per authorization.\n\nA successful response does *not* mean the payment has been captured. It only means the capture request was successfully submitted.\n", - "operationId": "capturePayment", - "tags": ["Payments"], - "responses": { - "202": { - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "description": "Payment capture successfully initiated." - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/payments/{id}/cancel": { + "/v1/businessAccount/payouts": { "post": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], "security": [ { "bearerAuth": [] } ], + "summary": "Create a payout", + "description": "Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency.\n", + "operationId": "createBusinessPayout", + "tags": ["Payouts"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CancelCreationRequest" + "$ref": "#/components/schemas/BusinessPayoutCreationRequest" } } } }, - "summary": "Cancel a payment", - "description": "The payment will be voided if possible meaning the payment source will not be charged & the payment will never settle.\nOtherwise, the payment will be refunded meaning the payment source will be charged & the payment will be refunded from deductions of future settlements.\nNot all payments are eligible to be cancelled.\n\nA successful response does *not* mean the payment has been cancelled; it only means the cancellation request is successfully submitted.\n", - "operationId": "cancelPayment", - "tags": ["Payments"], "responses": { - "200": { + "201": { + "description": "Successfully created a payout.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, - "description": "Payment cancellation successfully initiated.", "content": { "application/json": { "schema": { - "title": "CancelPaymentResponse", + "title": "CreateBusinessPayoutResponse", "properties": { "data": { - "$ref": "#/components/schemas/DetailedCancel" + "$ref": "#/components/schemas/BusinessPayout" } } }, @@ -4190,99 +3436,57 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "cancel", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", + "sourceWalletId": "53535335", + "destination": { + "type": "wire", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "name": "COMMERZBANK AG ****3000" + }, "amount": { "amount": "3.14", "currency": "USD" }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" + "toAmount": { + "amount": "3.14", + "currency": "USD" + }, + "fees": { + "amount": "3.14", + "currency": "USD" }, - "description": "Payment", "status": "pending", - "originalPayment": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { + "trackingRef": "CIR-6ESOQANEP3NAO", + "errorCode": "insufficient_funds", + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "adjustments": { + "fxCredit": { "amount": "3.14", "currency": "USD" }, - "fromAmount": { + "fxDebit": { "amount": "3.14", "currency": "USD" - }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, - "description": "Payment", - "status": "pending", - "captured": false, - "captureAmount": { + } + }, + "return": { + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac", + "amount": { "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", + "reason": "payout_returned", + "status": "pending", "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" - }, - "refund": false, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" } @@ -4292,200 +3496,150 @@ } } }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/payments/{id}/refund": { - "post": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], + }, + "get": { "security": [ { "bearerAuth": [] } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RefundCreationRequest" + "parameters": [ + { + "$ref": "#/components/parameters/Destination" + }, + { + "name": "type", + "description": "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.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["wire", "cubix"] + } + }, + { + "name": "status", + "description": "Queries items with the specified status. Matches any status if unspecified.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "uniqueItems": true, + "items": { + "$ref": "#/components/schemas/PayoutStatus" } } + }, + { + "name": "sourceWalletId", + "description": "Filters for payouts created from a specific source wallet.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/PageBefore" + }, + { + "$ref": "#/components/parameters/PageAfter" + }, + { + "$ref": "#/components/parameters/PageSize" } - }, - "summary": "Refund a payment", - "description": "The payment source will be refunded if possible. Not all payments are eligible to be cancelled.\n\nA successful response does *not* mean the payment has been refunded; it only means the refund request is successfully submitted.\n", - "operationId": "refundPayment", - "tags": ["Payments"], + ], + "summary": "List all payouts", + "description": "Lists all payouts for your account.\n\nNote that this endpoint does not return the tracking reference number for the payouts in the response. If you need that information you must get each payout individually by ID.\n", + "operationId": "listBusinessPayouts", + "tags": ["Payouts"], "responses": { "200": { + "description": "Successfully retrieved a list of payouts.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, - "description": "Payment refund successfully initiated.", "content": { "application/json": { "schema": { - "title": "RefundPaymentResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/DetailedRefund" - } - } + "$ref": "#/components/schemas/ListBusinessPayout" }, "examples": { "response": { "value": { - "data": { - "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": { + "data": [ + { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { - "amount": "3.14", - "currency": "USD" + "sourceWalletId": "53535335", + "destination": { + "type": "wire", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "name": "COMMERZBANK AG ****3000" }, - "fromAmount": { + "amount": { "amount": "3.14", "currency": "USD" }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" - }, - "description": "Payment", - "status": "pending", - "captured": false, - "captureAmount": { + "toAmount": { "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": "cancel", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantWalletId": "212000", - "amount": { - "amount": "3.14", - "currency": "USD" + "status": "pending", + "errorCode": "insufficient_funds", + "riskEvaluation": { + "decision": "approved", + "reason": "3000" }, - "source": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "card" + "adjustments": { + "fxCredit": { + "amount": "3.14", + "currency": "USD" + }, + "fxDebit": { + "amount": "3.14", + "currency": "USD" + } }, - "description": "Payment", - "status": "pending", - "originalPayment": { + "return": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "type": "payment", + "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac", "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" + "reason": "payout_returned", + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" }, - "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" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" - } + } + ] } } } @@ -4494,55 +3648,15 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } } }, - "/v1/payments/presign": { + "/v1/businessAccount/payouts/{id}": { "get": { "parameters": [ { - "name": "endUserAddress", - "description": "User wallet address", - "in": "query", - "required": true, - "schema": { - "type": "string", - "example": "0xdB055877e6c13b6A6B25aBcAA29B393777dD0a73" - } - }, - { - "name": "paymentIntentId", - "description": "Payment intent id which is from the create payment intent endpoint response", - "in": "query", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "example": "b48c8962-8e9f-40c3-9f1d-d9adde2ffe61" - } - }, - { - "name": "amount", - "required": false, - "in": "query", - "schema": { - "type": "string", - "example": "2.3" - } - }, - { - "name": "currency", - "description": "Only support USD at the moment", - "required": false, - "in": "query", - "schema": { - "type": "string", - "enum": ["USD"] - } + "$ref": "#/components/parameters/IdPath" } ], "security": [ @@ -4550,12 +3664,12 @@ "bearerAuth": [] } ], - "summary": "Get a typed message for signing", - "operationId": "presign", - "tags": ["Pull Crypto Payments"], + "summary": "Get a payout", + "operationId": "getBusinessPayout", + "tags": ["Payouts"], "responses": { "200": { - "description": "Successfully got a typed message for signing", + "description": "Successfully retrieved a payout.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -4564,10 +3678,10 @@ "content": { "application/json": { "schema": { - "title": "CreateCryptoPaymentResponse", + "title": "GetBusinessPayoutResponse", "properties": { "data": { - "$ref": "#/components/schemas/PresignResponse" + "$ref": "#/components/schemas/BusinessPayout" } } }, @@ -4575,78 +3689,60 @@ "response": { "value": { "data": { - "typedData": { - "domain": { - "name": "USD Coin", - "verifyingContract": "0x07865c6e87b9f70255377e024ace6630c1eaa37f", - "version": "2", - "chainId": 5 - }, - "message": { - "from": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "to": "0xdB055877e6c13b6A6B25aBcAA29B393777dD0a73", - "value": "5003456", - "validAfter": 1675317371, - "validBefore": 1675107967, - "nonce": "0x4f716a578b96592599c3ca7b2a46453df87511d4809f608cec982d6e83632604" - }, - "totalAmount": { - "amount": "3.14", + "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": "USD" + }, + "fees": { + "amount": "3.14", + "currency": "USD" + }, + "status": "pending", + "trackingRef": "CIR-6ESOQANEP3NAO", + "errorCode": "insufficient_funds", + "riskEvaluation": { + "decision": "approved", + "reason": "3000" + }, + "adjustments": { + "fxCredit": { + "amount": "3.14", "currency": "USD" }, - "feeChargeModel": "endUser", - "networkFeeQuote": { - "quoteId": "5d0bb4e7-bd83-44dd-b8f5-53ddd5f35a3a", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "expiresAt": "2023-02-02T06:01:21.152737680Z" + "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" }, - "types": { - "EIP712Domain": [ - { - "name": "name", - "type": "string" - }, - { - "name": "version", - "type": "string" - }, - { - "name": "chainId", - "type": "uint256" - }, - { - "name": "verifyingContract", - "type": "address" - } - ], - "TransferWithAuthorization": [ - { - "name": "from", - "type": "address" - }, - { - "name": "to", - "type": "address" - }, - { - "name": "validAfter", - "type": "uint256" - }, - { - "name": "validBefore", - "type": "uint256" - }, - { - "name": "nonce", - "type": "byte32" - } - ] + "fees": { + "amount": "3.14", + "currency": "USD" }, - "primaryType": "TransferWithAuthorization" - } + "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" } } } @@ -4654,9 +3750,6 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, "401": { "$ref": "#/components/responses/NotAuthorized" }, @@ -4666,7 +3759,7 @@ } } }, - "/v1/businessAccount/payouts": { + "/v1/payouts": { "post": { "security": [ { @@ -4674,14 +3767,14 @@ } ], "summary": "Create a payout", - "description": "\nCreate a payout. \n\nThe following table includes the supported pairs of amount.currency and toAmount.currency for FX payouts:\n\n| amount.currency | toAmount.currency |\n| ---------------- | ------------ |\n | USD | BRL |\n", - "operationId": "createBusinessPayout", + "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| EUR | EUR |\n", + "operationId": "createPayout", "tags": ["Payouts"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BusinessPayoutCreationRequest" + "$ref": "#/components/schemas/CryptoPayoutCreationRequest" } } } @@ -4697,23 +3790,22 @@ "content": { "application/json": { "schema": { - "title": "CreateBusinessPayoutResponse", + "title": "CreatePayoutResponse", "properties": { "data": { - "$ref": "#/components/schemas/BusinessPayout" + "$ref": "#/components/schemas/CryptoPayout" } } }, "examples": { - "response": { + "Crypto Payout": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "sourceWalletId": "53535335", "destination": { - "type": "wire", - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "name": "COMMERZBANK AG ****3000" + "type": "address_book", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29" }, "amount": { "amount": "3.14", @@ -4721,44 +3813,21 @@ }, "toAmount": { "amount": "3.14", - "currency": "USD" + "currency": "ETH" }, "fees": { "amount": "3.14", "currency": "USD" }, + "networkFees": { + "amount": "0.14", + "currency": "USD" + }, "status": "pending", - "trackingRef": "CIR-6ESOQANEP3NAO", - "errorCode": "insufficient_funds", + "errorCode": "transaction_denied", "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" + "decision": "denied", + "reason": "4000" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" @@ -4785,16 +3854,37 @@ ], "parameters": [ { - "$ref": "#/components/parameters/Destination" + "name": "source", + "description": "Identifier for the source wallet. Filters the fetched payout results to only be from a specific source wallet. If not provided, payouts from all wallets will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "1000565227" + } }, { - "name": "type", - "description": "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.", + "name": "destination", + "description": "Universally unique identifier (UUID v4) for the destination. Filters the fetched payout results made to a specific destination. If not provided, payouts to all destinations will be returned.", "in": "query", "required": false, "schema": { "type": "string", - "enum": ["wire", "cubix"] + "format": "uuid", + "example": "54c1cbab-c419-450f-ad23-906fa03af7f0" + } + }, + { + "name": "type", + "description": "Destination type. Filters the results to fetch all payouts made to a specified destination type. This query parameter can be passed multiple times to fetch results matching multiple destination types. The address_book destination type cannot be combined with other types.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "uniqueItems": true, + "items": { + "$ref": "#/components/schemas/PayoutDestinationType" + } } }, { @@ -4810,6 +3900,29 @@ } } }, + { + "name": "sourceCurrency", + "description": "Queries items with the specified source currency `amount.currency`. Matches any source currency if unspecified.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["USD", "EUR", "BTC", "ETH", "MTC", "FLW", "MAN"] + } + }, + { + "name": "destinationCurrency", + "description": "Queries items with the specified destination currency `toAmount.currency`. Matches any destination currency if unspecified.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["USD", "EUR", "BTC", "ETH", "MTC", "FLW", "MAN"] + } + }, + { + "$ref": "#/components/parameters/Chain" + }, { "$ref": "#/components/parameters/From" }, @@ -4827,7 +3940,7 @@ } ], "summary": "List all payouts", - "operationId": "listBusinessPayouts", + "operationId": "listPayouts", "tags": ["Payouts"], "responses": { "200": { @@ -4840,27 +3953,26 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessPayoutsResponse", + "title": "ListPayoutsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/BusinessPayout" + "$ref": "#/components/schemas/CryptoPayout" } } } }, "examples": { - "response": { + "Crypto Payout": { "value": { "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "sourceWalletId": "53535335", "destination": { - "type": "wire", - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "name": "COMMERZBANK AG ****3000" + "type": "address_book", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29" }, "amount": { "amount": "3.14", @@ -4868,44 +3980,21 @@ }, "toAmount": { "amount": "3.14", - "currency": "USD" + "currency": "ETH" }, "fees": { "amount": "3.14", "currency": "USD" }, + "networkFees": { + "amount": "0.14", + "currency": "USD" + }, "status": "pending", - "trackingRef": "CIR-6ESOQANEP3NAO", - "errorCode": "insufficient_funds", + "errorCode": "transaction_denied", "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" + "decision": "denied", + "reason": "4000" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" @@ -4923,7 +4012,7 @@ } } }, - "/v1/businessAccount/payouts/{id}": { + "/v1/payouts/{id}": { "get": { "parameters": [ { @@ -4936,7 +4025,7 @@ } ], "summary": "Get a payout", - "operationId": "getBusinessPayout", + "operationId": "getPayout", "tags": ["Payouts"], "responses": { "200": { @@ -4949,23 +4038,22 @@ "content": { "application/json": { "schema": { - "title": "GetBusinessPayoutResponse", + "title": "GetPayoutResponse", "properties": { "data": { - "$ref": "#/components/schemas/BusinessPayout" + "$ref": "#/components/schemas/CryptoPayout" } } }, "examples": { - "response": { + "Crypto Payout": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "sourceWalletId": "53535335", "destination": { - "type": "wire", - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "name": "COMMERZBANK AG ****3000" + "type": "address_book", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29" }, "amount": { "amount": "3.14", @@ -4973,44 +4061,21 @@ }, "toAmount": { "amount": "3.14", - "currency": "USD" + "currency": "ETH" }, "fees": { "amount": "3.14", "currency": "USD" }, + "networkFees": { + "amount": "0.14", + "currency": "USD" + }, "status": "pending", - "trackingRef": "CIR-6ESOQANEP3NAO", - "errorCode": "insufficient_funds", + "errorCode": "transaction_denied", "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" + "decision": "denied", + "reason": "4000" }, "createDate": "2020-04-10T02:13:30.000Z", "updateDate": "2020-04-10T02:13:30.000Z" @@ -5030,29 +4095,29 @@ } } }, - "/v1/payouts": { + "/v1/exchange/quotes": { "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"], + "summary": "Get quote", + "operationId": "getQuote", + "description": "Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD.\nNote: The current market exchange rate will be applied when Circle receives the deposit.\n", + "tags": ["Trades"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CryptoPayoutCreationRequest" + "$ref": "#/components/schemas/ExchangeRateRequest" } } } }, "responses": { "201": { - "description": "Successfully created a payout.", + "description": "Successfully fetched quote.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -5061,47 +4126,30 @@ "content": { "application/json": { "schema": { - "title": "CreatePayoutResponse", + "title": "FetchExchangeRateResponse", "properties": { "data": { - "$ref": "#/components/schemas/CryptoPayout" + "$ref": "#/components/schemas/ExchangeRateResponse" } } }, "examples": { - "Crypto Payout": { + "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "sourceWalletId": "53535335", - "destination": { - "type": "address_book", - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29" - }, - "amount": { + "rate": 0.1974, + "from": { "amount": "3.14", "currency": "USD" }, - "toAmount": { - "amount": "3.14", - "currency": "ETH" - }, - "fees": { + "to": { "amount": "3.14", "currency": "USD" }, - "networkFees": { - "amount": "0.14", - "currency": "USD" - }, - "status": "pending", - "errorCode": "transaction_denied", - "riskEvaluation": { - "decision": "denied", - "reason": "4000" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "expiry": "2020-04-10T02:13:30.000Z", + "type": "tradable", + "estimatedSettlementTime": "2020-04-10T03:13:30.000Z" } } } @@ -5114,9 +4162,14 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } - }, + } + }, + "/v1/fees/redemption/dailyReports": { "get": { "security": [ { @@ -5125,74 +4178,28 @@ ], "parameters": [ { - "name": "source", - "description": "Identifier for the source wallet. Filters the fetched payout results to only be from a specific source wallet. If not provided, payouts from all wallets will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "example": "1000565227" - } - }, - { - "name": "destination", - "description": "Universally unique identifier (UUID v4) for the destination. Filters the fetched payout results made to a specific destination. If not provided, payouts to all destinations will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "uuid", - "example": "54c1cbab-c419-450f-ad23-906fa03af7f0" - } - }, - { - "name": "type", - "description": "Destination type. Filters the results to fetch all payouts made to a specified destination type. This query parameter can be passed multiple times to fetch results matching multiple destination types. The address_book destination type cannot be combined with other types.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/PayoutDestinationType" - } - } - }, - { - "name": "status", - "description": "Queries items with the specified status. Matches any status if unspecified.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/PayoutStatus" - } - } - }, - { - "name": "sourceCurrency", - "description": "Queries items with the specified source currency `amount.currency`. Matches any source currency if unspecified.", + "name": "minimumFeeAmount", + "description": "Burn fee calculations below this value are filtered.", "in": "query", "required": false, "schema": { "type": "string", - "enum": ["USD", "EUR", "BTC", "ETH", "MTC", "FLW", "MAN"] + "example": "3.14" } }, { - "name": "destinationCurrency", - "description": "Queries items with the specified destination currency `toAmount.currency`. Matches any destination currency if unspecified.", + "name": "feeType", + "description": "Fee calculation type", "in": "query", - "required": false, + "required": true, "schema": { "type": "string", - "enum": ["USD", "EUR", "BTC", "ETH", "MTC", "FLW", "MAN"] + "enum": ["gross", "net"], + "example": "net" } }, { - "$ref": "#/components/parameters/Chain" + "$ref": "#/components/parameters/Currency" }, { "$ref": "#/components/parameters/From" @@ -5210,12 +4217,13 @@ "$ref": "#/components/parameters/PageSize" } ], - "summary": "List all payouts", - "operationId": "listPayouts", + "summary": "List daily burn fee calculations", + "description": "Returns daily burn fee calculations. This endpoint returns up to 50 daily fee calculations in descending chronological order or `pageSize`, if provided.", + "operationId": "listNetBurnFeeDailyCalculations", "tags": ["Payouts"], "responses": { "200": { - "description": "Successfully retrieved a list of payouts.", + "description": "Successfully retrieved a list of burn fee calculations.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -5224,51 +4232,42 @@ "content": { "application/json": { "schema": { - "title": "ListPayoutsResponse", + "title": "ListBurnFeeCalculationsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CryptoPayout" + "$ref": "#/components/schemas/RedemptionFeeCalculation" } } } }, "examples": { - "Crypto Payout": { + "response": { "value": { "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "sourceWalletId": "53535335", - "destination": { - "type": "address_book", - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29" - }, - "amount": { + "fee": { "amount": "3.14", "currency": "USD" }, - "toAmount": { - "amount": "3.14", - "currency": "ETH" - }, - "fees": { - "amount": "3.14", + "cumulatedPayoutAmount": { + "amount": "64.54", "currency": "USD" }, - "networkFees": { - "amount": "0.14", + "cumulatedPaymentAmount": { + "amount": "34.54", "currency": "USD" }, - "status": "pending", - "errorCode": "transaction_denied", - "riskEvaluation": { - "decision": "denied", - "reason": "4000" + "cumulatedNetAmount": { + "amount": "30.00", + "currency": "USD" }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "valueDate": "2023-05-23", + "status": "paid", + "thresholdResetTimestamp": "2023-05-23T23:59:59.999Z", + "createDate": "2024-04-10T02:13:30.000Z" } ] } @@ -5283,160 +4282,133 @@ } } }, - "/v1/payouts/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], + "/v1/businessAccount/transfers": { + "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Get a payout", - "operationId": "getPayout", - "tags": ["Payouts"], + "summary": "Create a transfer", + "description": "A transfer can be made from an existing business account to a blockchain location.", + "operationId": "createBusinessTransfer", + "tags": ["Transfers"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BusinessTransferCreationRequest" + } + } + } + }, "responses": { - "200": { - "description": "Successfully retrieved a payout.", + "201": { "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, + "description": "Successfully created a transfer.", "content": { "application/json": { "schema": { - "title": "GetPayoutResponse", + "title": "CreateBusinessTransferResponse", "properties": { "data": { - "$ref": "#/components/schemas/CryptoPayout" + "$ref": "#/components/schemas/Transfer" } } }, "examples": { - "Crypto Payout": { + "response": { "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "sourceWalletId": "53535335", + "source": { + "type": "wallet", + "id": "12345", + "identities": [ + { + "type": "individual", + "name": "Satoshi Nakamoto", + "addresses": [ + { + "line1": "100 Money Street", + "line2": "Suite 1", + "city": "Boston", + "district": "MA", + "postalCode": "01234", + "country": "US" + } + ] + } + ] + }, "destination": { - "type": "address_book", - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29" + "type": "blockchain", + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "chain": "ALGO" }, "amount": { "amount": "3.14", "currency": "USD" }, - "toAmount": { - "amount": "3.14", - "currency": "ETH" - }, - "fees": { - "amount": "3.14", - "currency": "USD" - }, - "networkFees": { - "amount": "0.14", - "currency": "USD" - }, - "status": "pending", - "errorCode": "transaction_denied", - "riskEvaluation": { - "decision": "denied", - "reason": "4000" - }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "fees": [ + { + "amount": "10.00", + "currency": "USD", + "type": "network" + } + ], + "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63", + "status": "pending", + "errorCode": "transfer_failed", + "createDate": "2020-04-10T02:13:30.000Z" } } } } } } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/exchange/rates/{trading-pair}": { + }, "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Get a exchange rate", - "description": "Fetch the current rates for the specified trading pair. The trading pair is defined by a base currency followed by a quote currency. The response contains buy and sell rates denominated in the quote currency. **Exchange rate is an estimate only and is subject to change by the time you submit the actual request.**", - "operationId": "getExchangeRates", - "tags": ["Crypto Exchange Rates"], "parameters": [ { - "name": "trading-pair", - "in": "path", - "required": true, + "name": "walletId", + "description": "Filters results to get only transfers to or from this Circle wallet.", + "in": "query", + "required": false, "schema": { - "type": "string", - "enum": ["BTC-USD", "ETH-USD", "FLOW-USD"] - } - } - ], - "responses": { - "200": { - "description": "Successfully retrieved rates.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetExchangeRatesResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/Rate" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "buy": "46317.59000", - "sell": "45400.41000", - "createDate": "2020-04-10T02:13:30.000Z" - } - } - } - } - } + "type": "string" } }, - "400": { - "$ref": "#/components/responses/BadRequest" + { + "name": "sourceWalletId", + "description": "Filters results to get only transfers from this Circle wallet.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - } - } - } - }, - "/v1/settlements": { - "get": { - "security": [ { - "bearerAuth": [] - } - ], - "parameters": [ + "name": "destinationWalletId", + "description": "Filters results to get only transfers to this Circle wallet.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/From" }, @@ -5453,12 +4425,13 @@ "$ref": "#/components/parameters/PageSize" } ], - "summary": "List all settlements", - "operationId": "listSettlements", - "tags": ["Settlements"], + "summary": "List all transfers", + "description": "Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided.", + "operationId": "listBusinessTransfers", + "tags": ["Transfers"], "responses": { "200": { - "description": "Successfully retrieved a list of settlements.", + "description": "Successfully retrieved a list of transfers.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -5467,12 +4440,12 @@ "content": { "application/json": { "schema": { - "title": "GetSettlementsResponse", + "title": "ListBusinessTransfersResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Settlement" + "$ref": "#/components/schemas/Transfer" } } } @@ -5483,26 +4456,47 @@ "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "merchantWalletId": "212000", - "walletId": "12345", - "totalDebits": { - "amount": "3.14", - "currency": "USD" - }, - "totalCredits": { - "amount": "3.14", - "currency": "USD" + "source": { + "type": "wallet", + "id": "12345", + "identities": [ + { + "type": "individual", + "name": "Satoshi Nakamoto", + "addresses": [ + { + "line1": "100 Money Street", + "line2": "Suite 1", + "city": "Boston", + "district": "MA", + "postalCode": "01234", + "country": "US" + } + ] + } + ] }, - "paymentFees": { - "amount": "3.14", - "currency": "USD" + "destination": { + "type": "blockchain", + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "chain": "ALGO" }, - "chargebackFees": { + "amount": { "amount": "3.14", "currency": "USD" }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "fees": [ + { + "amount": "10.00", + "currency": "USD", + "type": "network" + } + ], + "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63", + "status": "pending", + "errorCode": "transfer_failed", + "createDate": "2020-04-10T02:13:30.000Z" } ] } @@ -5517,7 +4511,7 @@ } } }, - "/v1/settlements/{id}": { + "/v1/businessAccount/transfers/{id}": { "get": { "parameters": [ { @@ -5529,24 +4523,24 @@ "bearerAuth": [] } ], - "summary": "Get a settlement", - "operationId": "getSettlement", - "tags": ["Settlements"], + "summary": "Get a transfer", + "operationId": "getBusinessTransfer", + "tags": ["Transfers"], "responses": { "200": { - "description": "Successfully retrieved a settlement.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, + "description": "Successfully retrieved a transfer.", "content": { "application/json": { "schema": { - "title": "GetSettlementResponse", + "title": "GetBusinessTransferResponse", "properties": { "data": { - "$ref": "#/components/schemas/Settlement" + "$ref": "#/components/schemas/Transfer" } } }, @@ -5555,76 +4549,80 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "merchantWalletId": "212000", - "walletId": "12345", - "totalDebits": { - "amount": "3.14", - "currency": "USD" - }, - "totalCredits": { - "amount": "3.14", - "currency": "USD" + "source": { + "type": "wallet", + "id": "12345", + "identities": [ + { + "type": "individual", + "name": "Satoshi Nakamoto", + "addresses": [ + { + "line1": "100 Money Street", + "line2": "Suite 1", + "city": "Boston", + "district": "MA", + "postalCode": "01234", + "country": "US" + } + ] + } + ] }, - "paymentFees": { - "amount": "3.14", - "currency": "USD" + "destination": { + "type": "blockchain", + "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", + "addressTag": "123456789", + "chain": "ALGO" }, - "chargebackFees": { + "amount": { "amount": "3.14", "currency": "USD" }, - "createDate": "2020-04-10T02:13:30.000Z", - "updateDate": "2020-04-10T02:13:30.000Z" + "fees": [ + { + "amount": "10.00", + "currency": "USD", + "type": "network" + } + ], + "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63", + "status": "pending", + "errorCode": "transfer_failed", + "createDate": "2020-04-10T02:13:30.000Z" } } } } } } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" } } } }, - "/v1/chargebacks": { - "get": { + "/v1/mocks/payments/wire": { + "post": { "security": [ { "bearerAuth": [] } ], - "parameters": [ - { - "$ref": "#/components/parameters/PaymentId" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" + "summary": "Create a mock Wire payment", + "description": "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.", + "operationId": "createMockWirePayment", + "tags": ["Payments"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MockWirePaymentRequest" + } + } } - ], - "summary": "List all chargebacks", - "description": "Retrieve list of chargebacks. Results will be sorted by create date descending: more recent chargebacks will be at the beginning of the list.\n", - "operationId": "listChargebacks", - "tags": ["Chargebacks"], + }, "responses": { - "200": { - "description": "Successfully retrieved a list of chargebacks.", + "201": { + "description": "Successfully created a mock wire payment.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -5633,45 +4631,27 @@ "content": { "application/json": { "schema": { - "title": "ListChargebacksResponse", + "title": "CreateWirePaymentResponse", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BasicChargeback" - } + "$ref": "#/components/schemas/MockWirePaymentResponse" } } }, "examples": { "response": { "value": { - "data": [ - { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "paymentId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "reasonCode": "10.4", - "status": "active", - "category": "Canceled Recurring Payment", - "history": [ - { - "type": "1st Chargeback", - "chargebackAmount": { - "amount": "3.14", - "currency": "USD" - }, - "fee": { - "amount": "3.14", - "currency": "USD" - }, - "description": "The cardholder claims an unauthorized transaction occurred.", - "settlementId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "createDate": "2020-04-10T02:13:30.000Z" - } - ] - } - ] + "data": { + "trackingRef": "CIR13FB13A", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "beneficiaryBank": { + "accountNumber": "11111111" + }, + "status": "pending" + } } } } @@ -5687,138 +4667,29 @@ } } }, - "/v1/chargebacks/{id}": { - "get": { - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a chargeback", - "operationId": "getChargeback", - "tags": ["Chargebacks"], - "responses": { - "200": { - "description": "Successfully retrieved a chargeback.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, - "content": { - "application/json": { - "schema": { - "title": "GetChargebackResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/BasicChargeback" - } - } - }, - "examples": { - "response": { - "value": { - "data": { - "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "paymentId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "reasonCode": "10.4", - "status": "active", - "category": "Canceled Recurring Payment", - "history": [ - { - "type": "1st Chargeback", - "chargebackAmount": { - "amount": "3.14", - "currency": "USD" - }, - "fee": { - "amount": "3.14", - "currency": "USD" - }, - "description": "The cardholder claims an unauthorized transaction occurred.", - "settlementId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32", - "createDate": "2020-04-10T02:13:30.000Z" - } - ] - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/NotAuthorized" - }, - "404": { - "$ref": "#/components/responses/NotFound" - } - } - } - }, - "/v1/exchange/quotes": { + "/v1/exchange/trades": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Fetch exchange rate", - "operationId": "exchangeRate", - "description": "Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD.\n\nNote: The current market exchange rate will be applied when Circle receives the deposit.\n", - "tags": ["Payments"], + "summary": "Create FX trade", + "description": "Creates a cross-currency trade", + "operationId": "createFxTrade", + "tags": ["Trades"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExchangeRateRequest" - }, - "examples": { - "Null amounts": { - "value": { - "from": { - "currency": "MXN" - }, - "to": { - "currency": "USD" - } - } - }, - "Non-null from amount": { - "value": { - "from": { - "amount": 5.05, - "currency": "MXN" - }, - "to": { - "currency": "USD" - } - } - }, - "Non-null to amount": { - "value": { - "from": { - "currency": "MXN" - }, - "to": { - "amount": 5.05, - "currency": "USD" - } - } - } + "$ref": "#/components/schemas/FxTradeRequest" } } } }, "responses": { - "201": { - "description": "Successfully fetched exchange rate.", + "200": { + "description": "Successfully created trade.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -5827,60 +4698,25 @@ "content": { "application/json": { "schema": { - "title": "FetchExchangeRateResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/ExchangeRateResponse" - } - } + "$ref": "#/components/schemas/CreateFxTradeResponse" }, "examples": { - "Null amounts": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "rate": 17.0531, - "from": { - "currency": "MXN" - }, - "to": { - "currency": "USD" - }, - "timestamp": "2022-07-21T20:13:35.578678Z" - } - } - }, - "Non-null from amount": { - "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "rate": 17.0531, - "from": { - "amount": 5.05, - "currency": "MXN" - }, - "to": { - "amount": 0.29, - "currency": "USD" - }, - "timestamp": "2022-07-21T20:13:35.578678Z" - } - } - }, - "Non-null to amount": { + "response": { "value": { "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "rate": 17.0531, + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", "from": { - "amount": 96.12, - "currency": "MXN" + "amount": "3.14", + "currency": "USDC" }, "to": { - "amount": 5.05, - "currency": "USD" + "amount": "3.14", + "currency": "USDC" }, - "timestamp": "2022-07-21T20:13:35.578678Z" + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z", + "quoteId": "b8627ae8-732b-4d25-b947-1df8f4007a29" } } } @@ -5898,52 +4734,25 @@ "$ref": "#/components/responses/NotFound" } } - } - }, - "/v1/fees/redemption/net/dailyReports": { + }, "get": { "security": [ { "bearerAuth": [] } ], + "summary": "Get all FX trades", + "description": "Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement.", + "operationId": "getFxTrades", + "tags": ["Trades"], "parameters": [ { - "name": "minimumFeeAmount", - "description": "Filters out NET burn daily fee calculations below minimumFeeAmount value.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "example": "3.14" - } - }, - { - "$ref": "#/components/parameters/Currency" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" + "$ref": "#/components/parameters/SettlementId" } ], - "summary": "List all NET burn daily fee calculations", - "description": "Searches for NET burn fee daily calculations. This endpoint returns up to 50 daily fee amount calculations in descending chronological order or pageSize, if provided.", - "operationId": "listNetBurnFeeDailyCalculations", - "tags": ["Payouts"], "responses": { "200": { - "description": "Successfully retrieved a list of NET burn fee calculations.", + "description": "Successfully retrieved trades.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -5952,12 +4761,12 @@ "content": { "application/json": { "schema": { - "title": "ListBurnFeeCalculationsResponse", + "title": "GetFxTradesResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RedemptionFeeCalculation" + "$ref": "#/components/schemas/Trade" } } } @@ -5968,26 +4777,21 @@ "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "fee": { + "from": { "amount": "3.14", - "currency": "USD" - }, - "cumulatedPayoutAmount": { - "amount": "64.54", - "currency": "USD" - }, - "cumulatedPaymentAmount": { - "amount": "34.54", - "currency": "USD" + "currency": "USDC" }, - "cumulatedNetAmount": { - "amount": "30.00", - "currency": "USD" + "to": { + "amount": "3.14", + "currency": "USDC" }, - "valueDate": "2023-05-23", - "status": "paid", - "thresholdResetTimestamp": "2023-05-23T23:59:59.999Z", - "createDate": "2024-04-10T02:13:30.000Z" + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z", + "quoteId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "settlementId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "rate": 0.9039, + "expectedBatchTime": "2020-04-10T02:13:30.000Z" } ] } @@ -5998,45 +4802,44 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/businessAccount/transfers": { - "post": { + "/v1/exchange/trades/{id}": { + "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a transfer", - "description": "A transfer can be made from an existing business account to a blockchain location.", - "operationId": "createBusinessTransfer", - "tags": ["Transfers"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BusinessTransferCreationRequest" - } - } + "summary": "Get FX trade", + "description": "Returns an FX trade by ID.", + "operationId": "getFxTradeId", + "tags": ["Trades"], + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" } - }, + ], "responses": { - "201": { + "200": { + "description": "Successfully retrieved trade.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, - "description": "Successfully created a transfer.", "content": { "application/json": { "schema": { - "title": "CreateBusinessTransferResponse", + "title": "GetFxTradesResponse", "properties": { "data": { - "$ref": "#/components/schemas/Transfer" + "$ref": "#/components/schemas/Trade" } } }, @@ -6045,62 +4848,48 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "source": { - "type": "wallet", - "id": "12345", - "identities": [ - { - "type": "individual", - "name": "Satoshi Nakamoto", - "addresses": [ - { - "line1": "100 Money Street", - "line2": "Suite 1", - "city": "Boston", - "district": "MA", - "postalCode": "01234", - "country": "US" - } - ] - } - ] - }, - "destination": { - "type": "blockchain", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "chain": "ALGO" + "from": { + "amount": "3.14", + "currency": "USDC" }, - "amount": { + "to": { "amount": "3.14", - "currency": "USD" + "currency": "USDC" }, - "fees": [ - { - "amount": "10.00", - "currency": "USD", - "type": "network" - } - ], - "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63", "status": "pending", - "errorCode": "transfer_failed", - "createDate": "2020-04-10T02:13:30.000Z" + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z", + "quoteId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "settlementId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "rate": 0.9039, + "expectedBatchTime": "2020-04-10T02:13:30.000Z" } } } } } } + }, + "401": { + "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } - }, + } + }, + "/v1/exchange/trades/settlements": { "get": { "security": [ { "bearerAuth": [] } ], + "summary": "Get all settlements", + "description": "Returns all settlements.", + "operationId": "getSettlements", + "tags": ["Settlements"], "parameters": [ { "$ref": "#/components/parameters/From" @@ -6116,15 +4905,40 @@ }, { "$ref": "#/components/parameters/PageSize" + }, + { + "name": "type", + "description": "The type of settlement.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["account_payable", "account_receivable"] + } + }, + { + "name": "status", + "description": "Status of the settlement.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/SettlementStatus" + } + }, + { + "name": "currency", + "description": "Currency of the settlement", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["MXN", "BRL"] + } } ], - "summary": "List all transfers", - "description": "Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided.", - "operationId": "listBusinessTransfers", - "tags": ["Transfers"], "responses": { "200": { - "description": "Successfully retrieved a list of transfers.", + "description": "Successfully retrieved settlements.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -6133,12 +4947,12 @@ "content": { "application/json": { "schema": { - "title": "ListBusinessTransfersResponse", + "title": "GetSettlementsResponse", "properties": { "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Transfer" + "$ref": "#/components/schemas/Settlement" } } } @@ -6149,47 +4963,24 @@ "data": [ { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "source": { - "type": "wallet", - "id": "12345", - "identities": [ - { - "type": "individual", - "name": "Satoshi Nakamoto", - "addresses": [ - { - "line1": "100 Money Street", - "line2": "Suite 1", - "city": "Boston", - "district": "MA", - "postalCode": "01234", - "country": "US" - } - ] - } - ] - }, - "destination": { - "type": "blockchain", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "chain": "ALGO" - }, - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "fees": [ + "entityId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z", + "details": [ { - "amount": "10.00", - "currency": "USD", - "type": "network" + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payable", + "amount": { + "amount": "3.14", + "currency": "USDC" + }, + "status": "pending", + "reference": "FXR1234567", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" } - ], - "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63", - "status": "pending", - "errorCode": "transfer_failed", - "createDate": "2020-04-10T02:13:30.000Z" + ] } ] } @@ -6200,40 +4991,44 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/businessAccount/transfers/{id}": { + "/v1/exchange/trades/settlements/{id}": { "get": { - "parameters": [ + "security": [ { - "$ref": "#/components/parameters/IdPath" + "bearerAuth": [] } ], - "security": [ + "summary": "Get settlement", + "description": "Returns a settlement by ID.", + "operationId": "getSettlementId", + "tags": ["Settlements"], + "parameters": [ { - "bearerAuth": [] + "$ref": "#/components/parameters/IdPath" } ], - "summary": "Get a transfer", - "operationId": "getBusinessTransfer", - "tags": ["Transfers"], "responses": { "200": { + "description": "Successfully retrieved settlement.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" } }, - "description": "Successfully retrieved a transfer.", "content": { "application/json": { "schema": { - "title": "GetBusinessTransferResponse", + "title": "GetSettlementIdResponse", "properties": { "data": { - "$ref": "#/components/schemas/Transfer" + "$ref": "#/components/schemas/Settlement" } } }, @@ -6242,80 +5037,59 @@ "value": { "data": { "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", - "source": { - "type": "wallet", - "id": "12345", - "identities": [ - { - "type": "individual", - "name": "Satoshi Nakamoto", - "addresses": [ - { - "line1": "100 Money Street", - "line2": "Suite 1", - "city": "Boston", - "district": "MA", - "postalCode": "01234", - "country": "US" - } - ] - } - ] - }, - "destination": { - "type": "blockchain", - "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F", - "addressTag": "123456789", - "chain": "ALGO" - }, - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "fees": [ + "entityId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "status": "pending", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z", + "details": [ { - "amount": "10.00", - "currency": "USD", - "type": "network" + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "type": "payable", + "amount": { + "amount": "3.14", + "currency": "USDC" + }, + "status": "pending", + "reference": "FXR1234567", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" } - ], - "transactionHash": "0x4cebf8f90c9243a23c77e4ae20df691469e4b933b295a73376292843968f7a63", - "status": "pending", - "errorCode": "transfer_failed", - "createDate": "2020-04-10T02:13:30.000Z" + ] } } } } } } + }, + "401": { + "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/mocks/cards/chargebacks": { - "post": { + "/v1/exchange/trades/settlements/instructions/{currency}": { + "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a mock chargeback", - "description": "In the sandbox environment, initiate a mock chargeback of a specified payment. The entire payment will be charged back for its full value. The payment must be in the `paid` state (otherwise the endpoint will return a `404`), and each payment can only be charged back once (otherwise the endpoint will return a `409`). This endpoint is only available in the sandbox environment.", - "operationId": "createMockChargeback", - "tags": ["Chargebacks"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MockChargebackCreationRequest" - } - } + "summary": "Get settlement instructions", + "description": "Returns settlement instructions for a specific currency.", + "operationId": "getSettlementInstructions", + "tags": ["Settlements"], + "parameters": [ + { + "$ref": "#/components/parameters/FxCurrencyPath" } - }, + ], "responses": { - "201": { - "description": "Successfully created a mock chargeback.", + "200": { + "description": "Successfully retrieved settlement instructions.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -6324,61 +5098,84 @@ "content": { "application/json": { "schema": { - "title": "CreateMockChargebackResponse", + "title": "GetSettlementInstructionsResponse", "properties": { "data": { - "$ref": "#/components/schemas/MockChargeback" + "oneOf": [ + { + "$ref": "#/components/schemas/MXNSettlementInstructions" + }, + { + "$ref": "#/components/schemas/BRLSettlementInstructions" + } + ] } } }, "examples": { "response": { "value": { - "data": {} + "data": { + "currency": "MXN", + "fiatAccountType": "wire", + "instruction": { + "trackingRef": "CIR13FB13A", + "beneficiary": { + "name": "CIRCLE INTERNET FINANCIAL INC", + "address1": "99 HIGH STREET", + "address2": "BOSTON MA 02110" + }, + "beneficiaryBank": { + "name": "WELLS FARGO BANK", + "swiftCode": "WFBIUS6SXXX", + "routingNumber": "121000248", + "accountNumber": "****7427", + "currency": "USD", + "address": "4250 EXECUTIVE SQUARE SUITE 300", + "city": "LA JOLLA", + "postalCode": "02110", + "country": "US" + } + } + } } } } } } }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, "401": { "$ref": "#/components/responses/NotAuthorized" }, "404": { "$ref": "#/components/responses/NotFound" - }, - "409": { - "$ref": "#/components/responses/Conflict" } } } }, - "/v1/mocks/payments/wire": { - "post": { + "/v1/exchange/fxConfigs/accounts": { + "put": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a mock Wire payment", - "description": "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.", - "operationId": "createMockWirePayment", - "tags": ["Payments"], + "summary": "Create FX account", + "description": "Creates a currency trading account", + "operationId": "createFxAccount", + "tags": ["Trades"], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MockWirePaymentRequest" + "$ref": "#/components/schemas/CreateFxAccountRequest" } } } }, "responses": { - "201": { - "description": "Successfully created a mock wire payment.", + "200": { + "description": "Successfully created a currency trading account.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -6387,10 +5184,10 @@ "content": { "application/json": { "schema": { - "title": "CreateWirePaymentResponse", + "title": "CreateFxAccountResponse", "properties": { "data": { - "$ref": "#/components/schemas/MockWirePaymentResponse" + "$ref": "#/components/schemas/CreateFxAccountResponse" } } }, @@ -6398,15 +5195,10 @@ "response": { "value": { "data": { - "trackingRef": "CIR13FB13A", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "beneficiaryBank": { - "accountNumber": "11111111" - }, - "status": "pending" + "currency": "MXN", + "fiatAccountId": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "createDate": "2020-04-10T02:13:30.000Z", + "updateDate": "2020-04-10T02:13:30.000Z" } } } @@ -6419,32 +5211,27 @@ }, "401": { "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" } } } }, - "/v1/checkoutSessions": { - "post": { + "/v1/exchange/fxConfigs/dailyLimits": { + "get": { "security": [ { "bearerAuth": [] } ], - "summary": "Create a checkout session", - "operationId": "createCheckoutSession", - "tags": ["Checkout Sessions"], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CheckoutSessionCreationRequest" - } - } - } - }, + "summary": "Get daily currency exchange limits", + "description": "Returns daily currency exchange limits and usages.", + "operationId": "getDailyFxLimits", + "tags": ["Trades"], "responses": { - "201": { - "description": "Successfully created a checkout session.", + "200": { + "description": "Successfully retrieved daily FX limits.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -6453,10 +5240,15 @@ "content": { "application/json": { "schema": { - "title": "CreateCheckoutSessionResponse", + "title": "GetFxLimitsResponse", "properties": { "data": { - "$ref": "#/components/schemas/CheckoutSession" + "type": "object", + "properties": { + "dailyLimits": { + "$ref": "#/components/schemas/DailyFxLimits" + } + } } } }, @@ -6464,24 +5256,28 @@ "response": { "value": { "data": { - "id": "3e4f4108-cbb4-4620-bd30-4bcf8c28ca20", - "type": "checkout_session", - "successUrl": "https://www.example.com/success", - "clientToken": "ck_test_19NoQz3jDq3mKgJFEuMkWs4dCk6Eiq1GZShWMF_jY_vL3dOAoT3EiTTgEprqaVcGbzB3pszRZhyU_v0mebyKiQ", - "status": "active", - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:13:35.578678Z", - "expiresOn": "2022-07-21T20:19:24.859052Z", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "2.20", - "currency": "USD" - }, - "paymentIds": [], - "paymentIntentIds": [] + "dailyLimits": { + "EURC": { + "limit": "1000000.00", + "usage": "0.00", + "available": "1000000.00" + }, + "MXN": { + "limit": "1000000.00", + "usage": "0.00", + "available": "1000000.00" + }, + "USDC": { + "limit": "1000000.00", + "usage": "0.00", + "available": "1000000.00" + }, + "BRL": { + "limit": "1000000.00", + "usage": "0.00", + "available": "1000000.00" + } + } } } } @@ -6489,43 +5285,35 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, "401": { "$ref": "#/components/responses/NotAuthorized" } } - }, - "get": { + } + }, + "/v1/mocks/payments/pix": { + "post": { "security": [ { "bearerAuth": [] } ], - "parameters": [ - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/PageBefore" - }, - { - "$ref": "#/components/parameters/PageAfter" - }, - { - "$ref": "#/components/parameters/PageSize" + "summary": "Create a mock PIX payment", + "description": "Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet.", + "operationId": "createMockPixPayment", + "tags": ["Payments"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MockPixPaymentRequest" + } + } } - ], - "summary": "List all checkout sessions", - "operationId": "listCheckoutSessions", - "tags": ["Checkout Sessions"], + }, "responses": { - "200": { - "description": "Successfully retrieved a list of checkout sessions.", + "201": { + "description": "Successfully created a mock PIX payment.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -6534,41 +5322,25 @@ "content": { "application/json": { "schema": { - "title": "ListCheckoutSessionsResponse", + "title": "CreatePixPaymentResponse", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CheckoutSession" - } + "$ref": "#/components/schemas/MockPixPaymentResponse" } } }, "examples": { "response": { "value": { - "data": [ - { - "id": "3e4f4108-cbb4-4620-bd30-4bcf8c28ca20", - "type": "checkout_session", - "successUrl": "https://www.example.com/success", - "clientToken": "ck_test_19NoQz3jDq3mKgJFEuMkWs4dCk6Eiq1GZShWMF_jY_vL3dOAoT3EiTTgEprqaVcGbzB3pszRZhyU_v0mebyKiQ", - "status": "active", - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:13:35.578678Z", - "expiresOn": "2022-07-21T20:19:24.859052Z", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "2.20", - "currency": "USD" - }, - "paymentIds": [], - "paymentIntentIds": [] - } - ] + "data": { + "trackingRef": "CIR13FB13A", + "amount": { + "amount": "3.14", + "currency": "BRL" + }, + "beneficiaryAccountNumber": "4842622", + "status": "pending" + } } } } @@ -6584,24 +5356,29 @@ } } }, - "/v1/checkoutSessions/{id}": { - "get": { + "/v2/reserveManagement/dailyCustodyBalances": { + "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Get a checkout session", - "operationId": "getCheckoutSession", - "tags": ["Checkout Sessions"], - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" + "summary": "Create daily custody balance report", + "operationId": "ReportDailyCustodyBalances", + "description": "Creates a daily custody balance report for USDC and EURC and sends it to Circle.\n\n**Note:** Only one report is allowed per day per currency.\n", + "tags": ["Reserve Management"], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DailyCustodyBalancesRequest" + } + } } - ], + }, "responses": { "200": { - "description": "Successfully retrieved a checkout session.", + "description": "Request with duplicate values and idempotency key has already been made. Existing record is returned.\n", "headers": { "X-Request-Id": { "$ref": "#/components/headers/XRequestId" @@ -6610,10 +5387,11 @@ "content": { "application/json": { "schema": { - "title": "GetCheckoutSessionResponse", + "title": "DuplicateRequest", + "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CheckoutSession" + "$ref": "#/components/schemas/DailyCustodyBalancesResponse" } } }, @@ -6621,24 +5399,59 @@ "response": { "value": { "data": { - "id": "3e4f4108-cbb4-4620-bd30-4bcf8c28ca20", - "type": "checkout_session", - "successUrl": "https://www.example.com/success", - "clientToken": "ck_test_19NoQz3jDq3mKgJFEuMkWs4dCk6Eiq1GZShWMF_jY_vL3dOAoT3EiTTgEprqaVcGbzB3pszRZhyU_v0mebyKiQ", - "status": "active", - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:13:35.578678Z", - "expiresOn": "2022-07-21T20:19:24.859052Z", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "2.20", - "currency": "USD" - }, - "paymentIds": [], - "paymentIntentIds": [] + "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "createDate": "2025-07-15T18:03:52.429Z", + "localBalance": 1000000, + "currency": "USDC", + "asOfDate": "2025-06-26", + "reportType": "eea", + "additionalFields": { + "equivalentEuroLocalBalance": 26994.6, + "totalBalance": 5000000, + "equivalentEuroTotalBalance": 853949.09 + } + } + } + } + } + } + } + }, + "201": { + "description": "Successfully created daily custody balance report.\n", + "headers": { + "X-Request-Id": { + "$ref": "#/components/headers/XRequestId" + } + }, + "content": { + "application/json": { + "schema": { + "title": "NewReportSuccess", + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DailyCustodyBalancesResponse" + } + } + }, + "examples": { + "response": { + "value": { + "data": { + "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7", + "id": "b8627ae8-732b-4d25-b947-1df8f4007a29", + "createDate": "2025-07-15T18:03:52.429Z", + "localBalance": 1000000, + "currency": "USDC", + "asOfDate": "2025-06-26", + "reportType": "eea", + "additionalFields": { + "equivalentEuroLocalBalance": 26994.6, + "totalBalance": 5000000, + "equivalentEuroTotalBalance": 853949.09 + } } } } @@ -6652,84 +5465,51 @@ "401": { "$ref": "#/components/responses/NotAuthorized" }, - "404": { - "$ref": "#/components/responses/NotFound" + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "409": { + "$ref": "#/components/responses/Conflict" } } } }, - "/v1/checkoutSessions/{id}/extend": { + "/v1/externalEntities": { "post": { "security": [ { "bearerAuth": [] } ], - "summary": "Extend a checkout session", - "operationId": "extendCheckoutSession", - "tags": ["Checkout Sessions"], - "parameters": [ - { - "$ref": "#/components/parameters/IdPath" - } - ], + "summary": "Create an external entity", + "description": "Creates an external entity for the institutional account.\n\nTo access the Core API for Institutions, contact your Circle account representative.\n", + "operationId": "createExternalEntity", + "tags": ["External Entities"], "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "extendTime": { - "type": "integer", - "description": "Extend the CheckoutSession by extendTime seconds if it is active or expired. The field is optional, if not provided, extend a period that configured by Merchant (default 1 day)", - "example": 3600 - } - } + "$ref": "#/components/schemas/ExternalEntityCreationRequest" } } } }, "responses": { "201": { - "description": "Successfully extended a payment intent.", - "headers": { - "X-Request-Id": { - "$ref": "#/components/headers/XRequestId" - } - }, + "description": "Successfully created an external entity.", "content": { "application/json": { "schema": { - "title": "ExtendCheckoutSessionResponse", - "properties": { - "data": { - "$ref": "#/components/schemas/CheckoutSession" - } - } + "$ref": "#/components/schemas/ExternalEntity" }, "examples": { "response": { "value": { - "data": { - "id": "3e4f4108-cbb4-4620-bd30-4bcf8c28ca20", - "type": "checkout_session", - "successUrl": "https://www.example.com/success", - "clientToken": "ck_test_19NoQz3jDq3mKgJFEuMkWs4dCk6Eiq1GZShWMF_jY_vL3dOAoT3EiTTgEprqaVcGbzB3pszRZhyU_v0mebyKiQ", - "status": "active", - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:13:35.578678Z", - "expiresOn": "2022-07-21T20:19:24.859052Z", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "2.20", - "currency": "USD" - }, - "paymentIds": [], - "paymentIntentIds": [] - } + "walletId": "212000", + "businessName": "Circle Internet Financial Inc.", + "businessUniqueIdentifier": "1234567890", + "identifierIssuingCountryCode": "US", + "complianceState": "PENDING" } } } @@ -6742,8 +5522,122 @@ "401": { "$ref": "#/components/responses/NotAuthorized" }, - "404": { - "$ref": "#/components/responses/NotFound" + "409": { + "$ref": "#/components/responses/Conflict" + } + } + }, + "get": { + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Get all external entities", + "description": "Returns all external entities for the institutional account.\n\nTo access the Core API for Institutions, contact your Circle account representative.\n\nNote that the `businessUniqueIdentifier` and `identifierIssuingCountryCode` must both be provided, or not at all. Only providing one will result in an error.\n", + "operationId": "getAllExternalEntities", + "tags": ["External Entities"], + "parameters": [ + { + "name": "businessUniqueIdentifier", + "description": "The unique identifier of the business. For example, a company number or tax ID.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "identifierIssuingCountryCode", + "description": "The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "pattern": "^[A-Z]{2}$" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a list of external entities.", + "content": { + "application/json": { + "schema": { + "title": "ListExternalEntitiesResponse", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalEntity" + } + } + } + }, + "examples": { + "response": { + "value": { + "data": [ + { + "walletId": "212000", + "businessName": "Circle Internet Financial Inc.", + "businessUniqueIdentifier": "1234567890", + "identifierIssuingCountryCode": "US", + "complianceState": "PENDING" + } + ] + } + } + } + } + } + } + } + } + }, + "/v1/externalEntities/{walletId}": { + "get": { + "security": [ + { + "bearerAuth": [] + } + ], + "summary": "Get an external entity by wallet ID", + "description": "Returns an external entity by wallet ID.\n\nTo access the Core API for Institutions, contact your Circle account representative.\n", + "operationId": "getExternalEntityByWalletId", + "tags": ["External Entities"], + "parameters": [ + { + "name": "walletId", + "description": "The wallet ID of the external entity.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved an external entity.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalEntity" + }, + "examples": { + "response": { + "value": { + "walletId": "212000", + "businessName": "Circle Internet Financial Inc.", + "businessUniqueIdentifier": "1234567890", + "identifierIssuingCountryCode": "US", + "complianceState": "PENDING" + } + } + } + } + } } } } @@ -6787,26 +5681,6 @@ } } }, - "IdKey": { - "type": "string", - "description": "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.", - "format": "uuid", - "example": "key1" - }, - "PublicKey": { - "type": "object", - "required": ["keyId", "publicKey"], - "properties": { - "keyId": { - "$ref": "#/components/schemas/IdKey" - }, - "publicKey": { - "type": "string", - "description": "A PGP ascii-armor encoded public key.", - "example": "LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DSy0tLS0tClZlcnNpb246IEJDUEcgdjEuNTQKCm1RRU5CRjAxdmk0QkNBQ3JzMDNLS1Y0Qk9SRkYyT0Z4bUdvb0UyaTZMbnNneE5UL1dsV2s1ZTl2RDd2NENkSm0KcGJJbENmZ0U4WFlnYmhKUTE4YStaTzlPM0RFYUp2dGhJSEtjL0l1UEIvZmdEYUJUT285NkJzL2pVRFp6ZGxaVApQazNFUjliNFZPeGVwMFNPSHFMcmxTVFY4ZXB3M1R3SEdaL3NpSWdBYXEwRGdJdlZxUTY4TGVaMnorUFJWZm04CmhhSnJpb05SRU5Ja2ZNTWY5aFdySlowSW1zUk1aVmpDMVVrd2FSSHdrTTMwQUlia1dYcFJ5R205SXhQaXdGa08Kb1RnWlpwUFpsdVczckdkWER0NHZqL24za09hczV1dFdoNFovMlhjWHBiSUUyU0FPK0hycUdIclRnK1ZmZ05JNwpZcVZqYW5MOEN1bm83UkxmcDhKZlZDNXBLUm5ySVNCTnphN1ZBQkVCQUFHMEJrTnBjbU5zWllrQkhBUVFBUWtBCkJnVUNYVFcrTGdBS0NSQ3EzaHNwWjBMeGEwdnpCLzQvQTJpdk1CWW1aZXV2bEJZMm5ZZnNXek9Sb28vU3BIYkQKY2Y0UmtxZzZ0RERJSkUzNHhDVit0MzJydmJkM0ZOdVZseWs1MDVZRkpESnI4cVc2S0tkQVRXdU16eW5mMVVoUAo1M25hTlc0cXdrdSt3b0RWWjJpci9lUVI1WUc4L0RGcnd3bXdaa0dRd0Ftc3h5ZHd5anBnLzBrQ3lpZHkxdVBkCmVVWGgwdWt4dS9Dais4UFl5cHcwdit5V2tzbjdSZ2dVbkJFMWhiQ2pEV3FweHZjMEpDNVAxdmx6L2xRcWQrR3oKRC9Td1FJTVdRVElnV3BHRVVvQTRDc3drbU5PdHhsRVF1U0tueXNtTG02S0ExUmRhTzd6V2IrdWNLN21FZ2VoSwpXU2hHZExqRVNNZlVRUTczemNqMXg2amxLUFNhRlJyLzhXcHhrVXYzVHYvQzZMb0JpejRLCj1WSWg3Ci0tLS0tRU5EIFBHUCBQVUJMSUMgS0VZIEJMT0NLLS0tLS0K" - } - } - }, "Id": { "type": "string", "description": "Unique system generated identifier for the entity.", @@ -6864,50 +5738,40 @@ "description": "Unsubscribe response object. No fields as of now.", "example": {} }, - "ChannelResponse": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "default": { - "type": "boolean", - "description": "Flag to indicate whether the channel is configured as default. At most one of the channels will have this flag set to true and the default channel is used when a payment request does not have the `channel` property set.", - "example": true - }, - "cardDescriptor": { - "type": "string", - "description": "Descriptor that appears on cardholders' bank statements for card payments submitted through this channel.", - "example": "CIRCLE LLC." - }, - "achDescriptor": { - "type": "string", - "description": "Descriptor that appears on end-users' bank statements for ACH payments submitted through this channel.", - "example": "CIRCLE LLC." - } - } - }, "Chain": { "type": "string", "description": "A blockchain that a given currency is available on.", "enum": [ "ALGO", + "APTOS", "ARB", "AVAX", "BASE", "BTC", "CELO", + "CODEX", "ETH", "HBAR", + "HYPEREVM", + "INK", + "LINEA", "NEAR", "NOBLE", "OP", + "PLUME", "PAH", "POLY", + "SEI", "SOL", + "SONIC", "SUI", + "UNI", + "WORLDCHAIN", + "XDC", "XLM", - "ZKS" + "XRP", + "ZKS", + "ZKSYNC" ] }, "TokenAmount": { @@ -7000,22 +5864,34 @@ "type": "string", "enum": ["pending", "complete", "failed"] }, - "SimpleBillingDetails": { + "FiatCurrency": { + "type": "string", + "description": "Currency code.", + "title": "Currency", + "enum": ["USD", "EUR", "MXN", "SGD", "BRL"] + }, + "TransferTypeInfo": { "type": "object", - "description": "Billing details of the card holder.", - "required": ["country", "district"], + "required": ["currencies"], + "description": "Additional information for specific transfer type.", "properties": { - "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" - }, - "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": "MA" + "currencies": { + "type": "array", + "uniqueItems": true, + "items": { + "$ref": "#/components/schemas/FiatCurrency" + } + }, + "additionalProperties": { + "description": "Additional properties that apply to specific transfer type.", + "type": "object", + "properties": { + "transactionLimits": { + "type": "integer", + "description": "Transaction amount limit for the transfer type.", + "example": 100000 + } + } } } }, @@ -7024,44 +5900,94 @@ "description": "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.", "example": "eb170539-9e1c-4e92-bf4f-1d09534fdca2" }, - "AvsResults": { - "type": "string", - "description": "Status of the AVS check. Raw AVS response, expressed as an upper-case letter. `not_requested` indicates check was not made. `pending` is pending/processing.", - "example": "D" - }, - "CvvResults": { - "description": "Enumerated status of the check. `not_requested` indicates check was not made. `pass` indicates value is correct. `fail` indicates value is incorrect. `unavailable` indicates card issuer did not do the provided check. `pending` indicates check is pending/processing.", - "type": "string", - "enum": ["not_requested", "pass", "fail", "unavailable", "pending"] - }, - "CardVerificationResponse": { + "BillingDetails": { "type": "object", - "description": "Indicates the status of the card for verification purposes.", - "required": ["avs", "cvv"], + "required": ["name", "city", "country", "line1", "postalCode"], "properties": { - "avs": { - "$ref": "#/components/schemas/AvsResults" + "name": { + "type": "string", + "description": "Full name of the card or bank account holder.", + "maxLength": 1024, + "example": "Satoshi Nakamoto" }, - "cvv": { - "$ref": "#/components/schemas/CvvResults" + "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" } } }, - "RiskEvaluation": { + "BankAddress": { "type": "object", - "description": "Results of risk evaluation. Only present if the payment is denied by Circle's risk service.", - "nullable": true, + "description": "The address details for the bank, as provided during bank account creation.", + "required": ["country"], "properties": { - "decision": { - "description": "Enumerated decision of the account.", + "bankName": { "type": "string", - "enum": ["approved", "denied", "review"] + "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" }, - "reason": { - "description": "Risk reason for the definitive decision outcome.", + "city": { "type": "string", - "nullable": true, - "example": "3000" + "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" + }, + "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" } } }, @@ -7070,17 +5996,15 @@ "description": "ISO-8601 UTC date/time format.", "example": "2020-04-10T02:13:30.000Z" }, - "SimpleCard": { + "Wire": { "type": "object", "required": [ "id", "status", + "description", + "trackingRef", "fingerprint", "billingDetails", - "expMonth", - "expYear", - "network", - "verification", "createDate", "updateDate" ], @@ -7088,56 +6012,58 @@ "id": { "$ref": "#/components/schemas/Id" }, + "type": { + "type": "string", + "description": "The type of the bank account.", + "example": "wire" + }, "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": { + "description": { "type": "string", - "description": "The bank identification number (BIN), the first 6 digits of the card.", - "example": "401230" + "description": "Bank name plus last four digits of the bank account number or IBAN.", + "example": "WELLS FARGO BANK, NA ****0010" }, - "issuerCountry": { + "trackingRef": { "type": "string", - "description": "The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.", - "example": "US" + "description": "Wire tracking ref that needs to be set in the wire reference to beneficiary field.", + "example": "CIR13FB13A" }, - "fundingType": { - "description": "The funding type of the card. Possible values are `credit`, `debit`, `prepaid`, and `unknown`.", - "type": "string", - "enum": ["credit", "debit", "prepaid", "unknown"] + "transferTypesInfo": { + "type": "object", + "description": "A map which shows transfer types supported on this account as well as additional information for each.", + "additionalProperties": { + "$ref": "#/components/schemas/TransferTypeInfo" + }, + "example": { + "wire": { + "currencies": ["USD", "EUR"] + }, + "rtgs": { + "currencies": ["USD"] + } + } }, "fingerprint": { "$ref": "#/components/schemas/Fingerprint" }, - "verification": { - "$ref": "#/components/schemas/CardVerificationResponse" + "billingDetails": { + "$ref": "#/components/schemas/BillingDetails" }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" + "bankAddress": { + "$ref": "#/components/schemas/BankAddress" }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, "updateDate": { "$ref": "#/components/schemas/UtcTimestamp" + }, + "virtualAccountEnabled": { + "type": "boolean", + "description": "Whether virtual account applies to the bank account.", + "example": false } } }, @@ -7147,21 +6073,57 @@ "format": "uuid", "example": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7" }, - "BillingDetails": { + "WireCreationRequestUs": { "type": "object", - "required": ["name", "city", "country", "line1", "postalCode"], + "title": "US Bank Account", + "description": "Relevant fields for U.S. bank accounts.", + "required": [ + "idempotencyKey", + "accountNumber", + "routingNumber", + "billingDetails", + "bankAddress" + ], "properties": { - "name": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" + }, + "accountNumber": { + "description": "Account number that identifies the bank account.", "type": "string", - "description": "Full name of the card or bank account holder.", - "maxLength": 1024, - "example": "Satoshi Nakamoto" + "example": "12340010", + "minLength": 6, + "maxLength": 35 + }, + "routingNumber": { + "description": "ABA routing number for the bank account. Note this has to be specific for bank wire transfers.", + "type": "string", + "example": "121000248" + }, + "billingDetails": { + "$ref": "#/components/schemas/BillingDetails" + }, + "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": { + "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.", + "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", @@ -7172,515 +6134,264 @@ "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": { - "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", + "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", "maxLength": 16, - "example": "MA" - }, - "postalCode": { - "type": "string", - "description": "Postal / ZIP code of the address.", - "maxLength": 16, - "example": "01234" + "example": "CA" } } }, - "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": { + "WireCreationRequestIban": { "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" - ], + "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" }, - "keyId": { - "$ref": "#/components/schemas/IdKey" - }, - "encryptedData": { + "iban": { + "description": "International Bank Account Number (IBAN) for the bank account.", "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" + "example": "DE31100400480532013000" }, "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" + "bankAddress": { + "$ref": "#/components/schemas/BankAddressIbanSupported" } } }, - "Card": { + "BankAddressNonIban": { "type": "object", - "required": [ - "id", - "status", - "billingDetails", - "expMonth", - "expYear", - "network", - "last4", - "fingerprint", - "verification", - "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" - }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" - }, - "expMonth": { - "$ref": "#/components/schemas/CardExpMonth" - }, - "expYear": { - "$ref": "#/components/schemas/CardExpYear" - }, - "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.", - "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`.", + "bankName": { "type": "string", - "enum": ["credit", "debit", "prepaid", "unknown"] - }, - "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" + "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" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "UpdateBillingDetails": { - "type": "object", - "properties": { - "firstName": { + "city": { "type": "string", - "description": "First name of the card or bank account holder.", + "description": "City portion of the address. This property is required for bank accounts outside of the US.", "maxLength": 1024, - "example": "Satoshi" + "example": "SAN FRANCISCO" }, - "lastName": { + "country": { "type": "string", - "description": "Last name of the card or bank account holder.", - "maxLength": 1024, - "example": "Nakamoto" + "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, + "maxLength": 35, "example": "100 Money Street" }, "line2": { "type": "string", "description": "Line two of the street address.", - "maxLength": 1024, + "maxLength": 35, "example": "Suite 1" }, - "city": { - "type": "string", - "description": "City portion of the address.", - "maxLength": 1024, - "example": "Boston" - }, "district": { - "description": "State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.", "type": "string", + "description": "State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision.", "maxLength": 16, - "example": "MA" + "example": "CA" + } + } + }, + "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": [ + "idempotencyKey", + "accountNumber", + "routingNumber", + "billingDetails", + "bankAddress" + ], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "postalCode": { + "accountNumber": { + "description": "Account number that identifies the bank account.", "type": "string", - "description": "Postal / ZIP code of the address.", - "maxLength": 16, - "example": "01234" + "example": "0321800123", + "minLength": 6, + "maxLength": 35 }, - "country": { + "routingNumber": { + "description": "The bank's SWIFT / BIC code.", "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": "SBININBB354" }, - "phone": { - "$ref": "#/components/schemas/PhoneNumber" + "billingDetails": { + "$ref": "#/components/schemas/BillingDetails" }, - "email": { - "$ref": "#/components/schemas/Email" + "bankAddress": { + "$ref": "#/components/schemas/BankAddressNonIban" } } }, - "CardUpdate": { + "WireCreationRequest": { "type": "object", - "required": ["keyId", "encryptedData"], - "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" + "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" }, - "expYear": { - "$ref": "#/components/schemas/CardExpYear" + { + "$ref": "#/components/schemas/WireCreationRequestIban" }, - "billingDetails": { - "$ref": "#/components/schemas/UpdateBillingDetails" + { + "$ref": "#/components/schemas/WireCreationRequestAccountNumber" } - } + ] }, - "ApplePayTokenEcHeader": { + "WireInstructionBeneficiary": { "type": "object", - "required": ["ephemeralPublicKey", "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", - "example": "" - }, - "ephemeralPublicKey": { - "description": "Ephemeral public key bytes.", + "name": { "type": "string", - "example": "MFkwEwYHKoZIzj.../zlsw==" + "description": "Name of the beneficiary.", + "example": "CIRCLE INTERNET FINANCIAL INC" }, - "publicKeyHash": { - "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate.", + "address1": { "type": "string", - "example": "tqYV+tmG9aMh+l/K6cicUnPqkb1gUiLjSTM9gEz6Nl0=" + "description": "Address line 1 of the beneficiary's address.", + "example": "99 HIGH STREET" }, - "transactionId": { - "description": "Transaction identifier, generated on the device.", + "address2": { "type": "string", - "example": "3cee89679130a4b2617c76118a1c62fd400cd45b49dc0916d5b951b560cd17b4" + "description": "Address line 2 of the beneficiary's address.", + "example": "BOSTON MA 02110" } } }, - "ApplePayTokenRsaHeader": { + "WireInstructionBeneficiaryBank": { "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" + "name": { + "type": "string", + "description": "Name of the beneficiary's bank.", + "example": "WELLS FARGO BANK" }, - "wrappedKey": { - "description": "The symmetric key wrapped using your RSA public key.", - "type": "string" + "swiftCode": { + "type": "string", + "description": "SWIFT code of the beneficiary's bank account.", + "example": "WFBIUS6SXXX" }, - "publicKeyHash": { - "description": "Hash of the X.509 encoded public key bytes of the merchant’s certificate.", - "type": "string" + "routingNumber": { + "type": "string", + "description": "ABA Routing number of the beneficiary's bank account.", + "example": "121000248" }, - "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.", + "accountNumber": { "type": "string", - "enum": ["EC_v1", "RSA_v1"] + "description": "Account number of the beneficiary's bank account.", + "example": "****7427" }, - "data": { - "description": "Encrypted payment data. Base64 encoded as a string.", + "currency": { + "type": "string", + "description": "Currency of the beneficiary's bank account.", + "example": "USD" + }, + "address": { "type": "string", - "example": "t7GeajLB9skXB6QSWfEpPA4WPhDqB7ekdd+...T6Ms7PhiNZpuGEE2QE=" + "description": "Address of the beneficiary's bank.", + "example": "4250 EXECUTIVE SQUARE SUITE 300" }, - "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.", + "city": { "type": "string", - "example": "MIAGCSqGSIb3DQEHAqCAMIACAQEx.../WIDkHWiFuSm5a3NVox7DlyIf0AAAAAAAA=" + "description": "City of the beneficiary's bank.", + "example": "LA JOLLA" }, - "header": { - "description": "Additional version-dependent information used to decrypt and verify the payment.", - "oneOf": [ - { - "$ref": "#/components/schemas/ApplePayTokenEcHeader" - }, - { - "$ref": "#/components/schemas/ApplePayTokenRsaHeader" - } - ] + "postalCode": { + "type": "string", + "description": "Postal code of the beneficiary's bank.", + "example": "02110" + }, + "country": { + "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" } } }, - "GooglePayToken": { + "WireInstruction": { "type": "object", - "required": ["signature", "protocolVersion", "signedMessage"], "properties": { - "signature": { - "description": "Verifies the message came from Google. The signature is created using ECDSA.", - "type": "string" + "trackingRef": { + "type": "string", + "description": "Circle tracking reference that needs to be set in the wire reference field.", + "example": "CIR13FB13A" }, - "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" + "beneficiary": { + "$ref": "#/components/schemas/WireInstructionBeneficiary" }, - "signedMessage": { - "description": "A serialized JSON string containing the encryptedMessage, ephemeralPublicKey, and tag. To simplify the signature verification process, this value is serialized.", - "type": "string" + "beneficiaryBank": { + "$ref": "#/components/schemas/WireInstructionBeneficiaryBank" } } }, - "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" - } - ] - } - } - }, - "TokenizedCardDetails": { - "type": "object", - "required": ["expMonth", "expYear", "last4", "bin"], - "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" - }, - "fundingType": { - "description": "The funding type of the card.", - "type": "string", - "enum": ["credit", "debit", "prepaid", "unknown"] - }, - "issuerCountry": { - "description": "The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard.", - "type": "string", - "example": "US" - } - } - }, - "PaymentToken": { + "CubixFiatAccountResponse": { "type": "object", "required": [ "id", - "type", - "expiresOn", - "cardDetails", + "status", + "trackingRef", + "accountId", "createDate", - "updateDate" + "updateDate", + "transferTypesInfo" ], "properties": { "id": { - "description": "Unique system generated identifier for the digital wallet token.", - "type": "string", - "format": "uuid", - "example": "gc988ed5-c189-4f70-a074-e5beb7eb8e32" + "$ref": "#/components/schemas/Id" }, - "type": { - "description": "Type of the digital wallet token.", + "status": { + "$ref": "#/components/schemas/ExternalFiatAccountStatus" + }, + "trackingRef": { "type": "string", - "enum": ["applepay", "googlepay"] + "description": "Tracking ref that needs to be set in the public description field when you send the funds to Circle's CUBIX account.", + "example": "CIR25XSXT8" }, - "expiresOn": { - "description": "Datetime when the digital token expires. ISO-8601.", + "accountId": { "type": "string", - "format": "date-time", - "example": "2022-01-18T19:20:00Z" + "format": "uuid", + "description": "Your CUBIX Account ID.", + "example": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" }, - "cardDetails": { - "$ref": "#/components/schemas/TokenizedCardDetails" + "transferTypesInfo": { + "type": "object", + "description": "A map which shows transfer types supported on this account as well as additional information for each. For CUBIX accounts this will always only show information for CUBIX transfers.", + "additionalProperties": { + "$ref": "#/components/schemas/TransferTypeInfo" + }, + "example": { + "cubix": { + "currencies": ["USD"] + } + } }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" @@ -7690,81 +6401,56 @@ } } }, - "FiatCurrency": { - "type": "string", - "description": "Currency code.", - "title": "Currency", - "enum": ["USD", "EUR", "MXN", "SGD", "BRL"] - }, - "TransferTypeInfo": { + "CubixFiatAccountCreationRequest": { "type": "object", - "required": ["currencies"], - "description": "Additional information for specific transfer type.", + "required": ["idempotencyKey", "accountId"], "properties": { - "currencies": { - "type": "array", - "uniqueItems": true, - "items": { - "$ref": "#/components/schemas/FiatCurrency" - } + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "additionalProperties": { - "description": "Additional properties that apply to specific transfer type.", - "type": "object", - "properties": { - "transactionLimits": { - "type": "integer", - "description": "Transaction amount limit for the transfer type.", - "example": 100000 - } - } + "accountId": { + "type": "string", + "format": "uuid", + "description": "Cubix Account ID.", + "example": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" } } }, - "BankAddress": { + "CubixInstruction": { "type": "object", - "description": "The address details for the bank, as provided during bank account creation.", - "required": ["country"], "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": { + "trackingRef": { "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" + "description": "Circle tracking reference that needs to be set in the CUBIX public memo field.", + "example": "CIR25XSXT8" }, - "line1": { + "accountId": { "type": "string", - "description": "Line one of the street address.", - "maxLength": 35, - "example": "100 Money Street" - }, - "line2": { + "format": "uuid", + "description": "Circle account ID that needs to be set in the CUBIX account ID field.", + "example": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" + } + } + }, + "RiskEvaluation": { + "type": "object", + "description": "Results of risk evaluation. Only present if the payment is denied by Circle's risk service.", + "nullable": true, + "properties": { + "decision": { + "description": "Enumerated decision of the account.", "type": "string", - "description": "Line two of the street address.", - "maxLength": 35, - "example": "Suite 1" + "enum": ["approved", "denied", "review"] }, - "district": { + "reason": { + "description": "Risk reason for the definitive decision outcome.", "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" + "nullable": true, + "example": "3000" } } }, - "Wire": { + "PixFiatAccountResponse": { "type": "object", "required": [ "id", @@ -7772,7 +6458,6 @@ "description", "trackingRef", "fingerprint", - "billingDetails", "createDate", "updateDate", "transferTypesInfo" @@ -7786,8 +6471,8 @@ }, "description": { "type": "string", - "description": "Bank name plus last four digits of the bank account number or IBAN.", - "example": "WELLS FARGO BANK, NA ****0010" + "description": "Bank name plus last four digits of the PIX account number.", + "example": "BTG Pactual ****0010" }, "trackingRef": { "type": "string", @@ -7796,28 +6481,22 @@ }, "transferTypesInfo": { "type": "object", - "description": "A map which shows transfer types supported on this account as well as additional information for each.", + "description": "A map which shows transfer types supported on this account as well as additional information for each. For PIX accounts this will always only show information for PIX transfers.", "additionalProperties": { "$ref": "#/components/schemas/TransferTypeInfo" }, "example": { - "wire": { - "currencies": ["USD", "EUR"] - }, - "rtgs": { - "currencies": ["USD"] + "pix": { + "currencies": ["BRL"] } } }, + "riskEvaluation": { + "$ref": "#/components/schemas/RiskEvaluation" + }, "fingerprint": { "$ref": "#/components/schemas/Fingerprint" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" - }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddress" - }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, @@ -7826,1705 +6505,769 @@ } } }, - "WireCreationRequestUs": { + "PixAccountType": { + "type": "string", + "title": "Account type", + "description": "Beneficiary account type.", + "enum": ["checking", "savings", "salary", "prepaid"], + "example": "checking" + }, + "PixFiatAccountCreationRequest": { "type": "object", - "title": "US Bank Account", - "description": "Relevant fields for U.S. bank accounts.", "required": [ "idempotencyKey", + "name", "accountNumber", - "routingNumber", - "billingDetails", - "bankAddress" + "ispb", + "branchCode", + "taxId", + "accountType" ], "properties": { "idempotencyKey": { "$ref": "#/components/schemas/IdempotencyKey" }, + "name": { + "type": "string", + "description": "Name of the beneficiary.", + "example": "CIRCLE INTERNET FINANCIAL INC" + }, "accountNumber": { - "description": "Account number that identifies the bank account.", "type": "string", - "example": "12340010", - "minLength": 6, - "maxLength": 35 + "description": "Beneficiary account number.", + "example": "322286803" }, - "routingNumber": { - "description": "ABA routing number for the bank account. Note this has to be specific for bank wire transfers.", + "ispb": { "type": "string", - "example": "121000248" + "description": "Beneficiary ISPB.", + "example": "68033222" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "branchCode": { + "type": "string", + "description": "Beneficiary account branch code.", + "example": "123" }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddress" + "taxId": { + "type": "string", + "description": "Beneficiary Tax ID.", + "example": "57112345675712" + }, + "accountType": { + "$ref": "#/components/schemas/PixAccountType" } } }, - "BankAddressIbanSupported": { + "PixInstruction": { "type": "object", - "description": "The address of the bank. City and country fields are required.", - "required": ["city", "country"], "properties": { - "bankName": { + "trackingRef": { "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": "Circle tracking reference that needs to be set in the PIX reference field.", + "example": "CIR25XSXT8" }, - "city": { + "ispb": { "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": "ISPB of beneficiary's bank.", + "example": "68033222" }, - "country": { + "branchCode": { "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" + "description": "Beneficiary account branch code.", + "example": "123" }, - "line1": { + "accountNumber": { "type": "string", - "description": "Line one of the street address.", - "maxLength": 35, - "example": "100 Money Street" + "description": "Beneficiary account number.", + "example": "322286803" }, - "line2": { + "accountType": { + "$ref": "#/components/schemas/PixAccountType" + }, + "taxId": { "type": "string", - "description": "Line two of the street address.", - "maxLength": 35, - "example": "Suite 1" + "description": "Beneficiary Tax ID.", + "example": "57112345675712" }, - "district": { + "name": { "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" + "description": "Name of the beneficiary.", + "example": "CIRCLE INTERNET FINANCIAL INC" } } }, - "WireCreationRequestIban": { + "Address": { + "type": "string", + "description": "An alphanumeric string representing a blockchain address. Formatting varies by blockchain.\nBe sure to preserve the exact formatting and capitalization of the address. \n**Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). \nThe `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`).\n", + "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" + }, + "AddressTag": { + "type": "string", + "description": "The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.", + "nullable": true, + "example": "123456789" + }, + "Currency": { + "type": "string", + "description": "A currency associated with a balance or address.", + "nullable": true, + "enum": ["USD", "EUR", "BTC", "ETH"] + }, + "AddressObject": { "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"], "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "address": { + "$ref": "#/components/schemas/Address" }, - "iban": { - "description": "International Bank Account Number (IBAN) for the bank account.", + "addressTag": { + "$ref": "#/components/schemas/AddressTag" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "id": { + "description": "Unique identifier of the deposit address.", + "$ref": "#/components/schemas/Id" + }, + "walletId": { "type": "string", - "example": "DE31100400480532013000" + "description": "Unique identifier of the wallet to which the deposit address is associated.", + "example": "1000999922" + } + } + }, + "BusinessGenerateAddressRequest": { + "type": "object", + "required": ["idempotencyKey", "currency", "chain"], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "currency": { + "$ref": "#/components/schemas/Currency" }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddressIbanSupported" + "chain": { + "$ref": "#/components/schemas/Chain" } } }, - "BankAddressNonIban": { + "AddressDescription": { + "type": "string", + "description": "An identifier or sentence that describes the recipient.", + "example": "My USDC address at a cryptocurrency exchange" + }, + "BusinessRecipientAddressObject": { "type": "object", - "description": "The address of the bank. BankName, City and Country fields are required.", - "required": ["bankName", "city", "country"], "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" + "id": { + "$ref": "#/components/schemas/Id" }, - "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" + "address": { + "$ref": "#/components/schemas/Address" }, - "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" + "addressTag": { + "$ref": "#/components/schemas/AddressTag" }, - "line1": { - "type": "string", - "description": "Line one of the street address.", - "maxLength": 35, - "example": "100 Money Street" + "chain": { + "$ref": "#/components/schemas/Chain" }, - "line2": { - "type": "string", - "description": "Line two of the street address.", - "maxLength": 35, - "example": "Suite 1" + "currency": { + "$ref": "#/components/schemas/Currency" }, - "district": { + "description": { + "$ref": "#/components/schemas/AddressDescription" + }, + "status": { "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" + "enum": ["active", "pending_verification", "verification_succeeded"] } } }, - "WireCreationRequestAccountNumber": { + "BusinessRecipientAddressCreationRequest": { "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" - ], + "description": "Adds a recipient address. The currency parameter will default to USD for all chains except for BTC where it defaults to BTC.", + "required": ["idempotencyKey", "address", "chain", "description"], "properties": { "idempotencyKey": { "$ref": "#/components/schemas/IdempotencyKey" }, - "accountNumber": { - "description": "Account number that identifies the bank account.", - "type": "string", - "example": "0321800123", - "minLength": 6, - "maxLength": 35 + "address": { + "$ref": "#/components/schemas/Address" }, - "routingNumber": { - "description": "The bank's SWIFT / BIC code.", - "type": "string", - "example": "SBININBB354" + "addressTag": { + "$ref": "#/components/schemas/AddressTag" }, - "billingDetails": { - "$ref": "#/components/schemas/BillingDetails" + "chain": { + "$ref": "#/components/schemas/Chain" }, - "bankAddress": { - "$ref": "#/components/schemas/BankAddressNonIban" + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "description": { + "$ref": "#/components/schemas/AddressDescription" } } }, - "WireCreationRequest": { + "WalletLocation": { "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" + "required": ["type", "id"], + "properties": { + "type": { + "type": "string", + "enum": ["wallet"] }, - { - "$ref": "#/components/schemas/WireCreationRequestAccountNumber" + "id": { + "type": "string", + "description": "The id of the wallet.", + "example": "12345" } - ] + } }, - "WireInstructionBeneficiary": { + "FiatMoney": { "type": "object", + "required": ["amount", "currency"], "properties": { - "name": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", "type": "string", - "description": "Name of the beneficiary.", - "example": "CIRCLE INTERNET FINANCIAL INC" + "example": "3.14" }, - "address1": { + "currency": { + "$ref": "#/components/schemas/FiatCurrency" + } + } + }, + "FiatMoneyUsd": { + "type": "object", + "required": ["amount", "currency"], + "properties": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", "type": "string", - "description": "Address line 1 of the beneficiary's address.", - "example": "99 HIGH STREET" + "example": "3.14" }, - "address2": { + "currency": { + "description": "Currency code.", "type": "string", - "description": "Address line 2 of the beneficiary's address.", - "example": "BOSTON MA 02110" + "enum": ["USD"] } } }, - "WireInstructionBeneficiaryBank": { + "InstitutionalCustomerExternalRef": { + "type": "string", + "description": "A reference to the external customer which is in the memo field of the fiat transfer.", + "pattern": "^(EXT[A-Z0-9]{18}).$", + "example": "EXT01ABSJKDKASJHDS922" + }, + "WireDestinationResponse": { "type": "object", + "required": ["type", "id"], "properties": { - "name": { + "type": { "type": "string", - "description": "Name of the beneficiary's bank.", - "example": "SILVERGATE BANK" + "enum": ["wire"] }, - "swiftCode": { - "type": "string", - "description": "SWIFT code of the beneficiary's bank account.", - "example": "SIVGUS66XXX" + "id": { + "$ref": "#/components/schemas/Id" }, - "routingNumber": { + "name": { "type": "string", - "description": "ABA Routing number of the beneficiary's bank account.", - "example": "322286803" + "description": "Bank name plus last four digits of the bank account number or IBAN.", + "example": "COMMERZBANK AG ****3000" + } + } + }, + "BusinessDeposit": { + "type": "object", + "description": "A deposit", + "required": ["id", "destination", "amount", "status", "createDate"], + "properties": { + "id": { + "$ref": "#/components/schemas/Id" }, - "accountNumber": { + "sourceWalletId": { "type": "string", - "description": "Account number of the beneficiary's bank account.", - "example": "****7427" + "description": "The identifier for the bank account where the funds were deposited from.", + "format": "uuid", + "example": "9b57048d-2365-4ff5-956b-0199170d1035" }, - "currency": { - "type": "string", - "description": "Currency of the beneficiary's bank account.", - "example": "USD" - }, - "address": { - "type": "string", - "description": "Address of the beneficiary's bank.", - "example": "4250 EXECUTIVE SQUARE SUITE 300" - }, - "city": { - "type": "string", - "description": "City of the beneficiary's bank.", - "example": "LA JOLLA" - }, - "postalCode": { - "type": "string", - "description": "Postal code of the beneficiary's bank.", - "example": "02110" - }, - "country": { - "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" - } - } - }, - "WireInstruction": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the wire reference field.", - "example": "CIR13FB13A" - }, - "beneficiary": { - "$ref": "#/components/schemas/WireInstructionBeneficiary" - }, - "beneficiaryBank": { - "$ref": "#/components/schemas/WireInstructionBeneficiaryBank" - } - } - }, - "CubixFiatAccountResponse": { - "type": "object", - "required": [ - "id", - "status", - "trackingRef", - "accountId", - "createDate", - "updateDate", - "transferTypesInfo" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" - }, - "trackingRef": { - "type": "string", - "description": "Tracking ref that needs to be set in the public description field when you send the funds to Circle's CUBIX account.", - "example": "CIR25XSXT8" - }, - "accountId": { - "type": "string", - "format": "uuid", - "description": "Your CUBIX Account ID.", - "example": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" - }, - "transferTypesInfo": { - "type": "object", - "description": "A map which shows transfer types supported on this account as well as additional information for each. For CUBIX accounts this will always only show information for CUBIX transfers.", - "additionalProperties": { - "$ref": "#/components/schemas/TransferTypeInfo" - }, - "example": { - "cubix": { - "currencies": ["USD"] - } - } - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "CubixFiatAccountCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "accountId"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "accountId": { - "type": "string", - "format": "uuid", - "description": "Cubix Account ID.", - "example": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" - } - } - }, - "CubixInstruction": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the CUBIX public memo field.", - "example": "CIR25XSXT8" - }, - "accountId": { - "type": "string", - "format": "uuid", - "description": "Circle account ID that needs to be set in the CUBIX account ID field.", - "example": "ff2212d7-8476-4d1e-9d95-eda6455f4f54" - } - } - }, - "PixFiatAccountResponse": { - "type": "object", - "required": [ - "id", - "status", - "description", - "trackingRef", - "fingerprint", - "createDate", - "updateDate", - "transferTypesInfo" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "status": { - "$ref": "#/components/schemas/ExternalFiatAccountStatus" - }, - "description": { - "type": "string", - "description": "Bank name plus last four digits of the PIX account number.", - "example": "BTG Pactual ****0010" - }, - "trackingRef": { - "type": "string", - "description": "Wire tracking ref that needs to be set in the wire reference to beneficiary field.", - "example": "CIR13FB13A" - }, - "transferTypesInfo": { - "type": "object", - "description": "A map which shows transfer types supported on this account as well as additional information for each. For PIX accounts this will always only show information for PIX transfers.", - "additionalProperties": { - "$ref": "#/components/schemas/TransferTypeInfo" - }, - "example": { - "pix": { - "currencies": ["BRL"] - } - } - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "fingerprint": { - "$ref": "#/components/schemas/Fingerprint" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "PixAccountType": { - "type": "string", - "title": "Account type", - "description": "Beneficiary account type.", - "enum": ["checking", "savings", "salary", "prepaid"], - "example": "checking" - }, - "PixFiatAccountCreationRequest": { - "type": "object", - "required": [ - "idempotencyKey", - "name", - "accountNumber", - "ispb", - "branchCode", - "taxId", - "accountType" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "name": { - "type": "string", - "description": "Name of the beneficiary.", - "example": "CIRCLE INTERNET FINANCIAL INC" - }, - "accountNumber": { - "type": "string", - "description": "Beneficiary account number.", - "example": "322286803" - }, - "ispb": { - "type": "string", - "description": "Beneficiary ISPB.", - "example": "68033222" - }, - "branchCode": { - "type": "string", - "description": "Beneficiary account branch code.", - "example": "123" - }, - "taxId": { - "type": "string", - "description": "Beneficiary Tax ID.", - "example": "57112345675712" - }, - "accountType": { - "$ref": "#/components/schemas/PixAccountType" - } - } - }, - "PixInstruction": { - "type": "object", - "properties": { - "trackingRef": { - "type": "string", - "description": "Circle tracking reference that needs to be set in the PIX reference field.", - "example": "CIR25XSXT8" - }, - "ispb": { - "type": "string", - "description": "ISPB of beneficiary's bank.", - "example": "68033222" - }, - "branchCode": { - "type": "string", - "description": "Beneficiary account branch code.", - "example": "123" - }, - "accountNumber": { - "type": "string", - "description": "Beneficiary account number.", - "example": "322286803" - }, - "accountType": { - "$ref": "#/components/schemas/PixAccountType" - }, - "taxId": { - "type": "string", - "description": "Beneficiary Tax ID.", - "example": "57112345675712" - }, - "name": { - "type": "string", - "description": "Name of the beneficiary.", - "example": "CIRCLE INTERNET FINANCIAL INC" - } - } - }, - "Address": { - "type": "string", - "description": "An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address.", - "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" - }, - "AddressTag": { - "type": "string", - "description": "The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.", - "nullable": true, - "example": "123456789" - }, - "Currency": { - "type": "string", - "description": "A currency associated with a balance or address.", - "nullable": true, - "enum": ["USD", "EUR", "BTC", "ETH"] - }, - "AddressObject": { - "type": "object", - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - } - } - }, - "BusinessGenerateAddressRequest": { - "type": "object", - "required": ["idempotencyKey", "currency", "chain"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - } - } - }, - "AddressDescription": { - "type": "string", - "description": "An identifier or sentence that describes the recipient.", - "example": "My USDC address at a cryptocurrency exchange" - }, - "BusinessRecipientAddressObject": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "address": { - "$ref": "#/components/schemas/Address" - }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "description": { - "$ref": "#/components/schemas/AddressDescription" - }, - "status": { - "type": "string", - "enum": ["active", "pending_verification", "verification_succeeded"] - } - } - }, - "BusinessRecipientAddressCreationRequest": { - "type": "object", - "description": "Adds a recipient address. The currency parameter will default to USD for all chains except for BTC where it defaults to BTC.", - "required": ["idempotencyKey", "address", "chain", "description"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "address": { - "$ref": "#/components/schemas/Address" - }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "description": { - "$ref": "#/components/schemas/AddressDescription" - } - } - }, - "WalletLocation": { - "type": "object", - "required": ["type", "id"], - "properties": { - "type": { - "type": "string", - "enum": ["wallet"] - }, - "id": { - "type": "string", - "description": "The id of the wallet.", - "example": "12345" - } - } - }, - "FiatMoney": { - "type": "object", - "required": ["amount", "currency"], - "properties": { - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" - }, - "currency": { - "$ref": "#/components/schemas/FiatCurrency" - } - } - }, - "FiatMoneyUsd": { - "type": "object", - "required": ["amount", "currency"], - "properties": { - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" - }, - "currency": { - "description": "Currency code.", - "type": "string", - "enum": ["USD"] - } - } - }, - "BusinessDeposit": { - "type": "object", - "description": "A deposit", - "required": ["id", "destination", "amount", "status", "createDate"], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "sourceWalletId": { - "type": "string", - "description": "The identifier for the bank account where the funds were deposited from.", - "format": "uuid", - "example": "9b57048d-2365-4ff5-956b-0199170d1035" - }, - "destination": { - "$ref": "#/components/schemas/WalletLocation" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoney" - }, - "fee": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "status": { - "type": "string", - "description": "Status of the deposit. Status `pending` indicates that the deposit is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.", - "enum": ["pending", "complete", "failed"] - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "CryptoPaymentsMoney": { - "type": "object", - "required": ["amount", "currency"], - "properties": { - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" - }, - "currency": { - "description": "Currency code.", - "type": "string", - "enum": ["USD", "ETH", "BTC"] - } - } - }, - "PaymentMethodBlockchain": { - "type": "object", - "required": ["type", "chain"], - "properties": { - "type": { - "type": "string", - "enum": ["blockchain"] - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "address": { - "type": "string", - "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" - } - } - }, - "PaymentIntentFees": { - "type": "object", - "required": ["type", "amount", "currency"], - "properties": { - "type": { - "type": "string", - "enum": ["blockchainLeaseFee", "totalPaymentFees"] - }, - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" - }, - "currency": { - "description": "Currency code.", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - } - } - }, - "Timeline": { - "type": "object", - "required": ["status", "time"], - "properties": { - "status": { - "type": "string", - "enum": [ - "created", - "pending", - "complete", - "expired", - "failed", - "refunded" - ] - }, - "context": { - "type": "string", - "enum": ["underpaid", "paid", "overpaid"] - }, - "reason": { - "type": "string", - "enum": ["requested_by_merchant", "fee_collection_failed"] - }, - "time": { - "description": "ISO-8601 UTC date/time format.", - "type": "string", - "format": "date-time" - } - } - }, - "PaymentIntent": { - "type": "object", - "required": ["amount", "settlementCurrency", "paymentMethods"], - "properties": { - "id": { - "type": "string", - "description": "Unique system generated identifier for the entity.", - "format": "uuid", - "example": "b8627ae8-732b-4d25-b947-1df8f4007a29" - }, - "amount": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" - }, - "amountPaid": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" - }, - "amountRefunded": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" - }, - "settlementCurrency": { - "description": "Desired currency for the payments to settle in.", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethodBlockchain" - } - }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentIntentFees" - } - }, - "paymentIds": { - "description": "List of associated payments.", - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "example": "69808f36-3e5e-4f37-bf82-ca79e4d70fc1" - } - }, - "refundIds": { - "description": "List of associated refunds.", - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "example": "425dca6d-ac79-43b6-b0f9-43fdc51de91b" - } - }, - "timeline": { - "description": "State management timeline.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Timeline" - } - }, - "expiresOn": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" - } - } - }, - "ContinuousPaymentIntent": { - "type": "object", - "required": [ - "currency", - "settlementCurrency", - "paymentMethods", - "type" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "currency": { - "description": "Desired currency of the payment.", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - }, - "amountPaid": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" - }, - "amountRefunded": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" - }, - "settlementCurrency": { - "description": "Desired currency for the payments to settle in.", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethodBlockchain" - } - }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentIntentFees" - } - }, - "timeline": { - "description": "State management timeline.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Timeline" - } - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "type": { - "type": "string", - "enum": ["continuous"] - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" - } - } - }, - "PaymentIntentCreationRequest": { - "type": "object", - "required": [ - "idempotencyKey", - "amount", - "settlementCurrency", - "paymentMethods" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "amount": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" - }, - "settlementCurrency": { - "description": "Desired currency for the payments to settle in.", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethodBlockchain" - } - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" - } - } - }, - "ContinuousPaymentIntentCreationRequest": { - "type": "object", - "required": [ - "idempotencyKey", - "currency", - "settlementCurrency", - "paymentMethods" - ], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "currency": { - "description": "Desired currency for the payment", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - }, - "settlementCurrency": { - "description": "Desired currency for the payments to settle in.", - "type": "string", - "enum": ["USD", "BTC", "ETH"] - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethodBlockchain" - } - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" - }, - "type": { - "type": "string", - "enum": ["continuous"] - } - } - }, - "CryptoRefundDestination": { - "type": "object", - "description": "The destination of a crypto refund.", - "required": ["address", "chain"], - "properties": { - "address": { - "type": "string", - "description": "The blockchain address.", - "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" - }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - } - } - }, - "CryptoRefundCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "destination", "amount", "toAmount"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "destination": { - "$ref": "#/components/schemas/CryptoRefundDestination" - }, - "amount": { - "description": "The source amount of the refund, it can be in either the original payment currency or the settlement currency.", - "required": ["currency"], - "properties": { - "currency": { - "description": "Currency code.", - "type": "string", - "enum": ["USD", "ETH", "BTC"] - } - } - }, - "toAmount": { - "description": "The destination amount of the refund, it must be in the original payment currency.", - "required": ["amount", "currency"], - "properties": { - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" - }, - "currency": { - "description": "Currency code.", - "type": "string", - "enum": ["USD", "ETH", "BTC"] - } - } - } - } - }, - "IdMerchant": { - "type": "string", - "description": "Unique system generated identifier for the merchant.", - "format": "uuid", - "example": "fc988ed5-c129-4f70-a064-e5beb7eb8e32" - }, - "CryptoPaymentsOptionalAmountMoney": { - "type": "object", - "required": ["currency"], - "properties": { - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" - }, - "currency": { - "description": "Currency code.", - "type": "string", - "enum": ["USD", "ETH", "BTC"] - } - } - }, - "PaymentStatus": { - "type": "string", - "description": "Enumerated status of the payment. `pending` means the payment is waiting to be processed. `confirmed` means the payment has been approved by the bank and the merchant can treat it as successful, but settlement funds are not yet available to the merchant. `paid` means settlement funds have been received and are available to the merchant. `failed` means something went wrong (most commonly that the payment was denied). `action_required` means that additional steps are required to process this payment; refer to `requiredAction` for more details. Terminal states are `paid` and `failed`.", - "enum": ["pending", "confirmed", "paid", "failed", "action_required"] - }, - "CryptoPaymentNetworkFee": { - "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"] - }, - "feePayer": { - "type": "string", - "description": "The party that pays the network fee based on merchant configuration.", - "enum": ["endUser", "merchant"] - } - } - }, - "CryptoPayment": { - "type": "object", - "description": "Status information of the related payment.", - "required": ["id", "type", "merchantId", "amount", "status"], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "type": { - "description": "Type of the payment object.", - "type": "string", - "enum": ["payment", "refund"] - }, - "merchantId": { - "$ref": "#/components/schemas/IdMerchant" - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" - }, - "amount": { - "$ref": "#/components/schemas/CryptoPaymentsOptionalAmountMoney" - }, - "status": { - "$ref": "#/components/schemas/PaymentStatus" - }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "networkFees": { - "$ref": "#/components/schemas/CryptoPaymentNetworkFee" + "destination": { + "$ref": "#/components/schemas/WalletLocation" }, - "paymentIntentId": { - "type": "string", - "format": "uuid", - "example": "6e4d4047-db14-4c09-b238-1215aee50d03" + "amount": { + "$ref": "#/components/schemas/FiatMoney" }, - "settlementAmount": { + "fee": { "$ref": "#/components/schemas/FiatMoneyUsd" }, - "fromAddresses": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Address" - } - } - } - }, - "depositAddress": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "address": { - "type": "string", - "example": "0x97de855690955e0da79ce5c1b6804847e7070c7f" - }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" - } - } - }, - "transactionHash": { + "status": { "type": "string", - "example": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "description": "Status of the deposit. Status `pending` indicates that the deposit is in the process of running; `complete` indicates it finished successfully; `failed` indicates it failed.", + "enum": ["pending", "complete", "failed"] }, "riskEvaluation": { "$ref": "#/components/schemas/RiskEvaluation" - } - } - }, - "AddressBookRecipientMetadata": { - "type": "object", - "properties": { - "nickname": { - "type": "string", - "description": "Nickname related to the address.", - "example": "sample nickname" - }, - "email": { - "$ref": "#/components/schemas/Email" - }, - "bns": { - "type": "string", - "description": "Blockchain Name Service (e.g. ENS) domain for the address.", - "example": "sample.circle" - } - } - }, - "AddressBookRecipient": { - "type": "object", - "required": ["chain", "address", "metadata"], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "address": { - "$ref": "#/components/schemas/Address" - }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" - }, - "metadata": { - "$ref": "#/components/schemas/AddressBookRecipientMetadata" }, - "status": { - "type": "string", - "description": "Status of the address book recipient.", - "enum": ["pending", "inactive", "active", "denied"] + "customerExternalRef": { + "$ref": "#/components/schemas/InstitutionalCustomerExternalRef" }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, "updateDate": { "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "AddressBookRecipientRequest": { - "type": "object", - "required": ["idempotencyKey", "chain", "address", "metadata"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" }, - "chain": { - "$ref": "#/components/schemas/Chain" + "source": { + "$ref": "#/components/schemas/WireDestinationResponse" }, - "address": { - "$ref": "#/components/schemas/Address" + "fromAmount": { + "$ref": "#/components/schemas/FiatMoneyUsd" }, - "addressTag": { - "$ref": "#/components/schemas/AddressTag" + "fees": { + "$ref": "#/components/schemas/FiatMoneyUsd" }, - "metadata": { - "$ref": "#/components/schemas/AddressBookRecipientMetadata" - } - } - }, - "AddressBookRecipientModifyRequest": { - "type": "object", - "properties": { - "metadata": { - "$ref": "#/components/schemas/AddressBookRecipientMetadata" - } - } - }, - "SourceResponse": { - "type": "object", - "description": "The payment source.", - "properties": { - "id": { + "externalRef": { + "description": "The external reference associated with the deposit.", "$ref": "#/components/schemas/Id" }, - "type": { + "trackingRef": { "type": "string", - "description": "Type of the source.", - "enum": ["card", "ach", "wire", "sepa"] + "description": "Tracking reference used for making the deposit.", + "example": "CIR37N5FXJ" } } }, - "RequiredAction": { + "CryptoPaymentsMoney": { "type": "object", - "description": "When the payment status is `action_required`, this object summarizes the required additional steps.", - "required": ["type", "redirectUrl"], + "required": ["amount", "currency"], "properties": { - "type": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", "type": "string", - "description": "The type of action that is required to proceed with the payment. Currently only one type is supported.", - "enum": ["three_d_secure_required"] + "example": "3.14" }, - "redirectUrl": { + "currency": { + "description": "Currency code.", "type": "string", - "description": "The URL to bring the user to in order to complete the payment.", - "example": "https://example.org" + "enum": ["USD", "EUR", "ETH", "BTC"] } } }, - "CancelRefundReversalStatus": { - "type": "string", - "enum": ["pending", "confirmed", "paid", "failed"], - "description": "Enumerated status of the payment. `pending` means the payment is waiting to be processed. `confirmed` means the payment has been approved by the bank and the merchant can treat it as successful, but settlement funds are not yet available to the merchant. `paid` means settlement funds have been received and are available to the merchant. `failed` means something went wrong (most commonly that the payment was denied). Terminal states are `paid` and `failed`." - }, - "PaymentInfoCancel": { + "PaymentMethodBlockchain": { "type": "object", - "description": "Status information of the related cancel. This property is only present on canceled payment or refund items.", - "nullable": true, + "required": ["type", "chain"], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, "type": { "type": "string", - "description": "Type of the payment object.", - "enum": ["cancel"] + "enum": ["blockchain"] }, - "description": { - "description": "Enumerated description of the payment item.", + "chain": { "type": "string", - "nullable": true, - "enum": ["Payment"] - }, - "status": { - "$ref": "#/components/schemas/CancelRefundReversalStatus" + "description": "The blockchain network for the payment.", + "enum": [ + "ALGO", + "ARB", + "AVAX", + "BASE", + "BTC", + "ETH", + "HBAR", + "NOBLE", + "OP", + "POLY", + "SOL", + "SUI", + "XLM" + ] }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "address": { + "type": "string", + "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" } } }, - "PaymentInfoPaymentAndRefund": { + "PaymentIntentFees": { "type": "object", - "description": "Status information of the related payment. This property is only present on refund or cancel items.", + "required": ["type", "amount", "currency"], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, "type": { "type": "string", - "description": "Type of the payment object.", - "enum": ["payment", "refund"] + "enum": ["blockchainLeaseFee", "totalPaymentFees"] }, "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "description": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", "type": "string", - "description": "Enumerated description of the payment item.", - "nullable": true, - "enum": ["Payment"] + "example": "3.14" }, + "currency": { + "description": "Currency code.", + "type": "string", + "enum": ["USD", "BTC", "ETH"] + } + } + }, + "Timeline": { + "type": "object", + "required": ["status", "time"], + "properties": { "status": { - "$ref": "#/components/schemas/PaymentStatus" + "type": "string", + "enum": [ + "created", + "pending", + "complete", + "expired", + "failed", + "refunded" + ] }, - "requiredAction": { - "$ref": "#/components/schemas/RequiredAction" + "context": { + "type": "string", + "enum": ["underpaid", "paid", "overpaid"] }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "reason": { + "type": "string", + "enum": ["requested_by_merchant", "fee_collection_failed"] }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "time": { + "description": "ISO-8601 UTC date/time format.", + "type": "string", + "format": "date-time" } } }, - "Channel": { - "type": "string", - "format": "uuid", - "description": "The channel identifier that can be set for the payment. When not provided, the default channel is used.", - "example": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7" - }, - "FiatPayment": { + "PaymentIntent": { "type": "object", - "description": "Status information of the related payment. This property is only present on refund or cancel items.", - "required": ["id", "type", "merchantId", "amount", "source", "status"], + "required": ["amount", "settlementCurrency", "paymentMethods"], "properties": { "id": { - "$ref": "#/components/schemas/Id" - }, - "type": { - "description": "Type of the payment object.", "type": "string", - "enum": ["payment"] - }, - "merchantId": { - "$ref": "#/components/schemas/IdMerchant" - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" + "description": "Unique system generated identifier for the entity.", + "format": "uuid", + "example": "b8627ae8-732b-4d25-b947-1df8f4007a29" }, "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "$ref": "#/components/schemas/CryptoPaymentsMoney" }, - "fromAmount": { - "$ref": "#/components/schemas/FiatMoney" + "amountPaid": { + "$ref": "#/components/schemas/CryptoPaymentsMoney" }, - "source": { - "$ref": "#/components/schemas/SourceResponse" + "amountRefunded": { + "$ref": "#/components/schemas/CryptoPaymentsMoney" }, - "description": { - "description": "Enumerated description of the payment.", + "settlementCurrency": { + "description": "Desired currency for the payments to settle in.", "type": "string", - "enum": ["Payment"] - }, - "status": { - "$ref": "#/components/schemas/PaymentStatus" - }, - "captured": { - "description": "Determines if a payment has successfully been captured. This property is only present for payments that did not use auto capture.", - "type": "boolean" + "enum": ["USD", "BTC", "ETH"] }, - "captureAmount": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethodBlockchain" + } }, - "captureDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "fees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentIntentFees" + } }, - "requiredAction": { - "$ref": "#/components/schemas/RequiredAction" + "paymentIds": { + "description": "List of associated payments.", + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "example": "69808f36-3e5e-4f37-bf82-ca79e4d70fc1" + } }, - "cancel": { - "$ref": "#/components/schemas/PaymentInfoCancel" + "refundIds": { + "description": "List of associated refunds.", + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "example": "425dca6d-ac79-43b6-b0f9-43fdc51de91b" + } }, - "refunds": { + "timeline": { + "description": "State management timeline.", "type": "array", "items": { - "$ref": "#/components/schemas/PaymentInfoPaymentAndRefund" + "$ref": "#/components/schemas/Timeline" } }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "expiresOn": { + "$ref": "#/components/schemas/UtcTimestamp" }, - "channel": { - "$ref": "#/components/schemas/Channel" + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "merchantWalletId": { + "$ref": "#/components/schemas/MerchantWalletId" } } }, - "FiatCancel": { + "ContinuousPaymentIntent": { "type": "object", - "description": "Status information of the related cancel. This property is only present on canceled payment or refund items.", - "nullable": true, - "required": ["id", "type", "merchantId", "amount", "source", "status"], + "required": [ + "currency", + "settlementCurrency", + "paymentMethods", + "type" + ], "properties": { "id": { "$ref": "#/components/schemas/Id" }, - "type": { + "currency": { + "description": "Desired currency of the payment.", "type": "string", - "description": "Type of the payment object.", - "enum": ["cancel"] - }, - "merchantId": { - "$ref": "#/components/schemas/IdMerchant" - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" + "enum": ["USD", "BTC", "ETH"] }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "amountPaid": { + "$ref": "#/components/schemas/CryptoPaymentsMoney" }, - "source": { - "$ref": "#/components/schemas/SourceResponse" + "amountRefunded": { + "$ref": "#/components/schemas/CryptoPaymentsMoney" }, - "description": { - "description": "Enumerated description of the payment.", + "settlementCurrency": { + "description": "Desired currency for the payments to settle in.", "type": "string", - "enum": ["Payment"] - }, - "status": { - "$ref": "#/components/schemas/CancelRefundReversalStatus" + "enum": ["USD", "BTC", "ETH"] }, - "originalPayment": { - "$ref": "#/components/schemas/PaymentInfoPaymentAndRefund" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethodBlockchain" + } }, "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentIntentFees" + } }, - "channel": { - "$ref": "#/components/schemas/Channel" + "timeline": { + "description": "State management timeline.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Timeline" + } }, - "createDate": { + "updateDate": { "$ref": "#/components/schemas/UtcTimestamp" }, - "updateDate": { + "createDate": { "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "FiatRefund": { - "type": "object", - "required": ["id", "type", "merchantId", "amount", "source", "status"], - "properties": { - "id": { - "$ref": "#/components/schemas/Id" }, "type": { - "description": "Type of the payment object.", "type": "string", - "enum": ["refund"] - }, - "merchantId": { - "$ref": "#/components/schemas/IdMerchant" + "enum": ["continuous"] }, "merchantWalletId": { "$ref": "#/components/schemas/MerchantWalletId" + } + } + }, + "PaymentIntentCreationRequest": { + "type": "object", + "required": [ + "idempotencyKey", + "amount", + "settlementCurrency", + "paymentMethods" + ], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "source": { - "$ref": "#/components/schemas/SourceResponse" + "$ref": "#/components/schemas/CryptoPaymentsMoney" }, - "description": { - "description": "Enumerated description of the payment.", + "settlementCurrency": { + "description": "Desired currency for the payments to settle in. This must match the currency used for the payment method.", "type": "string", - "enum": ["Payment"] - }, - "status": { - "$ref": "#/components/schemas/CancelRefundReversalStatus" - }, - "originalPayment": { - "$ref": "#/components/schemas/PaymentInfoPaymentAndRefund" - }, - "cancel": { - "$ref": "#/components/schemas/PaymentInfoCancel" - }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "enum": ["USD", "EUR", "BTC", "ETH"] }, - "channel": { - "$ref": "#/components/schemas/Channel" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethodBlockchain" + } }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "merchantWalletId": { + "$ref": "#/components/schemas/MerchantWalletId" + } + } + }, + "PaymentMethodBlockchainRequest": { + "type": "object", + "required": ["type", "chain"], + "properties": { + "type": { + "type": "string", + "enum": ["blockchain"] }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "chain": { + "$ref": "#/components/schemas/Chain" } } }, - "MetadataPayment": { + "ContinuousPaymentIntentCreationRequest": { "type": "object", - "required": ["email", "sessionId", "ipAddress"], + "required": [ + "idempotencyKey", + "currency", + "settlementCurrency", + "paymentMethods", + "merchantWalletId" + ], "properties": { - "email": { - "$ref": "#/components/schemas/Email" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "phoneNumber": { - "$ref": "#/components/schemas/PhoneNumber" + "currency": { + "description": "Desired currency for the payment", + "type": "string", + "enum": ["USD", "EUR", "BTC", "ETH"] + }, + "settlementCurrency": { + "description": "Desired currency for the payments to settle in. This must match the currency used for the payment.", + "type": "string", + "enum": ["USD", "EUR", "BTC", "ETH"] }, - "sessionId": { - "$ref": "#/components/schemas/SessionId" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethodBlockchainRequest" + } }, - "ipAddress": { - "$ref": "#/components/schemas/IpAddress" + "merchantWalletId": { + "$ref": "#/components/schemas/MerchantWalletId" + }, + "type": { + "type": "string", + "enum": ["continuous"] } } }, - "Source": { + "CryptoRefundDestination": { "type": "object", + "description": "The destination of a crypto refund.", + "required": ["address", "chain"], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "type": { + "address": { "type": "string", - "description": "Type of the source.", - "enum": ["card"] + "description": "The blockchain address.", + "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" + }, + "addressTag": { + "$ref": "#/components/schemas/AddressTag" + }, + "chain": { + "$ref": "#/components/schemas/Chain" } } }, - "PaymentCreationRequest": { + "CryptoRefundCreationRequest": { "type": "object", - "required": [ - "idempotencyKey", - "amount", - "verification", - "source", - "metadata" - ], + "required": ["idempotencyKey", "destination", "amount", "toAmount"], "properties": { "idempotencyKey": { "$ref": "#/components/schemas/IdempotencyKey" }, - "keyId": { - "$ref": "#/components/schemas/IdKey" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataPayment" + "destination": { + "$ref": "#/components/schemas/CryptoRefundDestination" }, "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "autoCapture": { - "type": "boolean", - "description": "Triggers the automatic capture of the full payment amount. If set to false the payment will only be authorized but not captured.", - "default": true, - "example": true - }, - "verification": { - "type": "string", - "description": "Indicates the verification method for this payment.", - "enum": ["none", "cvv", "three_d_secure"] - }, - "verificationSuccessUrl": { - "type": "string", - "description": "The URL to redirect users to after successful 3DS authentication.", - "format": "url", - "example": "https://www.example.com/3ds/verificationsuccessful" - }, - "verificationFailureUrl": { - "type": "string", - "description": "The URL to redirect users to after failed 3DS authentication.", - "format": "url", - "example": "https://www.example.com/3ds/verificationfailure" - }, - "source": { - "$ref": "#/components/schemas/Source" + "type": "object", + "description": "The source amount of the refund, it can be in either the original payment currency or the settlement currency.", + "required": ["currency"], + "properties": { + "currency": { + "description": "Currency code.", + "type": "string", + "enum": ["USD", "ETH", "BTC"] + } + } }, - "description": { + "toAmount": { + "type": "object", + "description": "The destination amount of the refund, it must be in the original payment currency.", + "required": ["amount", "currency"], + "properties": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", + "type": "string", + "example": "3.14" + }, + "currency": { + "description": "Currency code.", + "type": "string", + "enum": ["USD", "ETH", "BTC"] + } + } + } + } + }, + "IdMerchant": { + "type": "string", + "description": "Unique system generated identifier for the merchant.", + "format": "uuid", + "example": "fc988ed5-c129-4f70-a064-e5beb7eb8e32" + }, + "CryptoPaymentsOptionalAmountMoney": { + "type": "object", + "required": ["currency"], + "properties": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", "type": "string", - "description": "Description of the payment with length restriction of 240 characters.", - "example": "Payment" + "example": "3.14" }, - "encryptedData": { + "currency": { + "description": "Currency code.", "type": "string", - "format": "byte", - "description": "PGP encrypted base64 encoded string. Contains CVV.\n* **CVV (Card Verification Number)**: Three or four digit security code. Only required if `verification` is `cvv`.\n", - "example": "UHVibGljS2V5QmFzZTY0RW5jb2RlZA==" - }, - "channel": { - "$ref": "#/components/schemas/Channel" + "enum": ["USD", "ETH", "BTC"] } } }, - "ThreeDsResult": { - "type": "string", - "description": "Enumerated status of the check. `pass` indicates successful 3DS authentication. `fail` indicates failed 3DS authentication.", - "enum": ["pass", "fail"] - }, - "Eci": { + "PaymentStatus": { "type": "string", - "description": "ECI (electronic commerce indicator) value returned by Directory Servers (namely Visa, MasterCard, JCB, and American Express) indicating the outcome of authentication attempted on transactions enforced by 3DS.", - "enum": ["00", "01", "02", "05", "06", "07"] + "description": "Enumerated status of the payment. `pending` means the payment is waiting to be processed. `confirmed` means the payment has been approved by the bank and the merchant can treat it as successful, but settlement funds are not yet available to the merchant. `paid` means settlement funds have been received and are available to the merchant. `failed` means something went wrong (most commonly that the payment was denied). `action_required` means that additional steps are required to process this payment; refer to `requiredAction` for more details. Terminal states are `paid` and `failed`.", + "enum": ["pending", "confirmed", "paid", "failed", "action_required"] }, - "PaymentVerificationResponse": { + "CryptoPaymentNetworkFee": { "type": "object", - "description": "Indicates the status of the payment verification. This property will be present once the payment is confirmed.", - "required": ["avs", "cvv"], + "required": ["amount", "currency"], "properties": { - "avs": { - "$ref": "#/components/schemas/AvsResults" - }, - "cvv": { - "$ref": "#/components/schemas/CvvResults" + "amount": { + "type": "string", + "description": "Magnitude of the amount, in units of the currency, with a `.`.", + "example": "3.14" }, - "threeDSecure": { - "$ref": "#/components/schemas/ThreeDsResult" + "currency": { + "type": "string", + "description": "Currency code for the amount.", + "enum": ["USD", "EUR", "BTC", "ETH"] }, - "eci": { - "$ref": "#/components/schemas/Eci" + "feePayer": { + "type": "string", + "description": "The party that pays the network fee based on merchant configuration.", + "enum": ["endUser", "merchant"] } } }, - "PaymentErrorCode": { - "type": "string", - "description": "Indicates the failure reason of a payment. Only present for payments in failed state. Possible values are [`payment_failed`, `payment_fraud_detected`, `payment_denied`, `payment_not_supported_by_issuer`, `payment_not_funded`, `payment_unprocessable`, `payment_stopped_by_issuer`, `payment_canceled`, `payment_returned`, `payment_failed_balance_check`, `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`, `channel_invalid`, `unauthorized_transaction`, `bank_account_ineligible`, `bank_transaction_error`, `invalid_account_number`, `invalid_wire_rtn`, `invalid_ach_rtn`, `vendor_inactive`]'", - "nullable": true, - "enum": [ - "payment_failed", - "payment_fraud_detected", - "payment_denied", - "payment_not_supported_by_issuer", - "payment_not_funded", - "payment_unprocessable", - "payment_stopped_by_issuer", - "payment_canceled", - "payment_returned", - "payment_failed_balance_check", - "card_failed", - "card_invalid", - "card_address_mismatch", - "card_zip_mismatch", - "card_cvv_invalid", - "card_expired", - "card_limit_violated", - "card_not_honored", - "card_cvv_required", - "card_restricted,", - "card_account_ineligible", - "card_network_unsupported", - "channel_invalid", - "unauthorized_transaction", - "bank_account_ineligible", - "bank_transaction_error", - "invalid_account_number", - "invalid_wire_rtn", - "invalid_ach_rtn", - "ref_id_invalid", - "account_name_mismatch", - "account_number_mismatch", - "account_ineligible", - "wallet_address_mismatch", - "customer_name_mismatch", - "institution_name_mismatch", - "vendor_inactive" - ] - }, - "DetailedPayment": { + "CryptoPayment": { "type": "object", - "required": ["id", "type", "merchantId", "amount", "source", "status"], + "description": "Status information of the related payment.", + "required": ["id", "type", "merchantId", "amount", "status"], "properties": { "id": { "$ref": "#/components/schemas/Id" @@ -9532,7 +7275,7 @@ "type": { "description": "Type of the payment object.", "type": "string", - "enum": ["payment"] + "enum": ["payment", "refund"] }, "merchantId": { "$ref": "#/components/schemas/IdMerchant" @@ -9541,65 +7284,116 @@ "$ref": "#/components/schemas/MerchantWalletId" }, "amount": { + "$ref": "#/components/schemas/CryptoPaymentsOptionalAmountMoney" + }, + "status": { + "$ref": "#/components/schemas/PaymentStatus" + }, + "fees": { "$ref": "#/components/schemas/FiatMoneyUsd" }, - "source": { - "$ref": "#/components/schemas/SourceResponse" + "networkFees": { + "$ref": "#/components/schemas/CryptoPaymentNetworkFee" }, - "description": { + "paymentIntentId": { "type": "string", - "description": "Enumerated description of the payment.", - "enum": ["Payment"] + "format": "uuid", + "example": "6e4d4047-db14-4c09-b238-1215aee50d03" }, - "status": { - "$ref": "#/components/schemas/PaymentStatus" + "settlementAmount": { + "$ref": "#/components/schemas/FiatMoneyUsd" }, - "captured": { - "type": "boolean", - "description": "Determines if a payment has successfully been captured. This property is only present for payments that did not use auto capture." + "fromAddresses": { + "type": "object", + "properties": { + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Address" + } + } + } }, - "captureAmount": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "depositAddress": { + "type": "object", + "properties": { + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "address": { + "type": "string", + "example": "0x97de855690955e0da79ce5c1b6804847e7070c7f" + }, + "addressTag": { + "$ref": "#/components/schemas/AddressTag" + } + } }, - "captureDate": { + "transactionHash": { + "type": "string", + "example": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906" + }, + "createDate": { "$ref": "#/components/schemas/UtcTimestamp" }, - "requiredAction": { - "$ref": "#/components/schemas/RequiredAction" + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" }, - "verification": { - "$ref": "#/components/schemas/PaymentVerificationResponse" + "riskEvaluation": { + "$ref": "#/components/schemas/RiskEvaluation" + } + } + }, + "Email": { + "type": "string", + "description": "Email of the user.", + "maxLength": 1024, + "example": "satoshi@circle.com" + }, + "AddressBookRecipientMetadata": { + "type": "object", + "properties": { + "nickname": { + "type": "string", + "description": "Nickname related to the address.", + "example": "sample nickname" }, - "cancel": { - "$ref": "#/components/schemas/FiatCancel" + "email": { + "$ref": "#/components/schemas/Email" }, - "refunds": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FiatRefund" - } + "bns": { + "type": "string", + "description": "Blockchain Name Service (e.g. ENS) domain for the address.", + "example": "sample.circle" + } + } + }, + "AddressBookRecipient": { + "type": "object", + "required": ["chain", "address", "metadata"], + "properties": { + "id": { + "$ref": "#/components/schemas/Id" }, - "fees": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "chain": { + "$ref": "#/components/schemas/Chain" }, - "trackingRef": { - "description": "Payment tracking reference. Will be present once known.", - "type": "string", - "nullable": true, - "example": "24910599141085313498894" + "address": { + "$ref": "#/components/schemas/Address" }, - "errorCode": { - "$ref": "#/components/schemas/PaymentErrorCode", - "nullable": true + "addressTag": { + "$ref": "#/components/schemas/AddressTag" }, "metadata": { - "$ref": "#/components/schemas/MetadataPhoneEmail" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" + "$ref": "#/components/schemas/AddressBookRecipientMetadata" }, - "channel": { - "$ref": "#/components/schemas/Channel" + "status": { + "type": "string", + "description": "Status of the address book recipient.", + "enum": ["pending", "inactive", "active", "denied"] }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" @@ -9609,121 +7403,164 @@ } } }, - "MetadataCryptoPayment": { + "AddressBookRecipientRequest": { "type": "object", - "required": [ - "type", - "metaTxNonce", - "signatureValidAfter", - "signatureValidBefore", - "rawSignature" - ], + "required": ["idempotencyKey", "chain", "address", "metadata"], "properties": { - "type": { - "type": "string", - "description": "The protocol type. so far we only support \"TransferWithAuthorization\". find more details in EIP-3009", - "enum": ["TransferWithAuthorization"], - "example": "TransferWithAuthorization" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "metaTxNonce": { + "chain": { "type": "string", - "description": "meta transaction nonce", - "example": "0xfdb476566b75311fdd14444e6a77630c36e653a3e255adcaa7c34f3babc1de76" + "description": "The blockchain network to use for the address.", + "enum": [ + "ALGO", + "APTOS", + "ARB", + "AVAX", + "BASE", + "CELO", + "ETH", + "HBAR", + "NEAR", + "NOBLE", + "OP", + "PAH", + "POLY", + "SOL", + "SUI", + "UNI", + "XLM", + "XRP", + "ZKS" + ] }, - "signatureValidAfter": { - "type": "string", - "description": "This comes from the /presign response", - "example": "1675104393" + "address": { + "$ref": "#/components/schemas/Address" }, - "signatureValidBefore": { - "type": "string", - "description": "This comes from the /presign response", - "example": "1675107967" + "addressTag": { + "$ref": "#/components/schemas/AddressTag" }, - "rawSignature": { - "type": "string", - "description": "Raw signature coming from the wallet response", - "example": "0xcff7ef7a24b88d83fa3d6e81b41c9cef19cc0119c085a6ef98cb1b6bc9436a9f18dcb2d46b9cb4d31a7031466b450bbe1e6c0230c5503c7a68e04055b4be0cbc1b" + "metadata": { + "$ref": "#/components/schemas/AddressBookRecipientMetadata" } } }, - "CryptoPaymentSource": { + "AddressBookRecipientModifyRequest": { "type": "object", - "required": ["address", "type"], "properties": { - "address": { - "type": "string", - "description": "The source address", - "example": "0xdB055877e6c13b6A6B25aBcAA29B393777dD0a73" + "metadata": { + "$ref": "#/components/schemas/AddressBookRecipientMetadata" + } + } + }, + "SourceResponse": { + "type": "object", + "description": "The payment source.", + "properties": { + "id": { + "$ref": "#/components/schemas/Id" }, "type": { "type": "string", - "description": "The source type", - "enum": ["blockchain"] + "description": "Type of the source.", + "enum": ["card", "ach", "wire", "sepa"] } } }, - "CryptoPaymentDestination": { + "RequiredAction": { "type": "object", - "required": ["address", "chain"], + "description": "When the payment status is `action_required`, this object summarizes the required additional steps.", + "required": ["type", "redirectUrl"], "properties": { - "address": { + "type": { "type": "string", - "description": "The destination address", - "example": "0xda1ab716f7f7b3cb036a7fd74e5ca852126834c1" + "description": "The type of action that is required to proceed with the payment. Currently only one type is supported.", + "enum": ["three_d_secure_required"] }, - "chain": { + "redirectUrl": { "type": "string", - "enum": ["ETH"] + "description": "The URL to bring the user to in order to complete the payment.", + "example": "https://example.org" } } }, - "CryptoPaymentCreationRequest": { + "CancelRefundReversalStatus": { + "type": "string", + "enum": ["pending", "confirmed", "paid", "failed"], + "description": "Enumerated status of the payment. `pending` means the payment is waiting to be processed. `confirmed` means the payment has been approved by the bank and the merchant can treat it as successful, but settlement funds are not yet available to the merchant. `paid` means settlement funds have been received and are available to the merchant. `failed` means something went wrong (most commonly that the payment was denied). Terminal states are `paid` and `failed`." + }, + "PaymentInfoCancel": { "type": "object", - "required": [ - "idempotencyKey", - "paymentIntentId", - "amount", - "destination", - "source", - "protocolMetadata" - ], + "description": "Status information of the related cancel. This property is only present on canceled payment or refund items.", + "nullable": true, "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "id": { + "$ref": "#/components/schemas/Id" }, - "paymentIntentId": { + "type": { "type": "string", - "description": "Payment intent uuid which is generated by the create payment intent call", - "example": "4e9fa5b1-3964-4f02-a7ba-811cc5d94be1" + "description": "Type of the payment object.", + "enum": ["cancel"] }, - "protocolMetadata": { - "$ref": "#/components/schemas/MetadataCryptoPayment" + "description": { + "description": "Enumerated description of the payment item.", + "type": "string", + "nullable": true, + "enum": ["Payment"] }, - "amount": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" + "status": { + "$ref": "#/components/schemas/CancelRefundReversalStatus" }, - "source": { - "$ref": "#/components/schemas/CryptoPaymentSource" + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + } + } + }, + "PaymentInfoPaymentAndRefund": { + "type": "object", + "description": "Status information of the related payment. This property is only present on refund or cancel items.", + "properties": { + "id": { + "$ref": "#/components/schemas/Id" }, - "destination": { - "$ref": "#/components/schemas/CryptoPaymentDestination" + "type": { + "type": "string", + "description": "Type of the payment object.", + "enum": ["payment", "refund"] }, - "quoteId": { + "amount": { + "$ref": "#/components/schemas/FiatMoneyUsd" + }, + "description": { "type": "string", - "format": "uuid", - "description": "Network fee quote uuid which is returned from the /presign response. Only required when end user pays for gas fee", - "example": "c6ac001e-9812-4bc1-8dc3-1549b5adaa23" + "description": "Enumerated description of the payment item.", + "nullable": true, + "enum": ["Payment"] + }, + "status": { + "$ref": "#/components/schemas/PaymentStatus" + }, + "requiredAction": { + "$ref": "#/components/schemas/RequiredAction" + }, + "fees": { + "$ref": "#/components/schemas/FiatMoneyUsd" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" } } }, - "ExternalRef": { + "Channel": { "type": "string", - "description": "External network identifier which will be present once provided from the applicable network. \n\nExamples:\n* **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.\n", - "example": "YYYYMMDDXXXXXXXX012345" + "format": "uuid", + "description": "The channel identifier that can be set for the payment. When not provided, the default channel is used.", + "example": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7" }, - "FiatPaymentPolymorphic": { + "FiatPayment": { "type": "object", + "description": "Status information of the related payment. This property is only present on refund or cancel items.", "required": ["id", "type", "merchantId", "amount", "source", "status"], "properties": { "id": { @@ -9732,7 +7569,7 @@ "type": { "description": "Type of the payment object.", "type": "string", - "enum": ["payment", "refund", "cancel"] + "enum": ["payment"] }, "merchantId": { "$ref": "#/components/schemas/IdMerchant" @@ -9757,109 +7594,54 @@ "status": { "$ref": "#/components/schemas/PaymentStatus" }, - "requiredAction": { - "$ref": "#/components/schemas/RequiredAction" - }, - "verification": { - "$ref": "#/components/schemas/PaymentVerificationResponse" - }, - "originalPayment": { - "$ref": "#/components/schemas/FiatPayment" - }, - "cancel": { - "$ref": "#/components/schemas/FiatCancel" - }, - "refunds": { - "type": "array", - "nullable": true, - "items": { - "$ref": "#/components/schemas/FiatRefund" - } + "captured": { + "description": "Determines if a payment has successfully been captured. This property is only present for payments that did not use auto capture.", + "type": "boolean" }, - "fees": { + "captureAmount": { "$ref": "#/components/schemas/FiatMoneyUsd" }, - "trackingRef": { - "description": "Payment tracking reference. Will be present once known.", - "type": "string", - "nullable": true, - "example": "24910599141085313498894" - }, - "externalRef": { - "$ref": "#/components/schemas/ExternalRef" - }, - "errorCode": { - "$ref": "#/components/schemas/PaymentErrorCode" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataPhoneEmail" - }, - "channel": { - "$ref": "#/components/schemas/Channel" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - }, - "updateDate": { + "captureDate": { "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "CaptureCreationRequest": { - "type": "object", - "required": ["idempotencyKey"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - } - } - }, - "ReversalReason": { - "type": "string", - "description": "Enumerated reason for a returned payment. Providing this reason in the request is recommended (to improve risk evaluation) but not required.", - "enum": [ - "duplicate", - "fraudulent", - "requested_by_customer", - "bank_transaction_error", - "invalid_account_number", - "insufficient_funds", - "payment_stopped_by_issuer", - "payment_returned", - "bank_account_ineligible", - "invalid_ach_rtn", - "unauthorized_transaction", - "payment_failed" - ] - }, - "CancelCreationRequest": { - "type": "object", - "required": ["idempotencyKey"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "requiredAction": { + "$ref": "#/components/schemas/RequiredAction" }, - "reason": { - "$ref": "#/components/schemas/ReversalReason" + "cancel": { + "$ref": "#/components/schemas/PaymentInfoCancel" + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentInfoPaymentAndRefund" + } + }, + "fees": { + "$ref": "#/components/schemas/FiatMoneyUsd" + }, + "channel": { + "$ref": "#/components/schemas/Channel" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" } } }, - "DetailedCancel": { + "FiatCancel": { "type": "object", + "description": "Status information of the related cancel. This property is only present on canceled payment or refund items.", + "nullable": true, "required": ["id", "type", "merchantId", "amount", "source", "status"], "properties": { "id": { "$ref": "#/components/schemas/Id" }, "type": { - "description": "Type of the payment object.", "type": "string", + "description": "Type of the payment object.", "enum": ["cancel"] }, "merchantId": { @@ -9883,30 +7665,13 @@ "$ref": "#/components/schemas/CancelRefundReversalStatus" }, "originalPayment": { - "$ref": "#/components/schemas/FiatPayment" + "$ref": "#/components/schemas/PaymentInfoPaymentAndRefund" }, "fees": { "$ref": "#/components/schemas/FiatMoneyUsd" }, - "trackingRef": { - "description": "Payment tracking reference. Will be present once known.", - "type": "string", - "nullable": true, - "example": "24910599141085313498894" - }, - "errorCode": { - "$ref": "#/components/schemas/PaymentErrorCode" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataPhoneEmail" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" - }, - "refund": { - "description": "If the cancel was made after a cutoff time period, it will be processed as a refund. This flag indicates that the cancel was processed as a refund'", - "type": "boolean", - "default": false + "channel": { + "$ref": "#/components/schemas/Channel" }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" @@ -9916,22 +7681,7 @@ } } }, - "RefundCreationRequest": { - "type": "object", - "required": ["idempotencyKey", "amount"], - "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" - }, - "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "reason": { - "$ref": "#/components/schemas/ReversalReason" - } - } - }, - "DetailedRefund": { + "FiatRefund": { "type": "object", "required": ["id", "type", "merchantId", "amount", "source", "status"], "properties": { @@ -9964,28 +7714,16 @@ "$ref": "#/components/schemas/CancelRefundReversalStatus" }, "originalPayment": { - "$ref": "#/components/schemas/FiatPayment" + "$ref": "#/components/schemas/PaymentInfoPaymentAndRefund" }, "cancel": { - "$ref": "#/components/schemas/FiatCancel" + "$ref": "#/components/schemas/PaymentInfoCancel" }, "fees": { "$ref": "#/components/schemas/FiatMoneyUsd" }, - "trackingRef": { - "description": "Payment tracking reference. Will be present once known.", - "type": "string", - "nullable": true, - "example": "24910599141085313498894" - }, - "errorCode": { - "$ref": "#/components/schemas/PaymentErrorCode" - }, - "metadata": { - "$ref": "#/components/schemas/MetadataPhoneEmail" - }, - "riskEvaluation": { - "$ref": "#/components/schemas/RiskEvaluation" + "channel": { + "$ref": "#/components/schemas/Channel" }, "createDate": { "$ref": "#/components/schemas/UtcTimestamp" @@ -9995,216 +7733,196 @@ } } }, - "PresignDomain": { + "AvsResults": { + "type": "string", + "description": "Status of the AVS check. Raw AVS response, expressed as an upper-case letter. `not_requested` indicates check was not made. `pending` is pending/processing.", + "example": "D" + }, + "CvvResults": { + "description": "Enumerated status of the check. `not_requested` indicates check was not made. `pass` indicates value is correct. `fail` indicates value is incorrect. `unavailable` indicates card issuer did not do the provided check. `pending` indicates check is pending/processing.", + "type": "string", + "enum": ["not_requested", "pass", "fail", "unavailable", "pending"] + }, + "ThreeDsResult": { + "type": "string", + "description": "Enumerated status of the check. `pass` indicates successful 3DS authentication. `fail` indicates failed 3DS authentication.", + "enum": ["pass", "fail"] + }, + "Eci": { + "type": "string", + "description": "ECI (electronic commerce indicator) value returned by Directory Servers (namely Visa, MasterCard, JCB, and American Express) indicating the outcome of authentication attempted on transactions enforced by 3DS.", + "enum": ["00", "01", "02", "05", "06", "07"] + }, + "PaymentVerificationResponse": { "type": "object", - "required": ["name", "verifyingContract", "version", "chainId"], + "description": "Indicates the status of the payment verification. This property will be present once the payment is confirmed.", + "required": ["avs", "cvv"], "properties": { - "name": { - "type": "string", - "description": "User readable name of signing domain", - "example": "USD Coin" + "avs": { + "$ref": "#/components/schemas/AvsResults" }, - "verifyingContract": { - "type": "string", - "description": "The address of the contract that will verify the signature", - "example": "0x07865c6e87b9f70255377e024ace6630c1eaa37f" + "cvv": { + "$ref": "#/components/schemas/CvvResults" }, - "version": { - "type": "string", - "description": "The current major version of the signing domain. Signatures from different versions are not compatible", - "example": "2" + "threeDSecure": { + "$ref": "#/components/schemas/ThreeDsResult" }, - "chainId": { - "type": "integer", - "description": "chain id from https://chainid.network/", - "example": 5 + "eci": { + "$ref": "#/components/schemas/Eci" } } }, - "PresignMessage": { + "ExternalRef": { + "type": "string", + "description": "External network identifier which will be present once provided from the applicable network. \n\nExamples:\n* **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.\n", + "example": "YYYYMMDDXXXXXXXX012345" + }, + "PaymentErrorCode": { + "type": "string", + "description": "Indicates the failure reason of a payment. Only present for payments in failed state. Possible values are [`payment_failed`, `payment_fraud_detected`, `payment_denied`, `payment_not_supported_by_issuer`, `payment_not_funded`, `payment_unprocessable`, `payment_stopped_by_issuer`, `payment_canceled`, `payment_returned`, `payment_failed_balance_check`, `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`, `channel_invalid`, `unauthorized_transaction`, `bank_account_ineligible`, `bank_transaction_error`, `invalid_account_number`, `invalid_wire_rtn`, `invalid_ach_rtn`, `vendor_inactive`]'", + "nullable": true, + "enum": [ + "payment_failed", + "payment_fraud_detected", + "payment_denied", + "payment_not_supported_by_issuer", + "payment_not_funded", + "payment_unprocessable", + "payment_stopped_by_issuer", + "payment_canceled", + "payment_returned", + "payment_failed_balance_check", + "card_failed", + "card_invalid", + "card_address_mismatch", + "card_zip_mismatch", + "card_cvv_invalid", + "card_expired", + "card_limit_violated", + "card_not_honored", + "card_cvv_required", + "card_restricted,", + "card_account_ineligible", + "card_network_unsupported", + "channel_invalid", + "unauthorized_transaction", + "bank_account_ineligible", + "bank_transaction_error", + "invalid_account_number", + "invalid_wire_rtn", + "invalid_ach_rtn", + "ref_id_invalid", + "account_name_mismatch", + "account_number_mismatch", + "account_ineligible", + "wallet_address_mismatch", + "customer_name_mismatch", + "institution_name_mismatch", + "vendor_inactive" + ] + }, + "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" + }, + "MetadataPhoneEmail": { "type": "object", - "required": [ - "from", - "to", - "value", - "validAfter", - "validBefore", - "nonce" - ], + "required": ["email"], "properties": { - "from": { - "type": "string", - "description": "A blockchain address representing payer's address", - "example": "0x8381470ED67C3802402dbbFa0058E8871F017A6F" - }, - "to": { - "type": "string", - "description": "A blockchain address representing payee's address", - "example": "0xdB055877e6c13b6A6B25aBcAA29B393777dD0a73" - }, - "value": { - "type": "string", - "description": "Amount to be transferred", - "example": "5003456" - }, - "validAfter": { - "type": "integer", - "format": "int64", - "description": "the timestamp after which this is valid (unix time)", - "example": 1675317371 - }, - "validBefore": { - "type": "integer", - "format": "int64", - "description": "the timestamp before which this is valid (unix time)", - "example": 1675107967 + "email": { + "$ref": "#/components/schemas/Email" }, - "nonce": { - "type": "string", - "description": "unique nonce", - "example": "0x4f716a578b96592599c3ca7b2a46453df87511d4809f608cec982d6e83632604" + "phoneNumber": { + "$ref": "#/components/schemas/PhoneNumber" } } }, - "NetworkFeeQuote": { + "FiatPaymentPolymorphic": { "type": "object", - "required": ["quoteId", "amount", "expiresAt"], + "required": ["id", "type", "merchantId", "amount", "source", "status"], "properties": { - "quoteId": { + "id": { + "$ref": "#/components/schemas/Id" + }, + "type": { + "description": "Type of the payment object.", "type": "string", - "format": "uuid", - "description": "UUID of network fee quote", - "example": "5d0bb4e7-bd83-44dd-b8f5-53ddd5f35a3a" + "enum": ["payment", "refund", "cancel"] + }, + "merchantId": { + "$ref": "#/components/schemas/IdMerchant" + }, + "merchantWalletId": { + "$ref": "#/components/schemas/MerchantWalletId" }, "amount": { - "$ref": "#/components/schemas/CryptoPaymentsMoney" + "$ref": "#/components/schemas/FiatMoneyUsd" }, - "expiresAt": { - "description": "The timestamp when the quote will expire at, in ISO-8601 UTC date/time format.", - "type": "string", - "example": "2023-02-02T06:01:21.152737680Z" - } - } - }, - "PresignMessageTypesItems": { - "type": "object", - "required": ["name", "type"], - "properties": { - "name": { - "description": "The name of the field", - "type": "string", - "example": "name" + "fromAmount": { + "$ref": "#/components/schemas/FiatMoney" }, - "type": { - "description": "The type of the field", + "source": { + "$ref": "#/components/schemas/SourceResponse" + }, + "description": { + "description": "Enumerated description of the payment.", "type": "string", - "example": "string" - } - } - }, - "PresignMessageTypes": { - "type": "object", - "description": "The data schema of the message", - "properties": { - "EIP712Domain": { - "description": "Data schema of the domain field in typedData. It's a list of (name, type) pair", - "type": "array", - "items": { - "$ref": "#/components/schemas/PresignMessageTypesItems" - }, - "example": [ - { - "name": "name", - "type": "string" - }, - { - "name": "version", - "type": "string" - }, - { - "name": "chainId", - "type": "uint256" - }, - { - "name": "verifyingContract", - "type": "address" - } - ] + "enum": ["Payment"] }, - "TransferWithAuthorization": { - "description": "Data schema of the message in typedData. It's a list of (name, type) pair", + "status": { + "$ref": "#/components/schemas/PaymentStatus" + }, + "requiredAction": { + "$ref": "#/components/schemas/RequiredAction" + }, + "verification": { + "$ref": "#/components/schemas/PaymentVerificationResponse" + }, + "originalPayment": { + "$ref": "#/components/schemas/FiatPayment" + }, + "cancel": { + "$ref": "#/components/schemas/FiatCancel" + }, + "refunds": { "type": "array", + "nullable": true, "items": { - "$ref": "#/components/schemas/PresignMessageTypesItems" - }, - "example": [ - { - "name": "from", - "type": "address" - }, - { - "name": "to", - "type": "address" - }, - { - "name": "validAfter", - "type": "uint256" - }, - { - "name": "validBefore", - "type": "uint256" - }, - { - "name": "nonce", - "type": "byte32" - } - ] - } - } - }, - "PresignResponse": { - "type": "object", - "description": "Response of the GET /presign endpoint", - "required": ["typedData"], - "properties": { - "typedData": { - "type": "object", - "description": "The typed data", - "required": [ - "domain", - "message", - "totalAmount", - "feeChargeModel", - "types", - "primaryType" - ], - "properties": { - "domain": { - "$ref": "#/components/schemas/PresignDomain" - }, - "message": { - "$ref": "#/components/schemas/PresignMessage" - }, - "totalAmount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "feeChargeModel": { - "type": "string", - "description": "Who pays for network fee. Can only be endUser or merchant. If it's the endUser, totalAmount includes the network fee and networkFeeQuote isn't null; If it's the merchant, totalAmount doesn't include network fee and networkFeeQuote is null.", - "enum": ["endUser", "merchant"] - }, - "networkFeeQuote": { - "$ref": "#/components/schemas/NetworkFeeQuote" - }, - "types": { - "$ref": "#/components/schemas/PresignMessageTypes" - }, - "primaryType": { - "type": "string", - "description": "Type of the message", - "enum": ["TransferWithAuthorization", "EIP712Domain"] - } + "$ref": "#/components/schemas/FiatRefund" } + }, + "fees": { + "$ref": "#/components/schemas/FiatMoneyUsd" + }, + "trackingRef": { + "description": "Payment tracking reference. Will be present once known.", + "type": "string", + "nullable": true, + "example": "24910599141085313498894" + }, + "externalRef": { + "$ref": "#/components/schemas/ExternalRef" + }, + "errorCode": { + "$ref": "#/components/schemas/PaymentErrorCode" + }, + "metadata": { + "$ref": "#/components/schemas/MetadataPhoneEmail" + }, + "channel": { + "$ref": "#/components/schemas/Channel" + }, + "riskEvaluation": { + "$ref": "#/components/schemas/RiskEvaluation" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" } } }, @@ -10322,6 +8040,112 @@ } } }, + "ListBusinessPayout": { + "title": "ListBusinessPayoutsResponse", + "properties": { + "data": { + "type": "array", + "items": { + "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/BankDestination" + }, + "amount": { + "$ref": "#/components/schemas/FiatMoney" + }, + "toAmount": { + "$ref": "#/components/schemas/FiatPayoutToMoney" + }, + "fees": { + "$ref": "#/components/schemas/FiatMoneyUsd" + }, + "status": { + "$ref": "#/components/schemas/PayoutStatus" + }, + "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" + } + } + } + } + } + }, + "BusinessDestinationRequest": { + "type": "object", + "description": "The destination bank account.", + "required": ["type", "id"], + "properties": { + "type": { + "type": "string", + "enum": ["wire", "cubix", "pix", "sepa", "sepa_instant"] + }, + "id": { + "$ref": "#/components/schemas/Id" + } + } + }, + "InstitutionalWalletId": { + "type": "string", + "description": "Unique system-generated identifier for the wallet of the institutional entity.", + "example": "212000" + }, + "BusinessPayoutCreationRequest": { + "type": "object", + "required": ["idempotencyKey", "destination", "amount"], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" + }, + "destination": { + "$ref": "#/components/schemas/BusinessDestinationRequest" + }, + "amount": { + "$ref": "#/components/schemas/FiatMoney" + }, + "toAmount": { + "description": "To be used when requesting currency exchange", + "$ref": "#/components/schemas/FiatPayoutToMoney" + }, + "source": { + "type": "object", + "required": ["id", "type"], + "properties": { + "id": { + "$ref": "#/components/schemas/InstitutionalWalletId" + }, + "type": { + "type": "string", + "enum": ["wallet"] + } + }, + "description": "The source wallet to pay out from. If not provided, the deposit will come from the main wallet of the account.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n" + } + } + }, "BusinessPayout": { "type": "object", "properties": { @@ -10374,39 +8198,6 @@ } } }, - "BusinessDestinationRequest": { - "type": "object", - "description": "The destination bank account.", - "required": ["type", "id"], - "properties": { - "type": { - "type": "string", - "enum": ["wire", "cubix", "pix", "sepa", "sepa_instant"] - }, - "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" - }, - "toAmount": { - "description": "To be used when requesting currency exchange", - "$ref": "#/components/schemas/FiatPayoutToMoney" - } - } - }, "PayoutDestinationType": { "type": "string", "description": "The destination type.", @@ -10577,14 +8368,19 @@ } } }, - "ToAmount": { + "CryptoPayoutMoney": { "type": "object", - "required": ["currency"], + "required": ["amount", "currency"], "properties": { + "amount": { + "type": "string", + "description": "The numeric value of the amount, expressed in units of the specified currency.\nUse a period (`.`) as the decimal separator.\n", + "example": "3.14" + }, "currency": { "type": "string", - "description": "Currency code for the amount.", - "enum": ["USD", "EUR", "BTC", "ETH", "MTC"] + "description": "The ISO 4217 currency code for the amount.", + "enum": ["USD", "EUR"] } } }, @@ -10602,176 +8398,60 @@ "$ref": "#/components/schemas/CryptoPayoutDestination" }, "amount": { - "$ref": "#/components/schemas/Money" + "$ref": "#/components/schemas/CryptoPayoutMoney" }, "toAmount": { - "$ref": "#/components/schemas/ToAmount" + "$ref": "#/components/schemas/CryptoPayoutMoney" } } }, - "Rate": { - "type": "object", - "required": ["buy", "sell", "createDate"], - "properties": { - "buy": { - "type": "string", - "description": "The buy rate denominated in the quote currency of the trading pair.", - "example": "46317.59000" - }, - "sell": { - "type": "string", - "description": "The sell rate denominated in the quote currency of the trading pair.", - "example": "45400.41000" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } + "ExchangeType": { + "type": "string", + "description": "The type of exchange.", + "enum": ["reference", "tradable"], + "example": "tradable" }, - "Settlement": { + "ExchangeRateOptionalAmountMoney": { "type": "object", + "required": ["currency"], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "merchantWalletId": { - "$ref": "#/components/schemas/MerchantWalletId" - }, - "walletId": { - "description": "If this settlement was used for a marketplace payment, the wallet involved in the settlement. Not included for standard merchant settlements.", + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", "type": "string", - "example": "12345" - }, - "totalDebits": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "totalCredits": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "paymentFees": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "chargebackFees": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "example": "3.14" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" - } - } - }, - "IdPayment": { - "type": "string", - "description": "Unique system generated identifier for the payment that is associated to the chargeback item.", - "format": "uuid", - "example": "fc988ed5-c129-4f70-a064-e5beb7eb8e32" - }, - "ChargebackStatus": { - "type": "string", - "enum": [ - "active", - "resolved", - "pending", - "won", - "lost", - "canceled", - "closed" - ], - "description": "Enumerated status of the chargeback. `active` means you’ve received a dispute and you need to submit evidence if you want to defend against it. 'resolved' means the disputed payment had been refunded previously. Your account has not been debited. `pending` means we have acknowledged your evidence and forwarded it to the card issuer. `won` means you have won the dispute and your account has been credited. `lost` means the issuing bank has rejected your evidence and you have lost the dispute. There are no further financial implications. `canceled` means the issuing bank has canceled the dispute and your account has been credited. `closed` means the time to respond to this dispute has run out. No evidence can be submitted at this point." - }, - "ChargebackCategories": { - "type": "string", - "description": "Enumerated category of the chargeback status codes based on the chargeback status code.", - "enum": [ - "Canceled Recurring Payment", - "Customer Dispute", - "Fraudulent", - "General", - "Processing Error", - "Not Defined" - ] - }, - "IdSettlement": { - "type": "string", - "description": "Unique system generated identifier for the settlement related to the chargeback history.", - "format": "uuid", - "nullable": true, - "example": "fc988ed5-c129-4f70-a064-e5beb7eb8e32" - }, - "BasicChargebackHistory": { - "type": "object", - "required": ["type", "chargebackAmount", "description"], - "properties": { - "type": { + "currency": { "type": "string", - "description": "Enumerated type of the chargeback history event. `1st Chargeback` represents the first stage of the dispute procedure initiated by the cardholder’s issuing bank.\n `2nd Chargeback` represents the second stage of the dispute procedure initiated by the cardholder’s issuing bank (This stage is MasterCard only).\n `Chargeback Reversal` represents when 1st Chargeback or 2nd Chargeback is withdrawn by the issuer.\n `Representment` represents the stage when merchants decided to dispute 1st Chargeback or 2nd Chargeback.\n `Chargeback Settlement` can imply one of the two: 1) If merchant or marketplace is taking the lost of the chargeback, money will be debit from the wallet during this stage.\n 2) If merchant of marketplace successfully dispute the chargeback, money will be credit back to the wallet during this stage.\n", + "description": "Currency code.", "enum": [ - "1st Chargeback", - "2nd Chargeback", - "Chargeback Reversal", - "Representment", - "Chargeback Settlement" + "USDC", + "EURC", + "MXN", + "SGD", + "BRL", + "HKD", + "GBP", + "CNH", + "AED" ] - }, - "chargebackAmount": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "fee": { - "$ref": "#/components/schemas/FiatMoneyUsd" - }, - "description": { - "type": "string", - "description": "The reason the chargeback was created.", - "example": "The cardholder claims an unauthorized transaction occurred." - }, - "settlementId": { - "$ref": "#/components/schemas/IdSettlement" - }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" } } }, - "BasicChargeback": { + "ExchangeRateRequest": { "type": "object", - "required": [ - "id", - "paymentId", - "merchantId", - "status", - "history", - "reasonCode" - ], + "required": ["from", "to", "idempotencyKey", "type"], "properties": { - "id": { - "$ref": "#/components/schemas/Id" - }, - "paymentId": { - "$ref": "#/components/schemas/IdPayment" - }, - "merchantId": { - "$ref": "#/components/schemas/IdMerchant" - }, - "reasonCode": { - "description": "Reason code given by the card network for the chargeback item.", - "type": "string", - "example": "10.4" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, - "status": { - "$ref": "#/components/schemas/ChargebackStatus" + "type": { + "$ref": "#/components/schemas/ExchangeType" }, - "category": { - "$ref": "#/components/schemas/ChargebackCategories" + "from": { + "$ref": "#/components/schemas/ExchangeRateOptionalAmountMoney" }, - "history": { - "type": "array", - "description": "The chargeback item's history list will be sorted by create date descending: more recent chargeback statuses will be at the beginning of the list.\n", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/BasicChargebackHistory" - } + "to": { + "$ref": "#/components/schemas/ExchangeRateOptionalAmountMoney" } } }, @@ -10790,31 +8470,9 @@ } } }, - "ExchangeRateRequest": { - "type": "object", - "required": ["from", "to"], - "properties": { - "from": { - "allOf": [ - { - "$ref": "#/components/schemas/FiatOptionalAmountMoney" - } - ], - "description": "Amount (Optional) and currency to convert from. If an amount is provided here, then the amount in the \"to\" field must be null." - }, - "to": { - "allOf": [ - { - "$ref": "#/components/schemas/FiatOptionalAmountMoney" - } - ], - "description": "Amount (Optional) and currency to convert to. If an amount is provided here, then the amount in the \"from\" field must be null." - } - } - }, "ExchangeRateResponse": { "type": "object", - "required": ["id", "rate", "from", "to", "timestamp"], + "required": ["id", "rate", "from", "to", "expiry", "type"], "properties": { "id": { "$ref": "#/components/schemas/Id" @@ -10822,7 +8480,8 @@ "rate": { "description": "Exchange rate", "type": "number", - "format": "float" + "format": "float", + "example": 0.1974 }, "from": { "$ref": "#/components/schemas/FiatOptionalAmountMoney" @@ -10830,8 +8489,17 @@ "to": { "$ref": "#/components/schemas/FiatOptionalAmountMoney" }, - "timestamp": { + "expiry": { "$ref": "#/components/schemas/UtcTimestamp" + }, + "type": { + "$ref": "#/components/schemas/ExchangeType" + }, + "estimatedSettlementTime": { + "type": "string", + "format": "date-time", + "example": "2020-04-10T03:13:30.000Z", + "description": "Estimated settlement timestamp in ISO-8601 UTC date/time format. \nOnce funds are received, we aim to settle by the time shown. Settlement times are estimates and may vary due to processing delays. \nShown only for quotes where `type` = `tradable`.\n" } } }, @@ -10879,7 +8547,7 @@ }, "RedemptionFeeCalculation": { "type": "object", - "description": "A NET burn fee calculation for a day.", + "description": "A burn fee calculation for a day.", "properties": { "id": { "$ref": "#/components/schemas/Id" @@ -10912,9 +8580,15 @@ "example": "2023-05-23T23:59:59.999Z" }, "createDate": { - "description": "The create date of the NET burn daily fee calculation.", + "description": "The create date of the burn fee calculation.", "type": "string", "format": "date-time" + }, + "feeType": { + "description": "The aggregation method used to calculate the fee.", + "type": "string", + "enum": ["gross", "net"], + "example": "net" } } }, @@ -11096,193 +8770,668 @@ } } }, - "BusinessTransferCreationRequest": { + "BusinessTransferCreationRequest": { + "type": "object", + "required": ["idempotencyKey", "destination", "amount"], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" + }, + "destination": { + "$ref": "#/components/schemas/TransferRequestVerifiedBlockchainLocation" + }, + "amount": { + "$ref": "#/components/schemas/Money" + }, + "source": { + "description": "The wallet to be used as the source of the transfer. If not provided, the transfer will come from the main wallet of the account.\n\nYou can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities).\n", + "type": "object", + "required": ["id", "type"], + "properties": { + "id": { + "$ref": "#/components/schemas/InstitutionalWalletId" + }, + "type": { + "type": "string", + "enum": ["wallet"] + } + } + } + } + }, + "MockWirePaymentBeneficiaryBankInstruction": { + "type": "object", + "required": ["accountNumber"], + "properties": { + "accountNumber": { + "type": "string", + "description": "Virtual account number or Circle corporate Wells Fargo wire account number that needs to be set as destination.", + "example": "11111111" + } + } + }, + "MockWirePaymentRequest": { + "type": "object", + "required": ["trackingRef", "amount", "beneficiaryBank"], + "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/MockWirePaymentBeneficiaryBankInstruction" + } + } + }, + "MockWirePaymentResponse": { + "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/MockWirePaymentBeneficiaryBankInstruction" + }, + "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"] + } + } + }, + "FxCurrency": { + "type": "string", + "enum": ["USDC", "EURC", "MXN", "BRL"] + }, + "FxMoney": { + "type": "object", + "required": ["amount", "currency"], + "properties": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", + "type": "string", + "example": "3.14" + }, + "currency": { + "$ref": "#/components/schemas/FxCurrency" + } + } + }, + "TradeStatus": { + "type": "string", + "description": "Status of the trade.", + "enum": [ + "pending", + "confirmed", + "failed", + "complete", + "pending_settlement" + ] + }, + "Trade": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/Id" + }, + "from": { + "$ref": "#/components/schemas/FxMoney" + }, + "to": { + "$ref": "#/components/schemas/FxMoney" + }, + "status": { + "$ref": "#/components/schemas/TradeStatus" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "quoteId": { + "$ref": "#/components/schemas/Id" + }, + "settlementId": { + "$ref": "#/components/schemas/Id" + }, + "rate": { + "type": "string", + "description": "Rate associated with the FX trade.", + "example": 0.9039 + }, + "expectedBatchTime": { + "description": "Expected time for the trade to be batched for settlement.", + "$ref": "#/components/schemas/UtcTimestamp" + } + } + }, + "FxTradeRequest": { + "type": "object", + "required": ["idempotencyKey", "quoteId"], + "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" + }, + "quoteId": { + "$ref": "#/components/schemas/Id" + } + } + }, + "CreateFxTradeResponse": { + "title": "CreateFxTradeResponse", + "properties": { + "data": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/Id" + }, + "from": { + "$ref": "#/components/schemas/FxMoney" + }, + "to": { + "$ref": "#/components/schemas/FxMoney" + }, + "status": { + "$ref": "#/components/schemas/TradeStatus" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "quoteId": { + "$ref": "#/components/schemas/Id" + } + } + } + } + }, + "SettlementStatus": { + "type": "string", + "description": "Status of the settlement.", + "enum": ["pending", "settled"] + }, + "SettlementDetailStatus": { + "type": "string", + "enum": ["pending", "completed"] + }, + "Settlement": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/Id" + }, + "entityId": { + "$ref": "#/components/schemas/Id" + }, + "status": { + "$ref": "#/components/schemas/SettlementStatus" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/Id" + }, + "type": { + "type": "string", + "enum": ["payable", "receivable"] + }, + "amount": { + "$ref": "#/components/schemas/FxMoney" + }, + "status": { + "$ref": "#/components/schemas/SettlementDetailStatus" + }, + "reference": { + "type": "string", + "example": "FXR1234567" + }, + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" + } + } + } + } + } + }, + "MXNSettlementInstructions": { + "type": "object", + "properties": { + "currency": { + "type": "string", + "enum": ["MXN"] + }, + "fiatAccountType": { + "$ref": "#/components/schemas/BusinessAccountPayoutDestinationType" + }, + "instruction": { + "$ref": "#/components/schemas/WireInstruction" + } + } + }, + "BRLSettlementInstructions": { + "type": "object", + "properties": { + "currency": { + "type": "string", + "enum": ["BRL"] + }, + "fiatAccountType": { + "type": "string", + "enum": ["pix"] + }, + "instruction": { + "type": "object", + "properties": { + "ispb": { + "type": "string", + "example": "87654321" + }, + "branchCode": { + "type": "string", + "example": "0001" + }, + "accountNumber": { + "type": "string", + "example": "12345678" + }, + "name": { + "type": "string", + "example": "Circle Internet Financial LLC" + }, + "accountType": { + "$ref": "#/components/schemas/PixAccountType" + }, + "taxId": { + "type": "string", + "example": "12.345.678/0001-90" + } + } + } + } + }, + "FxFiatCurrency": { + "type": "string", + "enum": ["MXN", "BRL"] + }, + "CreateFxAccountRequest": { + "type": "object", + "properties": { + "fiatAccountId": { + "$ref": "#/components/schemas/Id" + }, + "currency": { + "$ref": "#/components/schemas/FxFiatCurrency" + } + } + }, + "CreateFxAccountResponse": { "type": "object", - "required": ["idempotencyKey", "destination", "amount"], "properties": { - "idempotencyKey": { - "$ref": "#/components/schemas/IdempotencyKey" + "currency": { + "$ref": "#/components/schemas/FxFiatCurrency" }, - "destination": { - "$ref": "#/components/schemas/TransferRequestVerifiedBlockchainLocation" + "fiatAccountId": { + "$ref": "#/components/schemas/Id" }, - "amount": { - "$ref": "#/components/schemas/Money" + "createDate": { + "$ref": "#/components/schemas/UtcTimestamp" + }, + "updateDate": { + "$ref": "#/components/schemas/UtcTimestamp" } } }, - "MockChargebackCreationRequest": { + "FxCurrencyLimit": { "type": "object", - "required": ["paymentId"], "properties": { - "paymentId": { + "limit": { "type": "string", - "format": "uuid", - "description": "The id of the payment to be charged back. Each payment can only be charged back once.", - "example": "fc988ed5-c129-4f70-a064-e5beb7eb8e32" + "example": "1000000.00" + }, + "usage": { + "type": "string", + "example": "0.00" + }, + "available": { + "type": "string", + "example": "1000000.00" } } }, - "MockChargeback": { - "type": "object", - "properties": {} - }, - "MockWirePaymentBeneficiaryBankInstruction": { + "DailyFxLimits": { "type": "object", - "required": ["accountNumber"], "properties": { - "accountNumber": { - "type": "string", - "description": "Virtual account number or Circle corporate Silvergate Wire account number that needs to be set as destination.", - "example": "11111111" + "EURC": { + "$ref": "#/components/schemas/FxCurrencyLimit" + }, + "MXN": { + "$ref": "#/components/schemas/FxCurrencyLimit" + }, + "USDC": { + "$ref": "#/components/schemas/FxCurrencyLimit" + }, + "BRL": { + "$ref": "#/components/schemas/FxCurrencyLimit" } } }, - "MockWirePaymentRequest": { + "MockPixPaymentRequest": { "type": "object", - "required": ["trackingRef", "amount", "beneficiaryBank"], + "required": ["trackingRef", "amount", "accountNumber"], "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.", + "description": "PIX tracking reference that needs to be set in the PIX reference to beneficiary field. This field is retrievable through the response during PIX creation or via the bank instruction endpoint.", "example": "CIR13FB13A" }, "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "type": "object", + "required": ["amount", "currency"], + "properties": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", + "type": "string", + "example": "3.14" + }, + "currency": { + "type": "string", + "enum": ["BRL"] + } + } }, - "beneficiaryBank": { - "$ref": "#/components/schemas/MockWirePaymentBeneficiaryBankInstruction" + "accountNumber": { + "type": "string", + "description": "The account number that the money should be transferred to.", + "example": "4842622" } } }, - "MockWirePaymentResponse": { + "MockPixPaymentResponse": { "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.", + "description": "PIX tracking reference that needs to be set in the PIX reference to beneficiary field. This field is retrievable through the response during PIX creation or via the bank instruction endpoint.", "example": "CIR13FB13A" }, "amount": { - "$ref": "#/components/schemas/FiatMoneyUsd" + "type": "object", + "required": ["amount", "currency"], + "properties": { + "amount": { + "description": "Magnitude of the amount, in units of the currency, with a `.`.", + "type": "string", + "example": "3.14" + }, + "currency": { + "type": "string", + "enum": ["BRL"] + } + } }, - "beneficiaryBank": { - "$ref": "#/components/schemas/MockWirePaymentBeneficiaryBankInstruction" + "beneficiaryAccountNumber": { + "type": "string", + "example": "4842622" }, "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.", + "description": "Enumerated status of the PIX payment. Status `pending` indicates that the PIX 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.", - "example": "https://www.example.com/success" - }, - "CheckoutSessionStatus": { - "description": "Status of the checkout session. Active: the checkout session is still in-progress. Completed: the payments of a checkout session is successful and the checkout session is completed. Expired: indicates that it expired and is no longer accepting any new payments.", - "type": "string", - "enum": ["active", "completed", "expired"] - }, - "CheckoutSessionMoney": { + "DailyCustodyBalancesRequest": { "type": "object", - "required": ["amount", "currency"], + "required": [ + "idempotencyKey", + "currency", + "localBalance", + "asOfDate", + "reportType", + "additionalFields" + ], "properties": { - "amount": { - "description": "Magnitude of the amount, in units of the currency, with a `.`.", - "type": "string", - "example": "3.14" + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" }, "currency": { - "description": "A currency associated with a balance or address.", "type": "string", - "enum": ["USD", "ETH", "BTC"] + "description": "The type of token being reported.", + "enum": ["USDC", "EURC"], + "example": "USDC" + }, + "localBalance": { + "type": "number", + "format": "double", + "description": "Regional specific balance for the provided token type.\n\neea - tokens held by the EU licensed crypto-asset service provider, which are held by Union clients of that EU licensed crypto-asset service provider.\n\njapan_trust - total amount held in custody on behalf of customers of the EPIESP.\n", + "example": 1000000 + }, + "asOfDate": { + "type": "string", + "format": "date", + "description": "The day being reported in the format YYYY-MM-DD with timezone UTC.", + "example": "2025-06-26" + }, + "reportType": { + "type": "string", + "description": "The type of report being created.", + "enum": ["eea", "japan_trust"], + "example": "eea" + }, + "additionalFields": { + "type": "object", + "description": "Additional fields are required only for the `eea` report type. They are ignored for the `japan_trust` report type.\n", + "required": [ + "equivalentEuroLocalBalance", + "totalBalance", + "equivalentEuroTotalBalance" + ], + "properties": { + "equivalentEuroLocalBalance": { + "type": "number", + "format": "double", + "description": "EUR equivalent of the `localBalance` field.", + "example": 26994.6 + }, + "totalBalance": { + "type": "number", + "format": "double", + "description": "Tokens held by the EU licensed crypto-asset service provider", + "example": 5000000 + }, + "equivalentEuroTotalBalance": { + "type": "number", + "format": "double", + "description": "EUR equivalent of the total worldwide token balance.", + "example": 853949.09 + } + } } } }, - "CheckoutSession": { + "DailyCustodyBalancesResponse": { "type": "object", - "required": [ - "id", - "type", - "clientToken", - "status", - "expiresOn", - "createDate", - "updateDate", - "amount", - "amountPaid", - "paymentIds", - "paymentIntentIds" - ], "properties": { + "idempotencyKey": { + "$ref": "#/components/schemas/IdempotencyKey" + }, "id": { "$ref": "#/components/schemas/Id" }, - "type": { + "createDate": { "type": "string", - "description": "The type of this response", - "enum": ["checkout_session"] + "format": "date-time", + "example": "2025-07-15T18:03:52.429Z" }, - "successUrl": { - "$ref": "#/components/schemas/SuccessUrl" + "localBalance": { + "type": "number", + "format": "double", + "description": "Regional specific balance for the provided token type.\n\neea - tokens held by the EU licensed crypto-asset service provider, which are held by Union clients of that EU licensed crypto-asset service provider.\n\njapan_trust - total amount held in custody on behalf of customers of the EPIESP.\n", + "example": 1000000 }, - "clientToken": { + "currency": { "type": "string", - "description": "The access token for the SDK to access checkout session resources", - "example": "ck_test_19NoQz3jDq3mKgJFEuMkWs4dCk6Eiq1GZShWMF_jY_vL3dOAoT3EiTTgEprqaVcGbzB3pszRZhyU_v0mebyKiQ" + "description": "The type of token being reported.", + "enum": ["USDC", "EURC"], + "example": "USDC" }, - "status": { - "$ref": "#/components/schemas/CheckoutSessionStatus" + "asOfDate": { + "type": "string", + "format": "date", + "description": "The day being reported in the format YYYY-MM-DD with timezone UTC.", + "example": "2025-06-26" }, - "expiresOn": { - "$ref": "#/components/schemas/UtcTimestamp" + "reportType": { + "type": "string", + "description": "The type of report being created.", + "enum": ["eea", "japan_trust"], + "example": "eea" }, - "createDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "additionalFields": { + "type": "object", + "description": "Additional fields are required only for the `eea` report type. They are ignored for the `japan_trust` report type.\n", + "properties": { + "equivalentEuroLocalBalance": { + "type": "number", + "format": "double", + "description": "EUR equivalent of the `localBalance` field.", + "example": 26994.6 + }, + "totalBalance": { + "type": "number", + "format": "double", + "description": "Tokens held by the EU licensed crypto-asset service provider", + "example": 5000000 + }, + "equivalentEuroTotalBalance": { + "type": "number", + "format": "double", + "description": "EUR equivalent of the total worldwide token balance.", + "example": 853949.09 + } + } + } + } + }, + "ExternalEntity": { + "type": "object", + "description": "An external entity", + "properties": { + "walletId": { + "$ref": "#/components/schemas/InstitutionalWalletId" }, - "updateDate": { - "$ref": "#/components/schemas/UtcTimestamp" + "businessName": { + "type": "string", + "description": "The name of the business.", + "example": "Circle Internet Financial Inc." }, - "amount": { - "$ref": "#/components/schemas/CheckoutSessionMoney" + "businessUniqueIdentifier": { + "type": "string", + "description": "The unique identifier of the business. For example, a company number or tax ID.", + "example": "1234567890" }, - "amountPaid": { - "$ref": "#/components/schemas/CheckoutSessionMoney" + "identifierIssuingCountryCode": { + "type": "string", + "description": "The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "pattern": "^[A-Z]{2}$", + "example": "US" }, - "paymentIds": { - "description": "IDs of all the associated payments.", - "type": "array", - "readOnly": true, - "items": { - "type": "string", - "format": "uuid", - "example": "69808f36-3e5e-4f37-bf82-ca79e4d70fc1" - } + "complianceState": { + "type": "string", + "description": "The compliance status of the external entity.", + "enum": ["PENDING", "ACCEPTED", "REJECTED"] + } + } + }, + "InstitutionalAddress": { + "type": "object", + "required": ["country", "state", "city", "postalCode"], + "properties": { + "country": { + "type": "string", + "description": "Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "pattern": "^[A-Z]{2}$", + "example": "US" }, - "paymentIntentIds": { - "description": "IDs of all the associated payment intents.", - "type": "array", - "readOnly": true, - "items": { - "type": "string", - "format": "uuid", - "example": "69808f36-3e5e-4f37-bf82-ca79e4d70fc1" - } + "state": { + "type": "string", + "description": "State / county / province / region / district / emirate portion of the address. US and Canada use the two-letter code for the subdivision.", + "example": "MA" + }, + "city": { + "type": "string", + "description": "City portion of the address.", + "example": "Boston" + }, + "postcode": { + "type": "string", + "description": "Postal / ZIP code of the address. If there is no applicable postal code, set the value to `00000`.", + "example": "01234" + }, + "streetName": { + "type": "string", + "description": "Street name of the address.", + "example": "Main Street" + }, + "buildingNumber": { + "type": "string", + "description": "Street number of the address.", + "example": "100" } } }, - "CheckoutSessionCreationRequest": { + "ExternalEntityCreationRequest": { "type": "object", - "required": ["amount"], + "required": [ + "businessName", + "businessUniqueIdentifier", + "identifierIssuingCountryCode", + "address" + ], "properties": { - "successUrl": { - "$ref": "#/components/schemas/SuccessUrl" + "businessName": { + "type": "string", + "description": "The name of the business.", + "example": "Circle Internet Financial Inc." }, - "amount": { - "$ref": "#/components/schemas/CheckoutSessionMoney" + "businessUniqueIdentifier": { + "type": "string", + "description": "The unique identifier of the business. For example, a company number or tax ID.", + "example": "1234567890" + }, + "identifierIssuingCountryCode": { + "type": "string", + "description": "The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.", + "pattern": "^[A-Z]{2}$", + "example": "US" + }, + "address": { + "$ref": "#/components/schemas/InstitutionalAddress" } } } @@ -11545,35 +9694,6 @@ "example": "b3d9d2d5-4c12-4946-a09d-953e82fae2b0" } }, - "PageBefore": { - "name": "pageBefore", - "description": "A collection ID value used for pagination.\n\nIt marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before\nthe id, with `n` being specified by `pageSize`.\n\nThe items will be returned in the natural order of the collection.\n\nThe resource will return the first page if neither `pageAfter` nor `pageBefore` are specified.\n\nSHOULD NOT be used in conjuction with pageAfter.\n", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - "PageAfter": { - "name": "pageAfter", - "description": "A collection ID value used for pagination.\n\nIt marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after\nthe id, with `n` being specified by `pageSize`.\n\nThe items will be returned in the natural order of the collection.\n\nThe resource will return the first page if neither `pageAfter` nor `pageBefore` are specified.\n\nSHOULD NOT be used in conjuction with pageBefore.\n", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - "PageSize": { - "name": "pageSize", - "description": "Limits the number of items to be returned.\n\nSome collections have a strict upper bound that will disregard this value. In case the specified value is higher\nthan the allowed limit, the collection limit will be used.\n\nIf avoided, the collection will determine the page size itself.\n", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "example": 5 - } - }, "Currency": { "name": "currency", "description": "Queries beneficiary bank account currency. Default is USD.", @@ -11606,6 +9726,35 @@ "example": "2020-04-10T02:13:30.000Z" } }, + "PageBefore": { + "name": "pageBefore", + "description": "A collection ID value used for pagination.\n\nIt marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before\nthe id, with `n` being specified by `pageSize`.\n\nThe items will be returned in the natural order of the collection.\n\nThe resource will return the first page if neither `pageAfter` nor `pageBefore` are specified.\n\nSHOULD NOT be used in conjuction with pageAfter.\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "PageAfter": { + "name": "pageAfter", + "description": "A collection ID value used for pagination.\n\nIt marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after\nthe id, with `n` being specified by `pageSize`.\n\nThe items will be returned in the natural order of the collection.\n\nThe resource will return the first page if neither `pageAfter` nor `pageBefore` are specified.\n\nSHOULD NOT be used in conjuction with pageBefore.\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "PageSize": { + "name": "pageSize", + "description": "Limits the number of items to be returned.\n\nSome collections have a strict upper bound that will disregard this value. In case the specified value is higher\nthan the allowed limit, the collection limit will be used.\n\nIf avoided, the collection will determine the page size itself.\n", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "example": 5 + } + }, "Source": { "name": "source", "description": "Universally unique identifier (UUID v4) for the source. Filters results to fetch only payments made from the provdided source.", @@ -11683,34 +9832,46 @@ "type": "string", "enum": [ "ALGO", + "APTOS", "ARB", "AVAX", "BASE", "BTC", "CELO", + "CODEX", "ETH", "HBAR", + "HYPEREVM", + "INK", + "LINEA", "NEAR", "NOBLE", "OP", + "PLUME", "PAH", "POLY", + "SEI", "SOL", + "SONIC", "SUI", + "UNI", + "WORLDCHAIN", + "XDC", "XLM", - "ZKS" + "XRP", + "ZKS", + "ZKSYNC" ] } }, - "PaymentId": { - "name": "paymentId", - "description": "The payment ID associated with the chargeback.", - "in": "query", - "required": false, + "FxCurrencyPath": { + "name": "currency", + "description": "Fiat currency name.", + "in": "path", + "required": true, "schema": { "type": "string", - "format": "uuid", - "example": "202ad9ce-974c-49ca-8d34-3afb7d7247ae" + "enum": ["BRL", "MXN"] } } } diff --git a/src/generated/.openapi-generator/FILES b/src/generated/.openapi-generator/FILES index cbdc609d..62bcb655 100644 --- a/src/generated/.openapi-generator/FILES +++ b/src/generated/.openapi-generator/FILES @@ -1,26 +1,21 @@ api.ts apis/addresses-api.ts apis/balances-api.ts -apis/cards-api.ts -apis/channels-api.ts -apis/chargebacks-api.ts -apis/checkout-sessions-api.ts apis/crypto-address-book-api.ts -apis/crypto-exchange-rates-api.ts apis/crypto-payment-intents-api.ts apis/cubixapi.ts apis/deposits-api.ts -apis/encryption-api.ts +apis/external-entities-api.ts apis/health-api.ts apis/management-api.ts -apis/payment-tokens-api.ts apis/payments-api.ts apis/payouts-api.ts apis/pixapi.ts -apis/pull-crypto-payments-api.ts +apis/reserve-management-api.ts apis/settlements-api.ts apis/stablecoins-api.ts apis/subscriptions-api.ts +apis/trades-api.ts apis/transfers-api.ts apis/wires-api.ts base.ts @@ -33,19 +28,15 @@ models/address-book-recipient-modify-request.ts models/address-book-recipient-request.ts models/address-book-recipient.ts models/address-object.ts -models/apple-pay-token-ec-header.ts -models/apple-pay-token-header.ts -models/apple-pay-token-rsa-header.ts -models/apple-pay-token.ts models/bad-request.ts models/balances.ts models/bank-address-iban-supported.ts models/bank-address-non-iban.ts models/bank-address.ts models/bank-destination.ts -models/basic-chargeback-history.ts -models/basic-chargeback.ts models/billing-details.ts +models/brlsettlement-instructions-instruction.ts +models/brlsettlement-instructions.ts models/burn-fee-net-amount.ts models/burn-fee-payment-amount.ts models/burn-fee-payout-amount.ts @@ -53,28 +44,16 @@ models/business-account-payout-destination-type.ts models/business-deposit.ts models/business-destination-request.ts models/business-generate-address-request.ts +models/business-payout-creation-request-source.ts models/business-payout-creation-request.ts models/business-payout.ts models/business-pix-account-instructions-response.ts models/business-recipient-address-creation-request.ts models/business-recipient-address-object.ts +models/business-transfer-creation-request-source.ts models/business-transfer-creation-request.ts -models/cancel-creation-request.ts -models/cancel-payment-response.ts models/cancel-refund-reversal-status.ts -models/capture-creation-request.ts -models/card-creation-request.ts -models/card-update.ts -models/card-verification-response.ts -models/card.ts models/chain.ts -models/channel-response.ts -models/chargeback-categories.ts -models/chargeback-status.ts -models/checkout-session-creation-request.ts -models/checkout-session-money.ts -models/checkout-session-status.ts -models/checkout-session.ts models/conflict.ts models/continuous-payment-intent-creation-request.ts models/continuous-payment-intent.ts @@ -86,32 +65,29 @@ models/create-business-pix-account-response.ts models/create-business-recipient-address-response.ts models/create-business-transfer-response.ts models/create-business-wire-account-response.ts -models/create-card-response.ts -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-chargeback-response.ts +models/create-fx-account-request.ts +models/create-fx-account-response.ts +models/create-fx-account-response1.ts +models/create-fx-trade-response-data.ts +models/create-fx-trade-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-response.ts +models/create-pix-payment-response.ts models/create-subscription-response.ts models/create-wire-payment-response.ts -models/crypto-payment-creation-request.ts models/crypto-payment-deposit-address.ts -models/crypto-payment-destination.ts models/crypto-payment-from-addresses.ts models/crypto-payment-network-fee.ts -models/crypto-payment-source.ts models/crypto-payment.ts models/crypto-payments-money.ts models/crypto-payments-optional-amount-money.ts models/crypto-payout-creation-request.ts models/crypto-payout-destination-type.ts models/crypto-payout-destination.ts +models/crypto-payout-money.ts models/crypto-payout.ts models/crypto-refund-creation-request-amount.ts models/crypto-refund-creation-request-to-amount.ts @@ -122,18 +98,21 @@ models/cubix-fiat-account-response.ts models/cubix-instruction.ts models/currency.ts models/cvv-results.ts +models/daily-custody-balances-request-additional-fields.ts +models/daily-custody-balances-request.ts +models/daily-custody-balances-response-additional-fields.ts +models/daily-custody-balances-response.ts +models/daily-fx-limits.ts models/delete-subscription-response.ts -models/detailed-cancel.ts -models/detailed-payment.ts -models/detailed-refund.ts +models/duplicate-request.ts models/eci.ts -models/exchange-rate-request-from.ts -models/exchange-rate-request-to.ts +models/exchange-rate-optional-amount-money.ts models/exchange-rate-request.ts models/exchange-rate-response.ts +models/exchange-type.ts models/expire-payment-intent-response.ts -models/extend-checkout-session-request.ts -models/extend-checkout-session-response.ts +models/external-entity-creation-request.ts +models/external-entity.ts models/external-fiat-account-status.ts models/fee.ts models/fetch-exchange-rate-response.ts @@ -148,6 +127,11 @@ models/fiat-payout-to-money.ts models/fiat-refund.ts models/final-adjustments.ts models/forbidden.ts +models/fx-currency-limit.ts +models/fx-currency.ts +models/fx-fiat-currency.ts +models/fx-money.ts +models/fx-trade-request.ts models/get-address-book-recipient-response.ts models/get-business-cubix-account-response.ts models/get-business-deposit-address-response.ts @@ -156,39 +140,37 @@ models/get-business-pix-account-response.ts models/get-business-transfer-response.ts models/get-business-wire-account-instructions-response.ts models/get-business-wire-account-response.ts -models/get-card-response.ts -models/get-chargeback-response.ts -models/get-checkout-session-response.ts models/get-config-response.ts -models/get-exchange-rates-response.ts +models/get-fx-limits-response-data.ts +models/get-fx-limits-response.ts +models/get-fx-trades-response.ts +models/get-fx-trades-response1.ts models/get-payment-intent-response.ts models/get-payment-response-data.ts models/get-payment-response.ts models/get-payout-response.ts -models/get-public-key-response.ts -models/get-settlement-response.ts +models/get-settlement-id-response.ts +models/get-settlement-instructions-response-data.ts +models/get-settlement-instructions-response.ts models/get-settlements-response.ts -models/google-pay-token.ts models/identity-address.ts models/identity.ts models/index.ts +models/institutional-address.ts models/limit-exceeded.ts models/list-address-book-recipients-response.ts -models/list-balances-response.ts models/list-burn-fee-calculations-response.ts models/list-business-balances-response.ts models/list-business-cubix-account-instructions-response.ts models/list-business-cubix-accounts-response.ts models/list-business-deposits-response.ts -models/list-business-payouts-response.ts +models/list-business-payout-data-inner.ts +models/list-business-payout.ts models/list-business-pix-accounts-response.ts models/list-business-recipient-addresses-response.ts models/list-business-transfers-response.ts models/list-business-wire-accounts-response.ts -models/list-cards-response.ts -models/list-channels-response.ts -models/list-chargebacks-response.ts -models/list-checkout-sessions-response.ts +models/list-external-entities-response.ts models/list-payment-intents-response-data-inner.ts models/list-payment-intents-response.ts models/list-payments-response-data-inner.ts @@ -196,31 +178,28 @@ models/list-payments-response.ts models/list-payouts-response.ts models/list-stablecoins-response.ts models/list-subscriptions-response.ts -models/metadata-card-and-ach.ts -models/metadata-crypto-payment.ts -models/metadata-payment.ts models/metadata-phone-email.ts -models/mock-chargeback-creation-request.ts +models/mock-pix-payment-request-amount.ts +models/mock-pix-payment-request.ts +models/mock-pix-payment-response.ts models/mock-wire-payment-beneficiary-bank-instruction.ts models/mock-wire-payment-request.ts models/mock-wire-payment-response.ts models/modify-address-book-recipient-response.ts models/money.ts -models/network-fee-quote.ts +models/mxnsettlement-instructions.ts +models/new-report-success.ts models/not-authorized.ts models/not-found.ts -models/payment-creation-request.ts models/payment-error-code.ts models/payment-info-cancel.ts models/payment-info-payment-and-refund.ts models/payment-intent-creation-request.ts models/payment-intent-fees.ts models/payment-intent.ts +models/payment-method-blockchain-request.ts models/payment-method-blockchain.ts models/payment-status.ts -models/payment-token-request-token-data.ts -models/payment-token-request.ts -models/payment-token.ts models/payment-verification-response.ts models/payout-destination-type.ts models/payout-error-code.ts @@ -231,34 +210,23 @@ models/pix-account-type.ts models/pix-fiat-account-creation-request.ts models/pix-fiat-account-response.ts models/pix-instruction.ts -models/presign-domain.ts -models/presign-message-types-items.ts -models/presign-message-types.ts -models/presign-message.ts -models/presign-response-typed-data.ts -models/presign-response.ts -models/public-key.ts -models/rate.ts models/redemption-fee-calculation.ts -models/refund-creation-request.ts -models/refund-payment-response.ts models/required-action.ts -models/reversal-reason.ts models/risk-evaluation.ts +models/settlement-detail-status.ts +models/settlement-details-inner.ts +models/settlement-status.ts models/settlement.ts -models/simple-billing-details.ts -models/simple-card.ts models/source-response.ts -models/source.ts models/stablecoin.ts models/subscription-detail.ts models/subscription-request.ts models/subscription-response.ts models/three-ds-result.ts models/timeline.ts -models/to-amount.ts models/token-amount.ts -models/tokenized-card-details.ts +models/trade-status.ts +models/trade.ts models/transfer-destination-blockchain-location.ts models/transfer-destination-location.ts models/transfer-destination-wallet-location.ts @@ -271,15 +239,13 @@ models/transfer-type-info-additional-properties.ts models/transfer-type-info.ts models/transfer.ts models/unwithdrawal-object.ts -models/update-billing-details.ts -models/update-card-response.ts -models/verification-error-code.ts models/wallet-config.ts models/wallet-location.ts models/wire-creation-request-account-number.ts models/wire-creation-request-iban.ts models/wire-creation-request-us.ts models/wire-creation-request.ts +models/wire-destination-response.ts models/wire-instruction-beneficiary-bank.ts models/wire-instruction-beneficiary.ts models/wire-instruction.ts diff --git a/src/generated/api.ts b/src/generated/api.ts index 02a686d5..d009c542 100644 --- a/src/generated/api.ts +++ b/src/generated/api.ts @@ -9,24 +9,19 @@ export * from "./apis/addresses-api"; export * from "./apis/balances-api"; export * from "./apis/cubixapi"; -export * from "./apis/cards-api"; -export * from "./apis/channels-api"; -export * from "./apis/chargebacks-api"; -export * from "./apis/checkout-sessions-api"; export * from "./apis/crypto-address-book-api"; -export * from "./apis/crypto-exchange-rates-api"; export * from "./apis/crypto-payment-intents-api"; export * from "./apis/deposits-api"; -export * from "./apis/encryption-api"; +export * from "./apis/external-entities-api"; export * from "./apis/health-api"; export * from "./apis/management-api"; export * from "./apis/pixapi"; -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/reserve-management-api"; export * from "./apis/settlements-api"; export * from "./apis/stablecoins-api"; export * from "./apis/subscriptions-api"; +export * from "./apis/trades-api"; export * from "./apis/transfers-api"; export * from "./apis/wires-api"; diff --git a/src/generated/apis/addresses-api.ts b/src/generated/apis/addresses-api.ts index c3913110..d13260b3 100644 --- a/src/generated/apis/addresses-api.ts +++ b/src/generated/apis/addresses-api.ts @@ -60,11 +60,13 @@ export const AddressesApiAxiosParamCreator = function ( /** * 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. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address + * @param {string} [walletId] The wallet ID to be credited when deposits are made to this address. If not provided, deposits default to the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessDepositAddress: async ( + walletId?: string, businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options: AxiosRequestConfig = {} ): Promise => { @@ -88,6 +90,10 @@ export const AddressesApiAxiosParamCreator = function ( // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration); + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + localVarHeaderParameter["Content-Type"] = "application/json"; setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -213,12 +219,14 @@ export const AddressesApiAxiosParamCreator = function ( }; }, /** - * + * Returns a list of deposit addresses for a given wallet. * @summary List all deposit addresses + * @param {string} [walletId] The wallet ID for which the deposit addresses were generated. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessDepositAddress: async ( + walletId?: string, options: AxiosRequestConfig = {} ): Promise => { const localVarPath = `/v1/businessAccount/wallets/addresses/deposit`; @@ -241,6 +249,10 @@ export const AddressesApiAxiosParamCreator = function ( // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration); + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -344,11 +356,13 @@ export const AddressesApiFp = function (configuration?: Configuration) { /** * 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. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address + * @param {string} [walletId] The wallet ID to be credited when deposits are made to this address. If not provided, deposits default to the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async createBusinessDepositAddress( + walletId?: string, businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: AxiosRequestConfig ): Promise< @@ -359,6 +373,7 @@ export const AddressesApiFp = function (configuration?: Configuration) { > { const localVarAxiosArgs = await localVarAxiosParamCreator.createBusinessDepositAddress( + walletId, businessGenerateAddressRequest, options ); @@ -423,12 +438,14 @@ export const AddressesApiFp = function (configuration?: Configuration) { ); }, /** - * + * Returns a list of deposit addresses for a given wallet. * @summary List all deposit addresses + * @param {string} [walletId] The wallet ID for which the deposit addresses were generated. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getBusinessDepositAddress( + walletId?: string, options?: AxiosRequestConfig ): Promise< ( @@ -437,7 +454,10 @@ export const AddressesApiFp = function (configuration?: Configuration) { ) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.getBusinessDepositAddress(options); + await localVarAxiosParamCreator.getBusinessDepositAddress( + walletId, + options + ); return createRequestFunction( localVarAxiosArgs, globalAxios, @@ -502,16 +522,22 @@ export const AddressesApiFactory = function ( /** * 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. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address + * @param {string} [walletId] The wallet ID to be credited when deposits are made to this address. If not provided, deposits default to the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessDepositAddress( + walletId?: string, businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: any ): AxiosPromise { return localVarFp - .createBusinessDepositAddress(businessGenerateAddressRequest, options) + .createBusinessDepositAddress( + walletId, + businessGenerateAddressRequest, + options + ) .then((request) => request(axios, basePath)); }, /** @@ -548,16 +574,18 @@ export const AddressesApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * + * Returns a list of deposit addresses for a given wallet. * @summary List all deposit addresses + * @param {string} [walletId] The wallet ID for which the deposit addresses were generated. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessDepositAddress( + walletId?: string, options?: any ): AxiosPromise { return localVarFp - .getBusinessDepositAddress(options) + .getBusinessDepositAddress(walletId, options) .then((request) => request(axios, basePath)); }, /** @@ -603,17 +631,23 @@ export class AddressesApi extends BaseAPI { /** * 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. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address + * @param {string} [walletId] The wallet ID to be credited when deposits are made to this address. If not provided, deposits default to the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ public createBusinessDepositAddress( + walletId?: string, businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: AxiosRequestConfig ) { return AddressesApiFp(this.configuration) - .createBusinessDepositAddress(businessGenerateAddressRequest, options) + .createBusinessDepositAddress( + walletId, + businessGenerateAddressRequest, + options + ) .then((request) => request(this.axios, this.basePath)); } @@ -655,15 +689,19 @@ export class AddressesApi extends BaseAPI { } /** - * + * Returns a list of deposit addresses for a given wallet. * @summary List all deposit addresses + * @param {string} [walletId] The wallet ID for which the deposit addresses were generated. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ - public getBusinessDepositAddress(options?: AxiosRequestConfig) { + public getBusinessDepositAddress( + walletId?: string, + options?: AxiosRequestConfig + ) { return AddressesApiFp(this.configuration) - .getBusinessDepositAddress(options) + .getBusinessDepositAddress(walletId, options) .then((request) => request(this.axios, this.basePath)); } diff --git a/src/generated/apis/balances-api.ts b/src/generated/apis/balances-api.ts index 5fc03e70..8b476264 100644 --- a/src/generated/apis/balances-api.ts +++ b/src/generated/apis/balances-api.ts @@ -32,8 +32,6 @@ import { RequiredError } from "../base"; // @ts-ignore -import { ListBalancesResponse } from "../models"; -// @ts-ignore import { ListBusinessBalancesResponse } from "../models"; // @ts-ignore import { NotAuthorized } from "../models"; @@ -45,56 +43,15 @@ export const BalancesApiAxiosParamCreator = function ( configuration?: Configuration ) { return { - /** - * Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled. - * @summary List all balances - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listBalances: async ( - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/balances`; - // 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 - }; - }, /** * Retrieves the balance of funds that are available for use. * @summary List all balances + * @param {string} [walletId] The wallet ID of the wallet for which to retrieve the balances. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBusinessBalances: async ( + walletId?: string, options: AxiosRequestConfig = {} ): Promise => { const localVarPath = `/v1/businessAccount/balances`; @@ -117,6 +74,10 @@ export const BalancesApiAxiosParamCreator = function ( // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration); + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -141,37 +102,15 @@ export const BalancesApiAxiosParamCreator = function ( export const BalancesApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = BalancesApiAxiosParamCreator(configuration); return { - /** - * Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled. - * @summary List all balances - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listBalances( - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listBalances( - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, /** * Retrieves the balance of funds that are available for use. * @summary List all balances + * @param {string} [walletId] The wallet ID of the wallet for which to retrieve the balances. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ async listBusinessBalances( + walletId?: string, options?: AxiosRequestConfig ): Promise< ( @@ -180,7 +119,7 @@ export const BalancesApiFp = function (configuration?: Configuration) { ) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.listBusinessBalances(options); + await localVarAxiosParamCreator.listBusinessBalances(walletId, options); return createRequestFunction( localVarAxiosArgs, globalAxios, @@ -202,28 +141,19 @@ export const BalancesApiFactory = function ( ) { const localVarFp = BalancesApiFp(configuration); return { - /** - * Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled. - * @summary List all balances - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listBalances(options?: any): AxiosPromise { - return localVarFp - .listBalances(options) - .then((request) => request(axios, basePath)); - }, /** * Retrieves the balance of funds that are available for use. * @summary List all balances + * @param {string} [walletId] The wallet ID of the wallet for which to retrieve the balances. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBusinessBalances( + walletId?: string, options?: any ): AxiosPromise { return localVarFp - .listBusinessBalances(options) + .listBusinessBalances(walletId, options) .then((request) => request(axios, basePath)); } }; @@ -236,29 +166,17 @@ export const BalancesApiFactory = function ( * @extends {BaseAPI} */ export class BalancesApi extends BaseAPI { - /** - * Retrieves the balance of merchant funds that have settled and also of funds that have been sent for processing but have not yet settled. - * @summary List all balances - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof BalancesApi - */ - public listBalances(options?: AxiosRequestConfig) { - return BalancesApiFp(this.configuration) - .listBalances(options) - .then((request) => request(this.axios, this.basePath)); - } - /** * Retrieves the balance of funds that are available for use. * @summary List all balances + * @param {string} [walletId] The wallet ID of the wallet for which to retrieve the balances. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BalancesApi */ - public listBusinessBalances(options?: AxiosRequestConfig) { + public listBusinessBalances(walletId?: string, options?: AxiosRequestConfig) { return BalancesApiFp(this.configuration) - .listBusinessBalances(options) + .listBusinessBalances(walletId, options) .then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated/apis/cards-api.ts b/src/generated/apis/cards-api.ts deleted file mode 100644 index 12ade189..00000000 --- a/src/generated/apis/cards-api.ts +++ /dev/null @@ -1,566 +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 { CardCreationRequest } from "../models"; -// @ts-ignore -import { CardUpdate } from "../models"; -// @ts-ignore -import { CreateCardResponse } from "../models"; -// @ts-ignore -import { GetCardResponse } from "../models"; -// @ts-ignore -import { ListCardsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -// @ts-ignore -import { UpdateCardResponse } from "../models"; -/** - * CardsApi - axios parameter creator - * @export - */ -export const CardsApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a card - * @param {CardCreationRequest} [cardCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCard: async ( - cardCreationRequest?: CardCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/cards`; - // 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( - cardCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCard: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getCard", "id", id); - const localVarPath = `/v1/cards/{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 - }; - }, - /** - * - * @summary List all cards - * @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} - */ - listCards: async ( - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/cards`; - // 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 (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 - }; - }, - /** - * - * @summary Update a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CardUpdate} [cardUpdate] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateCard: async ( - id: string, - cardUpdate?: CardUpdate, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("updateCard", "id", id); - const localVarPath = `/v1/cards/{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: "PUT", - ...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( - cardUpdate, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * CardsApi - functional programming interface - * @export - */ -export const CardsApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = CardsApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a card - * @param {CardCreationRequest} [cardCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createCard( - cardCreationRequest?: CardCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.createCard( - cardCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCard( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCard( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary List all cards - * @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 listCards( - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listCards( - pageBefore, - pageAfter, - pageSize, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Update a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CardUpdate} [cardUpdate] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateCard( - id: string, - cardUpdate?: CardUpdate, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCard( - id, - cardUpdate, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * CardsApi - factory interface - * @export - */ -export const CardsApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = CardsApiFp(configuration); - return { - /** - * - * @summary Create a card - * @param {CardCreationRequest} [cardCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCard( - cardCreationRequest?: CardCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createCard(cardCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCard(id: string, options?: any): AxiosPromise { - return localVarFp - .getCard(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary List all cards - * @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} - */ - listCards( - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: any - ): AxiosPromise { - return localVarFp - .listCards(pageBefore, pageAfter, pageSize, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Update a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CardUpdate} [cardUpdate] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateCard( - id: string, - cardUpdate?: CardUpdate, - options?: any - ): AxiosPromise { - return localVarFp - .updateCard(id, cardUpdate, options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * CardsApi - object-oriented interface - * @export - * @class CardsApi - * @extends {BaseAPI} - */ -export class CardsApi extends BaseAPI { - /** - * - * @summary Create a card - * @param {CardCreationRequest} [cardCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CardsApi - */ - public createCard( - cardCreationRequest?: CardCreationRequest, - options?: AxiosRequestConfig - ) { - return CardsApiFp(this.configuration) - .createCard(cardCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CardsApi - */ - public getCard(id: string, options?: AxiosRequestConfig) { - return CardsApiFp(this.configuration) - .getCard(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List all cards - * @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 CardsApi - */ - public listCards( - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ) { - return CardsApiFp(this.configuration) - .listCards(pageBefore, pageAfter, pageSize, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Update a card - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CardUpdate} [cardUpdate] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CardsApi - */ - public updateCard( - id: string, - cardUpdate?: CardUpdate, - options?: AxiosRequestConfig - ) { - return CardsApiFp(this.configuration) - .updateCard(id, cardUpdate, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/channels-api.ts b/src/generated/apis/channels-api.ts deleted file mode 100644 index e9ec06f9..00000000 --- a/src/generated/apis/channels-api.ts +++ /dev/null @@ -1,170 +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 { ListChannelsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -/** - * ChannelsApi - axios parameter creator - * @export - */ -export const ChannelsApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.). - * @summary List all channels - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listChannels: async ( - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/channels`; - // 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 - }; - } - }; -}; - -/** - * ChannelsApi - functional programming interface - * @export - */ -export const ChannelsApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = ChannelsApiAxiosParamCreator(configuration); - return { - /** - * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.). - * @summary List all channels - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listChannels( - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listChannels( - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * ChannelsApi - factory interface - * @export - */ -export const ChannelsApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = ChannelsApiFp(configuration); - return { - /** - * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.). - * @summary List all channels - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listChannels(options?: any): AxiosPromise { - return localVarFp - .listChannels(options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * ChannelsApi - object-oriented interface - * @export - * @class ChannelsApi - * @extends {BaseAPI} - */ -export class ChannelsApi extends BaseAPI { - /** - * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.). - * @summary List all channels - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ChannelsApi - */ - public listChannels(options?: AxiosRequestConfig) { - return ChannelsApiFp(this.configuration) - .listChannels(options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/chargebacks-api.ts b/src/generated/apis/chargebacks-api.ts deleted file mode 100644 index be8e6790..00000000 --- a/src/generated/apis/chargebacks-api.ts +++ /dev/null @@ -1,501 +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 { Conflict } from "../models"; -// @ts-ignore -import { CreateMockChargebackResponse } from "../models"; -// @ts-ignore -import { GetChargebackResponse } from "../models"; -// @ts-ignore -import { ListChargebacksResponse } from "../models"; -// @ts-ignore -import { MockChargebackCreationRequest } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -/** - * ChargebacksApi - axios parameter creator - * @export - */ -export const ChargebacksApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * In the sandbox environment, initiate a mock chargeback of a specified payment. The entire payment will be charged back for its full value. The payment must be in the `paid` state (otherwise the endpoint will return a `404`), and each payment can only be charged back once (otherwise the endpoint will return a `409`). This endpoint is only available in the sandbox environment. - * @summary Create a mock chargeback - * @param {MockChargebackCreationRequest} [mockChargebackCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockChargeback: async ( - mockChargebackCreationRequest?: MockChargebackCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/mocks/cards/chargebacks`; - // 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( - mockChargebackCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a chargeback - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getChargeback: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getChargeback", "id", id); - const localVarPath = `/v1/chargebacks/{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 - }; - }, - /** - * Retrieve list of chargebacks. Results will be sorted by create date descending: more recent chargebacks will be at the beginning of the list. - * @summary List all chargebacks - * @param {string} [paymentId] The payment ID associated with the chargeback. - * @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} - */ - listChargebacks: async ( - paymentId?: string, - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/chargebacks`; - // 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 (paymentId !== undefined) { - localVarQueryParameter["paymentId"] = paymentId; - } - - 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 - }; - } - }; -}; - -/** - * ChargebacksApi - functional programming interface - * @export - */ -export const ChargebacksApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = - ChargebacksApiAxiosParamCreator(configuration); - return { - /** - * In the sandbox environment, initiate a mock chargeback of a specified payment. The entire payment will be charged back for its full value. The payment must be in the `paid` state (otherwise the endpoint will return a `404`), and each payment can only be charged back once (otherwise the endpoint will return a `409`). This endpoint is only available in the sandbox environment. - * @summary Create a mock chargeback - * @param {MockChargebackCreationRequest} [mockChargebackCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createMockChargeback( - mockChargebackCreationRequest?: MockChargebackCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createMockChargeback( - mockChargebackCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a chargeback - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getChargeback( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getChargeback( - id, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Retrieve list of chargebacks. Results will be sorted by create date descending: more recent chargebacks will be at the beginning of the list. - * @summary List all chargebacks - * @param {string} [paymentId] The payment ID associated with the chargeback. - * @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 listChargebacks( - paymentId?: string, - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listChargebacks( - paymentId, - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * ChargebacksApi - factory interface - * @export - */ -export const ChargebacksApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = ChargebacksApiFp(configuration); - return { - /** - * In the sandbox environment, initiate a mock chargeback of a specified payment. The entire payment will be charged back for its full value. The payment must be in the `paid` state (otherwise the endpoint will return a `404`), and each payment can only be charged back once (otherwise the endpoint will return a `409`). This endpoint is only available in the sandbox environment. - * @summary Create a mock chargeback - * @param {MockChargebackCreationRequest} [mockChargebackCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMockChargeback( - mockChargebackCreationRequest?: MockChargebackCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createMockChargeback(mockChargebackCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a chargeback - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getChargeback( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getChargeback(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * Retrieve list of chargebacks. Results will be sorted by create date descending: more recent chargebacks will be at the beginning of the list. - * @summary List all chargebacks - * @param {string} [paymentId] The payment ID associated with the chargeback. - * @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} - */ - listChargebacks( - paymentId?: string, - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: any - ): AxiosPromise { - return localVarFp - .listChargebacks( - paymentId, - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * ChargebacksApi - object-oriented interface - * @export - * @class ChargebacksApi - * @extends {BaseAPI} - */ -export class ChargebacksApi extends BaseAPI { - /** - * In the sandbox environment, initiate a mock chargeback of a specified payment. The entire payment will be charged back for its full value. The payment must be in the `paid` state (otherwise the endpoint will return a `404`), and each payment can only be charged back once (otherwise the endpoint will return a `409`). This endpoint is only available in the sandbox environment. - * @summary Create a mock chargeback - * @param {MockChargebackCreationRequest} [mockChargebackCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ChargebacksApi - */ - public createMockChargeback( - mockChargebackCreationRequest?: MockChargebackCreationRequest, - options?: AxiosRequestConfig - ) { - return ChargebacksApiFp(this.configuration) - .createMockChargeback(mockChargebackCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a chargeback - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ChargebacksApi - */ - public getChargeback(id: string, options?: AxiosRequestConfig) { - return ChargebacksApiFp(this.configuration) - .getChargeback(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve list of chargebacks. Results will be sorted by create date descending: more recent chargebacks will be at the beginning of the list. - * @summary List all chargebacks - * @param {string} [paymentId] The payment ID associated with the chargeback. - * @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 ChargebacksApi - */ - public listChargebacks( - paymentId?: string, - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ) { - return ChargebacksApiFp(this.configuration) - .listChargebacks( - paymentId, - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/checkout-sessions-api.ts b/src/generated/apis/checkout-sessions-api.ts deleted file mode 100644 index eb35e9e4..00000000 --- a/src/generated/apis/checkout-sessions-api.ts +++ /dev/null @@ -1,606 +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 { CheckoutSessionCreationRequest } from "../models"; -// @ts-ignore -import { CreateCheckoutSessionResponse } from "../models"; -// @ts-ignore -import { ExtendCheckoutSessionRequest } from "../models"; -// @ts-ignore -import { ExtendCheckoutSessionResponse } from "../models"; -// @ts-ignore -import { GetCheckoutSessionResponse } from "../models"; -// @ts-ignore -import { ListCheckoutSessionsResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -/** - * CheckoutSessionsApi - axios parameter creator - * @export - */ -export const CheckoutSessionsApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a checkout session - * @param {CheckoutSessionCreationRequest} [checkoutSessionCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCheckoutSession: async ( - checkoutSessionCreationRequest?: CheckoutSessionCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/checkoutSessions`; - // 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( - checkoutSessionCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Extend a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {ExtendCheckoutSessionRequest} [extendCheckoutSessionRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - extendCheckoutSession: async ( - id: string, - extendCheckoutSessionRequest?: ExtendCheckoutSessionRequest, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("extendCheckoutSession", "id", id); - const localVarPath = `/v1/checkoutSessions/{id}/extend`.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: "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( - extendCheckoutSessionRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCheckoutSession: async ( - id: string, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("getCheckoutSession", "id", id); - const localVarPath = `/v1/checkoutSessions/{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 - }; - }, - /** - * - * @summary List all checkout sessions - * @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} - */ - listCheckoutSessions: async ( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/checkoutSessions`; - // 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 - }; - } - }; -}; - -/** - * CheckoutSessionsApi - functional programming interface - * @export - */ -export const CheckoutSessionsApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = - CheckoutSessionsApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a checkout session - * @param {CheckoutSessionCreationRequest} [checkoutSessionCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createCheckoutSession( - checkoutSessionCreationRequest?: CheckoutSessionCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createCheckoutSession( - checkoutSessionCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Extend a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {ExtendCheckoutSessionRequest} [extendCheckoutSessionRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async extendCheckoutSession( - id: string, - extendCheckoutSessionRequest?: ExtendCheckoutSessionRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.extendCheckoutSession( - id, - extendCheckoutSessionRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCheckoutSession( - id: string, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getCheckoutSession(id, options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary List all checkout sessions - * @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 listCheckoutSessions( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.listCheckoutSessions( - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * CheckoutSessionsApi - factory interface - * @export - */ -export const CheckoutSessionsApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = CheckoutSessionsApiFp(configuration); - return { - /** - * - * @summary Create a checkout session - * @param {CheckoutSessionCreationRequest} [checkoutSessionCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCheckoutSession( - checkoutSessionCreationRequest?: CheckoutSessionCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createCheckoutSession(checkoutSessionCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Extend a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {ExtendCheckoutSessionRequest} [extendCheckoutSessionRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - extendCheckoutSession( - id: string, - extendCheckoutSessionRequest?: ExtendCheckoutSessionRequest, - options?: any - ): AxiosPromise { - return localVarFp - .extendCheckoutSession(id, extendCheckoutSessionRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCheckoutSession( - id: string, - options?: any - ): AxiosPromise { - return localVarFp - .getCheckoutSession(id, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary List all checkout sessions - * @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} - */ - listCheckoutSessions( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: any - ): AxiosPromise { - return localVarFp - .listCheckoutSessions( - from, - to, - pageBefore, - pageAfter, - pageSize, - options - ) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * CheckoutSessionsApi - object-oriented interface - * @export - * @class CheckoutSessionsApi - * @extends {BaseAPI} - */ -export class CheckoutSessionsApi extends BaseAPI { - /** - * - * @summary Create a checkout session - * @param {CheckoutSessionCreationRequest} [checkoutSessionCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CheckoutSessionsApi - */ - public createCheckoutSession( - checkoutSessionCreationRequest?: CheckoutSessionCreationRequest, - options?: AxiosRequestConfig - ) { - return CheckoutSessionsApiFp(this.configuration) - .createCheckoutSession(checkoutSessionCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Extend a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {ExtendCheckoutSessionRequest} [extendCheckoutSessionRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CheckoutSessionsApi - */ - public extendCheckoutSession( - id: string, - extendCheckoutSessionRequest?: ExtendCheckoutSessionRequest, - options?: AxiosRequestConfig - ) { - return CheckoutSessionsApiFp(this.configuration) - .extendCheckoutSession(id, extendCheckoutSessionRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a checkout session - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CheckoutSessionsApi - */ - public getCheckoutSession(id: string, options?: AxiosRequestConfig) { - return CheckoutSessionsApiFp(this.configuration) - .getCheckoutSession(id, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary List all checkout sessions - * @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 CheckoutSessionsApi - */ - public listCheckoutSessions( - from?: string, - to?: string, - pageBefore?: string, - pageAfter?: string, - pageSize?: number, - options?: AxiosRequestConfig - ) { - return CheckoutSessionsApiFp(this.configuration) - .listCheckoutSessions(from, to, pageBefore, pageAfter, pageSize, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/crypto-exchange-rates-api.ts b/src/generated/apis/crypto-exchange-rates-api.ts deleted file mode 100644 index 29b9f223..00000000 --- a/src/generated/apis/crypto-exchange-rates-api.ts +++ /dev/null @@ -1,191 +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 { GetExchangeRatesResponse } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -/** - * CryptoExchangeRatesApi - axios parameter creator - * @export - */ -export const CryptoExchangeRatesApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * Fetch the current rates for the specified trading pair. The trading pair is defined by a base currency followed by a quote currency. The response contains buy and sell rates denominated in the quote currency. **Exchange rate is an estimate only and is subject to change by the time you submit the actual request.** - * @summary Get a exchange rate - * @param {'BTC-USD' | 'ETH-USD' | 'FLOW-USD'} tradingPair - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getExchangeRates: async ( - tradingPair: "BTC-USD" | "ETH-USD" | "FLOW-USD", - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'tradingPair' is not null or undefined - assertParamExists("getExchangeRates", "tradingPair", tradingPair); - const localVarPath = `/v1/exchange/rates/{trading-pair}`.replace( - `{${"trading-pair"}}`, - encodeURIComponent(String(tradingPair)) - ); - // 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 - }; - } - }; -}; - -/** - * CryptoExchangeRatesApi - functional programming interface - * @export - */ -export const CryptoExchangeRatesApiFp = function ( - configuration?: Configuration -) { - const localVarAxiosParamCreator = - CryptoExchangeRatesApiAxiosParamCreator(configuration); - return { - /** - * Fetch the current rates for the specified trading pair. The trading pair is defined by a base currency followed by a quote currency. The response contains buy and sell rates denominated in the quote currency. **Exchange rate is an estimate only and is subject to change by the time you submit the actual request.** - * @summary Get a exchange rate - * @param {'BTC-USD' | 'ETH-USD' | 'FLOW-USD'} tradingPair - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getExchangeRates( - tradingPair: "BTC-USD" | "ETH-USD" | "FLOW-USD", - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getExchangeRates(tradingPair, options); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * CryptoExchangeRatesApi - factory interface - * @export - */ -export const CryptoExchangeRatesApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = CryptoExchangeRatesApiFp(configuration); - return { - /** - * Fetch the current rates for the specified trading pair. The trading pair is defined by a base currency followed by a quote currency. The response contains buy and sell rates denominated in the quote currency. **Exchange rate is an estimate only and is subject to change by the time you submit the actual request.** - * @summary Get a exchange rate - * @param {'BTC-USD' | 'ETH-USD' | 'FLOW-USD'} tradingPair - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getExchangeRates( - tradingPair: "BTC-USD" | "ETH-USD" | "FLOW-USD", - options?: any - ): AxiosPromise { - return localVarFp - .getExchangeRates(tradingPair, options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * CryptoExchangeRatesApi - object-oriented interface - * @export - * @class CryptoExchangeRatesApi - * @extends {BaseAPI} - */ -export class CryptoExchangeRatesApi extends BaseAPI { - /** - * Fetch the current rates for the specified trading pair. The trading pair is defined by a base currency followed by a quote currency. The response contains buy and sell rates denominated in the quote currency. **Exchange rate is an estimate only and is subject to change by the time you submit the actual request.** - * @summary Get a exchange rate - * @param {'BTC-USD' | 'ETH-USD' | 'FLOW-USD'} tradingPair - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CryptoExchangeRatesApi - */ - public getExchangeRates( - tradingPair: "BTC-USD" | "ETH-USD" | "FLOW-USD", - options?: AxiosRequestConfig - ) { - return CryptoExchangeRatesApiFp(this.configuration) - .getExchangeRates(tradingPair, 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 d3e9b899..40f4ea57 100644 --- a/src/generated/apis/deposits-api.ts +++ b/src/generated/apis/deposits-api.ts @@ -32,9 +32,13 @@ import { RequiredError } from "../base"; // @ts-ignore +import { BusinessDeposit } from "../models"; +// @ts-ignore import { ListBusinessDepositsResponse } from "../models"; // @ts-ignore import { NotAuthorized } from "../models"; +// @ts-ignore +import { NotFound } from "../models"; /** * DepositsApi - axios parameter creator * @export @@ -43,10 +47,73 @@ export const DepositsApiAxiosParamCreator = function ( configuration?: Configuration ) { return { + /** + * Returns a deposit by ID. + * @summary Get a deposit by ID + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {'wire'} [type] Filters results to get only deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBusinessDepositById: async ( + id: string, + type?: "wire", + walletId?: string, + options: AxiosRequestConfig = {} + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("getBusinessDepositById", "id", id); + const localVarPath = `/v1/businessAccount/deposits/{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); + + if (type !== undefined) { + localVarQueryParameter["type"] = type; + } + + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers + }; + + 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 * @param {'wire'} [type] Unique identifier for the deposit type. Filters results to fetch deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @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. @@ -57,6 +124,7 @@ export const DepositsApiAxiosParamCreator = function ( */ listBusinessDeposits: async ( type?: "wire", + walletId?: string, from?: string, to?: string, pageBefore?: string, @@ -88,6 +156,10 @@ export const DepositsApiAxiosParamCreator = function ( localVarQueryParameter["type"] = type; } + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + if (from !== undefined) { localVarQueryParameter["from"] = (from as any) instanceof Date ? (from as any).toISOString() : from; @@ -134,10 +206,45 @@ export const DepositsApiAxiosParamCreator = function ( export const DepositsApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = DepositsApiAxiosParamCreator(configuration); return { + /** + * Returns a deposit by ID. + * @summary Get a deposit by ID + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {'wire'} [type] Filters results to get only deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getBusinessDepositById( + id: string, + type?: "wire", + walletId?: string, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.getBusinessDepositById( + id, + type, + walletId, + 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 * @param {'wire'} [type] Unique identifier for the deposit type. Filters results to fetch deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @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. @@ -148,6 +255,7 @@ export const DepositsApiFp = function (configuration?: Configuration) { */ async listBusinessDeposits( type?: "wire", + walletId?: string, from?: string, to?: string, pageBefore?: string, @@ -163,6 +271,7 @@ export const DepositsApiFp = function (configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.listBusinessDeposits( type, + walletId, from, to, pageBefore, @@ -191,10 +300,30 @@ export const DepositsApiFactory = function ( ) { const localVarFp = DepositsApiFp(configuration); return { + /** + * Returns a deposit by ID. + * @summary Get a deposit by ID + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {'wire'} [type] Filters results to get only deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBusinessDepositById( + id: string, + type?: "wire", + walletId?: string, + options?: any + ): AxiosPromise { + return localVarFp + .getBusinessDepositById(id, type, walletId, 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 * @param {'wire'} [type] Unique identifier for the deposit type. Filters results to fetch deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @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. @@ -205,6 +334,7 @@ export const DepositsApiFactory = function ( */ listBusinessDeposits( type?: "wire", + walletId?: string, from?: string, to?: string, pageBefore?: string, @@ -215,6 +345,7 @@ export const DepositsApiFactory = function ( return localVarFp .listBusinessDeposits( type, + walletId, from, to, pageBefore, @@ -234,10 +365,32 @@ export const DepositsApiFactory = function ( * @extends {BaseAPI} */ export class DepositsApi extends BaseAPI { + /** + * Returns a deposit by ID. + * @summary Get a deposit by ID + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {'wire'} [type] Filters results to get only deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DepositsApi + */ + public getBusinessDepositById( + id: string, + type?: "wire", + walletId?: string, + options?: AxiosRequestConfig + ) { + return DepositsApiFp(this.configuration) + .getBusinessDepositById(id, type, walletId, 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 * @param {'wire'} [type] Unique identifier for the deposit type. Filters results to fetch deposits made by this specific type. + * @param {string} [walletId] The wallet ID to which the deposits were made. If not provided, the default is the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). * @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. @@ -249,6 +402,7 @@ export class DepositsApi extends BaseAPI { */ public listBusinessDeposits( type?: "wire", + walletId?: string, from?: string, to?: string, pageBefore?: string, @@ -259,6 +413,7 @@ export class DepositsApi extends BaseAPI { return DepositsApiFp(this.configuration) .listBusinessDeposits( type, + walletId, from, to, pageBefore, diff --git a/src/generated/apis/encryption-api.ts b/src/generated/apis/encryption-api.ts deleted file mode 100644 index 5d25feab..00000000 --- a/src/generated/apis/encryption-api.ts +++ /dev/null @@ -1,169 +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 { GetPublicKeyResponse } from "../models"; -/** - * EncryptionApi - axios parameter creator - * @export - */ -export const EncryptionApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more. - * @summary Get public key - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getPublicKey: async ( - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/encryption/public`; - // 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 - }; - } - }; -}; - -/** - * EncryptionApi - functional programming interface - * @export - */ -export const EncryptionApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = - EncryptionApiAxiosParamCreator(configuration); - return { - /** - * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more. - * @summary Get public key - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getPublicKey( - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicKey( - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * EncryptionApi - factory interface - * @export - */ -export const EncryptionApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = EncryptionApiFp(configuration); - return { - /** - * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more. - * @summary Get public key - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getPublicKey(options?: any): AxiosPromise { - return localVarFp - .getPublicKey(options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * EncryptionApi - object-oriented interface - * @export - * @class EncryptionApi - * @extends {BaseAPI} - */ -export class EncryptionApi extends BaseAPI { - /** - * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more. - * @summary Get public key - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof EncryptionApi - */ - public getPublicKey(options?: AxiosRequestConfig) { - return EncryptionApiFp(this.configuration) - .getPublicKey(options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/external-entities-api.ts b/src/generated/apis/external-entities-api.ts new file mode 100644 index 00000000..e9b3a6e8 --- /dev/null +++ b/src/generated/apis/external-entities-api.ts @@ -0,0 +1,436 @@ +/* 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 { Conflict } from "../models"; +// @ts-ignore +import { ExternalEntity } from "../models"; +// @ts-ignore +import { ExternalEntityCreationRequest } from "../models"; +// @ts-ignore +import { ListExternalEntitiesResponse } from "../models"; +// @ts-ignore +import { NotAuthorized } from "../models"; +/** + * ExternalEntitiesApi - axios parameter creator + * @export + */ +export const ExternalEntitiesApiAxiosParamCreator = function ( + configuration?: Configuration +) { + return { + /** + * Creates an external entity for the institutional account. To access the Core API for Institutions, contact your Circle account representative. + * @summary Create an external entity + * @param {ExternalEntityCreationRequest} [externalEntityCreationRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createExternalEntity: async ( + externalEntityCreationRequest?: ExternalEntityCreationRequest, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/externalEntities`; + // 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( + externalEntityCreationRequest, + localVarRequestOptions, + configuration + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + }, + /** + * Returns all external entities for the institutional account. To access the Core API for Institutions, contact your Circle account representative. Note that the `businessUniqueIdentifier` and `identifierIssuingCountryCode` must both be provided, or not at all. Only providing one will result in an error. + * @summary Get all external entities + * @param {string} [businessUniqueIdentifier] The unique identifier of the business. For example, a company number or tax ID. + * @param {string} [identifierIssuingCountryCode] The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllExternalEntities: async ( + businessUniqueIdentifier?: string, + identifierIssuingCountryCode?: string, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/externalEntities`; + // 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 (businessUniqueIdentifier !== undefined) { + localVarQueryParameter["businessUniqueIdentifier"] = + businessUniqueIdentifier; + } + + if (identifierIssuingCountryCode !== undefined) { + localVarQueryParameter["identifierIssuingCountryCode"] = + identifierIssuingCountryCode; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + }, + /** + * Returns an external entity by wallet ID. To access the Core API for Institutions, contact your Circle account representative. + * @summary Get an external entity by wallet ID + * @param {string} walletId The wallet ID of the external entity. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getExternalEntityByWalletId: async ( + walletId: string, + options: AxiosRequestConfig = {} + ): Promise => { + // verify required parameter 'walletId' is not null or undefined + assertParamExists("getExternalEntityByWalletId", "walletId", walletId); + const localVarPath = `/v1/externalEntities/{walletId}`.replace( + `{${"walletId"}}`, + encodeURIComponent(String(walletId)) + ); + // 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 + }; + } + }; +}; + +/** + * ExternalEntitiesApi - functional programming interface + * @export + */ +export const ExternalEntitiesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + ExternalEntitiesApiAxiosParamCreator(configuration); + return { + /** + * Creates an external entity for the institutional account. To access the Core API for Institutions, contact your Circle account representative. + * @summary Create an external entity + * @param {ExternalEntityCreationRequest} [externalEntityCreationRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createExternalEntity( + externalEntityCreationRequest?: ExternalEntityCreationRequest, + options?: AxiosRequestConfig + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.createExternalEntity( + externalEntityCreationRequest, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Returns all external entities for the institutional account. To access the Core API for Institutions, contact your Circle account representative. Note that the `businessUniqueIdentifier` and `identifierIssuingCountryCode` must both be provided, or not at all. Only providing one will result in an error. + * @summary Get all external entities + * @param {string} [businessUniqueIdentifier] The unique identifier of the business. For example, a company number or tax ID. + * @param {string} [identifierIssuingCountryCode] The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAllExternalEntities( + businessUniqueIdentifier?: string, + identifierIssuingCountryCode?: string, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.getAllExternalEntities( + businessUniqueIdentifier, + identifierIssuingCountryCode, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Returns an external entity by wallet ID. To access the Core API for Institutions, contact your Circle account representative. + * @summary Get an external entity by wallet ID + * @param {string} walletId The wallet ID of the external entity. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getExternalEntityByWalletId( + walletId: string, + options?: AxiosRequestConfig + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.getExternalEntityByWalletId( + walletId, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + } + }; +}; + +/** + * ExternalEntitiesApi - factory interface + * @export + */ +export const ExternalEntitiesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance +) { + const localVarFp = ExternalEntitiesApiFp(configuration); + return { + /** + * Creates an external entity for the institutional account. To access the Core API for Institutions, contact your Circle account representative. + * @summary Create an external entity + * @param {ExternalEntityCreationRequest} [externalEntityCreationRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createExternalEntity( + externalEntityCreationRequest?: ExternalEntityCreationRequest, + options?: any + ): AxiosPromise { + return localVarFp + .createExternalEntity(externalEntityCreationRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * Returns all external entities for the institutional account. To access the Core API for Institutions, contact your Circle account representative. Note that the `businessUniqueIdentifier` and `identifierIssuingCountryCode` must both be provided, or not at all. Only providing one will result in an error. + * @summary Get all external entities + * @param {string} [businessUniqueIdentifier] The unique identifier of the business. For example, a company number or tax ID. + * @param {string} [identifierIssuingCountryCode] The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllExternalEntities( + businessUniqueIdentifier?: string, + identifierIssuingCountryCode?: string, + options?: any + ): AxiosPromise { + return localVarFp + .getAllExternalEntities( + businessUniqueIdentifier, + identifierIssuingCountryCode, + options + ) + .then((request) => request(axios, basePath)); + }, + /** + * Returns an external entity by wallet ID. To access the Core API for Institutions, contact your Circle account representative. + * @summary Get an external entity by wallet ID + * @param {string} walletId The wallet ID of the external entity. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getExternalEntityByWalletId( + walletId: string, + options?: any + ): AxiosPromise { + return localVarFp + .getExternalEntityByWalletId(walletId, options) + .then((request) => request(axios, basePath)); + } + }; +}; + +/** + * ExternalEntitiesApi - object-oriented interface + * @export + * @class ExternalEntitiesApi + * @extends {BaseAPI} + */ +export class ExternalEntitiesApi extends BaseAPI { + /** + * Creates an external entity for the institutional account. To access the Core API for Institutions, contact your Circle account representative. + * @summary Create an external entity + * @param {ExternalEntityCreationRequest} [externalEntityCreationRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ExternalEntitiesApi + */ + public createExternalEntity( + externalEntityCreationRequest?: ExternalEntityCreationRequest, + options?: AxiosRequestConfig + ) { + return ExternalEntitiesApiFp(this.configuration) + .createExternalEntity(externalEntityCreationRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns all external entities for the institutional account. To access the Core API for Institutions, contact your Circle account representative. Note that the `businessUniqueIdentifier` and `identifierIssuingCountryCode` must both be provided, or not at all. Only providing one will result in an error. + * @summary Get all external entities + * @param {string} [businessUniqueIdentifier] The unique identifier of the business. For example, a company number or tax ID. + * @param {string} [identifierIssuingCountryCode] The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ExternalEntitiesApi + */ + public getAllExternalEntities( + businessUniqueIdentifier?: string, + identifierIssuingCountryCode?: string, + options?: AxiosRequestConfig + ) { + return ExternalEntitiesApiFp(this.configuration) + .getAllExternalEntities( + businessUniqueIdentifier, + identifierIssuingCountryCode, + options + ) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns an external entity by wallet ID. To access the Core API for Institutions, contact your Circle account representative. + * @summary Get an external entity by wallet ID + * @param {string} walletId The wallet ID of the external entity. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ExternalEntitiesApi + */ + public getExternalEntityByWalletId( + walletId: string, + options?: AxiosRequestConfig + ) { + return ExternalEntitiesApiFp(this.configuration) + .getExternalEntityByWalletId(walletId, options) + .then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/generated/apis/payments-api.ts b/src/generated/apis/payments-api.ts index 1449a6ad..2624d0c9 100644 --- a/src/generated/apis/payments-api.ts +++ b/src/generated/apis/payments-api.ts @@ -34,35 +34,21 @@ import { // @ts-ignore import { BadRequest } from "../models"; // @ts-ignore -import { CancelCreationRequest } from "../models"; -// @ts-ignore -import { CancelPaymentResponse } from "../models"; -// @ts-ignore -import { CaptureCreationRequest } from "../models"; -// @ts-ignore -import { CreatePaymentResponse } from "../models"; +import { CreatePixPaymentResponse } from "../models"; // @ts-ignore import { CreateWirePaymentResponse } from "../models"; // @ts-ignore -import { ExchangeRateRequest } from "../models"; -// @ts-ignore -import { FetchExchangeRateResponse } from "../models"; -// @ts-ignore import { GetPaymentResponse } from "../models"; // @ts-ignore import { ListPaymentsResponse } from "../models"; // @ts-ignore +import { MockPixPaymentRequest } from "../models"; +// @ts-ignore import { MockWirePaymentRequest } from "../models"; // @ts-ignore import { NotAuthorized } from "../models"; // @ts-ignore import { NotFound } from "../models"; -// @ts-ignore -import { PaymentCreationRequest } from "../models"; -// @ts-ignore -import { RefundCreationRequest } from "../models"; -// @ts-ignore -import { RefundPaymentResponse } from "../models"; /** * PaymentsApi - axios parameter creator * @export @@ -72,83 +58,17 @@ export const PaymentsApiAxiosParamCreator = function ( ) { return { /** - * The payment will be voided if possible meaning the payment source will not be charged & the payment will never settle. Otherwise, the payment will be refunded meaning the payment source will be charged & the payment will be refunded from deductions of future settlements. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been cancelled; it only means the cancellation request is successfully submitted. - * @summary Cancel a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CancelCreationRequest} [cancelCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancelPayment: async ( - id: string, - cancelCreationRequest?: CancelCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("cancelPayment", "id", id); - const localVarPath = `/v1/payments/{id}/cancel`.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: "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( - cancelCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * Warning: Please contact Circle support if you are planning on using this feature. The given amount will be captured for the authorized payment if possible. If no amount is specified, the full amount will be captured. You can only capture once per authorization. A successful response does *not* mean the payment has been captured. It only means the capture request was successfully submitted. - * @summary Capture a payment (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CaptureCreationRequest} [captureCreationRequest] + * Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet. + * @summary Create a mock PIX payment + * @param {MockPixPaymentRequest} [mockPixPaymentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - capturePayment: async ( - id: string, - captureCreationRequest?: CaptureCreationRequest, + createMockPixPayment: async ( + mockPixPaymentRequest?: MockPixPaymentRequest, options: AxiosRequestConfig = {} ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("capturePayment", "id", id); - const localVarPath = `/v1/payments/{id}/capture`.replace( - `{${"id"}}`, - encodeURIComponent(String(id)) - ); + const localVarPath = `/v1/mocks/payments/pix`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -179,7 +99,7 @@ export const PaymentsApiAxiosParamCreator = function ( ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded( - captureCreationRequest, + mockPixPaymentRequest, localVarRequestOptions, configuration ); @@ -241,110 +161,6 @@ export const PaymentsApiAxiosParamCreator = function ( options: localVarRequestOptions }; }, - /** - * - * @summary Create a payment - * @param {PaymentCreationRequest} [paymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createPayment: async ( - paymentCreationRequest?: PaymentCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/payments`; - // 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( - paymentCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. - * @summary Fetch exchange rate - * @param {ExchangeRateRequest} [exchangeRateRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - exchangeRate: async ( - exchangeRateRequest?: ExchangeRateRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/exchange/quotes`; - // 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( - exchangeRateRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, /** * * @summary Get a payment @@ -495,65 +311,6 @@ export const PaymentsApiAxiosParamCreator = function ( ...options.headers }; - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * The payment source will be refunded if possible. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been refunded; it only means the refund request is successfully submitted. - * @summary Refund a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {RefundCreationRequest} [refundCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - refundPayment: async ( - id: string, - refundCreationRequest?: RefundCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists("refundPayment", "id", id); - const localVarPath = `/v1/payments/{id}/refund`.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: "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( - refundCreationRequest, - localVarRequestOptions, - configuration - ); - return { url: toPathString(localVarUrlObj), options: localVarRequestOptions @@ -570,55 +327,26 @@ export const PaymentsApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration); return { /** - * The payment will be voided if possible meaning the payment source will not be charged & the payment will never settle. Otherwise, the payment will be refunded meaning the payment source will be charged & the payment will be refunded from deductions of future settlements. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been cancelled; it only means the cancellation request is successfully submitted. - * @summary Cancel a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CancelCreationRequest} [cancelCreationRequest] + * Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet. + * @summary Create a mock PIX payment + * @param {MockPixPaymentRequest} [mockPixPaymentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async cancelPayment( - id: string, - cancelCreationRequest?: CancelCreationRequest, + async createMockPixPayment( + mockPixPaymentRequest?: MockPixPaymentRequest, options?: AxiosRequestConfig ): Promise< ( axios?: AxiosInstance, basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelPayment( - id, - cancelCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Warning: Please contact Circle support if you are planning on using this feature. The given amount will be captured for the authorized payment if possible. If no amount is specified, the full amount will be captured. You can only capture once per authorization. A successful response does *not* mean the payment has been captured. It only means the capture request was successfully submitted. - * @summary Capture a payment (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CaptureCreationRequest} [captureCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async capturePayment( - id: string, - captureCreationRequest?: CaptureCreationRequest, - options?: AxiosRequestConfig - ): Promise< - (axios?: AxiosInstance, basePath?: string) => AxiosPromise + ) => AxiosPromise > { - const localVarAxiosArgs = await localVarAxiosParamCreator.capturePayment( - id, - captureCreationRequest, - options - ); + const localVarAxiosArgs = + await localVarAxiosParamCreator.createMockPixPayment( + mockPixPaymentRequest, + options + ); return createRequestFunction( localVarAxiosArgs, globalAxios, @@ -654,60 +382,6 @@ export const PaymentsApiFp = function (configuration?: Configuration) { configuration ); }, - /** - * - * @summary Create a payment - * @param {PaymentCreationRequest} [paymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createPayment( - paymentCreationRequest?: PaymentCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.createPayment( - paymentCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. - * @summary Fetch exchange rate - * @param {ExchangeRateRequest} [exchangeRateRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async exchangeRate( - exchangeRateRequest?: ExchangeRateRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.exchangeRate( - exchangeRateRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, /** * * @summary Get a payment @@ -788,36 +462,6 @@ export const PaymentsApiFp = function (configuration?: Configuration) { BASE_PATH, configuration ); - }, - /** - * The payment source will be refunded if possible. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been refunded; it only means the refund request is successfully submitted. - * @summary Refund a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {RefundCreationRequest} [refundCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async refundPayment( - id: string, - refundCreationRequest?: RefundCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.refundPayment( - id, - refundCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); } }; }; @@ -834,37 +478,18 @@ export const PaymentsApiFactory = function ( const localVarFp = PaymentsApiFp(configuration); return { /** - * The payment will be voided if possible meaning the payment source will not be charged & the payment will never settle. Otherwise, the payment will be refunded meaning the payment source will be charged & the payment will be refunded from deductions of future settlements. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been cancelled; it only means the cancellation request is successfully submitted. - * @summary Cancel a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CancelCreationRequest} [cancelCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancelPayment( - id: string, - cancelCreationRequest?: CancelCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .cancelPayment(id, cancelCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * Warning: Please contact Circle support if you are planning on using this feature. The given amount will be captured for the authorized payment if possible. If no amount is specified, the full amount will be captured. You can only capture once per authorization. A successful response does *not* mean the payment has been captured. It only means the capture request was successfully submitted. - * @summary Capture a payment (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CaptureCreationRequest} [captureCreationRequest] + * Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet. + * @summary Create a mock PIX payment + * @param {MockPixPaymentRequest} [mockPixPaymentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - capturePayment( - id: string, - captureCreationRequest?: CaptureCreationRequest, + createMockPixPayment( + mockPixPaymentRequest?: MockPixPaymentRequest, options?: any - ): AxiosPromise { + ): AxiosPromise { return localVarFp - .capturePayment(id, captureCreationRequest, options) + .createMockPixPayment(mockPixPaymentRequest, options) .then((request) => request(axios, basePath)); }, /** @@ -882,36 +507,6 @@ export const PaymentsApiFactory = function ( .createMockWirePayment(mockWirePaymentRequest, options) .then((request) => request(axios, basePath)); }, - /** - * - * @summary Create a payment - * @param {PaymentCreationRequest} [paymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createPayment( - paymentCreationRequest?: PaymentCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createPayment(paymentCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. - * @summary Fetch exchange rate - * @param {ExchangeRateRequest} [exchangeRateRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - exchangeRate( - exchangeRateRequest?: ExchangeRateRequest, - options?: any - ): AxiosPromise { - return localVarFp - .exchangeRate(exchangeRateRequest, options) - .then((request) => request(axios, basePath)); - }, /** * * @summary Get a payment @@ -968,23 +563,6 @@ export const PaymentsApiFactory = function ( options ) .then((request) => request(axios, basePath)); - }, - /** - * The payment source will be refunded if possible. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been refunded; it only means the refund request is successfully submitted. - * @summary Refund a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {RefundCreationRequest} [refundCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - refundPayment( - id: string, - refundCreationRequest?: RefundCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .refundPayment(id, refundCreationRequest, options) - .then((request) => request(axios, basePath)); } }; }; @@ -997,40 +575,19 @@ export const PaymentsApiFactory = function ( */ export class PaymentsApi extends BaseAPI { /** - * The payment will be voided if possible meaning the payment source will not be charged & the payment will never settle. Otherwise, the payment will be refunded meaning the payment source will be charged & the payment will be refunded from deductions of future settlements. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been cancelled; it only means the cancellation request is successfully submitted. - * @summary Cancel a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CancelCreationRequest} [cancelCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PaymentsApi - */ - public cancelPayment( - id: string, - cancelCreationRequest?: CancelCreationRequest, - options?: AxiosRequestConfig - ) { - return PaymentsApiFp(this.configuration) - .cancelPayment(id, cancelCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Warning: Please contact Circle support if you are planning on using this feature. The given amount will be captured for the authorized payment if possible. If no amount is specified, the full amount will be captured. You can only capture once per authorization. A successful response does *not* mean the payment has been captured. It only means the capture request was successfully submitted. - * @summary Capture a payment (BETA) - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {CaptureCreationRequest} [captureCreationRequest] + * Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet. + * @summary Create a mock PIX payment + * @param {MockPixPaymentRequest} [mockPixPaymentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PaymentsApi */ - public capturePayment( - id: string, - captureCreationRequest?: CaptureCreationRequest, + public createMockPixPayment( + mockPixPaymentRequest?: MockPixPaymentRequest, options?: AxiosRequestConfig ) { return PaymentsApiFp(this.configuration) - .capturePayment(id, captureCreationRequest, options) + .createMockPixPayment(mockPixPaymentRequest, options) .then((request) => request(this.axios, this.basePath)); } @@ -1051,40 +608,6 @@ export class PaymentsApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Create a payment - * @param {PaymentCreationRequest} [paymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PaymentsApi - */ - public createPayment( - paymentCreationRequest?: PaymentCreationRequest, - options?: AxiosRequestConfig - ) { - return PaymentsApiFp(this.configuration) - .createPayment(paymentCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. - * @summary Fetch exchange rate - * @param {ExchangeRateRequest} [exchangeRateRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PaymentsApi - */ - public exchangeRate( - exchangeRateRequest?: ExchangeRateRequest, - options?: AxiosRequestConfig - ) { - return PaymentsApiFp(this.configuration) - .exchangeRate(exchangeRateRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Get a payment @@ -1145,23 +668,4 @@ export class PaymentsApi extends BaseAPI { ) .then((request) => request(this.axios, this.basePath)); } - - /** - * The payment source will be refunded if possible. Not all payments are eligible to be cancelled. A successful response does *not* mean the payment has been refunded; it only means the refund request is successfully submitted. - * @summary Refund a payment - * @param {string} id Universally unique identifier (UUID v4) of a resource. - * @param {RefundCreationRequest} [refundCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PaymentsApi - */ - public refundPayment( - id: string, - refundCreationRequest?: RefundCreationRequest, - options?: AxiosRequestConfig - ) { - return PaymentsApiFp(this.configuration) - .refundPayment(id, refundCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } } diff --git a/src/generated/apis/payouts-api.ts b/src/generated/apis/payouts-api.ts index 330cfa1b..65cebc71 100644 --- a/src/generated/apis/payouts-api.ts +++ b/src/generated/apis/payouts-api.ts @@ -48,7 +48,7 @@ import { GetPayoutResponse } from "../models"; // @ts-ignore import { ListBurnFeeCalculationsResponse } from "../models"; // @ts-ignore -import { ListBusinessPayoutsResponse } from "../models"; +import { ListBusinessPayout } from "../models"; // @ts-ignore import { ListPayoutsResponse } from "../models"; // @ts-ignore @@ -68,7 +68,7 @@ export const PayoutsApiAxiosParamCreator = function ( ) { return { /** - * Create a payout. The following table includes the supported pairs of amount.currency and toAmount.currency for FX payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | BRL | + * Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency. * @summary Create a payout * @param {BusinessPayoutCreationRequest} [businessPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -120,7 +120,7 @@ export const PayoutsApiAxiosParamCreator = function ( }; }, /** - * 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 | + * 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 | | EUR | EUR | * @summary Create a payout * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -272,11 +272,12 @@ export const PayoutsApiAxiosParamCreator = function ( }; }, /** - * + * Lists all payouts for your account. Note that this endpoint does not return the tracking reference number for the payouts in the response. If you need that information you must get each payout individually by ID. * @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' | 'cubix'} [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} [sourceWalletId] Filters for payouts created from a specific source wallet. * @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. @@ -289,6 +290,7 @@ export const PayoutsApiAxiosParamCreator = function ( destination?: string, type?: "wire" | "cubix", status?: Set, + sourceWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -328,6 +330,10 @@ export const PayoutsApiAxiosParamCreator = function ( localVarQueryParameter["status"] = Array.from(status); } + if (sourceWalletId !== undefined) { + localVarQueryParameter["sourceWalletId"] = sourceWalletId; + } + if (from !== undefined) { localVarQueryParameter["from"] = (from as any) instanceof Date ? (from as any).toISOString() : from; @@ -365,9 +371,10 @@ export const PayoutsApiAxiosParamCreator = function ( }; }, /** - * Searches for NET burn fee daily calculations. This endpoint returns up to 50 daily fee amount calculations in descending chronological order or pageSize, if provided. - * @summary List all NET burn daily fee calculations - * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * Returns daily burn fee calculations. This endpoint returns up to 50 daily fee calculations in descending chronological order or `pageSize`, if provided. + * @summary List daily burn fee calculations + * @param {'gross' | 'net'} feeType Fee calculation type + * @param {string} [minimumFeeAmount] Burn fee calculations below this value are filtered. * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -378,6 +385,7 @@ export const PayoutsApiAxiosParamCreator = function ( * @throws {RequiredError} */ listNetBurnFeeDailyCalculations: async ( + feeType: "gross" | "net", minimumFeeAmount?: string, currency?: "USD" | "EUR", from?: string, @@ -387,7 +395,9 @@ export const PayoutsApiAxiosParamCreator = function ( pageSize?: number, options: AxiosRequestConfig = {} ): Promise => { - const localVarPath = `/v1/fees/redemption/net/dailyReports`; + // verify required parameter 'feeType' is not null or undefined + assertParamExists("listNetBurnFeeDailyCalculations", "feeType", feeType); + const localVarPath = `/v1/fees/redemption/dailyReports`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -411,6 +421,10 @@ export const PayoutsApiAxiosParamCreator = function ( localVarQueryParameter["minimumFeeAmount"] = minimumFeeAmount; } + if (feeType !== undefined) { + localVarQueryParameter["feeType"] = feeType; + } + if (currency !== undefined) { localVarQueryParameter["currency"] = currency; } @@ -460,7 +474,7 @@ export const PayoutsApiAxiosParamCreator = function ( * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [sourceCurrency] Queries items with the specified source currency `amount.currency`. Matches any source currency if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [destinationCurrency] Queries items with the specified destination currency `toAmount.currency`. Matches any destination currency if unspecified. - * @param {'ALGO' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'ETH' | 'HBAR' | 'NEAR' | 'NOBLE' | 'OP' | 'PAH' | 'POLY' | 'SOL' | 'SUI' | 'XLM' | 'ZKS'} [chain] Queries items with the specified chain. Matches any chain if unspecified + * @param {'ALGO' | 'APTOS' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'CODEX' | 'ETH' | 'HBAR' | 'HYPEREVM' | 'INK' | 'LINEA' | 'NEAR' | 'NOBLE' | 'OP' | 'PLUME' | 'PAH' | 'POLY' | 'SEI' | 'SOL' | 'SONIC' | 'SUI' | 'UNI' | 'WORLDCHAIN' | 'XDC' | 'XLM' | 'XRP' | 'ZKS' | 'ZKSYNC'} [chain] Queries items with the specified chain. Matches any chain 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. @@ -485,22 +499,35 @@ export const PayoutsApiAxiosParamCreator = function ( | "MAN", chain?: | "ALGO" + | "APTOS" | "ARB" | "AVAX" | "BASE" | "BTC" | "CELO" + | "CODEX" | "ETH" | "HBAR" + | "HYPEREVM" + | "INK" + | "LINEA" | "NEAR" | "NOBLE" | "OP" + | "PLUME" | "PAH" | "POLY" + | "SEI" | "SOL" + | "SONIC" | "SUI" + | "UNI" + | "WORLDCHAIN" + | "XDC" | "XLM" - | "ZKS", + | "XRP" + | "ZKS" + | "ZKSYNC", from?: string, to?: string, pageBefore?: string, @@ -603,7 +630,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = PayoutsApiAxiosParamCreator(configuration); return { /** - * Create a payout. The following table includes the supported pairs of amount.currency and toAmount.currency for FX payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | BRL | + * Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency. * @summary Create a payout * @param {BusinessPayoutCreationRequest} [businessPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -631,7 +658,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { ); }, /** - * 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 | + * 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 | | EUR | EUR | * @summary Create a payout * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -710,11 +737,12 @@ export const PayoutsApiFp = function (configuration?: Configuration) { ); }, /** - * + * Lists all payouts for your account. Note that this endpoint does not return the tracking reference number for the payouts in the response. If you need that information you must get each payout individually by ID. * @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' | 'cubix'} [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} [sourceWalletId] Filters for payouts created from a specific source wallet. * @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. @@ -727,6 +755,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { destination?: string, type?: "wire" | "cubix", status?: Set, + sourceWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -737,13 +766,14 @@ export const PayoutsApiFp = function (configuration?: Configuration) { ( axios?: AxiosInstance, basePath?: string - ) => AxiosPromise + ) => AxiosPromise > { const localVarAxiosArgs = await localVarAxiosParamCreator.listBusinessPayouts( destination, type, status, + sourceWalletId, from, to, pageBefore, @@ -759,9 +789,10 @@ export const PayoutsApiFp = function (configuration?: Configuration) { ); }, /** - * Searches for NET burn fee daily calculations. This endpoint returns up to 50 daily fee amount calculations in descending chronological order or pageSize, if provided. - * @summary List all NET burn daily fee calculations - * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * Returns daily burn fee calculations. This endpoint returns up to 50 daily fee calculations in descending chronological order or `pageSize`, if provided. + * @summary List daily burn fee calculations + * @param {'gross' | 'net'} feeType Fee calculation type + * @param {string} [minimumFeeAmount] Burn fee calculations below this value are filtered. * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -772,6 +803,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async listNetBurnFeeDailyCalculations( + feeType: "gross" | "net", minimumFeeAmount?: string, currency?: "USD" | "EUR", from?: string, @@ -788,6 +820,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { > { const localVarAxiosArgs = await localVarAxiosParamCreator.listNetBurnFeeDailyCalculations( + feeType, minimumFeeAmount, currency, from, @@ -813,7 +846,7 @@ export const PayoutsApiFp = function (configuration?: Configuration) { * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [sourceCurrency] Queries items with the specified source currency `amount.currency`. Matches any source currency if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [destinationCurrency] Queries items with the specified destination currency `toAmount.currency`. Matches any destination currency if unspecified. - * @param {'ALGO' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'ETH' | 'HBAR' | 'NEAR' | 'NOBLE' | 'OP' | 'PAH' | 'POLY' | 'SOL' | 'SUI' | 'XLM' | 'ZKS'} [chain] Queries items with the specified chain. Matches any chain if unspecified + * @param {'ALGO' | 'APTOS' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'CODEX' | 'ETH' | 'HBAR' | 'HYPEREVM' | 'INK' | 'LINEA' | 'NEAR' | 'NOBLE' | 'OP' | 'PLUME' | 'PAH' | 'POLY' | 'SEI' | 'SOL' | 'SONIC' | 'SUI' | 'UNI' | 'WORLDCHAIN' | 'XDC' | 'XLM' | 'XRP' | 'ZKS' | 'ZKSYNC'} [chain] Queries items with the specified chain. Matches any chain 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. @@ -838,22 +871,35 @@ export const PayoutsApiFp = function (configuration?: Configuration) { | "MAN", chain?: | "ALGO" + | "APTOS" | "ARB" | "AVAX" | "BASE" | "BTC" | "CELO" + | "CODEX" | "ETH" | "HBAR" + | "HYPEREVM" + | "INK" + | "LINEA" | "NEAR" | "NOBLE" | "OP" + | "PLUME" | "PAH" | "POLY" + | "SEI" | "SOL" + | "SONIC" | "SUI" + | "UNI" + | "WORLDCHAIN" + | "XDC" | "XLM" - | "ZKS", + | "XRP" + | "ZKS" + | "ZKSYNC", from?: string, to?: string, pageBefore?: string, @@ -903,7 +949,7 @@ export const PayoutsApiFactory = function ( const localVarFp = PayoutsApiFp(configuration); return { /** - * Create a payout. The following table includes the supported pairs of amount.currency and toAmount.currency for FX payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | BRL | + * Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency. * @summary Create a payout * @param {BusinessPayoutCreationRequest} [businessPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -918,7 +964,7 @@ export const PayoutsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * 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 | + * 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 | | EUR | EUR | * @summary Create a payout * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -960,11 +1006,12 @@ export const PayoutsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * + * Lists all payouts for your account. Note that this endpoint does not return the tracking reference number for the payouts in the response. If you need that information you must get each payout individually by ID. * @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' | 'cubix'} [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} [sourceWalletId] Filters for payouts created from a specific source wallet. * @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. @@ -977,18 +1024,20 @@ export const PayoutsApiFactory = function ( destination?: string, type?: "wire" | "cubix", status?: Set, + sourceWalletId?: string, from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: any - ): AxiosPromise { + ): AxiosPromise { return localVarFp .listBusinessPayouts( destination, type, status, + sourceWalletId, from, to, pageBefore, @@ -999,9 +1048,10 @@ export const PayoutsApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Searches for NET burn fee daily calculations. This endpoint returns up to 50 daily fee amount calculations in descending chronological order or pageSize, if provided. - * @summary List all NET burn daily fee calculations - * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * Returns daily burn fee calculations. This endpoint returns up to 50 daily fee calculations in descending chronological order or `pageSize`, if provided. + * @summary List daily burn fee calculations + * @param {'gross' | 'net'} feeType Fee calculation type + * @param {string} [minimumFeeAmount] Burn fee calculations below this value are filtered. * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -1012,6 +1062,7 @@ export const PayoutsApiFactory = function ( * @throws {RequiredError} */ listNetBurnFeeDailyCalculations( + feeType: "gross" | "net", minimumFeeAmount?: string, currency?: "USD" | "EUR", from?: string, @@ -1023,6 +1074,7 @@ export const PayoutsApiFactory = function ( ): AxiosPromise { return localVarFp .listNetBurnFeeDailyCalculations( + feeType, minimumFeeAmount, currency, from, @@ -1043,7 +1095,7 @@ export const PayoutsApiFactory = function ( * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [sourceCurrency] Queries items with the specified source currency `amount.currency`. Matches any source currency if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [destinationCurrency] Queries items with the specified destination currency `toAmount.currency`. Matches any destination currency if unspecified. - * @param {'ALGO' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'ETH' | 'HBAR' | 'NEAR' | 'NOBLE' | 'OP' | 'PAH' | 'POLY' | 'SOL' | 'SUI' | 'XLM' | 'ZKS'} [chain] Queries items with the specified chain. Matches any chain if unspecified + * @param {'ALGO' | 'APTOS' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'CODEX' | 'ETH' | 'HBAR' | 'HYPEREVM' | 'INK' | 'LINEA' | 'NEAR' | 'NOBLE' | 'OP' | 'PLUME' | 'PAH' | 'POLY' | 'SEI' | 'SOL' | 'SONIC' | 'SUI' | 'UNI' | 'WORLDCHAIN' | 'XDC' | 'XLM' | 'XRP' | 'ZKS' | 'ZKSYNC'} [chain] Queries items with the specified chain. Matches any chain 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. @@ -1068,22 +1120,35 @@ export const PayoutsApiFactory = function ( | "MAN", chain?: | "ALGO" + | "APTOS" | "ARB" | "AVAX" | "BASE" | "BTC" | "CELO" + | "CODEX" | "ETH" | "HBAR" + | "HYPEREVM" + | "INK" + | "LINEA" | "NEAR" | "NOBLE" | "OP" + | "PLUME" | "PAH" | "POLY" + | "SEI" | "SOL" + | "SONIC" | "SUI" + | "UNI" + | "WORLDCHAIN" + | "XDC" | "XLM" - | "ZKS", + | "XRP" + | "ZKS" + | "ZKSYNC", from?: string, to?: string, pageBefore?: string, @@ -1120,7 +1185,7 @@ export const PayoutsApiFactory = function ( */ export class PayoutsApi extends BaseAPI { /** - * Create a payout. The following table includes the supported pairs of amount.currency and toAmount.currency for FX payouts: | amount.currency | toAmount.currency | | ---------------- | ------------ | | USD | BRL | + * Create a redemption (offramp) payout. This payout converts a digital asset to fiat currency. * @summary Create a payout * @param {BusinessPayoutCreationRequest} [businessPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -1137,7 +1202,7 @@ export class PayoutsApi extends BaseAPI { } /** - * 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 | + * 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 | | EUR | EUR | * @summary Create a payout * @param {CryptoPayoutCreationRequest} [cryptoPayoutCreationRequest] * @param {*} [options] Override http request option. @@ -1182,11 +1247,12 @@ export class PayoutsApi extends BaseAPI { } /** - * + * Lists all payouts for your account. Note that this endpoint does not return the tracking reference number for the payouts in the response. If you need that information you must get each payout individually by ID. * @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' | 'cubix'} [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} [sourceWalletId] Filters for payouts created from a specific source wallet. * @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. @@ -1200,6 +1266,7 @@ export class PayoutsApi extends BaseAPI { destination?: string, type?: "wire" | "cubix", status?: Set, + sourceWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -1212,6 +1279,7 @@ export class PayoutsApi extends BaseAPI { destination, type, status, + sourceWalletId, from, to, pageBefore, @@ -1223,9 +1291,10 @@ export class PayoutsApi extends BaseAPI { } /** - * Searches for NET burn fee daily calculations. This endpoint returns up to 50 daily fee amount calculations in descending chronological order or pageSize, if provided. - * @summary List all NET burn daily fee calculations - * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * Returns daily burn fee calculations. This endpoint returns up to 50 daily fee calculations in descending chronological order or `pageSize`, if provided. + * @summary List daily burn fee calculations + * @param {'gross' | 'net'} feeType Fee calculation type + * @param {string} [minimumFeeAmount] Burn fee calculations below this value are filtered. * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). @@ -1237,6 +1306,7 @@ export class PayoutsApi extends BaseAPI { * @memberof PayoutsApi */ public listNetBurnFeeDailyCalculations( + feeType: "gross" | "net", minimumFeeAmount?: string, currency?: "USD" | "EUR", from?: string, @@ -1248,6 +1318,7 @@ export class PayoutsApi extends BaseAPI { ) { return PayoutsApiFp(this.configuration) .listNetBurnFeeDailyCalculations( + feeType, minimumFeeAmount, currency, from, @@ -1269,7 +1340,7 @@ export class PayoutsApi extends BaseAPI { * @param {Set} [status] Queries items with the specified status. Matches any status if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [sourceCurrency] Queries items with the specified source currency `amount.currency`. Matches any source currency if unspecified. * @param {'USD' | 'EUR' | 'BTC' | 'ETH' | 'MTC' | 'FLW' | 'MAN'} [destinationCurrency] Queries items with the specified destination currency `toAmount.currency`. Matches any destination currency if unspecified. - * @param {'ALGO' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'ETH' | 'HBAR' | 'NEAR' | 'NOBLE' | 'OP' | 'PAH' | 'POLY' | 'SOL' | 'SUI' | 'XLM' | 'ZKS'} [chain] Queries items with the specified chain. Matches any chain if unspecified + * @param {'ALGO' | 'APTOS' | 'ARB' | 'AVAX' | 'BASE' | 'BTC' | 'CELO' | 'CODEX' | 'ETH' | 'HBAR' | 'HYPEREVM' | 'INK' | 'LINEA' | 'NEAR' | 'NOBLE' | 'OP' | 'PLUME' | 'PAH' | 'POLY' | 'SEI' | 'SOL' | 'SONIC' | 'SUI' | 'UNI' | 'WORLDCHAIN' | 'XDC' | 'XLM' | 'XRP' | 'ZKS' | 'ZKSYNC'} [chain] Queries items with the specified chain. Matches any chain 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. @@ -1288,22 +1359,35 @@ export class PayoutsApi extends BaseAPI { destinationCurrency?: "USD" | "EUR" | "BTC" | "ETH" | "MTC" | "FLW" | "MAN", chain?: | "ALGO" + | "APTOS" | "ARB" | "AVAX" | "BASE" | "BTC" | "CELO" + | "CODEX" | "ETH" | "HBAR" + | "HYPEREVM" + | "INK" + | "LINEA" | "NEAR" | "NOBLE" | "OP" + | "PLUME" | "PAH" | "POLY" + | "SEI" | "SOL" + | "SONIC" | "SUI" + | "UNI" + | "WORLDCHAIN" + | "XDC" | "XLM" - | "ZKS", + | "XRP" + | "ZKS" + | "ZKSYNC", from?: string, to?: string, pageBefore?: string, diff --git a/src/generated/apis/pull-crypto-payments-api.ts b/src/generated/apis/pull-crypto-payments-api.ts deleted file mode 100644 index a6c837e4..00000000 --- a/src/generated/apis/pull-crypto-payments-api.ts +++ /dev/null @@ -1,353 +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 { CreateCryptoPaymentResponse } from "../models"; -// @ts-ignore -import { CreateCryptoPaymentResponse1 } from "../models"; -// @ts-ignore -import { CryptoPaymentCreationRequest } from "../models"; -// @ts-ignore -import { NotAuthorized } from "../models"; -// @ts-ignore -import { NotFound } from "../models"; -/** - * PullCryptoPaymentsApi - axios parameter creator - * @export - */ -export const PullCryptoPaymentsApiAxiosParamCreator = function ( - configuration?: Configuration -) { - return { - /** - * - * @summary Create a crypto payment - * @param {CryptoPaymentCreationRequest} [cryptoPaymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCryptoPayment: async ( - cryptoPaymentCreationRequest?: CryptoPaymentCreationRequest, - options: AxiosRequestConfig = {} - ): Promise => { - const localVarPath = `/v1/payments/crypto`; - // 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( - cryptoPaymentCreationRequest, - localVarRequestOptions, - configuration - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - }, - /** - * - * @summary Get a typed message for signing - * @param {string} endUserAddress User wallet address - * @param {string} paymentIntentId Payment intent id which is from the create payment intent endpoint response - * @param {string} [amount] - * @param {'USD'} [currency] Only support USD at the moment - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - presign: async ( - endUserAddress: string, - paymentIntentId: string, - amount?: string, - currency?: "USD", - options: AxiosRequestConfig = {} - ): Promise => { - // verify required parameter 'endUserAddress' is not null or undefined - assertParamExists("presign", "endUserAddress", endUserAddress); - // verify required parameter 'paymentIntentId' is not null or undefined - assertParamExists("presign", "paymentIntentId", paymentIntentId); - const localVarPath = `/v1/payments/presign`; - // 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 (endUserAddress !== undefined) { - localVarQueryParameter["endUserAddress"] = endUserAddress; - } - - if (paymentIntentId !== undefined) { - localVarQueryParameter["paymentIntentId"] = paymentIntentId; - } - - if (amount !== undefined) { - localVarQueryParameter["amount"] = amount; - } - - if (currency !== undefined) { - localVarQueryParameter["currency"] = currency; - } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = - baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions - }; - } - }; -}; - -/** - * PullCryptoPaymentsApi - functional programming interface - * @export - */ -export const PullCryptoPaymentsApiFp = function ( - configuration?: Configuration -) { - const localVarAxiosParamCreator = - PullCryptoPaymentsApiAxiosParamCreator(configuration); - return { - /** - * - * @summary Create a crypto payment - * @param {CryptoPaymentCreationRequest} [cryptoPaymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createCryptoPayment( - cryptoPaymentCreationRequest?: CryptoPaymentCreationRequest, - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = - await localVarAxiosParamCreator.createCryptoPayment( - cryptoPaymentCreationRequest, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - }, - /** - * - * @summary Get a typed message for signing - * @param {string} endUserAddress User wallet address - * @param {string} paymentIntentId Payment intent id which is from the create payment intent endpoint response - * @param {string} [amount] - * @param {'USD'} [currency] Only support USD at the moment - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async presign( - endUserAddress: string, - paymentIntentId: string, - amount?: string, - currency?: "USD", - options?: AxiosRequestConfig - ): Promise< - ( - axios?: AxiosInstance, - basePath?: string - ) => AxiosPromise - > { - const localVarAxiosArgs = await localVarAxiosParamCreator.presign( - endUserAddress, - paymentIntentId, - amount, - currency, - options - ); - return createRequestFunction( - localVarAxiosArgs, - globalAxios, - BASE_PATH, - configuration - ); - } - }; -}; - -/** - * PullCryptoPaymentsApi - factory interface - * @export - */ -export const PullCryptoPaymentsApiFactory = function ( - configuration?: Configuration, - basePath?: string, - axios?: AxiosInstance -) { - const localVarFp = PullCryptoPaymentsApiFp(configuration); - return { - /** - * - * @summary Create a crypto payment - * @param {CryptoPaymentCreationRequest} [cryptoPaymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCryptoPayment( - cryptoPaymentCreationRequest?: CryptoPaymentCreationRequest, - options?: any - ): AxiosPromise { - return localVarFp - .createCryptoPayment(cryptoPaymentCreationRequest, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get a typed message for signing - * @param {string} endUserAddress User wallet address - * @param {string} paymentIntentId Payment intent id which is from the create payment intent endpoint response - * @param {string} [amount] - * @param {'USD'} [currency] Only support USD at the moment - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - presign( - endUserAddress: string, - paymentIntentId: string, - amount?: string, - currency?: "USD", - options?: any - ): AxiosPromise { - return localVarFp - .presign(endUserAddress, paymentIntentId, amount, currency, options) - .then((request) => request(axios, basePath)); - } - }; -}; - -/** - * PullCryptoPaymentsApi - object-oriented interface - * @export - * @class PullCryptoPaymentsApi - * @extends {BaseAPI} - */ -export class PullCryptoPaymentsApi extends BaseAPI { - /** - * - * @summary Create a crypto payment - * @param {CryptoPaymentCreationRequest} [cryptoPaymentCreationRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PullCryptoPaymentsApi - */ - public createCryptoPayment( - cryptoPaymentCreationRequest?: CryptoPaymentCreationRequest, - options?: AxiosRequestConfig - ) { - return PullCryptoPaymentsApiFp(this.configuration) - .createCryptoPayment(cryptoPaymentCreationRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Get a typed message for signing - * @param {string} endUserAddress User wallet address - * @param {string} paymentIntentId Payment intent id which is from the create payment intent endpoint response - * @param {string} [amount] - * @param {'USD'} [currency] Only support USD at the moment - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PullCryptoPaymentsApi - */ - public presign( - endUserAddress: string, - paymentIntentId: string, - amount?: string, - currency?: "USD", - options?: AxiosRequestConfig - ) { - return PullCryptoPaymentsApiFp(this.configuration) - .presign(endUserAddress, paymentIntentId, amount, currency, options) - .then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/generated/apis/payment-tokens-api.ts b/src/generated/apis/reserve-management-api.ts similarity index 54% rename from src/generated/apis/payment-tokens-api.ts rename to src/generated/apis/reserve-management-api.ts index cadcb0e4..f34aa5fd 100644 --- a/src/generated/apis/payment-tokens-api.ts +++ b/src/generated/apis/reserve-management-api.ts @@ -34,31 +34,37 @@ import { // @ts-ignore import { BadRequest } from "../models"; // @ts-ignore -import { CreatePaymentTokenResponse } from "../models"; +import { Conflict } from "../models"; // @ts-ignore -import { NotAuthorized } from "../models"; +import { DailyCustodyBalancesRequest } from "../models"; +// @ts-ignore +import { DuplicateRequest } from "../models"; +// @ts-ignore +import { Forbidden } from "../models"; // @ts-ignore -import { PaymentTokenRequest } from "../models"; +import { NewReportSuccess } from "../models"; +// @ts-ignore +import { NotAuthorized } from "../models"; /** - * PaymentTokensApi - axios parameter creator + * ReserveManagementApi - axios parameter creator * @export */ -export const PaymentTokensApiAxiosParamCreator = function ( +export const ReserveManagementApiAxiosParamCreator = function ( configuration?: Configuration ) { return { /** - * Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token. - * @summary Create a payment token - * @param {PaymentTokenRequest} [paymentTokenRequest] + * Creates a daily custody balance report for USDC and EURC and sends it to Circle. **Note:** Only one report is allowed per day per currency. + * @summary Create daily custody balance report + * @param {DailyCustodyBalancesRequest} [dailyCustodyBalancesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createPaymentToken: async ( - paymentTokenRequest?: PaymentTokenRequest, + reportDailyCustodyBalances: async ( + dailyCustodyBalancesRequest?: DailyCustodyBalancesRequest, options: AxiosRequestConfig = {} ): Promise => { - const localVarPath = `/v1/paymentTokens`; + const localVarPath = `/v2/reserveManagement/dailyCustodyBalances`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -89,7 +95,7 @@ export const PaymentTokensApiAxiosParamCreator = function ( ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded( - paymentTokenRequest, + dailyCustodyBalancesRequest, localVarRequestOptions, configuration ); @@ -103,32 +109,32 @@ export const PaymentTokensApiAxiosParamCreator = function ( }; /** - * PaymentTokensApi - functional programming interface + * ReserveManagementApi - functional programming interface * @export */ -export const PaymentTokensApiFp = function (configuration?: Configuration) { +export const ReserveManagementApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = - PaymentTokensApiAxiosParamCreator(configuration); + ReserveManagementApiAxiosParamCreator(configuration); return { /** - * Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token. - * @summary Create a payment token - * @param {PaymentTokenRequest} [paymentTokenRequest] + * Creates a daily custody balance report for USDC and EURC and sends it to Circle. **Note:** Only one report is allowed per day per currency. + * @summary Create daily custody balance report + * @param {DailyCustodyBalancesRequest} [dailyCustodyBalancesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async createPaymentToken( - paymentTokenRequest?: PaymentTokenRequest, + async reportDailyCustodyBalances( + dailyCustodyBalancesRequest?: DailyCustodyBalancesRequest, options?: AxiosRequestConfig ): Promise< ( axios?: AxiosInstance, basePath?: string - ) => AxiosPromise + ) => AxiosPromise > { const localVarAxiosArgs = - await localVarAxiosParamCreator.createPaymentToken( - paymentTokenRequest, + await localVarAxiosParamCreator.reportDailyCustodyBalances( + dailyCustodyBalancesRequest, options ); return createRequestFunction( @@ -142,55 +148,55 @@ export const PaymentTokensApiFp = function (configuration?: Configuration) { }; /** - * PaymentTokensApi - factory interface + * ReserveManagementApi - factory interface * @export */ -export const PaymentTokensApiFactory = function ( +export const ReserveManagementApiFactory = function ( configuration?: Configuration, basePath?: string, axios?: AxiosInstance ) { - const localVarFp = PaymentTokensApiFp(configuration); + const localVarFp = ReserveManagementApiFp(configuration); return { /** - * Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token. - * @summary Create a payment token - * @param {PaymentTokenRequest} [paymentTokenRequest] + * Creates a daily custody balance report for USDC and EURC and sends it to Circle. **Note:** Only one report is allowed per day per currency. + * @summary Create daily custody balance report + * @param {DailyCustodyBalancesRequest} [dailyCustodyBalancesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createPaymentToken( - paymentTokenRequest?: PaymentTokenRequest, + reportDailyCustodyBalances( + dailyCustodyBalancesRequest?: DailyCustodyBalancesRequest, options?: any - ): AxiosPromise { + ): AxiosPromise { return localVarFp - .createPaymentToken(paymentTokenRequest, options) + .reportDailyCustodyBalances(dailyCustodyBalancesRequest, options) .then((request) => request(axios, basePath)); } }; }; /** - * PaymentTokensApi - object-oriented interface + * ReserveManagementApi - object-oriented interface * @export - * @class PaymentTokensApi + * @class ReserveManagementApi * @extends {BaseAPI} */ -export class PaymentTokensApi extends BaseAPI { +export class ReserveManagementApi extends BaseAPI { /** - * Convert a digital wallet (Apple Pay, Google Pay) token to a single-use payment token. - * @summary Create a payment token - * @param {PaymentTokenRequest} [paymentTokenRequest] + * Creates a daily custody balance report for USDC and EURC and sends it to Circle. **Note:** Only one report is allowed per day per currency. + * @summary Create daily custody balance report + * @param {DailyCustodyBalancesRequest} [dailyCustodyBalancesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PaymentTokensApi + * @memberof ReserveManagementApi */ - public createPaymentToken( - paymentTokenRequest?: PaymentTokenRequest, + public reportDailyCustodyBalances( + dailyCustodyBalancesRequest?: DailyCustodyBalancesRequest, options?: AxiosRequestConfig ) { - return PaymentTokensApiFp(this.configuration) - .createPaymentToken(paymentTokenRequest, options) + return ReserveManagementApiFp(this.configuration) + .reportDailyCustodyBalances(dailyCustodyBalancesRequest, options) .then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated/apis/settlements-api.ts b/src/generated/apis/settlements-api.ts index fc2139a6..3f261dd4 100644 --- a/src/generated/apis/settlements-api.ts +++ b/src/generated/apis/settlements-api.ts @@ -32,13 +32,17 @@ import { RequiredError } from "../base"; // @ts-ignore -import { GetSettlementResponse } from "../models"; +import { GetSettlementIdResponse } from "../models"; +// @ts-ignore +import { GetSettlementInstructionsResponse } from "../models"; // @ts-ignore import { GetSettlementsResponse } from "../models"; // @ts-ignore import { NotAuthorized } from "../models"; // @ts-ignore import { NotFound } from "../models"; +// @ts-ignore +import { SettlementStatus } from "../models"; /** * SettlementsApi - axios parameter creator * @export @@ -48,19 +52,19 @@ export const SettlementsApiAxiosParamCreator = function ( ) { return { /** - * - * @summary Get a settlement + * Returns a settlement by ID. + * @summary Get settlement * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSettlement: async ( + getSettlementId: async ( id: string, options: AxiosRequestConfig = {} ): Promise => { // verify required parameter 'id' is not null or undefined - assertParamExists("getSettlement", "id", id); - const localVarPath = `/v1/settlements/{id}`.replace( + assertParamExists("getSettlementId", "id", id); + const localVarPath = `/v1/exchange/trades/settlements/{id}`.replace( `{${"id"}}`, encodeURIComponent(String(id)) ); @@ -98,25 +102,82 @@ export const SettlementsApiAxiosParamCreator = function ( }; }, /** - * - * @summary List all settlements + * Returns settlement instructions for a specific currency. + * @summary Get settlement instructions + * @param {'BRL' | 'MXN'} currency Fiat currency name. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSettlementInstructions: async ( + currency: "BRL" | "MXN", + options: AxiosRequestConfig = {} + ): Promise => { + // verify required parameter 'currency' is not null or undefined + assertParamExists("getSettlementInstructions", "currency", currency); + const localVarPath = + `/v1/exchange/trades/settlements/instructions/{currency}`.replace( + `{${"currency"}}`, + encodeURIComponent(String(currency)) + ); + // 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 + }; + }, + /** + * Returns all settlements. + * @summary Get all settlements * @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 {'account_payable' | 'account_receivable'} [type] The type of settlement. + * @param {SettlementStatus} [status] Status of the settlement. + * @param {'MXN' | 'BRL'} [currency] Currency of the settlement * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listSettlements: async ( + getSettlements: async ( from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, + type?: "account_payable" | "account_receivable", + status?: SettlementStatus, + currency?: "MXN" | "BRL", options: AxiosRequestConfig = {} ): Promise => { - const localVarPath = `/v1/settlements`; + const localVarPath = `/v1/exchange/trades/settlements`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -158,6 +219,18 @@ export const SettlementsApiAxiosParamCreator = function ( localVarQueryParameter["pageSize"] = pageSize; } + if (type !== undefined) { + localVarQueryParameter["type"] = type; + } + + if (status !== undefined) { + localVarQueryParameter["status"] = status; + } + + if (currency !== undefined) { + localVarQueryParameter["currency"] = currency; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -184,22 +257,22 @@ export const SettlementsApiFp = function (configuration?: Configuration) { SettlementsApiAxiosParamCreator(configuration); return { /** - * - * @summary Get a settlement + * Returns a settlement by ID. + * @summary Get settlement * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getSettlement( + async getSettlementId( id: string, options?: AxiosRequestConfig ): Promise< ( axios?: AxiosInstance, basePath?: string - ) => AxiosPromise + ) => AxiosPromise > { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSettlement( + const localVarAxiosArgs = await localVarAxiosParamCreator.getSettlementId( id, options ); @@ -211,22 +284,56 @@ export const SettlementsApiFp = function (configuration?: Configuration) { ); }, /** - * - * @summary List all settlements + * Returns settlement instructions for a specific currency. + * @summary Get settlement instructions + * @param {'BRL' | 'MXN'} currency Fiat currency name. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getSettlementInstructions( + currency: "BRL" | "MXN", + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.getSettlementInstructions( + currency, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Returns all settlements. + * @summary Get all settlements * @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 {'account_payable' | 'account_receivable'} [type] The type of settlement. + * @param {SettlementStatus} [status] Status of the settlement. + * @param {'MXN' | 'BRL'} [currency] Currency of the settlement * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listSettlements( + async getSettlements( from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, + type?: "account_payable" | "account_receivable", + status?: SettlementStatus, + currency?: "MXN" | "BRL", options?: AxiosRequestConfig ): Promise< ( @@ -234,12 +341,15 @@ export const SettlementsApiFp = function (configuration?: Configuration) { basePath?: string ) => AxiosPromise > { - const localVarAxiosArgs = await localVarAxiosParamCreator.listSettlements( + const localVarAxiosArgs = await localVarAxiosParamCreator.getSettlements( from, to, pageBefore, pageAfter, pageSize, + type, + status, + currency, options ); return createRequestFunction( @@ -264,41 +374,72 @@ export const SettlementsApiFactory = function ( const localVarFp = SettlementsApiFp(configuration); return { /** - * - * @summary Get a settlement + * Returns a settlement by ID. + * @summary Get settlement * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getSettlement( + getSettlementId( id: string, options?: any - ): AxiosPromise { + ): AxiosPromise { + return localVarFp + .getSettlementId(id, options) + .then((request) => request(axios, basePath)); + }, + /** + * Returns settlement instructions for a specific currency. + * @summary Get settlement instructions + * @param {'BRL' | 'MXN'} currency Fiat currency name. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSettlementInstructions( + currency: "BRL" | "MXN", + options?: any + ): AxiosPromise { return localVarFp - .getSettlement(id, options) + .getSettlementInstructions(currency, options) .then((request) => request(axios, basePath)); }, /** - * - * @summary List all settlements + * Returns all settlements. + * @summary Get all settlements * @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 {'account_payable' | 'account_receivable'} [type] The type of settlement. + * @param {SettlementStatus} [status] Status of the settlement. + * @param {'MXN' | 'BRL'} [currency] Currency of the settlement * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listSettlements( + getSettlements( from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, + type?: "account_payable" | "account_receivable", + status?: SettlementStatus, + currency?: "MXN" | "BRL", options?: any ): AxiosPromise { return localVarFp - .listSettlements(from, to, pageBefore, pageAfter, pageSize, options) + .getSettlements( + from, + to, + pageBefore, + pageAfter, + pageSize, + type, + status, + currency, + options + ) .then((request) => request(axios, basePath)); } }; @@ -312,41 +453,74 @@ export const SettlementsApiFactory = function ( */ export class SettlementsApi extends BaseAPI { /** - * - * @summary Get a settlement + * Returns a settlement by ID. + * @summary Get settlement * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettlementsApi */ - public getSettlement(id: string, options?: AxiosRequestConfig) { + public getSettlementId(id: string, options?: AxiosRequestConfig) { + return SettlementsApiFp(this.configuration) + .getSettlementId(id, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns settlement instructions for a specific currency. + * @summary Get settlement instructions + * @param {'BRL' | 'MXN'} currency Fiat currency name. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SettlementsApi + */ + public getSettlementInstructions( + currency: "BRL" | "MXN", + options?: AxiosRequestConfig + ) { return SettlementsApiFp(this.configuration) - .getSettlement(id, options) + .getSettlementInstructions(currency, options) .then((request) => request(this.axios, this.basePath)); } /** - * - * @summary List all settlements + * Returns all settlements. + * @summary Get all settlements * @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 {'account_payable' | 'account_receivable'} [type] The type of settlement. + * @param {SettlementStatus} [status] Status of the settlement. + * @param {'MXN' | 'BRL'} [currency] Currency of the settlement * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SettlementsApi */ - public listSettlements( + public getSettlements( from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, + type?: "account_payable" | "account_receivable", + status?: SettlementStatus, + currency?: "MXN" | "BRL", options?: AxiosRequestConfig ) { return SettlementsApiFp(this.configuration) - .listSettlements(from, to, pageBefore, pageAfter, pageSize, options) + .getSettlements( + from, + to, + pageBefore, + pageAfter, + pageSize, + type, + status, + currency, + options + ) .then((request) => request(this.axios, this.basePath)); } } diff --git a/src/generated/apis/trades-api.ts b/src/generated/apis/trades-api.ts new file mode 100644 index 00000000..6c4ce8e2 --- /dev/null +++ b/src/generated/apis/trades-api.ts @@ -0,0 +1,733 @@ +/* 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 { CreateFxAccountRequest } from "../models"; +// @ts-ignore +import { CreateFxAccountResponse1 } from "../models"; +// @ts-ignore +import { CreateFxTradeResponse } from "../models"; +// @ts-ignore +import { ExchangeRateRequest } from "../models"; +// @ts-ignore +import { FetchExchangeRateResponse } from "../models"; +// @ts-ignore +import { FxTradeRequest } from "../models"; +// @ts-ignore +import { GetFxLimitsResponse } from "../models"; +// @ts-ignore +import { GetFxTradesResponse } from "../models"; +// @ts-ignore +import { GetFxTradesResponse1 } from "../models"; +// @ts-ignore +import { NotAuthorized } from "../models"; +// @ts-ignore +import { NotFound } from "../models"; +/** + * TradesApi - axios parameter creator + * @export + */ +export const TradesApiAxiosParamCreator = function ( + configuration?: Configuration +) { + return { + /** + * Creates a currency trading account + * @summary Create FX account + * @param {CreateFxAccountRequest} [createFxAccountRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createFxAccount: async ( + createFxAccountRequest?: CreateFxAccountRequest, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/exchange/fxConfigs/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: "PUT", + ...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( + createFxAccountRequest, + localVarRequestOptions, + configuration + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + }, + /** + * Creates a cross-currency trade + * @summary Create FX trade + * @param {FxTradeRequest} [fxTradeRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createFxTrade: async ( + fxTradeRequest?: FxTradeRequest, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/exchange/trades`; + // 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( + fxTradeRequest, + localVarRequestOptions, + configuration + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + }, + /** + * Returns daily currency exchange limits and usages. + * @summary Get daily currency exchange limits + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDailyFxLimits: async ( + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/exchange/fxConfigs/dailyLimits`; + // 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 + }; + }, + /** + * Returns an FX trade by ID. + * @summary Get FX trade + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFxTradeId: async ( + id: string, + options: AxiosRequestConfig = {} + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("getFxTradeId", "id", id); + const localVarPath = `/v1/exchange/trades/{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 + }; + }, + /** + * Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement. + * @summary Get all FX trades + * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFxTrades: async ( + settlementId?: string, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/exchange/trades`; + // 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 (settlementId !== undefined) { + localVarQueryParameter["settlementId"] = settlementId; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + }, + /** + * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. + * @summary Get quote + * @param {ExchangeRateRequest} [exchangeRateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getQuote: async ( + exchangeRateRequest?: ExchangeRateRequest, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/exchange/quotes`; + // 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( + exchangeRateRequest, + localVarRequestOptions, + configuration + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + } + }; +}; + +/** + * TradesApi - functional programming interface + * @export + */ +export const TradesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = TradesApiAxiosParamCreator(configuration); + return { + /** + * Creates a currency trading account + * @summary Create FX account + * @param {CreateFxAccountRequest} [createFxAccountRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createFxAccount( + createFxAccountRequest?: CreateFxAccountRequest, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFxAccount( + createFxAccountRequest, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Creates a cross-currency trade + * @summary Create FX trade + * @param {FxTradeRequest} [fxTradeRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createFxTrade( + fxTradeRequest?: FxTradeRequest, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFxTrade( + fxTradeRequest, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Returns daily currency exchange limits and usages. + * @summary Get daily currency exchange limits + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getDailyFxLimits( + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.getDailyFxLimits(options); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Returns an FX trade by ID. + * @summary Get FX trade + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getFxTradeId( + id: string, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFxTradeId( + id, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement. + * @summary Get all FX trades + * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getFxTrades( + settlementId?: string, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFxTrades( + settlementId, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, + /** + * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. + * @summary Get quote + * @param {ExchangeRateRequest} [exchangeRateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getQuote( + exchangeRateRequest?: ExchangeRateRequest, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.getQuote( + exchangeRateRequest, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + } + }; +}; + +/** + * TradesApi - factory interface + * @export + */ +export const TradesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance +) { + const localVarFp = TradesApiFp(configuration); + return { + /** + * Creates a currency trading account + * @summary Create FX account + * @param {CreateFxAccountRequest} [createFxAccountRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createFxAccount( + createFxAccountRequest?: CreateFxAccountRequest, + options?: any + ): AxiosPromise { + return localVarFp + .createFxAccount(createFxAccountRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * Creates a cross-currency trade + * @summary Create FX trade + * @param {FxTradeRequest} [fxTradeRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createFxTrade( + fxTradeRequest?: FxTradeRequest, + options?: any + ): AxiosPromise { + return localVarFp + .createFxTrade(fxTradeRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * Returns daily currency exchange limits and usages. + * @summary Get daily currency exchange limits + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDailyFxLimits(options?: any): AxiosPromise { + return localVarFp + .getDailyFxLimits(options) + .then((request) => request(axios, basePath)); + }, + /** + * Returns an FX trade by ID. + * @summary Get FX trade + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFxTradeId( + id: string, + options?: any + ): AxiosPromise { + return localVarFp + .getFxTradeId(id, options) + .then((request) => request(axios, basePath)); + }, + /** + * Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement. + * @summary Get all FX trades + * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFxTrades( + settlementId?: string, + options?: any + ): AxiosPromise { + return localVarFp + .getFxTrades(settlementId, options) + .then((request) => request(axios, basePath)); + }, + /** + * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. + * @summary Get quote + * @param {ExchangeRateRequest} [exchangeRateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getQuote( + exchangeRateRequest?: ExchangeRateRequest, + options?: any + ): AxiosPromise { + return localVarFp + .getQuote(exchangeRateRequest, options) + .then((request) => request(axios, basePath)); + } + }; +}; + +/** + * TradesApi - object-oriented interface + * @export + * @class TradesApi + * @extends {BaseAPI} + */ +export class TradesApi extends BaseAPI { + /** + * Creates a currency trading account + * @summary Create FX account + * @param {CreateFxAccountRequest} [createFxAccountRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public createFxAccount( + createFxAccountRequest?: CreateFxAccountRequest, + options?: AxiosRequestConfig + ) { + return TradesApiFp(this.configuration) + .createFxAccount(createFxAccountRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Creates a cross-currency trade + * @summary Create FX trade + * @param {FxTradeRequest} [fxTradeRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public createFxTrade( + fxTradeRequest?: FxTradeRequest, + options?: AxiosRequestConfig + ) { + return TradesApiFp(this.configuration) + .createFxTrade(fxTradeRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns daily currency exchange limits and usages. + * @summary Get daily currency exchange limits + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public getDailyFxLimits(options?: AxiosRequestConfig) { + return TradesApiFp(this.configuration) + .getDailyFxLimits(options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns an FX trade by ID. + * @summary Get FX trade + * @param {string} id Universally unique identifier (UUID v4) of a resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public getFxTradeId(id: string, options?: AxiosRequestConfig) { + return TradesApiFp(this.configuration) + .getFxTradeId(id, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Returns all cross-currency trades. You can include an optional `settlementId` query parameter to filter the trades to only a specific settlement. + * @summary Get all FX trades + * @param {string} [settlementId] Queries items with the specified settlement id. Matches any settlement id if unspecified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public getFxTrades(settlementId?: string, options?: AxiosRequestConfig) { + return TradesApiFp(this.configuration) + .getFxTrades(settlementId, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * Fetches an indicative exchange rate between two currencies. Either the from currency or to currency must be USD. Note: The current market exchange rate will be applied when Circle receives the deposit. + * @summary Get quote + * @param {ExchangeRateRequest} [exchangeRateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TradesApi + */ + public getQuote( + exchangeRateRequest?: ExchangeRateRequest, + options?: AxiosRequestConfig + ) { + return TradesApiFp(this.configuration) + .getQuote(exchangeRateRequest, options) + .then((request) => request(this.axios, this.basePath)); + } +} diff --git a/src/generated/apis/transfers-api.ts b/src/generated/apis/transfers-api.ts index 488ad5ac..36c2fd80 100644 --- a/src/generated/apis/transfers-api.ts +++ b/src/generated/apis/transfers-api.ts @@ -154,6 +154,9 @@ export const TransfersApiAxiosParamCreator = function ( /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers + * @param {string} [walletId] Filters results to get only transfers to or from this Circle wallet. + * @param {string} [sourceWalletId] Filters results to get only transfers from this Circle wallet. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). + * @param {string} [destinationWalletId] Filters results to get only transfers to this Circle wallet. * @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. @@ -163,6 +166,9 @@ export const TransfersApiAxiosParamCreator = function ( * @throws {RequiredError} */ listBusinessTransfers: async ( + walletId?: string, + sourceWalletId?: string, + destinationWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -190,6 +196,18 @@ export const TransfersApiAxiosParamCreator = function ( // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration); + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + + if (sourceWalletId !== undefined) { + localVarQueryParameter["sourceWalletId"] = sourceWalletId; + } + + if (destinationWalletId !== undefined) { + localVarQueryParameter["destinationWalletId"] = destinationWalletId; + } + if (from !== undefined) { localVarQueryParameter["from"] = (from as any) instanceof Date ? (from as any).toISOString() : from; @@ -293,6 +311,9 @@ export const TransfersApiFp = function (configuration?: Configuration) { /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers + * @param {string} [walletId] Filters results to get only transfers to or from this Circle wallet. + * @param {string} [sourceWalletId] Filters results to get only transfers from this Circle wallet. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). + * @param {string} [destinationWalletId] Filters results to get only transfers to this Circle wallet. * @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. @@ -302,6 +323,9 @@ export const TransfersApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async listBusinessTransfers( + walletId?: string, + sourceWalletId?: string, + destinationWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -316,6 +340,9 @@ export const TransfersApiFp = function (configuration?: Configuration) { > { const localVarAxiosArgs = await localVarAxiosParamCreator.listBusinessTransfers( + walletId, + sourceWalletId, + destinationWalletId, from, to, pageBefore, @@ -377,6 +404,9 @@ export const TransfersApiFactory = function ( /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers + * @param {string} [walletId] Filters results to get only transfers to or from this Circle wallet. + * @param {string} [sourceWalletId] Filters results to get only transfers from this Circle wallet. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). + * @param {string} [destinationWalletId] Filters results to get only transfers to this Circle wallet. * @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. @@ -386,6 +416,9 @@ export const TransfersApiFactory = function ( * @throws {RequiredError} */ listBusinessTransfers( + walletId?: string, + sourceWalletId?: string, + destinationWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -395,6 +428,9 @@ export const TransfersApiFactory = function ( ): AxiosPromise { return localVarFp .listBusinessTransfers( + walletId, + sourceWalletId, + destinationWalletId, from, to, pageBefore, @@ -448,6 +484,9 @@ export class TransfersApi extends BaseAPI { /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers + * @param {string} [walletId] Filters results to get only transfers to or from this Circle wallet. + * @param {string} [sourceWalletId] Filters results to get only transfers from this Circle wallet. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). + * @param {string} [destinationWalletId] Filters results to get only transfers to this Circle wallet. * @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. @@ -458,6 +497,9 @@ export class TransfersApi extends BaseAPI { * @memberof TransfersApi */ public listBusinessTransfers( + walletId?: string, + sourceWalletId?: string, + destinationWalletId?: string, from?: string, to?: string, pageBefore?: string, @@ -466,7 +508,17 @@ export class TransfersApi extends BaseAPI { options?: AxiosRequestConfig ) { return TransfersApiFp(this.configuration) - .listBusinessTransfers(from, to, pageBefore, pageAfter, pageSize, options) + .listBusinessTransfers( + walletId, + sourceWalletId, + destinationWalletId, + from, + to, + pageBefore, + pageAfter, + pageSize, + 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 a8af1af2..a23a4c49 100644 --- a/src/generated/apis/wires-api.ts +++ b/src/generated/apis/wires-api.ts @@ -57,7 +57,7 @@ export const WiresApiAxiosParamCreator = function ( return { /** * - * @summary Create a Wire bank account + * @summary Create a wire bank account * @param {WireCreationRequest} [wireCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -109,7 +109,7 @@ export const WiresApiAxiosParamCreator = function ( }, /** * - * @summary Get a Wire bank account + * @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} @@ -158,16 +158,18 @@ export const WiresApiAxiosParamCreator = function ( }; }, /** - * Get the wire transfer instructions into the Circle bank account given your bank account id. - * @summary Get Wire instructions + * 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 {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [walletId] The wallet ID of the external entity. If not provided, the instructions will be for your default wallet. You can create additional wallets using the [Core API for Institutions](/api-reference/circle-mint/institutional/create-external-entity). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessWireAccountInstructions: async ( id: string, currency?: "USD" | "EUR", + walletId?: string, options: AxiosRequestConfig = {} ): Promise => { // verify required parameter 'id' is not null or undefined @@ -200,6 +202,10 @@ export const WiresApiAxiosParamCreator = function ( localVarQueryParameter["currency"] = currency; } + if (walletId !== undefined) { + localVarQueryParameter["walletId"] = walletId; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -216,7 +222,7 @@ export const WiresApiAxiosParamCreator = function ( }, /** * - * @summary List all Wire bank accounts + * @summary List all wire bank accounts * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -269,7 +275,7 @@ export const WiresApiFp = function (configuration?: Configuration) { return { /** * - * @summary Create a Wire bank account + * @summary Create a wire bank account * @param {WireCreationRequest} [wireCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -297,7 +303,7 @@ export const WiresApiFp = function (configuration?: Configuration) { }, /** * - * @summary Get a Wire bank account + * @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} @@ -321,16 +327,18 @@ export const WiresApiFp = function (configuration?: Configuration) { ); }, /** - * Get the wire transfer instructions into the Circle bank account given your bank account id. - * @summary Get Wire instructions + * 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 {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [walletId] The wallet ID of the external entity. If not provided, the instructions will be for your default wallet. You can create additional wallets using the [Core API for Institutions](/api-reference/circle-mint/institutional/create-external-entity). * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getBusinessWireAccountInstructions( id: string, currency?: "USD" | "EUR", + walletId?: string, options?: AxiosRequestConfig ): Promise< ( @@ -342,6 +350,7 @@ export const WiresApiFp = function (configuration?: Configuration) { await localVarAxiosParamCreator.getBusinessWireAccountInstructions( id, currency, + walletId, options ); return createRequestFunction( @@ -353,7 +362,7 @@ export const WiresApiFp = function (configuration?: Configuration) { }, /** * - * @summary List all Wire bank accounts + * @summary List all wire bank accounts * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -390,7 +399,7 @@ export const WiresApiFactory = function ( return { /** * - * @summary Create a Wire bank account + * @summary Create a wire bank account * @param {WireCreationRequest} [wireCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -405,7 +414,7 @@ export const WiresApiFactory = function ( }, /** * - * @summary Get a Wire bank account + * @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} @@ -419,25 +428,27 @@ export const WiresApiFactory = function ( .then((request) => request(axios, basePath)); }, /** - * Get the wire transfer instructions into the Circle bank account given your bank account id. - * @summary Get Wire instructions + * 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 {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [walletId] The wallet ID of the external entity. If not provided, the instructions will be for your default wallet. You can create additional wallets using the [Core API for Institutions](/api-reference/circle-mint/institutional/create-external-entity). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessWireAccountInstructions( id: string, currency?: "USD" | "EUR", + walletId?: string, options?: any ): AxiosPromise { return localVarFp - .getBusinessWireAccountInstructions(id, currency, options) + .getBusinessWireAccountInstructions(id, currency, walletId, options) .then((request) => request(axios, basePath)); }, /** * - * @summary List all Wire bank accounts + * @summary List all wire bank accounts * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -460,7 +471,7 @@ export const WiresApiFactory = function ( export class WiresApi extends BaseAPI { /** * - * @summary Create a Wire bank account + * @summary Create a wire bank account * @param {WireCreationRequest} [wireCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -477,7 +488,7 @@ export class WiresApi extends BaseAPI { /** * - * @summary Get a Wire bank account + * @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} @@ -490,10 +501,11 @@ export class WiresApi extends BaseAPI { } /** - * Get the wire transfer instructions into the Circle bank account given your bank account id. - * @summary Get Wire instructions + * 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 {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [walletId] The wallet ID of the external entity. If not provided, the instructions will be for your default wallet. You can create additional wallets using the [Core API for Institutions](/api-reference/circle-mint/institutional/create-external-entity). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WiresApi @@ -501,16 +513,17 @@ export class WiresApi extends BaseAPI { public getBusinessWireAccountInstructions( id: string, currency?: "USD" | "EUR", + walletId?: string, options?: AxiosRequestConfig ) { return WiresApiFp(this.configuration) - .getBusinessWireAccountInstructions(id, currency, options) + .getBusinessWireAccountInstructions(id, currency, walletId, options) .then((request) => request(this.axios, this.basePath)); } /** * - * @summary List all Wire bank accounts + * @summary List all wire bank accounts * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WiresApi diff --git a/src/generated/index.ts b/src/generated/index.ts index 2a9838ad..76dbab03 100644 --- a/src/generated/index.ts +++ b/src/generated/index.ts @@ -10,25 +10,20 @@ import { AddressesApi, BalancesApi, CUBIXApi, - CardsApi, - ChannelsApi, - ChargebacksApi, - CheckoutSessionsApi, CryptoAddressBookApi, - CryptoExchangeRatesApi, CryptoPaymentIntentsApi, DepositsApi, - EncryptionApi, + ExternalEntitiesApi, HealthApi, ManagementApi, PIXApi, - PaymentTokensApi, PaymentsApi, PayoutsApi, - PullCryptoPaymentsApi, + ReserveManagementApi, SettlementsApi, StablecoinsApi, SubscriptionsApi, + TradesApi, TransfersApi, WiresApi } from "./api"; @@ -40,25 +35,20 @@ export class Circle { public addresses: AddressesApi; public balances: BalancesApi; public cubix: CUBIXApi; - public cards: CardsApi; - public channels: ChannelsApi; - public chargebacks: ChargebacksApi; - public checkoutSessions: CheckoutSessionsApi; public cryptoAddressBook: CryptoAddressBookApi; - public cryptoExchangeRates: CryptoExchangeRatesApi; public cryptoPaymentIntents: CryptoPaymentIntentsApi; public deposits: DepositsApi; - public encryption: EncryptionApi; + public externalEntities: ExternalEntitiesApi; public health: HealthApi; public management: ManagementApi; public pix: PIXApi; - public paymentTokens: PaymentTokensApi; public payments: PaymentsApi; public payouts: PayoutsApi; - public pullCryptoPayments: PullCryptoPaymentsApi; + public reserveManagement: ReserveManagementApi; public settlements: SettlementsApi; public stablecoins: StablecoinsApi; public subscriptions: SubscriptionsApi; + public trades: TradesApi; public transfers: TransfersApi; public wires: WiresApi; @@ -67,25 +57,20 @@ export class Circle { this.addresses = new AddressesApi(configuration); this.balances = new BalancesApi(configuration); this.cubix = new CUBIXApi(configuration); - this.cards = new CardsApi(configuration); - this.channels = new ChannelsApi(configuration); - this.chargebacks = new ChargebacksApi(configuration); - this.checkoutSessions = new CheckoutSessionsApi(configuration); this.cryptoAddressBook = new CryptoAddressBookApi(configuration); - this.cryptoExchangeRates = new CryptoExchangeRatesApi(configuration); this.cryptoPaymentIntents = new CryptoPaymentIntentsApi(configuration); this.deposits = new DepositsApi(configuration); - this.encryption = new EncryptionApi(configuration); + this.externalEntities = new ExternalEntitiesApi(configuration); this.health = new HealthApi(configuration); this.management = new ManagementApi(configuration); this.pix = new PIXApi(configuration); - this.paymentTokens = new PaymentTokensApi(configuration); this.payments = new PaymentsApi(configuration); this.payouts = new PayoutsApi(configuration); - this.pullCryptoPayments = new PullCryptoPaymentsApi(configuration); + this.reserveManagement = new ReserveManagementApi(configuration); this.settlements = new SettlementsApi(configuration); this.stablecoins = new StablecoinsApi(configuration); this.subscriptions = new SubscriptionsApi(configuration); + this.trades = new TradesApi(configuration); this.transfers = new TransfersApi(configuration); this.wires = new WiresApi(configuration); } diff --git a/src/generated/models/address-book-recipient-request.ts b/src/generated/models/address-book-recipient-request.ts index 369ce1d1..38ffb9a0 100644 --- a/src/generated/models/address-book-recipient-request.ts +++ b/src/generated/models/address-book-recipient-request.ts @@ -9,9 +9,6 @@ // May contain unused imports in some cases // @ts-ignore import { AddressBookRecipientMetadata } from "./address-book-recipient-metadata"; -// May contain unused imports in some cases -// @ts-ignore -import { Chain } from "./chain"; /** * @@ -26,13 +23,13 @@ export interface AddressBookRecipientRequest { */ idempotencyKey: string; /** - * - * @type {Chain} + * The blockchain network to use for the address. + * @type {string} * @memberof AddressBookRecipientRequest */ - chain: Chain; + chain: AddressBookRecipientRequestChainEnum; /** - * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address. + * An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address. **Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). The `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`). * @type {string} * @memberof AddressBookRecipientRequest */ @@ -50,3 +47,28 @@ export interface AddressBookRecipientRequest { */ metadata: AddressBookRecipientMetadata; } + +export const AddressBookRecipientRequestChainEnum = { + Algo: "ALGO", + Aptos: "APTOS", + Arb: "ARB", + Avax: "AVAX", + Base: "BASE", + Celo: "CELO", + Eth: "ETH", + Hbar: "HBAR", + Near: "NEAR", + Noble: "NOBLE", + Op: "OP", + Pah: "PAH", + Poly: "POLY", + Sol: "SOL", + Sui: "SUI", + Uni: "UNI", + Xlm: "XLM", + Xrp: "XRP", + Zks: "ZKS" +} as const; + +export type AddressBookRecipientRequestChainEnum = + typeof AddressBookRecipientRequestChainEnum[keyof typeof AddressBookRecipientRequestChainEnum]; diff --git a/src/generated/models/address-book-recipient.ts b/src/generated/models/address-book-recipient.ts index 83ab1f34..1d77a9bb 100644 --- a/src/generated/models/address-book-recipient.ts +++ b/src/generated/models/address-book-recipient.ts @@ -32,7 +32,7 @@ export interface AddressBookRecipient { */ chain: Chain; /** - * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address. + * An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address. **Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). The `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`). * @type {string} * @memberof AddressBookRecipient */ diff --git a/src/generated/models/address-object.ts b/src/generated/models/address-object.ts index 8fda74d3..e6c4f15e 100644 --- a/src/generated/models/address-object.ts +++ b/src/generated/models/address-object.ts @@ -20,7 +20,7 @@ import { Currency } from "./currency"; */ export interface AddressObject { /** - * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address. + * An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address. **Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). The `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`). * @type {string} * @memberof AddressObject */ @@ -43,4 +43,16 @@ export interface AddressObject { * @memberof AddressObject */ chain?: Chain; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof AddressObject + */ + id?: string; + /** + * Unique identifier of the wallet to which the deposit address is associated. + * @type {string} + * @memberof AddressObject + */ + walletId?: string; } diff --git a/src/generated/models/apple-pay-token-ec-header.ts b/src/generated/models/apple-pay-token-ec-header.ts deleted file mode 100644 index a05bdd4b..00000000 --- a/src/generated/models/apple-pay-token-ec-header.ts +++ /dev/null @@ -1,39 +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 ApplePayTokenEcHeader - */ -export interface ApplePayTokenEcHeader { - /** - * 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} - * @memberof ApplePayTokenEcHeader - */ - applicationData?: string; - /** - * Ephemeral public key bytes. - * @type {string} - * @memberof ApplePayTokenEcHeader - */ - ephemeralPublicKey: string; - /** - * Hash of the X.509 encoded public key bytes of the merchant’s certificate. - * @type {string} - * @memberof ApplePayTokenEcHeader - */ - publicKeyHash: string; - /** - * Transaction identifier, generated on the device. - * @type {string} - * @memberof ApplePayTokenEcHeader - */ - transactionId: string; -} diff --git a/src/generated/models/apple-pay-token-header.ts b/src/generated/models/apple-pay-token-header.ts deleted file mode 100644 index 2b58c27e..00000000 --- a/src/generated/models/apple-pay-token-header.ts +++ /dev/null @@ -1,23 +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 { ApplePayTokenEcHeader } from "./apple-pay-token-ec-header"; -// May contain unused imports in some cases -// @ts-ignore -import { ApplePayTokenRsaHeader } from "./apple-pay-token-rsa-header"; - -/** - * @type ApplePayTokenHeader - * Additional version-dependent information used to decrypt and verify the payment. - * @export - */ -export type ApplePayTokenHeader = - | ApplePayTokenEcHeader - | ApplePayTokenRsaHeader; diff --git a/src/generated/models/apple-pay-token-rsa-header.ts b/src/generated/models/apple-pay-token-rsa-header.ts deleted file mode 100644 index bd2560c6..00000000 --- a/src/generated/models/apple-pay-token-rsa-header.ts +++ /dev/null @@ -1,39 +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 ApplePayTokenRsaHeader - */ -export interface ApplePayTokenRsaHeader { - /** - * 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} - * @memberof ApplePayTokenRsaHeader - */ - applicationData?: string; - /** - * The symmetric key wrapped using your RSA public key. - * @type {string} - * @memberof ApplePayTokenRsaHeader - */ - wrappedKey: string; - /** - * Hash of the X.509 encoded public key bytes of the merchant’s certificate. - * @type {string} - * @memberof ApplePayTokenRsaHeader - */ - publicKeyHash: string; - /** - * Transaction identifier, generated on the device. - * @type {string} - * @memberof ApplePayTokenRsaHeader - */ - transactionId: string; -} diff --git a/src/generated/models/apple-pay-token.ts b/src/generated/models/apple-pay-token.ts deleted file mode 100644 index dbcd1702..00000000 --- a/src/generated/models/apple-pay-token.ts +++ /dev/null @@ -1,51 +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 { ApplePayTokenHeader } from "./apple-pay-token-header"; - -/** - * - * @export - * @interface ApplePayToken - */ -export interface ApplePayToken { - /** - * ApplePay token version information. - * @type {string} - * @memberof ApplePayToken - */ - version: ApplePayTokenVersionEnum; - /** - * Encrypted payment data. Base64 encoded as a string. - * @type {string} - * @memberof ApplePayToken - */ - data: string; - /** - * 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} - * @memberof ApplePayToken - */ - signature: string; - /** - * - * @type {ApplePayTokenHeader} - * @memberof ApplePayToken - */ - header: ApplePayTokenHeader; -} - -export const ApplePayTokenVersionEnum = { - EcV1: "EC_v1", - RsaV1: "RSA_v1" -} as const; - -export type ApplePayTokenVersionEnum = - typeof ApplePayTokenVersionEnum[keyof typeof ApplePayTokenVersionEnum]; diff --git a/src/generated/models/basic-chargeback-history.ts b/src/generated/models/basic-chargeback-history.ts deleted file mode 100644 index b1b57fc4..00000000 --- a/src/generated/models/basic-chargeback-history.ts +++ /dev/null @@ -1,66 +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 BasicChargebackHistory - */ -export interface BasicChargebackHistory { - /** - * Enumerated type of the chargeback history event. `1st Chargeback` represents the first stage of the dispute procedure initiated by the cardholder’s issuing bank. `2nd Chargeback` represents the second stage of the dispute procedure initiated by the cardholder’s issuing bank (This stage is MasterCard only). `Chargeback Reversal` represents when 1st Chargeback or 2nd Chargeback is withdrawn by the issuer. `Representment` represents the stage when merchants decided to dispute 1st Chargeback or 2nd Chargeback. `Chargeback Settlement` can imply one of the two: 1) If merchant or marketplace is taking the lost of the chargeback, money will be debit from the wallet during this stage. 2) If merchant of marketplace successfully dispute the chargeback, money will be credit back to the wallet during this stage. - * @type {string} - * @memberof BasicChargebackHistory - */ - type: BasicChargebackHistoryTypeEnum; - /** - * - * @type {FiatMoneyUsd} - * @memberof BasicChargebackHistory - */ - chargebackAmount: FiatMoneyUsd; - /** - * - * @type {FiatMoneyUsd} - * @memberof BasicChargebackHistory - */ - fee?: FiatMoneyUsd; - /** - * The reason the chargeback was created. - * @type {string} - * @memberof BasicChargebackHistory - */ - description: string; - /** - * Unique system generated identifier for the settlement related to the chargeback history. - * @type {string} - * @memberof BasicChargebackHistory - */ - settlementId?: string | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof BasicChargebackHistory - */ - createDate?: string; -} - -export const BasicChargebackHistoryTypeEnum = { - _1stChargeback: "1st Chargeback", - _2ndChargeback: "2nd Chargeback", - ChargebackReversal: "Chargeback Reversal", - Representment: "Representment", - ChargebackSettlement: "Chargeback Settlement" -} as const; - -export type BasicChargebackHistoryTypeEnum = - typeof BasicChargebackHistoryTypeEnum[keyof typeof BasicChargebackHistoryTypeEnum]; diff --git a/src/generated/models/basic-chargeback.ts b/src/generated/models/basic-chargeback.ts deleted file mode 100644 index cd4c1eba..00000000 --- a/src/generated/models/basic-chargeback.ts +++ /dev/null @@ -1,67 +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 { BasicChargebackHistory } from "./basic-chargeback-history"; -// May contain unused imports in some cases -// @ts-ignore -import { ChargebackCategories } from "./chargeback-categories"; -// May contain unused imports in some cases -// @ts-ignore -import { ChargebackStatus } from "./chargeback-status"; - -/** - * - * @export - * @interface BasicChargeback - */ -export interface BasicChargeback { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof BasicChargeback - */ - id: string; - /** - * Unique system generated identifier for the payment that is associated to the chargeback item. - * @type {string} - * @memberof BasicChargeback - */ - paymentId: string; - /** - * Unique system generated identifier for the merchant. - * @type {string} - * @memberof BasicChargeback - */ - merchantId: string; - /** - * Reason code given by the card network for the chargeback item. - * @type {string} - * @memberof BasicChargeback - */ - reasonCode: string; - /** - * - * @type {ChargebackStatus} - * @memberof BasicChargeback - */ - status: ChargebackStatus; - /** - * - * @type {ChargebackCategories} - * @memberof BasicChargeback - */ - category?: ChargebackCategories; - /** - * The chargeback item\'s history list will be sorted by create date descending: more recent chargeback statuses will be at the beginning of the list. - * @type {Array} - * @memberof BasicChargeback - */ - history: Array; -} diff --git a/src/generated/models/brlsettlement-instructions-instruction.ts b/src/generated/models/brlsettlement-instructions-instruction.ts new file mode 100644 index 00000000..c954799a --- /dev/null +++ b/src/generated/models/brlsettlement-instructions-instruction.ts @@ -0,0 +1,55 @@ +/* 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 { PixAccountType } from "./pix-account-type"; + +/** + * + * @export + * @interface BRLSettlementInstructionsInstruction + */ +export interface BRLSettlementInstructionsInstruction { + /** + * + * @type {string} + * @memberof BRLSettlementInstructionsInstruction + */ + ispb?: string; + /** + * + * @type {string} + * @memberof BRLSettlementInstructionsInstruction + */ + branchCode?: string; + /** + * + * @type {string} + * @memberof BRLSettlementInstructionsInstruction + */ + accountNumber?: string; + /** + * + * @type {string} + * @memberof BRLSettlementInstructionsInstruction + */ + name?: string; + /** + * + * @type {PixAccountType} + * @memberof BRLSettlementInstructionsInstruction + */ + accountType?: PixAccountType; + /** + * + * @type {string} + * @memberof BRLSettlementInstructionsInstruction + */ + taxId?: string; +} diff --git a/src/generated/models/brlsettlement-instructions.ts b/src/generated/models/brlsettlement-instructions.ts new file mode 100644 index 00000000..1de9d7af --- /dev/null +++ b/src/generated/models/brlsettlement-instructions.ts @@ -0,0 +1,50 @@ +/* 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 { BRLSettlementInstructionsInstruction } from "./brlsettlement-instructions-instruction"; + +/** + * + * @export + * @interface BRLSettlementInstructions + */ +export interface BRLSettlementInstructions { + /** + * + * @type {string} + * @memberof BRLSettlementInstructions + */ + currency?: BRLSettlementInstructionsCurrencyEnum; + /** + * + * @type {string} + * @memberof BRLSettlementInstructions + */ + fiatAccountType?: BRLSettlementInstructionsFiatAccountTypeEnum; + /** + * + * @type {BRLSettlementInstructionsInstruction} + * @memberof BRLSettlementInstructions + */ + instruction?: BRLSettlementInstructionsInstruction; +} + +export const BRLSettlementInstructionsCurrencyEnum = { + Brl: "BRL" +} as const; + +export type BRLSettlementInstructionsCurrencyEnum = + typeof BRLSettlementInstructionsCurrencyEnum[keyof typeof BRLSettlementInstructionsCurrencyEnum]; +export const BRLSettlementInstructionsFiatAccountTypeEnum = { + Pix: "pix" +} as const; + +export type BRLSettlementInstructionsFiatAccountTypeEnum = + typeof BRLSettlementInstructionsFiatAccountTypeEnum[keyof typeof BRLSettlementInstructionsFiatAccountTypeEnum]; diff --git a/src/generated/models/business-deposit.ts b/src/generated/models/business-deposit.ts index 1fb6d154..a259ad79 100644 --- a/src/generated/models/business-deposit.ts +++ b/src/generated/models/business-deposit.ts @@ -18,6 +18,9 @@ import { RiskEvaluation } from "./risk-evaluation"; // May contain unused imports in some cases // @ts-ignore import { WalletLocation } from "./wallet-location"; +// May contain unused imports in some cases +// @ts-ignore +import { WireDestinationResponse } from "./wire-destination-response"; /** * A deposit @@ -67,6 +70,12 @@ export interface BusinessDeposit { * @memberof BusinessDeposit */ riskEvaluation?: RiskEvaluation | null; + /** + * A reference to the external customer which is in the memo field of the fiat transfer. + * @type {string} + * @memberof BusinessDeposit + */ + customerExternalRef?: string; /** * ISO-8601 UTC date/time format. * @type {string} @@ -79,6 +88,36 @@ export interface BusinessDeposit { * @memberof BusinessDeposit */ updateDate?: string; + /** + * + * @type {WireDestinationResponse} + * @memberof BusinessDeposit + */ + source?: WireDestinationResponse; + /** + * + * @type {FiatMoneyUsd} + * @memberof BusinessDeposit + */ + fromAmount?: FiatMoneyUsd; + /** + * + * @type {FiatMoneyUsd} + * @memberof BusinessDeposit + */ + fees?: FiatMoneyUsd; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof BusinessDeposit + */ + externalRef?: string; + /** + * Tracking reference used for making the deposit. + * @type {string} + * @memberof BusinessDeposit + */ + trackingRef?: string; } export const BusinessDepositStatusEnum = { diff --git a/src/generated/models/business-payout-creation-request-source.ts b/src/generated/models/business-payout-creation-request-source.ts new file mode 100644 index 00000000..6f91490b --- /dev/null +++ b/src/generated/models/business-payout-creation-request-source.ts @@ -0,0 +1,34 @@ +/* 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 source wallet to pay out from. If not provided, the deposit will come from the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). + * @export + * @interface BusinessPayoutCreationRequestSource + */ +export interface BusinessPayoutCreationRequestSource { + /** + * Unique system-generated identifier for the wallet of the institutional entity. + * @type {string} + * @memberof BusinessPayoutCreationRequestSource + */ + id: string; + /** + * + * @type {string} + * @memberof BusinessPayoutCreationRequestSource + */ + type: BusinessPayoutCreationRequestSourceTypeEnum; +} + +export const BusinessPayoutCreationRequestSourceTypeEnum = { + Wallet: "wallet" +} as const; + +export type BusinessPayoutCreationRequestSourceTypeEnum = + typeof BusinessPayoutCreationRequestSourceTypeEnum[keyof typeof BusinessPayoutCreationRequestSourceTypeEnum]; diff --git a/src/generated/models/business-payout-creation-request.ts b/src/generated/models/business-payout-creation-request.ts index b63c33ce..1a51766c 100644 --- a/src/generated/models/business-payout-creation-request.ts +++ b/src/generated/models/business-payout-creation-request.ts @@ -11,6 +11,9 @@ import { BusinessDestinationRequest } from "./business-destination-request"; // May contain unused imports in some cases // @ts-ignore +import { BusinessPayoutCreationRequestSource } from "./business-payout-creation-request-source"; +// May contain unused imports in some cases +// @ts-ignore import { FiatMoney } from "./fiat-money"; // May contain unused imports in some cases // @ts-ignore @@ -46,4 +49,10 @@ export interface BusinessPayoutCreationRequest { * @memberof BusinessPayoutCreationRequest */ toAmount?: FiatPayoutToMoney; + /** + * + * @type {BusinessPayoutCreationRequestSource} + * @memberof BusinessPayoutCreationRequest + */ + source?: BusinessPayoutCreationRequestSource; } diff --git a/src/generated/models/business-recipient-address-creation-request.ts b/src/generated/models/business-recipient-address-creation-request.ts index 86dc90ff..e0ea36fc 100644 --- a/src/generated/models/business-recipient-address-creation-request.ts +++ b/src/generated/models/business-recipient-address-creation-request.ts @@ -26,7 +26,7 @@ export interface BusinessRecipientAddressCreationRequest { */ idempotencyKey: string; /** - * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address. + * An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address. **Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). The `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`). * @type {string} * @memberof BusinessRecipientAddressCreationRequest */ diff --git a/src/generated/models/business-recipient-address-object.ts b/src/generated/models/business-recipient-address-object.ts index 2948001d..c2e93459 100644 --- a/src/generated/models/business-recipient-address-object.ts +++ b/src/generated/models/business-recipient-address-object.ts @@ -26,7 +26,7 @@ export interface BusinessRecipientAddressObject { */ id?: string; /** - * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address. + * An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address. **Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). The `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`). * @type {string} * @memberof BusinessRecipientAddressObject */ diff --git a/src/generated/models/business-transfer-creation-request-source.ts b/src/generated/models/business-transfer-creation-request-source.ts new file mode 100644 index 00000000..54d29710 --- /dev/null +++ b/src/generated/models/business-transfer-creation-request-source.ts @@ -0,0 +1,34 @@ +/* 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 wallet to be used as the source of the transfer. If not provided, the transfer will come from the main wallet of the account. You can get wallet IDs associated with your account using the [Core API for Institutions](/api-reference/circle-mint/institutional/get-all-external-entities). + * @export + * @interface BusinessTransferCreationRequestSource + */ +export interface BusinessTransferCreationRequestSource { + /** + * Unique system-generated identifier for the wallet of the institutional entity. + * @type {string} + * @memberof BusinessTransferCreationRequestSource + */ + id: string; + /** + * + * @type {string} + * @memberof BusinessTransferCreationRequestSource + */ + type: BusinessTransferCreationRequestSourceTypeEnum; +} + +export const BusinessTransferCreationRequestSourceTypeEnum = { + Wallet: "wallet" +} as const; + +export type BusinessTransferCreationRequestSourceTypeEnum = + typeof BusinessTransferCreationRequestSourceTypeEnum[keyof typeof BusinessTransferCreationRequestSourceTypeEnum]; diff --git a/src/generated/models/business-transfer-creation-request.ts b/src/generated/models/business-transfer-creation-request.ts index 0a6853d8..2b5f5ae5 100644 --- a/src/generated/models/business-transfer-creation-request.ts +++ b/src/generated/models/business-transfer-creation-request.ts @@ -6,6 +6,9 @@ * Do not edit the class manually. */ +// May contain unused imports in some cases +// @ts-ignore +import { BusinessTransferCreationRequestSource } from "./business-transfer-creation-request-source"; // May contain unused imports in some cases // @ts-ignore import { Money } from "./money"; @@ -37,4 +40,10 @@ export interface BusinessTransferCreationRequest { * @memberof BusinessTransferCreationRequest */ amount: Money; + /** + * + * @type {BusinessTransferCreationRequestSource} + * @memberof BusinessTransferCreationRequest + */ + source?: BusinessTransferCreationRequestSource; } diff --git a/src/generated/models/cancel-creation-request.ts b/src/generated/models/cancel-creation-request.ts deleted file mode 100644 index 62caea3c..00000000 --- a/src/generated/models/cancel-creation-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 { ReversalReason } from "./reversal-reason"; - -/** - * - * @export - * @interface CancelCreationRequest - */ -export interface CancelCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof CancelCreationRequest - */ - idempotencyKey: string; - /** - * - * @type {ReversalReason} - * @memberof CancelCreationRequest - */ - reason?: ReversalReason; -} diff --git a/src/generated/models/card-creation-request.ts b/src/generated/models/card-creation-request.ts deleted file mode 100644 index bbbcbc30..00000000 --- a/src/generated/models/card-creation-request.ts +++ /dev/null @@ -1,64 +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 { MetadataCardAndAch } from "./metadata-card-and-ach"; - -/** - * - * @export - * @interface CardCreationRequest - */ -export interface CardCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof CardCreationRequest - */ - idempotencyKey: string; - /** - * 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 CardCreationRequest - */ - keyId?: string; - /** - * PGP encrypted base64 encoded string. Contains Number and CVV. * **Number**: Card number. No spaces or other separators. REQUIRED * **CVV (Card Verification Number)**: Three or four digit security code. REQUIRED\' - * @type {string} - * @memberof CardCreationRequest - */ - encryptedData: string; - /** - * - * @type {BillingDetails} - * @memberof CardCreationRequest - */ - billingDetails: BillingDetails; - /** - * Two digit number representing the card\'s expiration month. - * @type {number} - * @memberof CardCreationRequest - */ - expMonth: number; - /** - * Four digit number representing the card\'s expiration year. - * @type {number} - * @memberof CardCreationRequest - */ - expYear: number; - /** - * - * @type {MetadataCardAndAch} - * @memberof CardCreationRequest - */ - metadata: MetadataCardAndAch; -} diff --git a/src/generated/models/card-update.ts b/src/generated/models/card-update.ts deleted file mode 100644 index d58b9485..00000000 --- a/src/generated/models/card-update.ts +++ /dev/null @@ -1,49 +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 { UpdateBillingDetails } from "./update-billing-details"; - -/** - * - * @export - * @interface CardUpdate - */ -export interface CardUpdate { - /** - * 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 CardUpdate - */ - keyId: string; - /** - * PGP encrypted base64 encoded string. Contains CVV. * **CVV (Card Verification Number)**: Three or four digit security code. REQUIRED\' - * @type {string} - * @memberof CardUpdate - */ - encryptedData: string; - /** - * Two digit number representing the card\'s expiration month. - * @type {number} - * @memberof CardUpdate - */ - expMonth?: number; - /** - * Four digit number representing the card\'s expiration year. - * @type {number} - * @memberof CardUpdate - */ - expYear?: number; - /** - * - * @type {UpdateBillingDetails} - * @memberof CardUpdate - */ - billingDetails?: UpdateBillingDetails; -} diff --git a/src/generated/models/card-verification-response.ts b/src/generated/models/card-verification-response.ts deleted file mode 100644 index c00facd4..00000000 --- a/src/generated/models/card-verification-response.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 { CvvResults } from "./cvv-results"; - -/** - * Indicates the status of the card for verification purposes. - * @export - * @interface CardVerificationResponse - */ -export interface CardVerificationResponse { - /** - * Status of the AVS check. Raw AVS response, expressed as an upper-case letter. `not_requested` indicates check was not made. `pending` is pending/processing. - * @type {string} - * @memberof CardVerificationResponse - */ - avs: string; - /** - * - * @type {CvvResults} - * @memberof CardVerificationResponse - */ - cvv: CvvResults; -} diff --git a/src/generated/models/card.ts b/src/generated/models/card.ts deleted file mode 100644 index 46ef1a3a..00000000 --- a/src/generated/models/card.ts +++ /dev/null @@ -1,155 +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 { CardVerificationResponse } from "./card-verification-response"; -// 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"; -// May contain unused imports in some cases -// @ts-ignore -import { VerificationErrorCode } from "./verification-error-code"; - -/** - * - * @export - * @interface Card - */ -export interface Card { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof Card - */ - id: string; - /** - * - * @type {ExternalFiatAccountStatus} - * @memberof Card - */ - status: ExternalFiatAccountStatus; - /** - * - * @type {BillingDetails} - * @memberof Card - */ - billingDetails: BillingDetails; - /** - * Two digit number representing the card\'s expiration month. - * @type {number} - * @memberof Card - */ - expMonth: number; - /** - * Four digit number representing the card\'s expiration year. - * @type {number} - * @memberof Card - */ - expYear: number; - /** - * The network of the card. - * @type {string} - * @memberof Card - */ - network: CardNetworkEnum; - /** - * The last 4 digits of the card. - * @type {string} - * @memberof Card - */ - last4: string; - /** - * The bank identification number (BIN), the first 6 digits of the card. - * @type {string} - * @memberof Card - */ - bin?: string; - /** - * The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard. - * @type {string} - * @memberof Card - */ - issuerCountry?: string; - /** - * The funding type of the card. Possible values are `credit`, `debit`, `prepaid`, and `unknown`. - * @type {string} - * @memberof Card - */ - fundingType?: CardFundingTypeEnum; - /** - * 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 Card - */ - fingerprint: string; - /** - * - * @type {VerificationErrorCode} - * @memberof Card - */ - errorCode?: VerificationErrorCode | null; - /** - * - * @type {CardVerificationResponse} - * @memberof Card - */ - verification: CardVerificationResponse; - /** - * - * @type {RiskEvaluation} - * @memberof Card - */ - riskEvaluation?: RiskEvaluation | null; - /** - * - * @type {MetadataPhoneEmail} - * @memberof Card - */ - metadata: MetadataPhoneEmail; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Card - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Card - */ - updateDate: string; -} - -export const CardNetworkEnum = { - Visa: "VISA", - Mastercard: "MASTERCARD", - Amex: "AMEX", - Unknown: "UNKNOWN" -} as const; - -export type CardNetworkEnum = - typeof CardNetworkEnum[keyof typeof CardNetworkEnum]; -export const CardFundingTypeEnum = { - Credit: "credit", - Debit: "debit", - Prepaid: "prepaid", - Unknown: "unknown" -} as const; - -export type CardFundingTypeEnum = - typeof CardFundingTypeEnum[keyof typeof CardFundingTypeEnum]; diff --git a/src/generated/models/chain.ts b/src/generated/models/chain.ts index a4efb7ac..3e7aa386 100644 --- a/src/generated/models/chain.ts +++ b/src/generated/models/chain.ts @@ -14,22 +14,35 @@ export const Chain = { Algo: "ALGO", + Aptos: "APTOS", Arb: "ARB", Avax: "AVAX", Base: "BASE", Btc: "BTC", Celo: "CELO", + Codex: "CODEX", Eth: "ETH", Hbar: "HBAR", + Hyperevm: "HYPEREVM", + Ink: "INK", + Linea: "LINEA", Near: "NEAR", Noble: "NOBLE", Op: "OP", + Plume: "PLUME", Pah: "PAH", Poly: "POLY", + Sei: "SEI", Sol: "SOL", + Sonic: "SONIC", Sui: "SUI", + Uni: "UNI", + Worldchain: "WORLDCHAIN", + Xdc: "XDC", Xlm: "XLM", - Zks: "ZKS" + Xrp: "XRP", + Zks: "ZKS", + Zksync: "ZKSYNC" } as const; export type Chain = typeof Chain[keyof typeof Chain]; diff --git a/src/generated/models/channel-response.ts b/src/generated/models/channel-response.ts deleted file mode 100644 index e0de40f9..00000000 --- a/src/generated/models/channel-response.ts +++ /dev/null @@ -1,39 +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 ChannelResponse - */ -export interface ChannelResponse { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof ChannelResponse - */ - id?: string; - /** - * Flag to indicate whether the channel is configured as default. At most one of the channels will have this flag set to true and the default channel is used when a payment request does not have the `channel` property set. - * @type {boolean} - * @memberof ChannelResponse - */ - default?: boolean; - /** - * Descriptor that appears on cardholders\' bank statements for card payments submitted through this channel. - * @type {string} - * @memberof ChannelResponse - */ - cardDescriptor?: string; - /** - * Descriptor that appears on end-users\' bank statements for ACH payments submitted through this channel. - * @type {string} - * @memberof ChannelResponse - */ - achDescriptor?: string; -} diff --git a/src/generated/models/chargeback-categories.ts b/src/generated/models/chargeback-categories.ts deleted file mode 100644 index 47fc3914..00000000 --- a/src/generated/models/chargeback-categories.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. - */ - -/** - * Enumerated category of the chargeback status codes based on the chargeback status code. - * @export - * @enum {string} - */ - -export const ChargebackCategories = { - CanceledRecurringPayment: "Canceled Recurring Payment", - CustomerDispute: "Customer Dispute", - Fraudulent: "Fraudulent", - General: "General", - ProcessingError: "Processing Error", - NotDefined: "Not Defined" -} as const; - -export type ChargebackCategories = - typeof ChargebackCategories[keyof typeof ChargebackCategories]; diff --git a/src/generated/models/chargeback-status.ts b/src/generated/models/chargeback-status.ts deleted file mode 100644 index 0423ae34..00000000 --- a/src/generated/models/chargeback-status.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. - */ - -/** - * Enumerated status of the chargeback. `active` means you’ve received a dispute and you need to submit evidence if you want to defend against it. \'resolved\' means the disputed payment had been refunded previously. Your account has not been debited. `pending` means we have acknowledged your evidence and forwarded it to the card issuer. `won` means you have won the dispute and your account has been credited. `lost` means the issuing bank has rejected your evidence and you have lost the dispute. There are no further financial implications. `canceled` means the issuing bank has canceled the dispute and your account has been credited. `closed` means the time to respond to this dispute has run out. No evidence can be submitted at this point. - * @export - * @enum {string} - */ - -export const ChargebackStatus = { - Active: "active", - Resolved: "resolved", - Pending: "pending", - Won: "won", - Lost: "lost", - Canceled: "canceled", - Closed: "closed" -} as const; - -export type ChargebackStatus = - typeof ChargebackStatus[keyof typeof ChargebackStatus]; diff --git a/src/generated/models/checkout-session-creation-request.ts b/src/generated/models/checkout-session-creation-request.ts deleted file mode 100644 index cf9147bd..00000000 --- a/src/generated/models/checkout-session-creation-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 { CheckoutSessionMoney } from "./checkout-session-money"; - -/** - * - * @export - * @interface CheckoutSessionCreationRequest - */ -export interface CheckoutSessionCreationRequest { - /** - * The URL returned to you through client-side callback when the payment is completed. - * @type {string} - * @memberof CheckoutSessionCreationRequest - */ - successUrl?: string; - /** - * - * @type {CheckoutSessionMoney} - * @memberof CheckoutSessionCreationRequest - */ - amount: CheckoutSessionMoney; -} diff --git a/src/generated/models/checkout-session-money.ts b/src/generated/models/checkout-session-money.ts deleted file mode 100644 index 6e4a9569..00000000 --- a/src/generated/models/checkout-session-money.ts +++ /dev/null @@ -1,36 +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 CheckoutSessionMoney - */ -export interface CheckoutSessionMoney { - /** - * Magnitude of the amount, in units of the currency, with a `.`. - * @type {string} - * @memberof CheckoutSessionMoney - */ - amount: string; - /** - * A currency associated with a balance or address. - * @type {string} - * @memberof CheckoutSessionMoney - */ - currency: CheckoutSessionMoneyCurrencyEnum; -} - -export const CheckoutSessionMoneyCurrencyEnum = { - Usd: "USD", - Eth: "ETH", - Btc: "BTC" -} as const; - -export type CheckoutSessionMoneyCurrencyEnum = - typeof CheckoutSessionMoneyCurrencyEnum[keyof typeof CheckoutSessionMoneyCurrencyEnum]; diff --git a/src/generated/models/checkout-session-status.ts b/src/generated/models/checkout-session-status.ts deleted file mode 100644 index 99ec7bde..00000000 --- a/src/generated/models/checkout-session-status.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. - */ - -/** - * Status of the checkout session. Active: the checkout session is still in-progress. Completed: the payments of a checkout session is successful and the checkout session is completed. Expired: indicates that it expired and is no longer accepting any new payments. - * @export - * @enum {string} - */ - -export const CheckoutSessionStatus = { - Active: "active", - Completed: "completed", - Expired: "expired" -} as const; - -export type CheckoutSessionStatus = - typeof CheckoutSessionStatus[keyof typeof CheckoutSessionStatus]; diff --git a/src/generated/models/checkout-session.ts b/src/generated/models/checkout-session.ts deleted file mode 100644 index badf5b7b..00000000 --- a/src/generated/models/checkout-session.ts +++ /dev/null @@ -1,101 +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 { CheckoutSessionMoney } from "./checkout-session-money"; -// May contain unused imports in some cases -// @ts-ignore -import { CheckoutSessionStatus } from "./checkout-session-status"; - -/** - * - * @export - * @interface CheckoutSession - */ -export interface CheckoutSession { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof CheckoutSession - */ - id: string; - /** - * The type of this response - * @type {string} - * @memberof CheckoutSession - */ - type: CheckoutSessionTypeEnum; - /** - * The URL returned to you through client-side callback when the payment is completed. - * @type {string} - * @memberof CheckoutSession - */ - successUrl?: string; - /** - * The access token for the SDK to access checkout session resources - * @type {string} - * @memberof CheckoutSession - */ - clientToken: string; - /** - * - * @type {CheckoutSessionStatus} - * @memberof CheckoutSession - */ - status: CheckoutSessionStatus; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof CheckoutSession - */ - expiresOn: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof CheckoutSession - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof CheckoutSession - */ - updateDate: string; - /** - * - * @type {CheckoutSessionMoney} - * @memberof CheckoutSession - */ - amount: CheckoutSessionMoney; - /** - * - * @type {CheckoutSessionMoney} - * @memberof CheckoutSession - */ - amountPaid: CheckoutSessionMoney; - /** - * IDs of all the associated payments. - * @type {Array} - * @memberof CheckoutSession - */ - paymentIds: Array; - /** - * IDs of all the associated payment intents. - * @type {Array} - * @memberof CheckoutSession - */ - paymentIntentIds: Array; -} - -export const CheckoutSessionTypeEnum = { - CheckoutSession: "checkout_session" -} as const; - -export type CheckoutSessionTypeEnum = - typeof CheckoutSessionTypeEnum[keyof typeof CheckoutSessionTypeEnum]; diff --git a/src/generated/models/continuous-payment-intent-creation-request.ts b/src/generated/models/continuous-payment-intent-creation-request.ts index 7fb0cb7a..2d2b6fc1 100644 --- a/src/generated/models/continuous-payment-intent-creation-request.ts +++ b/src/generated/models/continuous-payment-intent-creation-request.ts @@ -8,7 +8,7 @@ // May contain unused imports in some cases // @ts-ignore -import { PaymentMethodBlockchain } from "./payment-method-blockchain"; +import { PaymentMethodBlockchainRequest } from "./payment-method-blockchain-request"; /** * @@ -29,23 +29,23 @@ export interface ContinuousPaymentIntentCreationRequest { */ currency: ContinuousPaymentIntentCreationRequestCurrencyEnum; /** - * Desired currency for the payments to settle in. + * Desired currency for the payments to settle in. This must match the currency used for the payment. * @type {string} * @memberof ContinuousPaymentIntentCreationRequest */ settlementCurrency: ContinuousPaymentIntentCreationRequestSettlementCurrencyEnum; /** * - * @type {Array} + * @type {Array} * @memberof ContinuousPaymentIntentCreationRequest */ - paymentMethods: Array; + paymentMethods: Array; /** * Unique system generated identifier for the wallet of the merchant. * @type {string} * @memberof ContinuousPaymentIntentCreationRequest */ - merchantWalletId?: string; + merchantWalletId: string; /** * * @type {string} @@ -56,6 +56,7 @@ export interface ContinuousPaymentIntentCreationRequest { export const ContinuousPaymentIntentCreationRequestCurrencyEnum = { Usd: "USD", + Eur: "EUR", Btc: "BTC", Eth: "ETH" } as const; @@ -64,6 +65,7 @@ export type ContinuousPaymentIntentCreationRequestCurrencyEnum = typeof ContinuousPaymentIntentCreationRequestCurrencyEnum[keyof typeof ContinuousPaymentIntentCreationRequestCurrencyEnum]; export const ContinuousPaymentIntentCreationRequestSettlementCurrencyEnum = { Usd: "USD", + Eur: "EUR", Btc: "BTC", Eth: "ETH" } as const; diff --git a/src/generated/models/create-crypto-payment-response1.ts b/src/generated/models/create-crypto-payment-response1.ts deleted file mode 100644 index a99c5758..00000000 --- a/src/generated/models/create-crypto-payment-response1.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 { PresignResponse } from "./presign-response"; - -/** - * - * @export - * @interface CreateCryptoPaymentResponse1 - */ -export interface CreateCryptoPaymentResponse1 { - /** - * - * @type {PresignResponse} - * @memberof CreateCryptoPaymentResponse1 - */ - data?: PresignResponse; -} diff --git a/src/generated/models/create-fx-account-request.ts b/src/generated/models/create-fx-account-request.ts new file mode 100644 index 00000000..f3e61c27 --- /dev/null +++ b/src/generated/models/create-fx-account-request.ts @@ -0,0 +1,31 @@ +/* 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 { FxFiatCurrency } from "./fx-fiat-currency"; + +/** + * + * @export + * @interface CreateFxAccountRequest + */ +export interface CreateFxAccountRequest { + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof CreateFxAccountRequest + */ + fiatAccountId?: string; + /** + * + * @type {FxFiatCurrency} + * @memberof CreateFxAccountRequest + */ + currency?: FxFiatCurrency; +} diff --git a/src/generated/models/create-fx-account-response.ts b/src/generated/models/create-fx-account-response.ts new file mode 100644 index 00000000..c4d58ba0 --- /dev/null +++ b/src/generated/models/create-fx-account-response.ts @@ -0,0 +1,43 @@ +/* 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 { FxFiatCurrency } from "./fx-fiat-currency"; + +/** + * + * @export + * @interface CreateFxAccountResponse + */ +export interface CreateFxAccountResponse { + /** + * + * @type {FxFiatCurrency} + * @memberof CreateFxAccountResponse + */ + currency?: FxFiatCurrency; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof CreateFxAccountResponse + */ + fiatAccountId?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof CreateFxAccountResponse + */ + createDate?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof CreateFxAccountResponse + */ + updateDate?: string; +} diff --git a/src/generated/models/create-fx-account-response1.ts b/src/generated/models/create-fx-account-response1.ts new file mode 100644 index 00000000..a9eecab2 --- /dev/null +++ b/src/generated/models/create-fx-account-response1.ts @@ -0,0 +1,25 @@ +/* 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 { CreateFxAccountResponse } from "./create-fx-account-response"; + +/** + * + * @export + * @interface CreateFxAccountResponse1 + */ +export interface CreateFxAccountResponse1 { + /** + * + * @type {CreateFxAccountResponse} + * @memberof CreateFxAccountResponse1 + */ + data?: CreateFxAccountResponse; +} diff --git a/src/generated/models/create-fx-trade-response-data.ts b/src/generated/models/create-fx-trade-response-data.ts new file mode 100644 index 00000000..d0131eca --- /dev/null +++ b/src/generated/models/create-fx-trade-response-data.ts @@ -0,0 +1,64 @@ +/* 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 { FxMoney } from "./fx-money"; +// May contain unused imports in some cases +// @ts-ignore +import { TradeStatus } from "./trade-status"; + +/** + * + * @export + * @interface CreateFxTradeResponseData + */ +export interface CreateFxTradeResponseData { + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof CreateFxTradeResponseData + */ + id?: string; + /** + * + * @type {FxMoney} + * @memberof CreateFxTradeResponseData + */ + from?: FxMoney; + /** + * + * @type {FxMoney} + * @memberof CreateFxTradeResponseData + */ + to?: FxMoney; + /** + * + * @type {TradeStatus} + * @memberof CreateFxTradeResponseData + */ + status?: TradeStatus; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof CreateFxTradeResponseData + */ + createDate?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof CreateFxTradeResponseData + */ + updateDate?: string; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof CreateFxTradeResponseData + */ + quoteId?: string; +} diff --git a/src/generated/models/create-fx-trade-response.ts b/src/generated/models/create-fx-trade-response.ts new file mode 100644 index 00000000..b83af290 --- /dev/null +++ b/src/generated/models/create-fx-trade-response.ts @@ -0,0 +1,25 @@ +/* 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 { CreateFxTradeResponseData } from "./create-fx-trade-response-data"; + +/** + * + * @export + * @interface CreateFxTradeResponse + */ +export interface CreateFxTradeResponse { + /** + * + * @type {CreateFxTradeResponseData} + * @memberof CreateFxTradeResponse + */ + data?: CreateFxTradeResponseData; +} diff --git a/src/generated/models/create-payment-intent-request.ts b/src/generated/models/create-payment-intent-request.ts index f7310bf0..90aefd9b 100644 --- a/src/generated/models/create-payment-intent-request.ts +++ b/src/generated/models/create-payment-intent-request.ts @@ -17,7 +17,7 @@ import { CryptoPaymentsMoney } from "./crypto-payments-money"; import { PaymentIntentCreationRequest } from "./payment-intent-creation-request"; // May contain unused imports in some cases // @ts-ignore -import { PaymentMethodBlockchain } from "./payment-method-blockchain"; +import { PaymentMethodBlockchainRequest } from "./payment-method-blockchain-request"; /** * @type CreatePaymentIntentRequest diff --git a/src/generated/models/create-payment-token-response.ts b/src/generated/models/create-payment-token-response.ts deleted file mode 100644 index 0e33119b..00000000 --- a/src/generated/models/create-payment-token-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 { PaymentToken } from "./payment-token"; - -/** - * - * @export - * @interface CreatePaymentTokenResponse - */ -export interface CreatePaymentTokenResponse { - /** - * - * @type {PaymentToken} - * @memberof CreatePaymentTokenResponse - */ - data?: PaymentToken; -} diff --git a/src/generated/models/cancel-payment-response.ts b/src/generated/models/create-pix-payment-response.ts similarity index 54% rename from src/generated/models/cancel-payment-response.ts rename to src/generated/models/create-pix-payment-response.ts index e3a48988..422ec54d 100644 --- a/src/generated/models/cancel-payment-response.ts +++ b/src/generated/models/create-pix-payment-response.ts @@ -8,18 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { DetailedCancel } from "./detailed-cancel"; +import { MockPixPaymentResponse } from "./mock-pix-payment-response"; /** * * @export - * @interface CancelPaymentResponse + * @interface CreatePixPaymentResponse */ -export interface CancelPaymentResponse { +export interface CreatePixPaymentResponse { /** * - * @type {DetailedCancel} - * @memberof CancelPaymentResponse + * @type {MockPixPaymentResponse} + * @memberof CreatePixPaymentResponse */ - data?: DetailedCancel; + data?: MockPixPaymentResponse; } diff --git a/src/generated/models/crypto-payment-creation-request.ts b/src/generated/models/crypto-payment-creation-request.ts deleted file mode 100644 index 67440156..00000000 --- a/src/generated/models/crypto-payment-creation-request.ts +++ /dev/null @@ -1,70 +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 { CryptoPaymentDestination } from "./crypto-payment-destination"; -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPaymentSource } from "./crypto-payment-source"; -// May contain unused imports in some cases -// @ts-ignore -import { CryptoPaymentsMoney } from "./crypto-payments-money"; -// May contain unused imports in some cases -// @ts-ignore -import { MetadataCryptoPayment } from "./metadata-crypto-payment"; - -/** - * - * @export - * @interface CryptoPaymentCreationRequest - */ -export interface CryptoPaymentCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof CryptoPaymentCreationRequest - */ - idempotencyKey: string; - /** - * Payment intent uuid which is generated by the create payment intent call - * @type {string} - * @memberof CryptoPaymentCreationRequest - */ - paymentIntentId: string; - /** - * - * @type {MetadataCryptoPayment} - * @memberof CryptoPaymentCreationRequest - */ - protocolMetadata: MetadataCryptoPayment; - /** - * - * @type {CryptoPaymentsMoney} - * @memberof CryptoPaymentCreationRequest - */ - amount: CryptoPaymentsMoney; - /** - * - * @type {CryptoPaymentSource} - * @memberof CryptoPaymentCreationRequest - */ - source: CryptoPaymentSource; - /** - * - * @type {CryptoPaymentDestination} - * @memberof CryptoPaymentCreationRequest - */ - destination: CryptoPaymentDestination; - /** - * Network fee quote uuid which is returned from the /presign response. Only required when end user pays for gas fee - * @type {string} - * @memberof CryptoPaymentCreationRequest - */ - quoteId?: string; -} diff --git a/src/generated/models/crypto-payment-destination.ts b/src/generated/models/crypto-payment-destination.ts deleted file mode 100644 index 916603ae..00000000 --- a/src/generated/models/crypto-payment-destination.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. - */ - -/** - * - * @export - * @interface CryptoPaymentDestination - */ -export interface CryptoPaymentDestination { - /** - * The destination address - * @type {string} - * @memberof CryptoPaymentDestination - */ - address: string; - /** - * - * @type {string} - * @memberof CryptoPaymentDestination - */ - chain: CryptoPaymentDestinationChainEnum; -} - -export const CryptoPaymentDestinationChainEnum = { - Eth: "ETH" -} as const; - -export type CryptoPaymentDestinationChainEnum = - typeof CryptoPaymentDestinationChainEnum[keyof typeof CryptoPaymentDestinationChainEnum]; diff --git a/src/generated/models/crypto-payment-source.ts b/src/generated/models/crypto-payment-source.ts deleted file mode 100644 index 3d72cf2b..00000000 --- a/src/generated/models/crypto-payment-source.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. - */ - -/** - * - * @export - * @interface CryptoPaymentSource - */ -export interface CryptoPaymentSource { - /** - * The source address - * @type {string} - * @memberof CryptoPaymentSource - */ - address: string; - /** - * The source type - * @type {string} - * @memberof CryptoPaymentSource - */ - type: CryptoPaymentSourceTypeEnum; -} - -export const CryptoPaymentSourceTypeEnum = { - Blockchain: "blockchain" -} as const; - -export type CryptoPaymentSourceTypeEnum = - typeof CryptoPaymentSourceTypeEnum[keyof typeof CryptoPaymentSourceTypeEnum]; diff --git a/src/generated/models/crypto-payments-money.ts b/src/generated/models/crypto-payments-money.ts index 4da721df..b6627a62 100644 --- a/src/generated/models/crypto-payments-money.ts +++ b/src/generated/models/crypto-payments-money.ts @@ -28,6 +28,7 @@ export interface CryptoPaymentsMoney { export const CryptoPaymentsMoneyCurrencyEnum = { Usd: "USD", + Eur: "EUR", Eth: "ETH", Btc: "BTC" } as const; diff --git a/src/generated/models/crypto-payout-creation-request.ts b/src/generated/models/crypto-payout-creation-request.ts index 83f9c226..6e4125c1 100644 --- a/src/generated/models/crypto-payout-creation-request.ts +++ b/src/generated/models/crypto-payout-creation-request.ts @@ -11,10 +11,7 @@ import { CryptoPayoutDestination } from "./crypto-payout-destination"; // 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"; +import { CryptoPayoutMoney } from "./crypto-payout-money"; // May contain unused imports in some cases // @ts-ignore import { TransferSourceWalletLocation } from "./transfer-source-wallet-location"; @@ -45,14 +42,14 @@ export interface CryptoPayoutCreationRequest { destination: CryptoPayoutDestination; /** * - * @type {Money} + * @type {CryptoPayoutMoney} * @memberof CryptoPayoutCreationRequest */ - amount: Money; + amount: CryptoPayoutMoney; /** * - * @type {ToAmount} + * @type {CryptoPayoutMoney} * @memberof CryptoPayoutCreationRequest */ - toAmount?: ToAmount; + toAmount?: CryptoPayoutMoney; } diff --git a/src/generated/models/crypto-payout-money.ts b/src/generated/models/crypto-payout-money.ts new file mode 100644 index 00000000..08b6e16e --- /dev/null +++ b/src/generated/models/crypto-payout-money.ts @@ -0,0 +1,35 @@ +/* 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 CryptoPayoutMoney + */ +export interface CryptoPayoutMoney { + /** + * The numeric value of the amount, expressed in units of the specified currency. Use a period (`.`) as the decimal separator. + * @type {string} + * @memberof CryptoPayoutMoney + */ + amount: string; + /** + * The ISO 4217 currency code for the amount. + * @type {string} + * @memberof CryptoPayoutMoney + */ + currency: CryptoPayoutMoneyCurrencyEnum; +} + +export const CryptoPayoutMoneyCurrencyEnum = { + Usd: "USD", + Eur: "EUR" +} as const; + +export type CryptoPayoutMoneyCurrencyEnum = + typeof CryptoPayoutMoneyCurrencyEnum[keyof typeof CryptoPayoutMoneyCurrencyEnum]; diff --git a/src/generated/models/daily-custody-balances-request-additional-fields.ts b/src/generated/models/daily-custody-balances-request-additional-fields.ts new file mode 100644 index 00000000..1e11c573 --- /dev/null +++ b/src/generated/models/daily-custody-balances-request-additional-fields.ts @@ -0,0 +1,33 @@ +/* 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 fields are required only for the `eea` report type. They are ignored for the `japan_trust` report type. + * @export + * @interface DailyCustodyBalancesRequestAdditionalFields + */ +export interface DailyCustodyBalancesRequestAdditionalFields { + /** + * EUR equivalent of the `localBalance` field. + * @type {number} + * @memberof DailyCustodyBalancesRequestAdditionalFields + */ + equivalentEuroLocalBalance: number; + /** + * Tokens held by the EU licensed crypto-asset service provider + * @type {number} + * @memberof DailyCustodyBalancesRequestAdditionalFields + */ + totalBalance: number; + /** + * EUR equivalent of the total worldwide token balance. + * @type {number} + * @memberof DailyCustodyBalancesRequestAdditionalFields + */ + equivalentEuroTotalBalance: number; +} diff --git a/src/generated/models/daily-custody-balances-request.ts b/src/generated/models/daily-custody-balances-request.ts new file mode 100644 index 00000000..aeed9f7d --- /dev/null +++ b/src/generated/models/daily-custody-balances-request.ts @@ -0,0 +1,70 @@ +/* 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 { DailyCustodyBalancesRequestAdditionalFields } from "./daily-custody-balances-request-additional-fields"; + +/** + * + * @export + * @interface DailyCustodyBalancesRequest + */ +export interface DailyCustodyBalancesRequest { + /** + * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. + * @type {string} + * @memberof DailyCustodyBalancesRequest + */ + idempotencyKey: string; + /** + * The type of token being reported. + * @type {string} + * @memberof DailyCustodyBalancesRequest + */ + currency: DailyCustodyBalancesRequestCurrencyEnum; + /** + * Regional specific balance for the provided token type. eea - tokens held by the EU licensed crypto-asset service provider, which are held by Union clients of that EU licensed crypto-asset service provider. japan_trust - total amount held in custody on behalf of customers of the EPIESP. + * @type {number} + * @memberof DailyCustodyBalancesRequest + */ + localBalance: number; + /** + * The day being reported in the format YYYY-MM-DD with timezone UTC. + * @type {string} + * @memberof DailyCustodyBalancesRequest + */ + asOfDate: string; + /** + * The type of report being created. + * @type {string} + * @memberof DailyCustodyBalancesRequest + */ + reportType: DailyCustodyBalancesRequestReportTypeEnum; + /** + * + * @type {DailyCustodyBalancesRequestAdditionalFields} + * @memberof DailyCustodyBalancesRequest + */ + additionalFields: DailyCustodyBalancesRequestAdditionalFields; +} + +export const DailyCustodyBalancesRequestCurrencyEnum = { + Usdc: "USDC", + Eurc: "EURC" +} as const; + +export type DailyCustodyBalancesRequestCurrencyEnum = + typeof DailyCustodyBalancesRequestCurrencyEnum[keyof typeof DailyCustodyBalancesRequestCurrencyEnum]; +export const DailyCustodyBalancesRequestReportTypeEnum = { + Eea: "eea", + JapanTrust: "japan_trust" +} as const; + +export type DailyCustodyBalancesRequestReportTypeEnum = + typeof DailyCustodyBalancesRequestReportTypeEnum[keyof typeof DailyCustodyBalancesRequestReportTypeEnum]; diff --git a/src/generated/models/daily-custody-balances-response-additional-fields.ts b/src/generated/models/daily-custody-balances-response-additional-fields.ts new file mode 100644 index 00000000..9ebcee7b --- /dev/null +++ b/src/generated/models/daily-custody-balances-response-additional-fields.ts @@ -0,0 +1,33 @@ +/* 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 fields are required only for the `eea` report type. They are ignored for the `japan_trust` report type. + * @export + * @interface DailyCustodyBalancesResponseAdditionalFields + */ +export interface DailyCustodyBalancesResponseAdditionalFields { + /** + * EUR equivalent of the `localBalance` field. + * @type {number} + * @memberof DailyCustodyBalancesResponseAdditionalFields + */ + equivalentEuroLocalBalance?: number; + /** + * Tokens held by the EU licensed crypto-asset service provider + * @type {number} + * @memberof DailyCustodyBalancesResponseAdditionalFields + */ + totalBalance?: number; + /** + * EUR equivalent of the total worldwide token balance. + * @type {number} + * @memberof DailyCustodyBalancesResponseAdditionalFields + */ + equivalentEuroTotalBalance?: number; +} diff --git a/src/generated/models/daily-custody-balances-response.ts b/src/generated/models/daily-custody-balances-response.ts new file mode 100644 index 00000000..36cf2547 --- /dev/null +++ b/src/generated/models/daily-custody-balances-response.ts @@ -0,0 +1,82 @@ +/* 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 { DailyCustodyBalancesResponseAdditionalFields } from "./daily-custody-balances-response-additional-fields"; + +/** + * + * @export + * @interface DailyCustodyBalancesResponse + */ +export interface DailyCustodyBalancesResponse { + /** + * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. + * @type {string} + * @memberof DailyCustodyBalancesResponse + */ + idempotencyKey?: string; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof DailyCustodyBalancesResponse + */ + id?: string; + /** + * + * @type {string} + * @memberof DailyCustodyBalancesResponse + */ + createDate?: string; + /** + * Regional specific balance for the provided token type. eea - tokens held by the EU licensed crypto-asset service provider, which are held by Union clients of that EU licensed crypto-asset service provider. japan_trust - total amount held in custody on behalf of customers of the EPIESP. + * @type {number} + * @memberof DailyCustodyBalancesResponse + */ + localBalance?: number; + /** + * The type of token being reported. + * @type {string} + * @memberof DailyCustodyBalancesResponse + */ + currency?: DailyCustodyBalancesResponseCurrencyEnum; + /** + * The day being reported in the format YYYY-MM-DD with timezone UTC. + * @type {string} + * @memberof DailyCustodyBalancesResponse + */ + asOfDate?: string; + /** + * The type of report being created. + * @type {string} + * @memberof DailyCustodyBalancesResponse + */ + reportType?: DailyCustodyBalancesResponseReportTypeEnum; + /** + * + * @type {DailyCustodyBalancesResponseAdditionalFields} + * @memberof DailyCustodyBalancesResponse + */ + additionalFields?: DailyCustodyBalancesResponseAdditionalFields; +} + +export const DailyCustodyBalancesResponseCurrencyEnum = { + Usdc: "USDC", + Eurc: "EURC" +} as const; + +export type DailyCustodyBalancesResponseCurrencyEnum = + typeof DailyCustodyBalancesResponseCurrencyEnum[keyof typeof DailyCustodyBalancesResponseCurrencyEnum]; +export const DailyCustodyBalancesResponseReportTypeEnum = { + Eea: "eea", + JapanTrust: "japan_trust" +} as const; + +export type DailyCustodyBalancesResponseReportTypeEnum = + typeof DailyCustodyBalancesResponseReportTypeEnum[keyof typeof DailyCustodyBalancesResponseReportTypeEnum]; diff --git a/src/generated/models/daily-fx-limits.ts b/src/generated/models/daily-fx-limits.ts new file mode 100644 index 00000000..2b2582b9 --- /dev/null +++ b/src/generated/models/daily-fx-limits.ts @@ -0,0 +1,43 @@ +/* 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 { FxCurrencyLimit } from "./fx-currency-limit"; + +/** + * + * @export + * @interface DailyFxLimits + */ +export interface DailyFxLimits { + /** + * + * @type {FxCurrencyLimit} + * @memberof DailyFxLimits + */ + EURC?: FxCurrencyLimit; + /** + * + * @type {FxCurrencyLimit} + * @memberof DailyFxLimits + */ + MXN?: FxCurrencyLimit; + /** + * + * @type {FxCurrencyLimit} + * @memberof DailyFxLimits + */ + USDC?: FxCurrencyLimit; + /** + * + * @type {FxCurrencyLimit} + * @memberof DailyFxLimits + */ + BRL?: FxCurrencyLimit; +} diff --git a/src/generated/models/detailed-cancel.ts b/src/generated/models/detailed-cancel.ts deleted file mode 100644 index 6b1d3ecb..00000000 --- a/src/generated/models/detailed-cancel.ts +++ /dev/null @@ -1,152 +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 { FiatPayment } from "./fiat-payment"; -// 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 { PaymentErrorCode } from "./payment-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { SourceResponse } from "./source-response"; - -/** - * - * @export - * @interface DetailedCancel - */ -export interface DetailedCancel { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof DetailedCancel - */ - id: string; - /** - * Type of the payment object. - * @type {string} - * @memberof DetailedCancel - */ - type: DetailedCancelTypeEnum; - /** - * Unique system generated identifier for the merchant. - * @type {string} - * @memberof DetailedCancel - */ - merchantId: string; - /** - * Unique system generated identifier for the wallet of the merchant. - * @type {string} - * @memberof DetailedCancel - */ - merchantWalletId?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedCancel - */ - amount: FiatMoneyUsd; - /** - * - * @type {SourceResponse} - * @memberof DetailedCancel - */ - source: SourceResponse; - /** - * Enumerated description of the payment. - * @type {string} - * @memberof DetailedCancel - */ - description?: DetailedCancelDescriptionEnum; - /** - * - * @type {CancelRefundReversalStatus} - * @memberof DetailedCancel - */ - status: CancelRefundReversalStatus; - /** - * - * @type {FiatPayment} - * @memberof DetailedCancel - */ - originalPayment?: FiatPayment; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedCancel - */ - fees?: FiatMoneyUsd; - /** - * Payment tracking reference. Will be present once known. - * @type {string} - * @memberof DetailedCancel - */ - trackingRef?: string | null; - /** - * - * @type {PaymentErrorCode} - * @memberof DetailedCancel - */ - errorCode?: PaymentErrorCode | null; - /** - * - * @type {MetadataPhoneEmail} - * @memberof DetailedCancel - */ - metadata?: MetadataPhoneEmail; - /** - * - * @type {RiskEvaluation} - * @memberof DetailedCancel - */ - riskEvaluation?: RiskEvaluation | null; - /** - * If the cancel was made after a cutoff time period, it will be processed as a refund. This flag indicates that the cancel was processed as a refund\' - * @type {boolean} - * @memberof DetailedCancel - */ - refund?: boolean; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedCancel - */ - createDate?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedCancel - */ - updateDate?: string; -} - -export const DetailedCancelTypeEnum = { - Cancel: "cancel" -} as const; - -export type DetailedCancelTypeEnum = - typeof DetailedCancelTypeEnum[keyof typeof DetailedCancelTypeEnum]; -export const DetailedCancelDescriptionEnum = { - Payment: "Payment" -} as const; - -export type DetailedCancelDescriptionEnum = - typeof DetailedCancelDescriptionEnum[keyof typeof DetailedCancelDescriptionEnum]; diff --git a/src/generated/models/detailed-payment.ts b/src/generated/models/detailed-payment.ts deleted file mode 100644 index a2946636..00000000 --- a/src/generated/models/detailed-payment.ts +++ /dev/null @@ -1,197 +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 { FiatCancel } from "./fiat-cancel"; -// 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 { FiatRefund } from "./fiat-refund"; -// 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 { PaymentErrorCode } from "./payment-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { PaymentStatus } from "./payment-status"; -// May contain unused imports in some cases -// @ts-ignore -import { PaymentVerificationResponse } from "./payment-verification-response"; -// May contain unused imports in some cases -// @ts-ignore -import { RequiredAction } from "./required-action"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { SourceResponse } from "./source-response"; - -/** - * - * @export - * @interface DetailedPayment - */ -export interface DetailedPayment { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof DetailedPayment - */ - id: string; - /** - * Type of the payment object. - * @type {string} - * @memberof DetailedPayment - */ - type: DetailedPaymentTypeEnum; - /** - * Unique system generated identifier for the merchant. - * @type {string} - * @memberof DetailedPayment - */ - merchantId: string; - /** - * Unique system generated identifier for the wallet of the merchant. - * @type {string} - * @memberof DetailedPayment - */ - merchantWalletId?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedPayment - */ - amount: FiatMoneyUsd; - /** - * - * @type {SourceResponse} - * @memberof DetailedPayment - */ - source: SourceResponse; - /** - * Enumerated description of the payment. - * @type {string} - * @memberof DetailedPayment - */ - description?: DetailedPaymentDescriptionEnum; - /** - * - * @type {PaymentStatus} - * @memberof DetailedPayment - */ - status: PaymentStatus; - /** - * Determines if a payment has successfully been captured. This property is only present for payments that did not use auto capture. - * @type {boolean} - * @memberof DetailedPayment - */ - captured?: boolean; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedPayment - */ - captureAmount?: FiatMoneyUsd; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedPayment - */ - captureDate?: string; - /** - * - * @type {RequiredAction} - * @memberof DetailedPayment - */ - requiredAction?: RequiredAction; - /** - * - * @type {PaymentVerificationResponse} - * @memberof DetailedPayment - */ - verification?: PaymentVerificationResponse; - /** - * - * @type {FiatCancel} - * @memberof DetailedPayment - */ - cancel?: FiatCancel | null; - /** - * - * @type {Array} - * @memberof DetailedPayment - */ - refunds?: Array; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedPayment - */ - fees?: FiatMoneyUsd; - /** - * Payment tracking reference. Will be present once known. - * @type {string} - * @memberof DetailedPayment - */ - trackingRef?: string | null; - /** - * - * @type {PaymentErrorCode} - * @memberof DetailedPayment - */ - errorCode?: PaymentErrorCode | null; - /** - * - * @type {MetadataPhoneEmail} - * @memberof DetailedPayment - */ - metadata?: MetadataPhoneEmail; - /** - * - * @type {RiskEvaluation} - * @memberof DetailedPayment - */ - riskEvaluation?: RiskEvaluation | null; - /** - * The channel identifier that can be set for the payment. When not provided, the default channel is used. - * @type {string} - * @memberof DetailedPayment - */ - channel?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedPayment - */ - createDate?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedPayment - */ - updateDate?: string; -} - -export const DetailedPaymentTypeEnum = { - Payment: "payment" -} as const; - -export type DetailedPaymentTypeEnum = - typeof DetailedPaymentTypeEnum[keyof typeof DetailedPaymentTypeEnum]; -export const DetailedPaymentDescriptionEnum = { - Payment: "Payment" -} as const; - -export type DetailedPaymentDescriptionEnum = - typeof DetailedPaymentDescriptionEnum[keyof typeof DetailedPaymentDescriptionEnum]; diff --git a/src/generated/models/detailed-refund.ts b/src/generated/models/detailed-refund.ts deleted file mode 100644 index 47b85374..00000000 --- a/src/generated/models/detailed-refund.ts +++ /dev/null @@ -1,155 +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 { FiatCancel } from "./fiat-cancel"; -// 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 { FiatPayment } from "./fiat-payment"; -// 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 { PaymentErrorCode } from "./payment-error-code"; -// May contain unused imports in some cases -// @ts-ignore -import { RiskEvaluation } from "./risk-evaluation"; -// May contain unused imports in some cases -// @ts-ignore -import { SourceResponse } from "./source-response"; - -/** - * - * @export - * @interface DetailedRefund - */ -export interface DetailedRefund { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof DetailedRefund - */ - id: string; - /** - * Type of the payment object. - * @type {string} - * @memberof DetailedRefund - */ - type: DetailedRefundTypeEnum; - /** - * Unique system generated identifier for the merchant. - * @type {string} - * @memberof DetailedRefund - */ - merchantId: string; - /** - * Unique system generated identifier for the wallet of the merchant. - * @type {string} - * @memberof DetailedRefund - */ - merchantWalletId?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedRefund - */ - amount: FiatMoneyUsd; - /** - * - * @type {SourceResponse} - * @memberof DetailedRefund - */ - source: SourceResponse; - /** - * Enumerated description of the payment. - * @type {string} - * @memberof DetailedRefund - */ - description?: DetailedRefundDescriptionEnum; - /** - * - * @type {CancelRefundReversalStatus} - * @memberof DetailedRefund - */ - status: CancelRefundReversalStatus; - /** - * - * @type {FiatPayment} - * @memberof DetailedRefund - */ - originalPayment?: FiatPayment; - /** - * - * @type {FiatCancel} - * @memberof DetailedRefund - */ - cancel?: FiatCancel | null; - /** - * - * @type {FiatMoneyUsd} - * @memberof DetailedRefund - */ - fees?: FiatMoneyUsd; - /** - * Payment tracking reference. Will be present once known. - * @type {string} - * @memberof DetailedRefund - */ - trackingRef?: string | null; - /** - * - * @type {PaymentErrorCode} - * @memberof DetailedRefund - */ - errorCode?: PaymentErrorCode | null; - /** - * - * @type {MetadataPhoneEmail} - * @memberof DetailedRefund - */ - metadata?: MetadataPhoneEmail; - /** - * - * @type {RiskEvaluation} - * @memberof DetailedRefund - */ - riskEvaluation?: RiskEvaluation | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedRefund - */ - createDate?: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof DetailedRefund - */ - updateDate?: string; -} - -export const DetailedRefundTypeEnum = { - Refund: "refund" -} as const; - -export type DetailedRefundTypeEnum = - typeof DetailedRefundTypeEnum[keyof typeof DetailedRefundTypeEnum]; -export const DetailedRefundDescriptionEnum = { - Payment: "Payment" -} as const; - -export type DetailedRefundDescriptionEnum = - typeof DetailedRefundDescriptionEnum[keyof typeof DetailedRefundDescriptionEnum]; diff --git a/src/generated/models/duplicate-request.ts b/src/generated/models/duplicate-request.ts new file mode 100644 index 00000000..5c893b2b --- /dev/null +++ b/src/generated/models/duplicate-request.ts @@ -0,0 +1,25 @@ +/* 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 { DailyCustodyBalancesResponse } from "./daily-custody-balances-response"; + +/** + * + * @export + * @interface DuplicateRequest + */ +export interface DuplicateRequest { + /** + * + * @type {DailyCustodyBalancesResponse} + * @memberof DuplicateRequest + */ + data?: DailyCustodyBalancesResponse; +} diff --git a/src/generated/models/exchange-rate-optional-amount-money.ts b/src/generated/models/exchange-rate-optional-amount-money.ts new file mode 100644 index 00000000..9e49e53d --- /dev/null +++ b/src/generated/models/exchange-rate-optional-amount-money.ts @@ -0,0 +1,42 @@ +/* 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 ExchangeRateOptionalAmountMoney + */ +export interface ExchangeRateOptionalAmountMoney { + /** + * Magnitude of the amount, in units of the currency, with a `.`. + * @type {string} + * @memberof ExchangeRateOptionalAmountMoney + */ + amount?: string; + /** + * Currency code. + * @type {string} + * @memberof ExchangeRateOptionalAmountMoney + */ + currency: ExchangeRateOptionalAmountMoneyCurrencyEnum; +} + +export const ExchangeRateOptionalAmountMoneyCurrencyEnum = { + Usdc: "USDC", + Eurc: "EURC", + Mxn: "MXN", + Sgd: "SGD", + Brl: "BRL", + Hkd: "HKD", + Gbp: "GBP", + Cnh: "CNH", + Aed: "AED" +} as const; + +export type ExchangeRateOptionalAmountMoneyCurrencyEnum = + typeof ExchangeRateOptionalAmountMoneyCurrencyEnum[keyof typeof ExchangeRateOptionalAmountMoneyCurrencyEnum]; diff --git a/src/generated/models/exchange-rate-request-from.ts b/src/generated/models/exchange-rate-request-from.ts deleted file mode 100644 index b1febb27..00000000 --- a/src/generated/models/exchange-rate-request-from.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. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatCurrency } from "./fiat-currency"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatOptionalAmountMoney } from "./fiat-optional-amount-money"; - -/** - * @type ExchangeRateRequestFrom - * Amount (Optional) and currency to convert from. If an amount is provided here, then the amount in the \"to\" field must be null. - * @export - */ -export type ExchangeRateRequestFrom = FiatOptionalAmountMoney; diff --git a/src/generated/models/exchange-rate-request-to.ts b/src/generated/models/exchange-rate-request-to.ts deleted file mode 100644 index ed02a6f7..00000000 --- a/src/generated/models/exchange-rate-request-to.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. - */ - -// May contain unused imports in some cases -// @ts-ignore -import { FiatCurrency } from "./fiat-currency"; -// May contain unused imports in some cases -// @ts-ignore -import { FiatOptionalAmountMoney } from "./fiat-optional-amount-money"; - -/** - * @type ExchangeRateRequestTo - * Amount (Optional) and currency to convert to. If an amount is provided here, then the amount in the \"from\" field must be null. - * @export - */ -export type ExchangeRateRequestTo = FiatOptionalAmountMoney; diff --git a/src/generated/models/exchange-rate-request.ts b/src/generated/models/exchange-rate-request.ts index 67299140..6c34b746 100644 --- a/src/generated/models/exchange-rate-request.ts +++ b/src/generated/models/exchange-rate-request.ts @@ -8,10 +8,10 @@ // May contain unused imports in some cases // @ts-ignore -import { ExchangeRateRequestFrom } from "./exchange-rate-request-from"; +import { ExchangeRateOptionalAmountMoney } from "./exchange-rate-optional-amount-money"; // May contain unused imports in some cases // @ts-ignore -import { ExchangeRateRequestTo } from "./exchange-rate-request-to"; +import { ExchangeType } from "./exchange-type"; /** * @@ -19,16 +19,28 @@ import { ExchangeRateRequestTo } from "./exchange-rate-request-to"; * @interface ExchangeRateRequest */ export interface ExchangeRateRequest { + /** + * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. + * @type {string} + * @memberof ExchangeRateRequest + */ + idempotencyKey: string; + /** + * + * @type {ExchangeType} + * @memberof ExchangeRateRequest + */ + type: ExchangeType; /** * - * @type {ExchangeRateRequestFrom} + * @type {ExchangeRateOptionalAmountMoney} * @memberof ExchangeRateRequest */ - from: ExchangeRateRequestFrom; + from: ExchangeRateOptionalAmountMoney; /** * - * @type {ExchangeRateRequestTo} + * @type {ExchangeRateOptionalAmountMoney} * @memberof ExchangeRateRequest */ - to: ExchangeRateRequestTo; + to: ExchangeRateOptionalAmountMoney; } diff --git a/src/generated/models/exchange-rate-response.ts b/src/generated/models/exchange-rate-response.ts index cf7b836c..c02d8ee3 100644 --- a/src/generated/models/exchange-rate-response.ts +++ b/src/generated/models/exchange-rate-response.ts @@ -6,6 +6,9 @@ * Do not edit the class manually. */ +// May contain unused imports in some cases +// @ts-ignore +import { ExchangeType } from "./exchange-type"; // May contain unused imports in some cases // @ts-ignore import { FiatOptionalAmountMoney } from "./fiat-optional-amount-money"; @@ -45,5 +48,17 @@ export interface ExchangeRateResponse { * @type {string} * @memberof ExchangeRateResponse */ - timestamp: string; + expiry: string; + /** + * + * @type {ExchangeType} + * @memberof ExchangeRateResponse + */ + type: ExchangeType; + /** + * Estimated settlement timestamp in ISO-8601 UTC date/time format. Once funds are received, we aim to settle by the time shown. Settlement times are estimates and may vary due to processing delays. Shown only for quotes where `type` = `tradable`. + * @type {string} + * @memberof ExchangeRateResponse + */ + estimatedSettlementTime?: string; } diff --git a/src/generated/models/exchange-type.ts b/src/generated/models/exchange-type.ts new file mode 100644 index 00000000..177c756e --- /dev/null +++ b/src/generated/models/exchange-type.ts @@ -0,0 +1,20 @@ +/* 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 type of exchange. + * @export + * @enum {string} + */ + +export const ExchangeType = { + Reference: "reference", + Tradable: "tradable" +} as const; + +export type ExchangeType = typeof ExchangeType[keyof typeof ExchangeType]; diff --git a/src/generated/models/extend-checkout-session-request.ts b/src/generated/models/extend-checkout-session-request.ts deleted file mode 100644 index d7789d3c..00000000 --- a/src/generated/models/extend-checkout-session-request.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 ExtendCheckoutSessionRequest - */ -export interface ExtendCheckoutSessionRequest { - /** - * Extend the CheckoutSession by extendTime seconds if it is active or expired. The field is optional, if not provided, extend a period that configured by Merchant (default 1 day) - * @type {number} - * @memberof ExtendCheckoutSessionRequest - */ - extendTime?: number; -} diff --git a/src/generated/models/extend-checkout-session-response.ts b/src/generated/models/extend-checkout-session-response.ts deleted file mode 100644 index d36084af..00000000 --- a/src/generated/models/extend-checkout-session-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 { CheckoutSession } from "./checkout-session"; - -/** - * - * @export - * @interface ExtendCheckoutSessionResponse - */ -export interface ExtendCheckoutSessionResponse { - /** - * - * @type {CheckoutSession} - * @memberof ExtendCheckoutSessionResponse - */ - data?: CheckoutSession; -} diff --git a/src/generated/models/external-entity-creation-request.ts b/src/generated/models/external-entity-creation-request.ts new file mode 100644 index 00000000..240a0778 --- /dev/null +++ b/src/generated/models/external-entity-creation-request.ts @@ -0,0 +1,43 @@ +/* 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 { InstitutionalAddress } from "./institutional-address"; + +/** + * + * @export + * @interface ExternalEntityCreationRequest + */ +export interface ExternalEntityCreationRequest { + /** + * The name of the business. + * @type {string} + * @memberof ExternalEntityCreationRequest + */ + businessName: string; + /** + * The unique identifier of the business. For example, a company number or tax ID. + * @type {string} + * @memberof ExternalEntityCreationRequest + */ + businessUniqueIdentifier: string; + /** + * The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @type {string} + * @memberof ExternalEntityCreationRequest + */ + identifierIssuingCountryCode: string; + /** + * + * @type {InstitutionalAddress} + * @memberof ExternalEntityCreationRequest + */ + address: InstitutionalAddress; +} diff --git a/src/generated/models/external-entity.ts b/src/generated/models/external-entity.ts new file mode 100644 index 00000000..e9116ee1 --- /dev/null +++ b/src/generated/models/external-entity.ts @@ -0,0 +1,54 @@ +/* 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. + */ + +/** + * An external entity + * @export + * @interface ExternalEntity + */ +export interface ExternalEntity { + /** + * Unique system-generated identifier for the wallet of the institutional entity. + * @type {string} + * @memberof ExternalEntity + */ + walletId?: string; + /** + * The name of the business. + * @type {string} + * @memberof ExternalEntity + */ + businessName?: string; + /** + * The unique identifier of the business. For example, a company number or tax ID. + * @type {string} + * @memberof ExternalEntity + */ + businessUniqueIdentifier?: string; + /** + * The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @type {string} + * @memberof ExternalEntity + */ + identifierIssuingCountryCode?: string; + /** + * The compliance status of the external entity. + * @type {string} + * @memberof ExternalEntity + */ + complianceState?: ExternalEntityComplianceStateEnum; +} + +export const ExternalEntityComplianceStateEnum = { + Pending: "PENDING", + Accepted: "ACCEPTED", + Rejected: "REJECTED" +} as const; + +export type ExternalEntityComplianceStateEnum = + typeof ExternalEntityComplianceStateEnum[keyof typeof ExternalEntityComplianceStateEnum]; diff --git a/src/generated/models/presign-message-types-items.ts b/src/generated/models/fx-currency-limit.ts similarity index 53% rename from src/generated/models/presign-message-types-items.ts rename to src/generated/models/fx-currency-limit.ts index c4812790..de22ad42 100644 --- a/src/generated/models/presign-message-types-items.ts +++ b/src/generated/models/fx-currency-limit.ts @@ -9,19 +9,25 @@ /** * * @export - * @interface PresignMessageTypesItems + * @interface FxCurrencyLimit */ -export interface PresignMessageTypesItems { +export interface FxCurrencyLimit { /** - * The name of the field + * * @type {string} - * @memberof PresignMessageTypesItems + * @memberof FxCurrencyLimit */ - name: string; + limit?: string; /** - * The type of the field + * * @type {string} - * @memberof PresignMessageTypesItems + * @memberof FxCurrencyLimit */ - type: string; + usage?: string; + /** + * + * @type {string} + * @memberof FxCurrencyLimit + */ + available?: string; } diff --git a/src/generated/models/create-mock-chargeback-response.ts b/src/generated/models/fx-currency.ts similarity index 55% rename from src/generated/models/create-mock-chargeback-response.ts rename to src/generated/models/fx-currency.ts index 389f13a8..73f92081 100644 --- a/src/generated/models/create-mock-chargeback-response.ts +++ b/src/generated/models/fx-currency.ts @@ -9,13 +9,14 @@ /** * * @export - * @interface CreateMockChargebackResponse + * @enum {string} */ -export interface CreateMockChargebackResponse { - /** - * - * @type {object} - * @memberof CreateMockChargebackResponse - */ - data?: object; -} + +export const FxCurrency = { + Usdc: "USDC", + Eurc: "EURC", + Mxn: "MXN", + Brl: "BRL" +} as const; + +export type FxCurrency = typeof FxCurrency[keyof typeof FxCurrency]; diff --git a/src/generated/models/fx-fiat-currency.ts b/src/generated/models/fx-fiat-currency.ts new file mode 100644 index 00000000..f6d8c6c6 --- /dev/null +++ b/src/generated/models/fx-fiat-currency.ts @@ -0,0 +1,20 @@ +/* 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 + * @enum {string} + */ + +export const FxFiatCurrency = { + Mxn: "MXN", + Brl: "BRL" +} as const; + +export type FxFiatCurrency = typeof FxFiatCurrency[keyof typeof FxFiatCurrency]; diff --git a/src/generated/models/fx-money.ts b/src/generated/models/fx-money.ts new file mode 100644 index 00000000..33f0d6dd --- /dev/null +++ b/src/generated/models/fx-money.ts @@ -0,0 +1,31 @@ +/* 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 { FxCurrency } from "./fx-currency"; + +/** + * + * @export + * @interface FxMoney + */ +export interface FxMoney { + /** + * Magnitude of the amount, in units of the currency, with a `.`. + * @type {string} + * @memberof FxMoney + */ + amount: string; + /** + * + * @type {FxCurrency} + * @memberof FxMoney + */ + currency: FxCurrency; +} diff --git a/src/generated/models/capture-creation-request.ts b/src/generated/models/fx-trade-request.ts similarity index 58% rename from src/generated/models/capture-creation-request.ts rename to src/generated/models/fx-trade-request.ts index 43253579..fb2fa255 100644 --- a/src/generated/models/capture-creation-request.ts +++ b/src/generated/models/fx-trade-request.ts @@ -6,26 +6,22 @@ * Do not edit the class manually. */ -// May contain unused imports in some cases -// @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; - /** * * @export - * @interface CaptureCreationRequest + * @interface FxTradeRequest */ -export interface CaptureCreationRequest { +export interface FxTradeRequest { /** * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. * @type {string} - * @memberof CaptureCreationRequest + * @memberof FxTradeRequest */ idempotencyKey: string; /** - * - * @type {FiatMoneyUsd} - * @memberof CaptureCreationRequest + * Unique system generated identifier for the entity. + * @type {string} + * @memberof FxTradeRequest */ - amount?: FiatMoneyUsd; + quoteId: string; } diff --git a/src/generated/models/get-chargeback-response.ts b/src/generated/models/get-chargeback-response.ts deleted file mode 100644 index a5bf84c7..00000000 --- a/src/generated/models/get-chargeback-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 { BasicChargeback } from "./basic-chargeback"; - -/** - * - * @export - * @interface GetChargebackResponse - */ -export interface GetChargebackResponse { - /** - * - * @type {BasicChargeback} - * @memberof GetChargebackResponse - */ - data?: BasicChargeback; -} diff --git a/src/generated/models/get-checkout-session-response.ts b/src/generated/models/get-checkout-session-response.ts deleted file mode 100644 index 67759c3b..00000000 --- a/src/generated/models/get-checkout-session-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 { CheckoutSession } from "./checkout-session"; - -/** - * - * @export - * @interface GetCheckoutSessionResponse - */ -export interface GetCheckoutSessionResponse { - /** - * - * @type {CheckoutSession} - * @memberof GetCheckoutSessionResponse - */ - data?: CheckoutSession; -} diff --git a/src/generated/models/get-exchange-rates-response.ts b/src/generated/models/get-exchange-rates-response.ts deleted file mode 100644 index 6b619112..00000000 --- a/src/generated/models/get-exchange-rates-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 { Rate } from "./rate"; - -/** - * - * @export - * @interface GetExchangeRatesResponse - */ -export interface GetExchangeRatesResponse { - /** - * - * @type {Rate} - * @memberof GetExchangeRatesResponse - */ - data?: Rate; -} diff --git a/src/generated/models/create-payment-response.ts b/src/generated/models/get-fx-limits-response-data.ts similarity index 57% rename from src/generated/models/create-payment-response.ts rename to src/generated/models/get-fx-limits-response-data.ts index c4c604ac..a768b72d 100644 --- a/src/generated/models/create-payment-response.ts +++ b/src/generated/models/get-fx-limits-response-data.ts @@ -8,18 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { DetailedPayment } from "./detailed-payment"; +import { DailyFxLimits } from "./daily-fx-limits"; /** * * @export - * @interface CreatePaymentResponse + * @interface GetFxLimitsResponseData */ -export interface CreatePaymentResponse { +export interface GetFxLimitsResponseData { /** * - * @type {DetailedPayment} - * @memberof CreatePaymentResponse + * @type {DailyFxLimits} + * @memberof GetFxLimitsResponseData */ - data?: DetailedPayment; + dailyLimits?: DailyFxLimits; } diff --git a/src/generated/models/create-checkout-session-response.ts b/src/generated/models/get-fx-limits-response.ts similarity index 55% rename from src/generated/models/create-checkout-session-response.ts rename to src/generated/models/get-fx-limits-response.ts index ad391344..bd4fbc27 100644 --- a/src/generated/models/create-checkout-session-response.ts +++ b/src/generated/models/get-fx-limits-response.ts @@ -8,18 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { CheckoutSession } from "./checkout-session"; +import { GetFxLimitsResponseData } from "./get-fx-limits-response-data"; /** * * @export - * @interface CreateCheckoutSessionResponse + * @interface GetFxLimitsResponse */ -export interface CreateCheckoutSessionResponse { +export interface GetFxLimitsResponse { /** * - * @type {CheckoutSession} - * @memberof CreateCheckoutSessionResponse + * @type {GetFxLimitsResponseData} + * @memberof GetFxLimitsResponse */ - data?: CheckoutSession; + data?: GetFxLimitsResponseData; } diff --git a/src/generated/models/create-card-response.ts b/src/generated/models/get-fx-trades-response.ts similarity index 62% rename from src/generated/models/create-card-response.ts rename to src/generated/models/get-fx-trades-response.ts index b45cb19b..8098719f 100644 --- a/src/generated/models/create-card-response.ts +++ b/src/generated/models/get-fx-trades-response.ts @@ -8,18 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { Card } from "./card"; +import { Trade } from "./trade"; /** * * @export - * @interface CreateCardResponse + * @interface GetFxTradesResponse */ -export interface CreateCardResponse { +export interface GetFxTradesResponse { /** * - * @type {Card} - * @memberof CreateCardResponse + * @type {Array} + * @memberof GetFxTradesResponse */ - data?: Card; + data?: Array; } diff --git a/src/generated/models/get-card-response.ts b/src/generated/models/get-fx-trades-response1.ts similarity index 63% rename from src/generated/models/get-card-response.ts rename to src/generated/models/get-fx-trades-response1.ts index 2273dc16..e8c3b5b6 100644 --- a/src/generated/models/get-card-response.ts +++ b/src/generated/models/get-fx-trades-response1.ts @@ -8,18 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { Card } from "./card"; +import { Trade } from "./trade"; /** * * @export - * @interface GetCardResponse + * @interface GetFxTradesResponse1 */ -export interface GetCardResponse { +export interface GetFxTradesResponse1 { /** * - * @type {Card} - * @memberof GetCardResponse + * @type {Trade} + * @memberof GetFxTradesResponse1 */ - data?: Card; + data?: Trade; } diff --git a/src/generated/models/get-public-key-response.ts b/src/generated/models/get-public-key-response.ts deleted file mode 100644 index 2eb5688c..00000000 --- a/src/generated/models/get-public-key-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 { PublicKey } from "./public-key"; - -/** - * - * @export - * @interface GetPublicKeyResponse - */ -export interface GetPublicKeyResponse { - /** - * - * @type {PublicKey} - * @memberof GetPublicKeyResponse - */ - data?: PublicKey; -} diff --git a/src/generated/models/get-settlement-response.ts b/src/generated/models/get-settlement-id-response.ts similarity index 76% rename from src/generated/models/get-settlement-response.ts rename to src/generated/models/get-settlement-id-response.ts index 71b5c5d7..2758e038 100644 --- a/src/generated/models/get-settlement-response.ts +++ b/src/generated/models/get-settlement-id-response.ts @@ -13,13 +13,13 @@ import { Settlement } from "./settlement"; /** * * @export - * @interface GetSettlementResponse + * @interface GetSettlementIdResponse */ -export interface GetSettlementResponse { +export interface GetSettlementIdResponse { /** * * @type {Settlement} - * @memberof GetSettlementResponse + * @memberof GetSettlementIdResponse */ data?: Settlement; } diff --git a/src/generated/models/payment-token-request-token-data.ts b/src/generated/models/get-settlement-instructions-response-data.ts similarity index 50% rename from src/generated/models/payment-token-request-token-data.ts rename to src/generated/models/get-settlement-instructions-response-data.ts index 13f9f213..7b4a3033 100644 --- a/src/generated/models/payment-token-request-token-data.ts +++ b/src/generated/models/get-settlement-instructions-response-data.ts @@ -8,17 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { ApplePayToken } from "./apple-pay-token"; +import { BRLSettlementInstructions } from "./brlsettlement-instructions"; // May contain unused imports in some cases // @ts-ignore -import { ApplePayTokenHeader } from "./apple-pay-token-header"; +import { BRLSettlementInstructionsInstruction } from "./brlsettlement-instructions-instruction"; // May contain unused imports in some cases // @ts-ignore -import { GooglePayToken } from "./google-pay-token"; +import { MXNSettlementInstructions } from "./mxnsettlement-instructions"; /** - * @type PaymentTokenRequestTokenData - * The token data + * @type GetSettlementInstructionsResponseData * @export */ -export type PaymentTokenRequestTokenData = ApplePayToken | GooglePayToken; +export type GetSettlementInstructionsResponseData = + | BRLSettlementInstructions + | MXNSettlementInstructions; diff --git a/src/generated/models/get-settlement-instructions-response.ts b/src/generated/models/get-settlement-instructions-response.ts new file mode 100644 index 00000000..f9459eba --- /dev/null +++ b/src/generated/models/get-settlement-instructions-response.ts @@ -0,0 +1,25 @@ +/* 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 { GetSettlementInstructionsResponseData } from "./get-settlement-instructions-response-data"; + +/** + * + * @export + * @interface GetSettlementInstructionsResponse + */ +export interface GetSettlementInstructionsResponse { + /** + * + * @type {GetSettlementInstructionsResponseData} + * @memberof GetSettlementInstructionsResponse + */ + data?: GetSettlementInstructionsResponseData; +} diff --git a/src/generated/models/google-pay-token.ts b/src/generated/models/google-pay-token.ts deleted file mode 100644 index 24c03c9c..00000000 --- a/src/generated/models/google-pay-token.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 GooglePayToken - */ -export interface GooglePayToken { - /** - * Verifies the message came from Google. The signature is created using ECDSA. - * @type {string} - * @memberof GooglePayToken - */ - signature: string; - /** - * 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} - * @memberof GooglePayToken - */ - protocolVersion: string; - /** - * A serialized JSON string containing the encryptedMessage, ephemeralPublicKey, and tag. To simplify the signature verification process, this value is serialized. - * @type {string} - * @memberof GooglePayToken - */ - signedMessage: string; -} diff --git a/src/generated/models/index.ts b/src/generated/models/index.ts index ca49ae9b..c8569dd5 100644 --- a/src/generated/models/index.ts +++ b/src/generated/models/index.ts @@ -4,18 +4,14 @@ export * from "./address-book-recipient-metadata"; export * from "./address-book-recipient-modify-request"; export * from "./address-book-recipient-request"; export * from "./address-object"; -export * from "./apple-pay-token"; -export * from "./apple-pay-token-ec-header"; -export * from "./apple-pay-token-header"; -export * from "./apple-pay-token-rsa-header"; +export * from "./brlsettlement-instructions"; +export * from "./brlsettlement-instructions-instruction"; export * from "./bad-request"; export * from "./balances"; export * from "./bank-address"; export * from "./bank-address-iban-supported"; export * from "./bank-address-non-iban"; export * from "./bank-destination"; -export * from "./basic-chargeback"; -export * from "./basic-chargeback-history"; export * from "./billing-details"; export * from "./burn-fee-net-amount"; export * from "./burn-fee-payment-amount"; @@ -26,26 +22,14 @@ export * from "./business-destination-request"; export * from "./business-generate-address-request"; export * from "./business-payout"; export * from "./business-payout-creation-request"; +export * from "./business-payout-creation-request-source"; export * from "./business-pix-account-instructions-response"; export * from "./business-recipient-address-creation-request"; export * from "./business-recipient-address-object"; export * from "./business-transfer-creation-request"; -export * from "./cancel-creation-request"; -export * from "./cancel-payment-response"; +export * from "./business-transfer-creation-request-source"; export * from "./cancel-refund-reversal-status"; -export * from "./capture-creation-request"; -export * from "./card"; -export * from "./card-creation-request"; -export * from "./card-update"; -export * from "./card-verification-response"; export * from "./chain"; -export * from "./channel-response"; -export * from "./chargeback-categories"; -export * from "./chargeback-status"; -export * from "./checkout-session"; -export * from "./checkout-session-creation-request"; -export * from "./checkout-session-money"; -export * from "./checkout-session-status"; export * from "./conflict"; export * from "./continuous-payment-intent"; export * from "./continuous-payment-intent-creation-request"; @@ -57,33 +41,30 @@ export * from "./create-business-pix-account-response"; export * from "./create-business-recipient-address-response"; export * from "./create-business-transfer-response"; export * from "./create-business-wire-account-response"; -export * from "./create-card-response"; -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-chargeback-response"; +export * from "./create-fx-account-request"; +export * from "./create-fx-account-response"; +export * from "./create-fx-account-response1"; +export * from "./create-fx-trade-response"; +export * from "./create-fx-trade-response-data"; 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-response"; +export * from "./create-pix-payment-response"; export * from "./create-subscription-response"; export * from "./create-wire-payment-response"; export * from "./crypto-payment"; -export * from "./crypto-payment-creation-request"; export * from "./crypto-payment-deposit-address"; -export * from "./crypto-payment-destination"; export * from "./crypto-payment-from-addresses"; export * from "./crypto-payment-network-fee"; -export * from "./crypto-payment-source"; export * from "./crypto-payments-money"; export * from "./crypto-payments-optional-amount-money"; export * from "./crypto-payout"; export * from "./crypto-payout-creation-request"; export * from "./crypto-payout-destination"; export * from "./crypto-payout-destination-type"; +export * from "./crypto-payout-money"; export * from "./crypto-refund-creation-request"; export * from "./crypto-refund-creation-request-amount"; export * from "./crypto-refund-creation-request-to-amount"; @@ -93,18 +74,21 @@ export * from "./cubix-fiat-account-response"; export * from "./cubix-instruction"; export * from "./currency"; export * from "./cvv-results"; +export * from "./daily-custody-balances-request"; +export * from "./daily-custody-balances-request-additional-fields"; +export * from "./daily-custody-balances-response"; +export * from "./daily-custody-balances-response-additional-fields"; +export * from "./daily-fx-limits"; export * from "./delete-subscription-response"; -export * from "./detailed-cancel"; -export * from "./detailed-payment"; -export * from "./detailed-refund"; +export * from "./duplicate-request"; export * from "./eci"; +export * from "./exchange-rate-optional-amount-money"; export * from "./exchange-rate-request"; -export * from "./exchange-rate-request-from"; -export * from "./exchange-rate-request-to"; export * from "./exchange-rate-response"; +export * from "./exchange-type"; export * from "./expire-payment-intent-response"; -export * from "./extend-checkout-session-request"; -export * from "./extend-checkout-session-response"; +export * from "./external-entity"; +export * from "./external-entity-creation-request"; export * from "./external-fiat-account-status"; export * from "./fee"; export * from "./fetch-exchange-rate-response"; @@ -119,6 +103,11 @@ export * from "./fiat-payout-to-money"; export * from "./fiat-refund"; export * from "./final-adjustments"; export * from "./forbidden"; +export * from "./fx-currency"; +export * from "./fx-currency-limit"; +export * from "./fx-fiat-currency"; +export * from "./fx-money"; +export * from "./fx-trade-request"; export * from "./get-address-book-recipient-response"; export * from "./get-business-cubix-account-response"; export * from "./get-business-deposit-address-response"; @@ -127,38 +116,36 @@ export * from "./get-business-pix-account-response"; export * from "./get-business-transfer-response"; export * from "./get-business-wire-account-instructions-response"; export * from "./get-business-wire-account-response"; -export * from "./get-card-response"; -export * from "./get-chargeback-response"; -export * from "./get-checkout-session-response"; export * from "./get-config-response"; -export * from "./get-exchange-rates-response"; +export * from "./get-fx-limits-response"; +export * from "./get-fx-limits-response-data"; +export * from "./get-fx-trades-response"; +export * from "./get-fx-trades-response1"; 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-public-key-response"; -export * from "./get-settlement-response"; +export * from "./get-settlement-id-response"; +export * from "./get-settlement-instructions-response"; +export * from "./get-settlement-instructions-response-data"; export * from "./get-settlements-response"; -export * from "./google-pay-token"; export * from "./identity"; export * from "./identity-address"; +export * from "./institutional-address"; export * from "./limit-exceeded"; export * from "./list-address-book-recipients-response"; -export * from "./list-balances-response"; export * from "./list-burn-fee-calculations-response"; export * from "./list-business-balances-response"; export * from "./list-business-cubix-account-instructions-response"; export * from "./list-business-cubix-accounts-response"; export * from "./list-business-deposits-response"; -export * from "./list-business-payouts-response"; +export * from "./list-business-payout"; +export * from "./list-business-payout-data-inner"; export * from "./list-business-pix-accounts-response"; export * from "./list-business-recipient-addresses-response"; export * from "./list-business-transfers-response"; export * from "./list-business-wire-accounts-response"; -export * from "./list-cards-response"; -export * from "./list-channels-response"; -export * from "./list-chargebacks-response"; -export * from "./list-checkout-sessions-response"; +export * from "./list-external-entities-response"; export * from "./list-payment-intents-response"; export * from "./list-payment-intents-response-data-inner"; export * from "./list-payments-response"; @@ -166,20 +153,19 @@ export * from "./list-payments-response-data-inner"; export * from "./list-payouts-response"; export * from "./list-stablecoins-response"; export * from "./list-subscriptions-response"; -export * from "./metadata-card-and-ach"; -export * from "./metadata-crypto-payment"; -export * from "./metadata-payment"; +export * from "./mxnsettlement-instructions"; export * from "./metadata-phone-email"; -export * from "./mock-chargeback-creation-request"; +export * from "./mock-pix-payment-request"; +export * from "./mock-pix-payment-request-amount"; +export * from "./mock-pix-payment-response"; export * from "./mock-wire-payment-beneficiary-bank-instruction"; export * from "./mock-wire-payment-request"; export * from "./mock-wire-payment-response"; export * from "./modify-address-book-recipient-response"; export * from "./money"; -export * from "./network-fee-quote"; +export * from "./new-report-success"; export * from "./not-authorized"; export * from "./not-found"; -export * from "./payment-creation-request"; export * from "./payment-error-code"; export * from "./payment-info-cancel"; export * from "./payment-info-payment-and-refund"; @@ -187,10 +173,8 @@ export * from "./payment-intent"; export * from "./payment-intent-creation-request"; export * from "./payment-intent-fees"; export * from "./payment-method-blockchain"; +export * from "./payment-method-blockchain-request"; export * from "./payment-status"; -export * from "./payment-token"; -export * from "./payment-token-request"; -export * from "./payment-token-request-token-data"; export * from "./payment-verification-response"; export * from "./payout-destination-type"; export * from "./payout-error-code"; @@ -201,24 +185,13 @@ export * from "./pix-account-type"; export * from "./pix-fiat-account-creation-request"; export * from "./pix-fiat-account-response"; export * from "./pix-instruction"; -export * from "./presign-domain"; -export * from "./presign-message"; -export * from "./presign-message-types"; -export * from "./presign-message-types-items"; -export * from "./presign-response"; -export * from "./presign-response-typed-data"; -export * from "./public-key"; -export * from "./rate"; export * from "./redemption-fee-calculation"; -export * from "./refund-creation-request"; -export * from "./refund-payment-response"; export * from "./required-action"; -export * from "./reversal-reason"; export * from "./risk-evaluation"; export * from "./settlement"; -export * from "./simple-billing-details"; -export * from "./simple-card"; -export * from "./source"; +export * from "./settlement-detail-status"; +export * from "./settlement-details-inner"; +export * from "./settlement-status"; export * from "./source-response"; export * from "./stablecoin"; export * from "./subscription-detail"; @@ -226,9 +199,9 @@ export * from "./subscription-request"; export * from "./subscription-response"; export * from "./three-ds-result"; export * from "./timeline"; -export * from "./to-amount"; export * from "./token-amount"; -export * from "./tokenized-card-details"; +export * from "./trade"; +export * from "./trade-status"; export * from "./transfer"; export * from "./transfer-destination-blockchain-location"; export * from "./transfer-destination-location"; @@ -241,9 +214,6 @@ export * from "./transfer-source-wallet-location"; export * from "./transfer-type-info"; export * from "./transfer-type-info-additional-properties"; export * from "./unwithdrawal-object"; -export * from "./update-billing-details"; -export * from "./update-card-response"; -export * from "./verification-error-code"; export * from "./wallet-config"; export * from "./wallet-location"; export * from "./wire"; @@ -251,6 +221,7 @@ export * from "./wire-creation-request"; export * from "./wire-creation-request-account-number"; export * from "./wire-creation-request-iban"; export * from "./wire-creation-request-us"; +export * from "./wire-destination-response"; export * from "./wire-instruction"; export * from "./wire-instruction-beneficiary"; export * from "./wire-instruction-beneficiary-bank"; diff --git a/src/generated/models/institutional-address.ts b/src/generated/models/institutional-address.ts new file mode 100644 index 00000000..831b109a --- /dev/null +++ b/src/generated/models/institutional-address.ts @@ -0,0 +1,51 @@ +/* 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 InstitutionalAddress + */ +export interface InstitutionalAddress { + /** + * Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. + * @type {string} + * @memberof InstitutionalAddress + */ + country: string; + /** + * State / county / province / region / district / emirate portion of the address. US and Canada use the two-letter code for the subdivision. + * @type {string} + * @memberof InstitutionalAddress + */ + state: string; + /** + * City portion of the address. + * @type {string} + * @memberof InstitutionalAddress + */ + city: string; + /** + * Postal / ZIP code of the address. If there is no applicable postal code, set the value to `00000`. + * @type {string} + * @memberof InstitutionalAddress + */ + postcode?: string; + /** + * Street name of the address. + * @type {string} + * @memberof InstitutionalAddress + */ + streetName?: string; + /** + * Street number of the address. + * @type {string} + * @memberof InstitutionalAddress + */ + buildingNumber?: string; +} diff --git a/src/generated/models/list-balances-response.ts b/src/generated/models/list-balances-response.ts deleted file mode 100644 index ffb2fffb..00000000 --- a/src/generated/models/list-balances-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 { Balances } from "./balances"; - -/** - * - * @export - * @interface ListBalancesResponse - */ -export interface ListBalancesResponse { - /** - * - * @type {Balances} - * @memberof ListBalancesResponse - */ - data?: Balances; -} diff --git a/src/generated/models/list-business-payout-data-inner.ts b/src/generated/models/list-business-payout-data-inner.ts new file mode 100644 index 00000000..6c595fd5 --- /dev/null +++ b/src/generated/models/list-business-payout-data-inner.ts @@ -0,0 +1,121 @@ +/* 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 { BankDestination } from "./bank-destination"; +// May contain unused imports in some cases +// @ts-ignore +import { FiatMoney } from "./fiat-money"; +// 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 { FiatPayoutToMoney } from "./fiat-payout-to-money"; +// 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 { 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 ListBusinessPayoutDataInner + */ +export interface ListBusinessPayoutDataInner { + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof ListBusinessPayoutDataInner + */ + id?: string; + /** + * The identifier of the source wallet used to fund a payout. + * @type {string} + * @memberof ListBusinessPayoutDataInner + */ + sourceWalletId?: string; + /** + * + * @type {BankDestination} + * @memberof ListBusinessPayoutDataInner + */ + destination?: BankDestination; + /** + * + * @type {FiatMoney} + * @memberof ListBusinessPayoutDataInner + */ + amount?: FiatMoney; + /** + * + * @type {FiatPayoutToMoney} + * @memberof ListBusinessPayoutDataInner + */ + toAmount?: FiatPayoutToMoney; + /** + * + * @type {FiatMoneyUsd} + * @memberof ListBusinessPayoutDataInner + */ + fees?: FiatMoneyUsd; + /** + * + * @type {PayoutStatus} + * @memberof ListBusinessPayoutDataInner + */ + status?: PayoutStatus; + /** + * + * @type {PayoutErrorCode} + * @memberof ListBusinessPayoutDataInner + */ + errorCode?: PayoutErrorCode | null; + /** + * + * @type {RiskEvaluation} + * @memberof ListBusinessPayoutDataInner + */ + riskEvaluation?: RiskEvaluation | null; + /** + * + * @type {FinalAdjustments} + * @memberof ListBusinessPayoutDataInner + */ + adjustments?: FinalAdjustments | null; + /** + * + * @type {UnwithdrawalObject} + * @memberof ListBusinessPayoutDataInner + */ + return?: UnwithdrawalObject | null; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof ListBusinessPayoutDataInner + */ + createDate?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof ListBusinessPayoutDataInner + */ + updateDate?: string; +} diff --git a/src/generated/models/list-business-payout.ts b/src/generated/models/list-business-payout.ts new file mode 100644 index 00000000..f5372fb7 --- /dev/null +++ b/src/generated/models/list-business-payout.ts @@ -0,0 +1,25 @@ +/* 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 { ListBusinessPayoutDataInner } from "./list-business-payout-data-inner"; + +/** + * + * @export + * @interface ListBusinessPayout + */ +export interface ListBusinessPayout { + /** + * + * @type {Array} + * @memberof ListBusinessPayout + */ + data?: Array; +} diff --git a/src/generated/models/list-business-payouts-response.ts b/src/generated/models/list-business-payouts-response.ts deleted file mode 100644 index a14eaab5..00000000 --- a/src/generated/models/list-business-payouts-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 { BusinessPayout } from "./business-payout"; - -/** - * - * @export - * @interface ListBusinessPayoutsResponse - */ -export interface ListBusinessPayoutsResponse { - /** - * - * @type {Array} - * @memberof ListBusinessPayoutsResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-cards-response.ts b/src/generated/models/list-cards-response.ts deleted file mode 100644 index 8ded9bb7..00000000 --- a/src/generated/models/list-cards-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 { SimpleCard } from "./simple-card"; - -/** - * - * @export - * @interface ListCardsResponse - */ -export interface ListCardsResponse { - /** - * - * @type {Array} - * @memberof ListCardsResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-channels-response.ts b/src/generated/models/list-channels-response.ts deleted file mode 100644 index da5c8e83..00000000 --- a/src/generated/models/list-channels-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 { ChannelResponse } from "./channel-response"; - -/** - * - * @export - * @interface ListChannelsResponse - */ -export interface ListChannelsResponse { - /** - * - * @type {Array} - * @memberof ListChannelsResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-chargebacks-response.ts b/src/generated/models/list-chargebacks-response.ts deleted file mode 100644 index 29f06403..00000000 --- a/src/generated/models/list-chargebacks-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 { BasicChargeback } from "./basic-chargeback"; - -/** - * - * @export - * @interface ListChargebacksResponse - */ -export interface ListChargebacksResponse { - /** - * - * @type {Array} - * @memberof ListChargebacksResponse - */ - data?: Array; -} diff --git a/src/generated/models/list-checkout-sessions-response.ts b/src/generated/models/list-checkout-sessions-response.ts deleted file mode 100644 index 98ba67b8..00000000 --- a/src/generated/models/list-checkout-sessions-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 { CheckoutSession } from "./checkout-session"; - -/** - * - * @export - * @interface ListCheckoutSessionsResponse - */ -export interface ListCheckoutSessionsResponse { - /** - * - * @type {Array} - * @memberof ListCheckoutSessionsResponse - */ - data?: Array; -} diff --git a/src/generated/models/create-crypto-payment-response.ts b/src/generated/models/list-external-entities-response.ts similarity index 55% rename from src/generated/models/create-crypto-payment-response.ts rename to src/generated/models/list-external-entities-response.ts index bbe20b28..8e6c480a 100644 --- a/src/generated/models/create-crypto-payment-response.ts +++ b/src/generated/models/list-external-entities-response.ts @@ -8,18 +8,18 @@ // May contain unused imports in some cases // @ts-ignore -import { CryptoPayment } from "./crypto-payment"; +import { ExternalEntity } from "./external-entity"; /** * * @export - * @interface CreateCryptoPaymentResponse + * @interface ListExternalEntitiesResponse */ -export interface CreateCryptoPaymentResponse { +export interface ListExternalEntitiesResponse { /** * - * @type {CryptoPayment} - * @memberof CreateCryptoPaymentResponse + * @type {Array} + * @memberof ListExternalEntitiesResponse */ - data?: CryptoPayment; + data?: Array; } diff --git a/src/generated/models/metadata-card-and-ach.ts b/src/generated/models/metadata-card-and-ach.ts deleted file mode 100644 index 1eb476aa..00000000 --- a/src/generated/models/metadata-card-and-ach.ts +++ /dev/null @@ -1,39 +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 MetadataCardAndAch - */ -export interface MetadataCardAndAch { - /** - * Email of the user. - * @type {string} - * @memberof MetadataCardAndAch - */ - email: string; - /** - * 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. - * @type {string} - * @memberof MetadataCardAndAch - */ - phoneNumber?: string; - /** - * 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. - * @type {string} - * @memberof MetadataCardAndAch - */ - sessionId: string; - /** - * Single IPv4 or IPv6 address of user\' - * @type {string} - * @memberof MetadataCardAndAch - */ - ipAddress: string; -} diff --git a/src/generated/models/metadata-crypto-payment.ts b/src/generated/models/metadata-crypto-payment.ts deleted file mode 100644 index 0aa61500..00000000 --- a/src/generated/models/metadata-crypto-payment.ts +++ /dev/null @@ -1,52 +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 MetadataCryptoPayment - */ -export interface MetadataCryptoPayment { - /** - * The protocol type. so far we only support \"TransferWithAuthorization\". find more details in EIP-3009 - * @type {string} - * @memberof MetadataCryptoPayment - */ - type: MetadataCryptoPaymentTypeEnum; - /** - * meta transaction nonce - * @type {string} - * @memberof MetadataCryptoPayment - */ - metaTxNonce: string; - /** - * This comes from the /presign response - * @type {string} - * @memberof MetadataCryptoPayment - */ - signatureValidAfter: string; - /** - * This comes from the /presign response - * @type {string} - * @memberof MetadataCryptoPayment - */ - signatureValidBefore: string; - /** - * Raw signature coming from the wallet response - * @type {string} - * @memberof MetadataCryptoPayment - */ - rawSignature: string; -} - -export const MetadataCryptoPaymentTypeEnum = { - TransferWithAuthorization: "TransferWithAuthorization" -} as const; - -export type MetadataCryptoPaymentTypeEnum = - typeof MetadataCryptoPaymentTypeEnum[keyof typeof MetadataCryptoPaymentTypeEnum]; diff --git a/src/generated/models/metadata-payment.ts b/src/generated/models/metadata-payment.ts deleted file mode 100644 index 28b05ff3..00000000 --- a/src/generated/models/metadata-payment.ts +++ /dev/null @@ -1,39 +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 MetadataPayment - */ -export interface MetadataPayment { - /** - * Email of the user. - * @type {string} - * @memberof MetadataPayment - */ - email: string; - /** - * 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. - * @type {string} - * @memberof MetadataPayment - */ - phoneNumber?: string; - /** - * 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. - * @type {string} - * @memberof MetadataPayment - */ - sessionId: string; - /** - * Single IPv4 or IPv6 address of user\' - * @type {string} - * @memberof MetadataPayment - */ - ipAddress: string; -} diff --git a/src/generated/models/mock-chargeback-creation-request.ts b/src/generated/models/mock-chargeback-creation-request.ts deleted file mode 100644 index 18af2f8e..00000000 --- a/src/generated/models/mock-chargeback-creation-request.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 MockChargebackCreationRequest - */ -export interface MockChargebackCreationRequest { - /** - * The id of the payment to be charged back. Each payment can only be charged back once. - * @type {string} - * @memberof MockChargebackCreationRequest - */ - paymentId: string; -} diff --git a/src/generated/models/mock-pix-payment-request-amount.ts b/src/generated/models/mock-pix-payment-request-amount.ts new file mode 100644 index 00000000..2e668dad --- /dev/null +++ b/src/generated/models/mock-pix-payment-request-amount.ts @@ -0,0 +1,34 @@ +/* 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 MockPixPaymentRequestAmount + */ +export interface MockPixPaymentRequestAmount { + /** + * Magnitude of the amount, in units of the currency, with a `.`. + * @type {string} + * @memberof MockPixPaymentRequestAmount + */ + amount: string; + /** + * + * @type {string} + * @memberof MockPixPaymentRequestAmount + */ + currency: MockPixPaymentRequestAmountCurrencyEnum; +} + +export const MockPixPaymentRequestAmountCurrencyEnum = { + Brl: "BRL" +} as const; + +export type MockPixPaymentRequestAmountCurrencyEnum = + typeof MockPixPaymentRequestAmountCurrencyEnum[keyof typeof MockPixPaymentRequestAmountCurrencyEnum]; diff --git a/src/generated/models/mock-pix-payment-request.ts b/src/generated/models/mock-pix-payment-request.ts new file mode 100644 index 00000000..3a6b0279 --- /dev/null +++ b/src/generated/models/mock-pix-payment-request.ts @@ -0,0 +1,37 @@ +/* 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 { MockPixPaymentRequestAmount } from "./mock-pix-payment-request-amount"; + +/** + * + * @export + * @interface MockPixPaymentRequest + */ +export interface MockPixPaymentRequest { + /** + * PIX tracking reference that needs to be set in the PIX reference to beneficiary field. This field is retrievable through the response during PIX creation or via the bank instruction endpoint. + * @type {string} + * @memberof MockPixPaymentRequest + */ + trackingRef: string; + /** + * + * @type {MockPixPaymentRequestAmount} + * @memberof MockPixPaymentRequest + */ + amount: MockPixPaymentRequestAmount; + /** + * The account number that the money should be transferred to. + * @type {string} + * @memberof MockPixPaymentRequest + */ + accountNumber: string; +} diff --git a/src/generated/models/mock-pix-payment-response.ts b/src/generated/models/mock-pix-payment-response.ts new file mode 100644 index 00000000..9bf50349 --- /dev/null +++ b/src/generated/models/mock-pix-payment-response.ts @@ -0,0 +1,52 @@ +/* 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 { MockPixPaymentRequestAmount } from "./mock-pix-payment-request-amount"; + +/** + * + * @export + * @interface MockPixPaymentResponse + */ +export interface MockPixPaymentResponse { + /** + * PIX tracking reference that needs to be set in the PIX reference to beneficiary field. This field is retrievable through the response during PIX creation or via the bank instruction endpoint. + * @type {string} + * @memberof MockPixPaymentResponse + */ + trackingRef?: string; + /** + * + * @type {MockPixPaymentRequestAmount} + * @memberof MockPixPaymentResponse + */ + amount?: MockPixPaymentRequestAmount; + /** + * + * @type {string} + * @memberof MockPixPaymentResponse + */ + beneficiaryAccountNumber?: string; + /** + * Enumerated status of the PIX payment. Status `pending` indicates that the PIX payment is in process; `processed` indicates it finished successfully; `failed` indicates it failed. + * @type {string} + * @memberof MockPixPaymentResponse + */ + status?: MockPixPaymentResponseStatusEnum; +} + +export const MockPixPaymentResponseStatusEnum = { + Pending: "pending", + Processed: "processed", + Failed: "failed" +} as const; + +export type MockPixPaymentResponseStatusEnum = + typeof MockPixPaymentResponseStatusEnum[keyof typeof MockPixPaymentResponseStatusEnum]; diff --git a/src/generated/models/mock-wire-payment-beneficiary-bank-instruction.ts b/src/generated/models/mock-wire-payment-beneficiary-bank-instruction.ts index cdeb69cd..fdbf7a39 100644 --- a/src/generated/models/mock-wire-payment-beneficiary-bank-instruction.ts +++ b/src/generated/models/mock-wire-payment-beneficiary-bank-instruction.ts @@ -13,7 +13,7 @@ */ export interface MockWirePaymentBeneficiaryBankInstruction { /** - * Virtual account number or Circle corporate Silvergate Wire account number that needs to be set as destination. + * Virtual account number or Circle corporate Wells Fargo wire account number that needs to be set as destination. * @type {string} * @memberof MockWirePaymentBeneficiaryBankInstruction */ diff --git a/src/generated/models/mxnsettlement-instructions.ts b/src/generated/models/mxnsettlement-instructions.ts new file mode 100644 index 00000000..9f62bad9 --- /dev/null +++ b/src/generated/models/mxnsettlement-instructions.ts @@ -0,0 +1,47 @@ +/* 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 { BusinessAccountPayoutDestinationType } from "./business-account-payout-destination-type"; +// May contain unused imports in some cases +// @ts-ignore +import { WireInstruction } from "./wire-instruction"; + +/** + * + * @export + * @interface MXNSettlementInstructions + */ +export interface MXNSettlementInstructions { + /** + * + * @type {string} + * @memberof MXNSettlementInstructions + */ + currency?: MXNSettlementInstructionsCurrencyEnum; + /** + * + * @type {BusinessAccountPayoutDestinationType} + * @memberof MXNSettlementInstructions + */ + fiatAccountType?: BusinessAccountPayoutDestinationType; + /** + * + * @type {WireInstruction} + * @memberof MXNSettlementInstructions + */ + instruction?: WireInstruction; +} + +export const MXNSettlementInstructionsCurrencyEnum = { + Mxn: "MXN" +} as const; + +export type MXNSettlementInstructionsCurrencyEnum = + typeof MXNSettlementInstructionsCurrencyEnum[keyof typeof MXNSettlementInstructionsCurrencyEnum]; diff --git a/src/generated/models/network-fee-quote.ts b/src/generated/models/network-fee-quote.ts deleted file mode 100644 index 6beb2989..00000000 --- a/src/generated/models/network-fee-quote.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 { CryptoPaymentsMoney } from "./crypto-payments-money"; - -/** - * - * @export - * @interface NetworkFeeQuote - */ -export interface NetworkFeeQuote { - /** - * UUID of network fee quote - * @type {string} - * @memberof NetworkFeeQuote - */ - quoteId: string; - /** - * - * @type {CryptoPaymentsMoney} - * @memberof NetworkFeeQuote - */ - amount: CryptoPaymentsMoney; - /** - * The timestamp when the quote will expire at, in ISO-8601 UTC date/time format. - * @type {string} - * @memberof NetworkFeeQuote - */ - expiresAt: string; -} diff --git a/src/generated/models/new-report-success.ts b/src/generated/models/new-report-success.ts new file mode 100644 index 00000000..c0475480 --- /dev/null +++ b/src/generated/models/new-report-success.ts @@ -0,0 +1,25 @@ +/* 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 { DailyCustodyBalancesResponse } from "./daily-custody-balances-response"; + +/** + * + * @export + * @interface NewReportSuccess + */ +export interface NewReportSuccess { + /** + * + * @type {DailyCustodyBalancesResponse} + * @memberof NewReportSuccess + */ + data?: DailyCustodyBalancesResponse; +} diff --git a/src/generated/models/payment-creation-request.ts b/src/generated/models/payment-creation-request.ts deleted file mode 100644 index cf911889..00000000 --- a/src/generated/models/payment-creation-request.ts +++ /dev/null @@ -1,106 +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 { MetadataPayment } from "./metadata-payment"; -// May contain unused imports in some cases -// @ts-ignore -import { Source } from "./source"; - -/** - * - * @export - * @interface PaymentCreationRequest - */ -export interface PaymentCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof PaymentCreationRequest - */ - idempotencyKey: string; - /** - * 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 PaymentCreationRequest - */ - keyId?: string; - /** - * - * @type {MetadataPayment} - * @memberof PaymentCreationRequest - */ - metadata: MetadataPayment; - /** - * - * @type {FiatMoneyUsd} - * @memberof PaymentCreationRequest - */ - amount: FiatMoneyUsd; - /** - * Triggers the automatic capture of the full payment amount. If set to false the payment will only be authorized but not captured. - * @type {boolean} - * @memberof PaymentCreationRequest - */ - autoCapture?: boolean; - /** - * Indicates the verification method for this payment. - * @type {string} - * @memberof PaymentCreationRequest - */ - verification: PaymentCreationRequestVerificationEnum; - /** - * The URL to redirect users to after successful 3DS authentication. - * @type {string} - * @memberof PaymentCreationRequest - */ - verificationSuccessUrl?: string; - /** - * The URL to redirect users to after failed 3DS authentication. - * @type {string} - * @memberof PaymentCreationRequest - */ - verificationFailureUrl?: string; - /** - * - * @type {Source} - * @memberof PaymentCreationRequest - */ - source: Source; - /** - * Description of the payment with length restriction of 240 characters. - * @type {string} - * @memberof PaymentCreationRequest - */ - description?: string; - /** - * PGP encrypted base64 encoded string. Contains CVV. * **CVV (Card Verification Number)**: Three or four digit security code. Only required if `verification` is `cvv`. - * @type {string} - * @memberof PaymentCreationRequest - */ - encryptedData?: string; - /** - * The channel identifier that can be set for the payment. When not provided, the default channel is used. - * @type {string} - * @memberof PaymentCreationRequest - */ - channel?: string; -} - -export const PaymentCreationRequestVerificationEnum = { - None: "none", - Cvv: "cvv", - ThreeDSecure: "three_d_secure" -} as const; - -export type PaymentCreationRequestVerificationEnum = - typeof PaymentCreationRequestVerificationEnum[keyof typeof PaymentCreationRequestVerificationEnum]; diff --git a/src/generated/models/payment-intent-creation-request.ts b/src/generated/models/payment-intent-creation-request.ts index 7dea00cf..3dd9779b 100644 --- a/src/generated/models/payment-intent-creation-request.ts +++ b/src/generated/models/payment-intent-creation-request.ts @@ -32,7 +32,7 @@ export interface PaymentIntentCreationRequest { */ amount: CryptoPaymentsMoney; /** - * Desired currency for the payments to settle in. + * Desired currency for the payments to settle in. This must match the currency used for the payment method. * @type {string} * @memberof PaymentIntentCreationRequest */ @@ -53,6 +53,7 @@ export interface PaymentIntentCreationRequest { export const PaymentIntentCreationRequestSettlementCurrencyEnum = { Usd: "USD", + Eur: "EUR", Btc: "BTC", Eth: "ETH" } as const; diff --git a/src/generated/models/payment-method-blockchain-request.ts b/src/generated/models/payment-method-blockchain-request.ts new file mode 100644 index 00000000..74f13d69 --- /dev/null +++ b/src/generated/models/payment-method-blockchain-request.ts @@ -0,0 +1,38 @@ +/* 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 { Chain } from "./chain"; + +/** + * + * @export + * @interface PaymentMethodBlockchainRequest + */ +export interface PaymentMethodBlockchainRequest { + /** + * + * @type {string} + * @memberof PaymentMethodBlockchainRequest + */ + type: PaymentMethodBlockchainRequestTypeEnum; + /** + * + * @type {Chain} + * @memberof PaymentMethodBlockchainRequest + */ + chain: Chain; +} + +export const PaymentMethodBlockchainRequestTypeEnum = { + Blockchain: "blockchain" +} as const; + +export type PaymentMethodBlockchainRequestTypeEnum = + typeof PaymentMethodBlockchainRequestTypeEnum[keyof typeof PaymentMethodBlockchainRequestTypeEnum]; diff --git a/src/generated/models/payment-method-blockchain.ts b/src/generated/models/payment-method-blockchain.ts index ef2ab860..a77eb127 100644 --- a/src/generated/models/payment-method-blockchain.ts +++ b/src/generated/models/payment-method-blockchain.ts @@ -6,10 +6,6 @@ * Do not edit the class manually. */ -// May contain unused imports in some cases -// @ts-ignore -import { Chain } from "./chain"; - /** * * @export @@ -23,11 +19,11 @@ export interface PaymentMethodBlockchain { */ type: PaymentMethodBlockchainTypeEnum; /** - * - * @type {Chain} + * The blockchain network for the payment. + * @type {string} * @memberof PaymentMethodBlockchain */ - chain: Chain; + chain: PaymentMethodBlockchainChainEnum; /** * * @type {string} @@ -42,3 +38,21 @@ export const PaymentMethodBlockchainTypeEnum = { export type PaymentMethodBlockchainTypeEnum = typeof PaymentMethodBlockchainTypeEnum[keyof typeof PaymentMethodBlockchainTypeEnum]; +export const PaymentMethodBlockchainChainEnum = { + Algo: "ALGO", + Arb: "ARB", + Avax: "AVAX", + Base: "BASE", + Btc: "BTC", + Eth: "ETH", + Hbar: "HBAR", + Noble: "NOBLE", + Op: "OP", + Poly: "POLY", + Sol: "SOL", + Sui: "SUI", + Xlm: "XLM" +} as const; + +export type PaymentMethodBlockchainChainEnum = + typeof PaymentMethodBlockchainChainEnum[keyof typeof PaymentMethodBlockchainChainEnum]; diff --git a/src/generated/models/payment-token-request.ts b/src/generated/models/payment-token-request.ts deleted file mode 100644 index 090eb026..00000000 --- a/src/generated/models/payment-token-request.ts +++ /dev/null @@ -1,45 +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 { PaymentTokenRequestTokenData } from "./payment-token-request-token-data"; - -/** - * - * @export - * @interface PaymentTokenRequest - */ -export interface PaymentTokenRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof PaymentTokenRequest - */ - idempotencyKey: string; - /** - * Type of the digital wallet token. - * @type {string} - * @memberof PaymentTokenRequest - */ - type: PaymentTokenRequestTypeEnum; - /** - * - * @type {PaymentTokenRequestTokenData} - * @memberof PaymentTokenRequest - */ - tokenData: PaymentTokenRequestTokenData; -} - -export const PaymentTokenRequestTypeEnum = { - Applepay: "applepay", - Googlepay: "googlepay" -} as const; - -export type PaymentTokenRequestTypeEnum = - typeof PaymentTokenRequestTypeEnum[keyof typeof PaymentTokenRequestTypeEnum]; diff --git a/src/generated/models/payment-token.ts b/src/generated/models/payment-token.ts deleted file mode 100644 index 5436ed8d..00000000 --- a/src/generated/models/payment-token.ts +++ /dev/null @@ -1,63 +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 { TokenizedCardDetails } from "./tokenized-card-details"; - -/** - * - * @export - * @interface PaymentToken - */ -export interface PaymentToken { - /** - * Unique system generated identifier for the digital wallet token. - * @type {string} - * @memberof PaymentToken - */ - id: string; - /** - * Type of the digital wallet token. - * @type {string} - * @memberof PaymentToken - */ - type: PaymentTokenTypeEnum; - /** - * Datetime when the digital token expires. ISO-8601. - * @type {string} - * @memberof PaymentToken - */ - expiresOn: string; - /** - * - * @type {TokenizedCardDetails} - * @memberof PaymentToken - */ - cardDetails: TokenizedCardDetails; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof PaymentToken - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof PaymentToken - */ - updateDate: string; -} - -export const PaymentTokenTypeEnum = { - Applepay: "applepay", - Googlepay: "googlepay" -} as const; - -export type PaymentTokenTypeEnum = - typeof PaymentTokenTypeEnum[keyof typeof PaymentTokenTypeEnum]; diff --git a/src/generated/models/presign-domain.ts b/src/generated/models/presign-domain.ts deleted file mode 100644 index 856b9c7c..00000000 --- a/src/generated/models/presign-domain.ts +++ /dev/null @@ -1,39 +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 PresignDomain - */ -export interface PresignDomain { - /** - * User readable name of signing domain - * @type {string} - * @memberof PresignDomain - */ - name: string; - /** - * The address of the contract that will verify the signature - * @type {string} - * @memberof PresignDomain - */ - verifyingContract: string; - /** - * The current major version of the signing domain. Signatures from different versions are not compatible - * @type {string} - * @memberof PresignDomain - */ - version: string; - /** - * chain id from https://chainid.network/ - * @type {number} - * @memberof PresignDomain - */ - chainId: number; -} diff --git a/src/generated/models/presign-message-types.ts b/src/generated/models/presign-message-types.ts deleted file mode 100644 index e11fdd57..00000000 --- a/src/generated/models/presign-message-types.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 { PresignMessageTypesItems } from "./presign-message-types-items"; - -/** - * The data schema of the message - * @export - * @interface PresignMessageTypes - */ -export interface PresignMessageTypes { - /** - * Data schema of the domain field in typedData. It\'s a list of (name, type) pair - * @type {Array} - * @memberof PresignMessageTypes - */ - EIP712Domain?: Array; - /** - * Data schema of the message in typedData. It\'s a list of (name, type) pair - * @type {Array} - * @memberof PresignMessageTypes - */ - TransferWithAuthorization?: Array; -} diff --git a/src/generated/models/presign-message.ts b/src/generated/models/presign-message.ts deleted file mode 100644 index 6c6dadf7..00000000 --- a/src/generated/models/presign-message.ts +++ /dev/null @@ -1,51 +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 PresignMessage - */ -export interface PresignMessage { - /** - * A blockchain address representing payer\'s address - * @type {string} - * @memberof PresignMessage - */ - from: string; - /** - * A blockchain address representing payee\'s address - * @type {string} - * @memberof PresignMessage - */ - to: string; - /** - * Amount to be transferred - * @type {string} - * @memberof PresignMessage - */ - value: string; - /** - * the timestamp after which this is valid (unix time) - * @type {number} - * @memberof PresignMessage - */ - validAfter: number; - /** - * the timestamp before which this is valid (unix time) - * @type {number} - * @memberof PresignMessage - */ - validBefore: number; - /** - * unique nonce - * @type {string} - * @memberof PresignMessage - */ - nonce: string; -} diff --git a/src/generated/models/presign-response-typed-data.ts b/src/generated/models/presign-response-typed-data.ts deleted file mode 100644 index 619a420d..00000000 --- a/src/generated/models/presign-response-typed-data.ts +++ /dev/null @@ -1,88 +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 { NetworkFeeQuote } from "./network-fee-quote"; -// May contain unused imports in some cases -// @ts-ignore -import { PresignDomain } from "./presign-domain"; -// May contain unused imports in some cases -// @ts-ignore -import { PresignMessage } from "./presign-message"; -// May contain unused imports in some cases -// @ts-ignore -import { PresignMessageTypes } from "./presign-message-types"; - -/** - * The typed data - * @export - * @interface PresignResponseTypedData - */ -export interface PresignResponseTypedData { - /** - * - * @type {PresignDomain} - * @memberof PresignResponseTypedData - */ - domain: PresignDomain; - /** - * - * @type {PresignMessage} - * @memberof PresignResponseTypedData - */ - message: PresignMessage; - /** - * - * @type {FiatMoneyUsd} - * @memberof PresignResponseTypedData - */ - totalAmount: FiatMoneyUsd; - /** - * Who pays for network fee. Can only be endUser or merchant. If it\'s the endUser, totalAmount includes the network fee and networkFeeQuote isn\'t null; If it\'s the merchant, totalAmount doesn\'t include network fee and networkFeeQuote is null. - * @type {string} - * @memberof PresignResponseTypedData - */ - feeChargeModel: PresignResponseTypedDataFeeChargeModelEnum; - /** - * - * @type {NetworkFeeQuote} - * @memberof PresignResponseTypedData - */ - networkFeeQuote?: NetworkFeeQuote; - /** - * - * @type {PresignMessageTypes} - * @memberof PresignResponseTypedData - */ - types: PresignMessageTypes; - /** - * Type of the message - * @type {string} - * @memberof PresignResponseTypedData - */ - primaryType: PresignResponseTypedDataPrimaryTypeEnum; -} - -export const PresignResponseTypedDataFeeChargeModelEnum = { - EndUser: "endUser", - Merchant: "merchant" -} as const; - -export type PresignResponseTypedDataFeeChargeModelEnum = - typeof PresignResponseTypedDataFeeChargeModelEnum[keyof typeof PresignResponseTypedDataFeeChargeModelEnum]; -export const PresignResponseTypedDataPrimaryTypeEnum = { - TransferWithAuthorization: "TransferWithAuthorization", - Eip712Domain: "EIP712Domain" -} as const; - -export type PresignResponseTypedDataPrimaryTypeEnum = - typeof PresignResponseTypedDataPrimaryTypeEnum[keyof typeof PresignResponseTypedDataPrimaryTypeEnum]; diff --git a/src/generated/models/presign-response.ts b/src/generated/models/presign-response.ts deleted file mode 100644 index 0f04b1fb..00000000 --- a/src/generated/models/presign-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 { PresignResponseTypedData } from "./presign-response-typed-data"; - -/** - * Response of the GET /presign endpoint - * @export - * @interface PresignResponse - */ -export interface PresignResponse { - /** - * - * @type {PresignResponseTypedData} - * @memberof PresignResponse - */ - typedData: PresignResponseTypedData; -} diff --git a/src/generated/models/public-key.ts b/src/generated/models/public-key.ts deleted file mode 100644 index 518f00d0..00000000 --- a/src/generated/models/public-key.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 PublicKey - */ -export interface PublicKey { - /** - * 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 PublicKey - */ - keyId: string; - /** - * A PGP ascii-armor encoded public key. - * @type {string} - * @memberof PublicKey - */ - publicKey: string; -} diff --git a/src/generated/models/rate.ts b/src/generated/models/rate.ts deleted file mode 100644 index 2712b07a..00000000 --- a/src/generated/models/rate.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 Rate - */ -export interface Rate { - /** - * The buy rate denominated in the quote currency of the trading pair. - * @type {string} - * @memberof Rate - */ - buy: string; - /** - * The sell rate denominated in the quote currency of the trading pair. - * @type {string} - * @memberof Rate - */ - sell: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof Rate - */ - createDate: string; -} diff --git a/src/generated/models/redemption-fee-calculation.ts b/src/generated/models/redemption-fee-calculation.ts index 222e6cb1..abb1eeab 100644 --- a/src/generated/models/redemption-fee-calculation.ts +++ b/src/generated/models/redemption-fee-calculation.ts @@ -20,7 +20,7 @@ import { BurnFeePayoutAmount } from "./burn-fee-payout-amount"; import { FiatMoney } from "./fiat-money"; /** - * A NET burn fee calculation for a day. + * A burn fee calculation for a day. * @export * @interface RedemptionFeeCalculation */ @@ -74,11 +74,17 @@ export interface RedemptionFeeCalculation { */ thresholdResetTimestamp?: string; /** - * The create date of the NET burn daily fee calculation. + * The create date of the burn fee calculation. * @type {string} * @memberof RedemptionFeeCalculation */ createDate?: string; + /** + * The aggregation method used to calculate the fee. + * @type {string} + * @memberof RedemptionFeeCalculation + */ + feeType?: RedemptionFeeCalculationFeeTypeEnum; } export const RedemptionFeeCalculationStatusEnum = { @@ -89,3 +95,10 @@ export const RedemptionFeeCalculationStatusEnum = { export type RedemptionFeeCalculationStatusEnum = typeof RedemptionFeeCalculationStatusEnum[keyof typeof RedemptionFeeCalculationStatusEnum]; +export const RedemptionFeeCalculationFeeTypeEnum = { + Gross: "gross", + Net: "net" +} as const; + +export type RedemptionFeeCalculationFeeTypeEnum = + typeof RedemptionFeeCalculationFeeTypeEnum[keyof typeof RedemptionFeeCalculationFeeTypeEnum]; diff --git a/src/generated/models/refund-creation-request.ts b/src/generated/models/refund-creation-request.ts deleted file mode 100644 index cb33814c..00000000 --- a/src/generated/models/refund-creation-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 { FiatMoneyUsd } from "./fiat-money-usd"; -// May contain unused imports in some cases -// @ts-ignore -import { ReversalReason } from "./reversal-reason"; - -/** - * - * @export - * @interface RefundCreationRequest - */ -export interface RefundCreationRequest { - /** - * Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. - * @type {string} - * @memberof RefundCreationRequest - */ - idempotencyKey: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof RefundCreationRequest - */ - amount: FiatMoneyUsd; - /** - * - * @type {ReversalReason} - * @memberof RefundCreationRequest - */ - reason?: ReversalReason; -} diff --git a/src/generated/models/refund-payment-response.ts b/src/generated/models/refund-payment-response.ts deleted file mode 100644 index 74e83d36..00000000 --- a/src/generated/models/refund-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 { DetailedRefund } from "./detailed-refund"; - -/** - * - * @export - * @interface RefundPaymentResponse - */ -export interface RefundPaymentResponse { - /** - * - * @type {DetailedRefund} - * @memberof RefundPaymentResponse - */ - data?: DetailedRefund; -} diff --git a/src/generated/models/reversal-reason.ts b/src/generated/models/reversal-reason.ts deleted file mode 100644 index 7cff7adc..00000000 --- a/src/generated/models/reversal-reason.ts +++ /dev/null @@ -1,30 +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. - */ - -/** - * Enumerated reason for a returned payment. Providing this reason in the request is recommended (to improve risk evaluation) but not required. - * @export - * @enum {string} - */ - -export const ReversalReason = { - Duplicate: "duplicate", - Fraudulent: "fraudulent", - RequestedByCustomer: "requested_by_customer", - BankTransactionError: "bank_transaction_error", - InvalidAccountNumber: "invalid_account_number", - InsufficientFunds: "insufficient_funds", - PaymentStoppedByIssuer: "payment_stopped_by_issuer", - PaymentReturned: "payment_returned", - BankAccountIneligible: "bank_account_ineligible", - InvalidAchRtn: "invalid_ach_rtn", - UnauthorizedTransaction: "unauthorized_transaction", - PaymentFailed: "payment_failed" -} as const; - -export type ReversalReason = typeof ReversalReason[keyof typeof ReversalReason]; diff --git a/src/generated/models/settlement-detail-status.ts b/src/generated/models/settlement-detail-status.ts new file mode 100644 index 00000000..2cc1ef9d --- /dev/null +++ b/src/generated/models/settlement-detail-status.ts @@ -0,0 +1,21 @@ +/* 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 + * @enum {string} + */ + +export const SettlementDetailStatus = { + Pending: "pending", + Completed: "completed" +} as const; + +export type SettlementDetailStatus = + typeof SettlementDetailStatus[keyof typeof SettlementDetailStatus]; diff --git a/src/generated/models/settlement-details-inner.ts b/src/generated/models/settlement-details-inner.ts new file mode 100644 index 00000000..7e135367 --- /dev/null +++ b/src/generated/models/settlement-details-inner.ts @@ -0,0 +1,72 @@ +/* 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 { FxMoney } from "./fx-money"; +// May contain unused imports in some cases +// @ts-ignore +import { SettlementDetailStatus } from "./settlement-detail-status"; + +/** + * + * @export + * @interface SettlementDetailsInner + */ +export interface SettlementDetailsInner { + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof SettlementDetailsInner + */ + id?: string; + /** + * + * @type {string} + * @memberof SettlementDetailsInner + */ + type?: SettlementDetailsInnerTypeEnum; + /** + * + * @type {FxMoney} + * @memberof SettlementDetailsInner + */ + amount?: FxMoney; + /** + * + * @type {SettlementDetailStatus} + * @memberof SettlementDetailsInner + */ + status?: SettlementDetailStatus; + /** + * + * @type {string} + * @memberof SettlementDetailsInner + */ + reference?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof SettlementDetailsInner + */ + createDate?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof SettlementDetailsInner + */ + updateDate?: string; +} + +export const SettlementDetailsInnerTypeEnum = { + Payable: "payable", + Receivable: "receivable" +} as const; + +export type SettlementDetailsInnerTypeEnum = + typeof SettlementDetailsInnerTypeEnum[keyof typeof SettlementDetailsInnerTypeEnum]; diff --git a/src/generated/models/settlement-status.ts b/src/generated/models/settlement-status.ts new file mode 100644 index 00000000..dc42ce55 --- /dev/null +++ b/src/generated/models/settlement-status.ts @@ -0,0 +1,21 @@ +/* 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. + */ + +/** + * Status of the settlement. + * @export + * @enum {string} + */ + +export const SettlementStatus = { + Pending: "pending", + Settled: "settled" +} as const; + +export type SettlementStatus = + typeof SettlementStatus[keyof typeof SettlementStatus]; diff --git a/src/generated/models/settlement.ts b/src/generated/models/settlement.ts index 171e789e..36afb018 100644 --- a/src/generated/models/settlement.ts +++ b/src/generated/models/settlement.ts @@ -8,7 +8,10 @@ // May contain unused imports in some cases // @ts-ignore -import { FiatMoneyUsd } from "./fiat-money-usd"; +import { SettlementDetailsInner } from "./settlement-details-inner"; +// May contain unused imports in some cases +// @ts-ignore +import { SettlementStatus } from "./settlement-status"; /** * @@ -23,41 +26,17 @@ export interface Settlement { */ id?: string; /** - * Unique system generated identifier for the wallet of the merchant. - * @type {string} - * @memberof Settlement - */ - merchantWalletId?: string; - /** - * If this settlement was used for a marketplace payment, the wallet involved in the settlement. Not included for standard merchant settlements. + * Unique system generated identifier for the entity. * @type {string} * @memberof Settlement */ - walletId?: string; - /** - * - * @type {FiatMoneyUsd} - * @memberof Settlement - */ - totalDebits?: FiatMoneyUsd; + entityId?: string; /** * - * @type {FiatMoneyUsd} + * @type {SettlementStatus} * @memberof Settlement */ - totalCredits?: FiatMoneyUsd; - /** - * - * @type {FiatMoneyUsd} - * @memberof Settlement - */ - paymentFees?: FiatMoneyUsd; - /** - * - * @type {FiatMoneyUsd} - * @memberof Settlement - */ - chargebackFees?: FiatMoneyUsd; + status?: SettlementStatus; /** * ISO-8601 UTC date/time format. * @type {string} @@ -70,4 +49,10 @@ export interface Settlement { * @memberof Settlement */ updateDate?: string; + /** + * + * @type {Array} + * @memberof Settlement + */ + details?: Array; } diff --git a/src/generated/models/simple-billing-details.ts b/src/generated/models/simple-billing-details.ts deleted file mode 100644 index 7c29f01e..00000000 --- a/src/generated/models/simple-billing-details.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. - */ - -/** - * Billing details of the card holder. - * @export - * @interface SimpleBillingDetails - */ -export interface SimpleBillingDetails { - /** - * Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. - * @type {string} - * @memberof SimpleBillingDetails - */ - country: string; - /** - * State / County / Province / Region portion of the address. US and Canada use the two-letter code for the subdivision. - * @type {string} - * @memberof SimpleBillingDetails - */ - district: string; -} diff --git a/src/generated/models/simple-card.ts b/src/generated/models/simple-card.ts deleted file mode 100644 index f9a3d146..00000000 --- a/src/generated/models/simple-card.ts +++ /dev/null @@ -1,131 +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 { CardVerificationResponse } from "./card-verification-response"; -// 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"; -// May contain unused imports in some cases -// @ts-ignore -import { SimpleBillingDetails } from "./simple-billing-details"; - -/** - * - * @export - * @interface SimpleCard - */ -export interface SimpleCard { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof SimpleCard - */ - id: string; - /** - * - * @type {ExternalFiatAccountStatus} - * @memberof SimpleCard - */ - status: ExternalFiatAccountStatus; - /** - * - * @type {SimpleBillingDetails} - * @memberof SimpleCard - */ - billingDetails: SimpleBillingDetails; - /** - * Two digit number representing the card\'s expiration month. - * @type {number} - * @memberof SimpleCard - */ - expMonth: number; - /** - * Four digit number representing the card\'s expiration year. - * @type {number} - * @memberof SimpleCard - */ - expYear: number; - /** - * The network of the card. - * @type {string} - * @memberof SimpleCard - */ - network: SimpleCardNetworkEnum; - /** - * The bank identification number (BIN), the first 6 digits of the card. - * @type {string} - * @memberof SimpleCard - */ - bin?: string; - /** - * The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard. - * @type {string} - * @memberof SimpleCard - */ - issuerCountry?: string; - /** - * The funding type of the card. Possible values are `credit`, `debit`, `prepaid`, and `unknown`. - * @type {string} - * @memberof SimpleCard - */ - fundingType?: SimpleCardFundingTypeEnum; - /** - * 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 SimpleCard - */ - fingerprint: string; - /** - * - * @type {CardVerificationResponse} - * @memberof SimpleCard - */ - verification: CardVerificationResponse; - /** - * - * @type {RiskEvaluation} - * @memberof SimpleCard - */ - riskEvaluation?: RiskEvaluation | null; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof SimpleCard - */ - createDate: string; - /** - * ISO-8601 UTC date/time format. - * @type {string} - * @memberof SimpleCard - */ - updateDate: string; -} - -export const SimpleCardNetworkEnum = { - Visa: "VISA", - Mastercard: "MASTERCARD", - Amex: "AMEX", - Unknown: "UNKNOWN" -} as const; - -export type SimpleCardNetworkEnum = - typeof SimpleCardNetworkEnum[keyof typeof SimpleCardNetworkEnum]; -export const SimpleCardFundingTypeEnum = { - Credit: "credit", - Debit: "debit", - Prepaid: "prepaid", - Unknown: "unknown" -} as const; - -export type SimpleCardFundingTypeEnum = - typeof SimpleCardFundingTypeEnum[keyof typeof SimpleCardFundingTypeEnum]; diff --git a/src/generated/models/source.ts b/src/generated/models/source.ts deleted file mode 100644 index 7947a75d..00000000 --- a/src/generated/models/source.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 Source - */ -export interface Source { - /** - * Unique system generated identifier for the entity. - * @type {string} - * @memberof Source - */ - id?: string; - /** - * Type of the source. - * @type {string} - * @memberof Source - */ - type?: SourceTypeEnum; -} - -export const SourceTypeEnum = { - Card: "card" -} as const; - -export type SourceTypeEnum = typeof SourceTypeEnum[keyof typeof SourceTypeEnum]; diff --git a/src/generated/models/to-amount.ts b/src/generated/models/to-amount.ts deleted file mode 100644 index 3d06dcb8..00000000 --- a/src/generated/models/to-amount.ts +++ /dev/null @@ -1,32 +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 ToAmount - */ -export interface ToAmount { - /** - * Currency code for the amount. - * @type {string} - * @memberof ToAmount - */ - currency: ToAmountCurrencyEnum; -} - -export const ToAmountCurrencyEnum = { - Usd: "USD", - Eur: "EUR", - Btc: "BTC", - Eth: "ETH", - Mtc: "MTC" -} as const; - -export type ToAmountCurrencyEnum = - typeof ToAmountCurrencyEnum[keyof typeof ToAmountCurrencyEnum]; diff --git a/src/generated/models/tokenized-card-details.ts b/src/generated/models/tokenized-card-details.ts deleted file mode 100644 index eefa0e94..00000000 --- a/src/generated/models/tokenized-card-details.ts +++ /dev/null @@ -1,76 +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 TokenizedCardDetails - */ -export interface TokenizedCardDetails { - /** - * The card\'s expiration month. - * @type {number} - * @memberof TokenizedCardDetails - */ - expMonth: number; - /** - * Four digit number representing the card\'s expiration year. - * @type {number} - * @memberof TokenizedCardDetails - */ - expYear: number; - /** - * The network of the card. - * @type {string} - * @memberof TokenizedCardDetails - */ - network?: TokenizedCardDetailsNetworkEnum; - /** - * The last 4 digits of the card. - * @type {string} - * @memberof TokenizedCardDetails - */ - last4: string; - /** - * The bank identification number (BIN), the first 6 digits of the card. - * @type {string} - * @memberof TokenizedCardDetails - */ - bin: string; - /** - * The funding type of the card. - * @type {string} - * @memberof TokenizedCardDetails - */ - fundingType?: TokenizedCardDetailsFundingTypeEnum; - /** - * The country code of the issuer bank. Follows the ISO 3166-1 alpha-2 standard. - * @type {string} - * @memberof TokenizedCardDetails - */ - issuerCountry?: string; -} - -export const TokenizedCardDetailsNetworkEnum = { - Visa: "VISA", - Mastercard: "MASTERCARD", - Amex: "AMEX", - Unknown: "UNKNOWN" -} as const; - -export type TokenizedCardDetailsNetworkEnum = - typeof TokenizedCardDetailsNetworkEnum[keyof typeof TokenizedCardDetailsNetworkEnum]; -export const TokenizedCardDetailsFundingTypeEnum = { - Credit: "credit", - Debit: "debit", - Prepaid: "prepaid", - Unknown: "unknown" -} as const; - -export type TokenizedCardDetailsFundingTypeEnum = - typeof TokenizedCardDetailsFundingTypeEnum[keyof typeof TokenizedCardDetailsFundingTypeEnum]; diff --git a/src/generated/models/trade-status.ts b/src/generated/models/trade-status.ts new file mode 100644 index 00000000..cf378a03 --- /dev/null +++ b/src/generated/models/trade-status.ts @@ -0,0 +1,23 @@ +/* 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. + */ + +/** + * Status of the trade. + * @export + * @enum {string} + */ + +export const TradeStatus = { + Pending: "pending", + Confirmed: "confirmed", + Failed: "failed", + Complete: "complete", + PendingSettlement: "pending_settlement" +} as const; + +export type TradeStatus = typeof TradeStatus[keyof typeof TradeStatus]; diff --git a/src/generated/models/trade.ts b/src/generated/models/trade.ts new file mode 100644 index 00000000..958816c1 --- /dev/null +++ b/src/generated/models/trade.ts @@ -0,0 +1,82 @@ +/* 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 { FxMoney } from "./fx-money"; +// May contain unused imports in some cases +// @ts-ignore +import { TradeStatus } from "./trade-status"; + +/** + * + * @export + * @interface Trade + */ +export interface Trade { + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof Trade + */ + id?: string; + /** + * + * @type {FxMoney} + * @memberof Trade + */ + from?: FxMoney; + /** + * + * @type {FxMoney} + * @memberof Trade + */ + to?: FxMoney; + /** + * + * @type {TradeStatus} + * @memberof Trade + */ + status?: TradeStatus; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof Trade + */ + createDate?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof Trade + */ + updateDate?: string; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof Trade + */ + quoteId?: string; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof Trade + */ + settlementId?: string; + /** + * Rate associated with the FX trade. + * @type {string} + * @memberof Trade + */ + rate?: string; + /** + * ISO-8601 UTC date/time format. + * @type {string} + * @memberof Trade + */ + expectedBatchTime?: string; +} diff --git a/src/generated/models/transfer-destination-blockchain-location.ts b/src/generated/models/transfer-destination-blockchain-location.ts index 778c5460..204aa7e8 100644 --- a/src/generated/models/transfer-destination-blockchain-location.ts +++ b/src/generated/models/transfer-destination-blockchain-location.ts @@ -23,7 +23,7 @@ export interface TransferDestinationBlockchainLocation { */ type: TransferDestinationBlockchainLocationTypeEnum; /** - * An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address. + * An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address. **Important:** For Ripple (XRP) addresses, only the classic address format is supported (for example, `rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY`). The `x-address` format is NOT supported currently (for example, `XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV`). * @type {string} * @memberof TransferDestinationBlockchainLocation */ diff --git a/src/generated/models/update-billing-details.ts b/src/generated/models/update-billing-details.ts deleted file mode 100644 index 67aeaef0..00000000 --- a/src/generated/models/update-billing-details.ts +++ /dev/null @@ -1,75 +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 UpdateBillingDetails - */ -export interface UpdateBillingDetails { - /** - * First name of the card or bank account holder. - * @type {string} - * @memberof UpdateBillingDetails - */ - firstName?: string; - /** - * Last name of the card or bank account holder. - * @type {string} - * @memberof UpdateBillingDetails - */ - lastName?: string; - /** - * Line one of the street address. - * @type {string} - * @memberof UpdateBillingDetails - */ - line1?: string; - /** - * Line two of the street address. - * @type {string} - * @memberof UpdateBillingDetails - */ - line2?: string; - /** - * City portion of the address. - * @type {string} - * @memberof UpdateBillingDetails - */ - city?: 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 UpdateBillingDetails - */ - district?: string; - /** - * Postal / ZIP code of the address. - * @type {string} - * @memberof UpdateBillingDetails - */ - postalCode?: string; - /** - * Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2. - * @type {string} - * @memberof UpdateBillingDetails - */ - country?: string; - /** - * 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. - * @type {string} - * @memberof UpdateBillingDetails - */ - phone?: string; - /** - * Email of the user. - * @type {string} - * @memberof UpdateBillingDetails - */ - email?: string; -} diff --git a/src/generated/models/update-card-response.ts b/src/generated/models/update-card-response.ts deleted file mode 100644 index bfbc9a47..00000000 --- a/src/generated/models/update-card-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 { Card } from "./card"; - -/** - * - * @export - * @interface UpdateCardResponse - */ -export interface UpdateCardResponse { - /** - * - * @type {Card} - * @memberof UpdateCardResponse - */ - data?: Card; -} diff --git a/src/generated/models/verification-error-code.ts b/src/generated/models/verification-error-code.ts deleted file mode 100644 index 5a0e27c6..00000000 --- a/src/generated/models/verification-error-code.ts +++ /dev/null @@ -1,36 +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 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]\' - * @export - * @enum {string} - */ - -export const VerificationErrorCode = { - VerificationFailed: "verification_failed", - VerificationFraudDetected: "verification_fraud_detected", - VerificationDenied: "verification_denied", - VerificationNotSupportedByIssuer: "verification_not_supported_by_issuer", - VerificationStoppedByIssuer: "verification_stopped_by_issuer", - CardFailed: "card_failed", - CardInvalid: "card_invalid", - CardAddressMismatch: "card_address_mismatch", - CardZipMismatch: "card_zip_mismatch", - CardCvvInvalid: "card_cvv_invalid", - CardExpired: "card_expired", - CardLimitViolated: "card_limit_violated", - CardNotHonored: "card_not_honored", - CardCvvRequired: "card_cvv_required", - CreditCardNotAllowed: "credit_card_not_allowed", - CardAccountIneligible: "card_account_ineligible", - CardNetworkUnsupported: "card_network_unsupported" -} as const; - -export type VerificationErrorCode = - typeof VerificationErrorCode[keyof typeof VerificationErrorCode]; diff --git a/src/generated/models/wire-destination-response.ts b/src/generated/models/wire-destination-response.ts new file mode 100644 index 00000000..8b0ff364 --- /dev/null +++ b/src/generated/models/wire-destination-response.ts @@ -0,0 +1,40 @@ +/* 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 WireDestinationResponse + */ +export interface WireDestinationResponse { + /** + * + * @type {string} + * @memberof WireDestinationResponse + */ + type: WireDestinationResponseTypeEnum; + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof WireDestinationResponse + */ + id: string; + /** + * Bank name plus last four digits of the bank account number or IBAN. + * @type {string} + * @memberof WireDestinationResponse + */ + name?: string; +} + +export const WireDestinationResponseTypeEnum = { + Wire: "wire" +} as const; + +export type WireDestinationResponseTypeEnum = + typeof WireDestinationResponseTypeEnum[keyof typeof WireDestinationResponseTypeEnum]; diff --git a/src/generated/models/wire.ts b/src/generated/models/wire.ts index 608d85e7..b4c24591 100644 --- a/src/generated/models/wire.ts +++ b/src/generated/models/wire.ts @@ -31,6 +31,12 @@ export interface Wire { * @memberof Wire */ id: string; + /** + * The type of the bank account. + * @type {string} + * @memberof Wire + */ + type?: string; /** * * @type {ExternalFiatAccountStatus} @@ -54,7 +60,7 @@ export interface Wire { * @type {{ [key: string]: TransferTypeInfo; }} * @memberof Wire */ - transferTypesInfo: { [key: string]: TransferTypeInfo }; + transferTypesInfo?: { [key: string]: TransferTypeInfo }; /** * 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} @@ -85,4 +91,10 @@ export interface Wire { * @memberof Wire */ updateDate: string; + /** + * Whether virtual account applies to the bank account. + * @type {boolean} + * @memberof Wire + */ + virtualAccountEnabled?: boolean; }