From 0e93355e01755631614596054aa69424438c5c47 Mon Sep 17 00:00:00 2001 From: "hyperswitch-bot[bot]" <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Date: Thu, 31 Oct 2024 08:11:34 +0000 Subject: [PATCH] docs(openapi): re-generate OpenAPI specification --- api-reference-v2/openapi_spec.json | 2938 ++++++++++++++++++++++------ 1 file changed, 2288 insertions(+), 650 deletions(-) diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json index fe956fde5c01..e725126460fa 100644 --- a/api-reference-v2/openapi_spec.json +++ b/api-reference-v2/openapi_spec.json @@ -22,7 +22,9 @@ "paths": { "/v2/organization": { "post": { - "tags": ["Organization"], + "tags": [ + "Organization" + ], "summary": "Organization - Create", "description": "Create a new organization", "operationId": "Create an Organization", @@ -67,7 +69,9 @@ }, "/v2/organization/{id}": { "get": { - "tags": ["Organization"], + "tags": [ + "Organization" + ], "summary": "Organization - Retrieve", "description": "Retrieve an existing organization", "operationId": "Retrieve an Organization", @@ -104,7 +108,9 @@ ] }, "put": { - "tags": ["Organization"], + "tags": [ + "Organization" + ], "summary": "Organization - Update", "description": "Create a new organization for .", "operationId": "Update an Organization", @@ -160,7 +166,9 @@ }, "/v2/organization/{id}/merchant_accounts": { "get": { - "tags": ["Organization"], + "tags": [ + "Organization" + ], "summary": "Organization - Merchant Account - List", "description": "List merchant accounts for an Organization", "operationId": "List Merchant Accounts", @@ -202,7 +210,9 @@ }, "/v2/connector_accounts": { "post": { - "tags": ["Merchant Connector Account"], + "tags": [ + "Merchant Connector Account" + ], "summary": "Merchant Connector - Create", "description": "Creates a new Merchant Connector for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.", "operationId": "Create a Merchant Connector", @@ -277,7 +287,9 @@ }, "/v2/connector_accounts/{id}": { "get": { - "tags": ["Merchant Connector Account"], + "tags": [ + "Merchant Connector Account" + ], "summary": "Merchant Connector - Retrieve", "description": "Retrieves details of a Connector account", "operationId": "Retrieve a Merchant Connector", @@ -318,7 +330,9 @@ ] }, "put": { - "tags": ["Merchant Connector Account"], + "tags": [ + "Merchant Connector Account" + ], "summary": "Merchant Connector - Update", "description": "To update an existing Merchant Connector account. Helpful in enabling/disabling different payment methods and other settings for the connector", "operationId": "Update a Merchant Connector", @@ -388,7 +402,9 @@ ] }, "delete": { - "tags": ["Merchant Connector Account"], + "tags": [ + "Merchant Connector Account" + ], "summary": "Merchant Connector - Delete", "description": "Delete or Detach a Merchant Connector from Merchant Account", "operationId": "Delete a Merchant Connector", @@ -431,7 +447,9 @@ }, "/v2/merchant_accounts": { "post": { - "tags": ["Merchant Account"], + "tags": [ + "Merchant Account" + ], "summary": "Merchant Account - Create", "description": "Create a new account for a *merchant* and the *merchant* could be a seller or retailer or client who likes to receive and send payments.\n\nBefore creating the merchant account, it is mandatory to create an organization.", "operationId": "Create a Merchant Account", @@ -508,7 +526,9 @@ }, "/v2/merchant_accounts/{id}": { "get": { - "tags": ["Merchant Account"], + "tags": [ + "Merchant Account" + ], "summary": "Merchant Account - Retrieve", "description": "Retrieve a *merchant* account details.", "operationId": "Retrieve a Merchant Account", @@ -545,7 +565,9 @@ ] }, "put": { - "tags": ["Merchant Account"], + "tags": [ + "Merchant Account" + ], "summary": "Merchant Account - Update", "description": "Updates details of an existing merchant account. Helpful in updating merchant details such as email, contact details, or other configuration details like webhook, routing algorithm etc", "operationId": "Update a Merchant Account", @@ -610,7 +632,9 @@ }, "/v2/merchant_accounts/{account_id}/profiles": { "get": { - "tags": ["Merchant Account"], + "tags": [ + "Merchant Account" + ], "summary": "Profile - List", "description": "List profiles for an Merchant", "operationId": "List Profiles", @@ -652,7 +676,9 @@ }, "/v2/payments/{payment_id}/create-external-sdk-tokens": { "post": { - "tags": ["Payments"], + "tags": [ + "Payments" + ], "summary": "Payments - Session token", "description": "Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by Hyperswitch's SDK to initiate these wallets' SDK.", "operationId": "Create Session tokens for a Payment", @@ -690,7 +716,9 @@ }, "/v2/profiles": { "post": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Create", "description": "Creates a new *profile* for a merchant", "operationId": "Create A Profile", @@ -749,7 +777,9 @@ }, "/v2/profiles/{profile_id}": { "get": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Retrieve", "description": "Retrieve existing *profile*", "operationId": "Retrieve a Profile", @@ -798,7 +828,9 @@ ] }, "put": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Update", "description": "Update the *profile*", "operationId": "Update a Profile", @@ -866,7 +898,9 @@ }, "/v2/profiles/{profile_id}/connector_accounts": { "get": { - "tags": ["Business Profile"], + "tags": [ + "Business Profile" + ], "summary": "Merchant Connector - List", "description": "List Merchant Connector Details for the business profile", "operationId": "List all Merchant Connectors", @@ -923,7 +957,9 @@ }, "/v2/profiles/{profile_id}/activate_routing_algorithm": { "patch": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Activate routing algorithm", "description": "Activates a routing algorithm under a profile", "operationId": "Activates a routing algorithm under a profile", @@ -988,7 +1024,9 @@ }, "/v2/profiles/{profile_id}/deactivate_routing_algorithm": { "patch": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Deactivate routing algorithm", "description": "Deactivates a routing algorithm under a profile", "operationId": " Deactivates a routing algorithm under a profile", @@ -1039,7 +1077,9 @@ }, "/v2/profiles/{profile_id}/fallback_routing": { "patch": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Update Default Fallback Routing Algorithm", "description": "Update the default fallback routing algorithm for the profile", "operationId": "Update the default fallback routing algorithm for the profile", @@ -1101,7 +1141,9 @@ ] }, "get": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Retrieve Default Fallback Routing Algorithm", "description": "Retrieve the default fallback routing algorithm for the profile", "operationId": "Retrieve the default fallback routing algorithm for the profile", @@ -1146,7 +1188,9 @@ }, "/v2/profiles/{profile_id}/routing_algorithm": { "get": { - "tags": ["Profile"], + "tags": [ + "Profile" + ], "summary": "Profile - Retrieve Active Routing Algorithm", "description": "Retrieve active routing algorithm under the profile", "operationId": "Retrieve the active routing algorithm under the profile", @@ -1218,7 +1262,9 @@ }, "/v2/routing_algorithm": { "post": { - "tags": ["Routing"], + "tags": [ + "Routing" + ], "summary": "Routing - Create", "description": "Create a routing algorithm", "operationId": "Create a routing algprithm", @@ -1271,7 +1317,9 @@ }, "/v2/routing_algorithm/{routing_algorithm_id}": { "get": { - "tags": ["Routing"], + "tags": [ + "Routing" + ], "summary": "Routing - Retrieve", "description": "Retrieve a routing algorithm with its algorithm id", "operationId": "Retrieve a routing algorithm with its algorithm id", @@ -1319,7 +1367,9 @@ }, "/v2/api_keys": { "post": { - "tags": ["API Key"], + "tags": [ + "API Key" + ], "summary": "API Key - Create", "description": "Create a new API Key for accessing our APIs from your servers. The plaintext API Key will be\ndisplayed only once on creation, so ensure you store it securely.", "operationId": "Create an API Key", @@ -1357,7 +1407,9 @@ }, "/v2/api_keys/{key_id}": { "get": { - "tags": ["API Key"], + "tags": [ + "API Key" + ], "summary": "API Key - Retrieve", "description": "Retrieve information about the specified API Key.", "operationId": "Retrieve an API Key", @@ -1394,7 +1446,9 @@ ] }, "put": { - "tags": ["API Key"], + "tags": [ + "API Key" + ], "summary": "API Key - Update", "description": "Update information for the specified API Key.", "operationId": "Update an API Key", @@ -1441,7 +1495,9 @@ ] }, "delete": { - "tags": ["API Key"], + "tags": [ + "API Key" + ], "summary": "API Key - Revoke", "description": "Revoke the specified API Key. Once revoked, the API Key can no longer be used for\nauthenticating with our APIs.", "operationId": "Revoke an API Key", @@ -1480,7 +1536,9 @@ }, "/v2/api_keys/list": { "get": { - "tags": ["API Key"], + "tags": [ + "API Key" + ], "summary": "API Key - List", "description": "List all the API Keys associated to a merchant account.", "operationId": "List all API Keys associated with a merchant account", @@ -1532,7 +1590,9 @@ }, "/v2/customers": { "post": { - "tags": ["Customers"], + "tags": [ + "Customers" + ], "summary": "Customers - Create", "description": "Creates a customer object and stores the customer details to be reused for future payments.\nIncase the customer already exists in the system, this API will respond with the customer details.", "operationId": "Create a Customer", @@ -1578,7 +1638,9 @@ }, "/v2/customers/{id}": { "get": { - "tags": ["Customers"], + "tags": [ + "Customers" + ], "summary": "Customers - Retrieve", "description": "Retrieves a customer's details.", "operationId": "Retrieve a Customer", @@ -1618,7 +1680,9 @@ ] }, "post": { - "tags": ["Customers"], + "tags": [ + "Customers" + ], "summary": "Customers - Update", "description": "Updates the customer's details in a customer object.", "operationId": "Update a Customer", @@ -1673,7 +1737,9 @@ ] }, "delete": { - "tags": ["Customers"], + "tags": [ + "Customers" + ], "summary": "Customers - Delete", "description": "Delete a customer record.", "operationId": "Delete a Customer", @@ -1712,7 +1778,9 @@ }, "/v2/customers/list": { "get": { - "tags": ["Customers"], + "tags": [ + "Customers" + ], "summary": "Customers - List", "description": "Lists all the customers for a particular merchant id.", "operationId": "List all Customers for a Merchant", @@ -1743,7 +1811,9 @@ }, "/v2/payments/create-intent": { "post": { - "tags": ["Payments"], + "tags": [ + "Payments" + ], "summary": "Payments - Create Intent", "description": "**Creates a payment intent object when amount_details are passed.**\n\nYou will require the 'API - Key' from the Hyperswitch dashboard to make the first call, and use the 'client secret' returned in this API along with your 'publishable key' to make subsequent API calls from your client.", "operationId": "Create a Payment Intent", @@ -1791,7 +1861,9 @@ }, "/v2/payments/{id}/get-intent": { "get": { - "tags": ["Payments"], + "tags": [ + "Payments" + ], "summary": "Payments - Get Intent", "description": "**Get a payment intent object when id is passed in path**\n\nYou will require the 'API - Key' from the Hyperswitch dashboard to make the call.", "operationId": "Get the Payment Intent details", @@ -1830,7 +1902,9 @@ }, "/v2/payments/{id}/confirm-intent": { "post": { - "tags": ["Payments"], + "tags": [ + "Payments" + ], "summary": "Payments - Confirm Intent", "description": "**Confirms a payment intent object with the payment method data**\n\n.", "operationId": "Confirm Payment Intent", @@ -1884,7 +1958,9 @@ }, "/v2/refunds": { "post": { - "tags": ["Refunds"], + "tags": [ + "Refunds" + ], "summary": "Refunds - Create", "description": "Creates a refund against an already processed payment. In case of some processors, you can even opt to refund only a partial amount multiple times until the original charge amount has been refunded", "operationId": "Create a Refund", @@ -1952,17 +2028,25 @@ "AcceptanceType": { "type": "string", "description": "This is used to indicate if the mandate was accepted online or offline", - "enum": ["online", "offline"] + "enum": [ + "online", + "offline" + ] }, "AcceptedCountries": { "oneOf": [ { "type": "object", - "required": ["type", "list"], + "required": [ + "type", + "list" + ], "properties": { "type": { "type": "string", - "enum": ["enable_only"] + "enum": [ + "enable_only" + ] }, "list": { "type": "array", @@ -1974,11 +2058,16 @@ }, { "type": "object", - "required": ["type", "list"], + "required": [ + "type", + "list" + ], "properties": { "type": { "type": "string", - "enum": ["disable_only"] + "enum": [ + "disable_only" + ] }, "list": { "type": "array", @@ -1990,11 +2079,15 @@ }, { "type": "object", - "required": ["type"], + "required": [ + "type" + ], "properties": { "type": { "type": "string", - "enum": ["all_accepted"] + "enum": [ + "all_accepted" + ] } } } @@ -2008,11 +2101,16 @@ "oneOf": [ { "type": "object", - "required": ["type", "list"], + "required": [ + "type", + "list" + ], "properties": { "type": { "type": "string", - "enum": ["enable_only"] + "enum": [ + "enable_only" + ] }, "list": { "type": "array", @@ -2024,11 +2122,16 @@ }, { "type": "object", - "required": ["type", "list"], + "required": [ + "type", + "list" + ], "properties": { "type": { "type": "string", - "enum": ["disable_only"] + "enum": [ + "disable_only" + ] }, "list": { "type": "array", @@ -2040,11 +2143,15 @@ }, { "type": "object", - "required": ["type"], + "required": [ + "type" + ], "properties": { "type": { "type": "string", - "enum": ["all_accepted"] + "enum": [ + "all_accepted" + ] } } } @@ -2055,7 +2162,10 @@ }, "AchBankDebitAdditionalData": { "type": "object", - "required": ["account_number", "routing_number"], + "required": [ + "account_number", + "routing_number" + ], "properties": { "account_number": { "type": "string", @@ -2107,7 +2217,10 @@ }, "AchBankTransfer": { "type": "object", - "required": ["bank_account_number", "bank_routing_number"], + "required": [ + "bank_account_number", + "bank_routing_number" + ], "properties": { "bank_name": { "type": "string", @@ -2144,7 +2257,10 @@ "AchBankTransferAdditionalData": { "type": "object", "description": "Masked payout method details for ach bank transfer payout method", - "required": ["bank_account_number", "bank_routing_number"], + "required": [ + "bank_account_number", + "bank_routing_number" + ], "properties": { "bank_account_number": { "type": "string", @@ -2221,7 +2337,9 @@ "oneOf": [ { "type": "object", - "required": ["open_banking_recipient_data"], + "required": [ + "open_banking_recipient_data" + ], "properties": { "open_banking_recipient_data": { "$ref": "#/components/schemas/MerchantRecipientData" @@ -2234,7 +2352,9 @@ "oneOf": [ { "type": "object", - "required": ["Card"], + "required": [ + "Card" + ], "properties": { "Card": { "$ref": "#/components/schemas/CardAdditionalData" @@ -2243,7 +2363,9 @@ }, { "type": "object", - "required": ["Bank"], + "required": [ + "Bank" + ], "properties": { "Bank": { "$ref": "#/components/schemas/BankAdditionalData" @@ -2252,7 +2374,9 @@ }, { "type": "object", - "required": ["Wallet"], + "required": [ + "Wallet" + ], "properties": { "Wallet": { "$ref": "#/components/schemas/WalletAdditionalData" @@ -2402,7 +2526,9 @@ }, "AmountDetails": { "type": "object", - "required": ["currency"], + "required": [ + "currency" + ], "properties": { "order_amount": { "type": "integer", @@ -2532,7 +2658,10 @@ }, "AmountInfo": { "type": "object", - "required": ["label", "amount"], + "required": [ + "label", + "amount" + ], "properties": { "label": { "type": "string", @@ -2554,7 +2683,9 @@ "oneOf": [ { "type": "string", - "enum": ["never"] + "enum": [ + "never" + ] }, { "type": "string", @@ -2564,7 +2695,11 @@ }, "ApplePayAddressParameters": { "type": "string", - "enum": ["postalAddress", "phone", "email"] + "enum": [ + "postalAddress", + "phone", + "email" + ] }, "ApplePayBillingContactFields": { "type": "array", @@ -2574,7 +2709,11 @@ }, "ApplePayPaymentRequest": { "type": "object", - "required": ["country_code", "currency_code", "total"], + "required": [ + "country_code", + "currency_code", + "total" + ], "properties": { "country_code": { "$ref": "#/components/schemas/CountryAlpha2" @@ -2686,11 +2825,18 @@ }, "ApplepayInitiative": { "type": "string", - "enum": ["web", "ios"] + "enum": [ + "web", + "ios" + ] }, "ApplepayPaymentMethod": { "type": "object", - "required": ["display_name", "network", "type"], + "required": [ + "display_name", + "network", + "type" + ], "properties": { "display_name": { "type": "string", @@ -2708,7 +2854,11 @@ }, "ApplepaySessionTokenResponse": { "type": "object", - "required": ["connector", "delayed_session_token", "sdk_next_action"], + "required": [ + "connector", + "delayed_session_token", + "sdk_next_action" + ], "properties": { "session_token_data": { "allOf": [ @@ -2786,7 +2936,10 @@ }, "AuthenticationConnectorDetails": { "type": "object", - "required": ["authentication_connectors", "three_ds_requestor_url"], + "required": [ + "authentication_connectors", + "three_ds_requestor_url" + ], "properties": { "authentication_connectors": { "type": "array", @@ -2803,24 +2956,44 @@ }, "AuthenticationConnectors": { "type": "string", - "enum": ["threedsecureio", "netcetera", "gpayments"] + "enum": [ + "threedsecureio", + "netcetera", + "gpayments" + ] }, "AuthenticationStatus": { "type": "string", - "enum": ["started", "pending", "success", "failed"] + "enum": [ + "started", + "pending", + "success", + "failed" + ] }, "AuthenticationType": { "type": "string", "description": "Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set", - "enum": ["three_ds", "no_three_ds"] + "enum": [ + "three_ds", + "no_three_ds" + ] }, "AuthorizationStatus": { "type": "string", - "enum": ["success", "failure", "processing", "unresolved"] + "enum": [ + "success", + "failure", + "processing", + "unresolved" + ] }, "BacsBankDebitAdditionalData": { "type": "object", - "required": ["account_number", "sort_code"], + "required": [ + "account_number", + "sort_code" + ], "properties": { "account_number": { "type": "string", @@ -2842,7 +3015,10 @@ }, "BacsBankTransfer": { "type": "object", - "required": ["bank_account_number", "bank_sort_code"], + "required": [ + "bank_account_number", + "bank_sort_code" + ], "properties": { "bank_name": { "type": "string", @@ -2879,7 +3055,10 @@ "BacsBankTransferAdditionalData": { "type": "object", "description": "Masked payout method details for bacs bank transfer payout method", - "required": ["bank_sort_code", "bank_account_number"], + "required": [ + "bank_sort_code", + "bank_account_number" + ], "properties": { "bank_sort_code": { "type": "string", @@ -2915,7 +3094,11 @@ }, "BacsBankTransferInstructions": { "type": "object", - "required": ["account_holder_name", "account_number", "sort_code"], + "required": [ + "account_holder_name", + "account_number", + "sort_code" + ], "properties": { "account_holder_name": { "type": "string", @@ -2997,7 +3180,9 @@ "oneOf": [ { "type": "object", - "required": ["ach"], + "required": [ + "ach" + ], "properties": { "ach": { "$ref": "#/components/schemas/AchBankDebitAdditionalData" @@ -3006,7 +3191,9 @@ }, { "type": "object", - "required": ["bacs"], + "required": [ + "bacs" + ], "properties": { "bacs": { "$ref": "#/components/schemas/BacsBankDebitAdditionalData" @@ -3015,7 +3202,9 @@ }, { "type": "object", - "required": ["becs"], + "required": [ + "becs" + ], "properties": { "becs": { "$ref": "#/components/schemas/BecsBankDebitAdditionalData" @@ -3024,7 +3213,9 @@ }, { "type": "object", - "required": ["sepa"], + "required": [ + "sepa" + ], "properties": { "sepa": { "$ref": "#/components/schemas/SepaBankDebitAdditionalData" @@ -3062,7 +3253,9 @@ "oneOf": [ { "type": "object", - "required": ["ach_bank_debit"], + "required": [ + "ach_bank_debit" + ], "properties": { "ach_bank_debit": { "type": "object", @@ -3121,11 +3314,16 @@ }, { "type": "object", - "required": ["sepa_bank_debit"], + "required": [ + "sepa_bank_debit" + ], "properties": { "sepa_bank_debit": { "type": "object", - "required": ["iban", "bank_account_holder_name"], + "required": [ + "iban", + "bank_account_holder_name" + ], "properties": { "billing_details": { "allOf": [ @@ -3151,11 +3349,16 @@ }, { "type": "object", - "required": ["becs_bank_debit"], + "required": [ + "becs_bank_debit" + ], "properties": { "becs_bank_debit": { "type": "object", - "required": ["account_number", "bsb_number"], + "required": [ + "account_number", + "bsb_number" + ], "properties": { "billing_details": { "allOf": [ @@ -3187,7 +3390,9 @@ }, { "type": "object", - "required": ["bacs_bank_debit"], + "required": [ + "bacs_bank_debit" + ], "properties": { "bacs_bank_debit": { "type": "object", @@ -3243,7 +3448,10 @@ }, "BankHolderType": { "type": "string", - "enum": ["personal", "business"] + "enum": [ + "personal", + "business" + ] }, "BankNames": { "type": "string", @@ -3399,7 +3607,10 @@ }, "BankRedirectBilling": { "type": "object", - "required": ["billing_name", "email"], + "required": [ + "billing_name", + "email" + ], "properties": { "billing_name": { "type": "string", @@ -3417,7 +3628,9 @@ "oneOf": [ { "type": "object", - "required": ["bancontact_card"], + "required": [ + "bancontact_card" + ], "properties": { "bancontact_card": { "type": "object", @@ -3462,7 +3675,9 @@ }, { "type": "object", - "required": ["bizum"], + "required": [ + "bizum" + ], "properties": { "bizum": { "type": "object" @@ -3471,7 +3686,9 @@ }, { "type": "object", - "required": ["blik"], + "required": [ + "blik" + ], "properties": { "blik": { "type": "object", @@ -3486,11 +3703,16 @@ }, { "type": "object", - "required": ["eps"], + "required": [ + "eps" + ], "properties": { "eps": { "type": "object", - "required": ["bank_name", "country"], + "required": [ + "bank_name", + "country" + ], "properties": { "billing_details": { "allOf": [ @@ -3512,11 +3734,15 @@ }, { "type": "object", - "required": ["giropay"], + "required": [ + "giropay" + ], "properties": { "giropay": { "type": "object", - "required": ["country"], + "required": [ + "country" + ], "properties": { "billing_details": { "allOf": [ @@ -3545,11 +3771,16 @@ }, { "type": "object", - "required": ["ideal"], + "required": [ + "ideal" + ], "properties": { "ideal": { "type": "object", - "required": ["bank_name", "country"], + "required": [ + "bank_name", + "country" + ], "properties": { "billing_details": { "allOf": [ @@ -3571,7 +3802,9 @@ }, { "type": "object", - "required": ["interac"], + "required": [ + "interac" + ], "properties": { "interac": { "type": "object", @@ -3595,11 +3828,15 @@ }, { "type": "object", - "required": ["online_banking_czech_republic"], + "required": [ + "online_banking_czech_republic" + ], "properties": { "online_banking_czech_republic": { "type": "object", - "required": ["issuer"], + "required": [ + "issuer" + ], "properties": { "issuer": { "$ref": "#/components/schemas/BankNames" @@ -3610,7 +3847,9 @@ }, { "type": "object", - "required": ["online_banking_finland"], + "required": [ + "online_banking_finland" + ], "properties": { "online_banking_finland": { "type": "object", @@ -3625,11 +3864,15 @@ }, { "type": "object", - "required": ["online_banking_poland"], + "required": [ + "online_banking_poland" + ], "properties": { "online_banking_poland": { "type": "object", - "required": ["issuer"], + "required": [ + "issuer" + ], "properties": { "issuer": { "$ref": "#/components/schemas/BankNames" @@ -3640,11 +3883,15 @@ }, { "type": "object", - "required": ["online_banking_slovakia"], + "required": [ + "online_banking_slovakia" + ], "properties": { "online_banking_slovakia": { "type": "object", - "required": ["issuer"], + "required": [ + "issuer" + ], "properties": { "issuer": { "$ref": "#/components/schemas/BankNames" @@ -3655,11 +3902,16 @@ }, { "type": "object", - "required": ["open_banking_uk"], + "required": [ + "open_banking_uk" + ], "properties": { "open_banking_uk": { "type": "object", - "required": ["issuer", "country"], + "required": [ + "issuer", + "country" + ], "properties": { "issuer": { "$ref": "#/components/schemas/BankNames" @@ -3673,7 +3925,9 @@ }, { "type": "object", - "required": ["przelewy24"], + "required": [ + "przelewy24" + ], "properties": { "przelewy24": { "type": "object", @@ -3700,11 +3954,15 @@ }, { "type": "object", - "required": ["sofort"], + "required": [ + "sofort" + ], "properties": { "sofort": { "type": "object", - "required": ["country"], + "required": [ + "country" + ], "properties": { "billing_details": { "allOf": [ @@ -3729,11 +3987,15 @@ }, { "type": "object", - "required": ["trustly"], + "required": [ + "trustly" + ], "properties": { "trustly": { "type": "object", - "required": ["country"], + "required": [ + "country" + ], "properties": { "country": { "$ref": "#/components/schemas/CountryAlpha2" @@ -3744,11 +4006,15 @@ }, { "type": "object", - "required": ["online_banking_fpx"], + "required": [ + "online_banking_fpx" + ], "properties": { "online_banking_fpx": { "type": "object", - "required": ["issuer"], + "required": [ + "issuer" + ], "properties": { "issuer": { "$ref": "#/components/schemas/BankNames" @@ -3759,11 +4025,15 @@ }, { "type": "object", - "required": ["online_banking_thailand"], + "required": [ + "online_banking_thailand" + ], "properties": { "online_banking_thailand": { "type": "object", - "required": ["issuer"], + "required": [ + "issuer" + ], "properties": { "issuer": { "$ref": "#/components/schemas/BankNames" @@ -3774,7 +4044,9 @@ }, { "type": "object", - "required": ["local_bank_redirect"], + "required": [ + "local_bank_redirect" + ], "properties": { "local_bank_redirect": { "type": "object" @@ -3787,7 +4059,9 @@ "oneOf": [ { "type": "object", - "required": ["BancontactCard"], + "required": [ + "BancontactCard" + ], "properties": { "BancontactCard": { "$ref": "#/components/schemas/BancontactBankRedirectAdditionalData" @@ -3796,7 +4070,9 @@ }, { "type": "object", - "required": ["Blik"], + "required": [ + "Blik" + ], "properties": { "Blik": { "$ref": "#/components/schemas/BlikBankRedirectAdditionalData" @@ -3805,7 +4081,9 @@ }, { "type": "object", - "required": ["Giropay"], + "required": [ + "Giropay" + ], "properties": { "Giropay": { "$ref": "#/components/schemas/GiropayBankRedirectAdditionalData" @@ -3843,7 +4121,9 @@ "oneOf": [ { "type": "object", - "required": ["ach"], + "required": [ + "ach" + ], "properties": { "ach": { "type": "object" @@ -3852,7 +4132,9 @@ }, { "type": "object", - "required": ["sepa"], + "required": [ + "sepa" + ], "properties": { "sepa": { "type": "object" @@ -3861,7 +4143,9 @@ }, { "type": "object", - "required": ["bacs"], + "required": [ + "bacs" + ], "properties": { "bacs": { "type": "object" @@ -3870,7 +4154,9 @@ }, { "type": "object", - "required": ["multibanco"], + "required": [ + "multibanco" + ], "properties": { "multibanco": { "type": "object" @@ -3879,7 +4165,9 @@ }, { "type": "object", - "required": ["permata"], + "required": [ + "permata" + ], "properties": { "permata": { "type": "object" @@ -3888,7 +4176,9 @@ }, { "type": "object", - "required": ["bca"], + "required": [ + "bca" + ], "properties": { "bca": { "type": "object" @@ -3897,7 +4187,9 @@ }, { "type": "object", - "required": ["bni_va"], + "required": [ + "bni_va" + ], "properties": { "bni_va": { "type": "object" @@ -3906,7 +4198,9 @@ }, { "type": "object", - "required": ["bri_va"], + "required": [ + "bri_va" + ], "properties": { "bri_va": { "type": "object" @@ -3915,7 +4209,9 @@ }, { "type": "object", - "required": ["cimb_va"], + "required": [ + "cimb_va" + ], "properties": { "cimb_va": { "type": "object" @@ -3924,7 +4220,9 @@ }, { "type": "object", - "required": ["danamon_va"], + "required": [ + "danamon_va" + ], "properties": { "danamon_va": { "type": "object" @@ -3933,7 +4231,9 @@ }, { "type": "object", - "required": ["mandiri_va"], + "required": [ + "mandiri_va" + ], "properties": { "mandiri_va": { "type": "object" @@ -3942,7 +4242,9 @@ }, { "type": "object", - "required": ["pix"], + "required": [ + "pix" + ], "properties": { "pix": { "$ref": "#/components/schemas/PixBankTransferAdditionalData" @@ -3951,7 +4253,9 @@ }, { "type": "object", - "required": ["pse"], + "required": [ + "pse" + ], "properties": { "pse": { "type": "object" @@ -3960,7 +4264,9 @@ }, { "type": "object", - "required": ["local_bank_transfer"], + "required": [ + "local_bank_transfer" + ], "properties": { "local_bank_transfer": { "$ref": "#/components/schemas/LocalBankTransferAdditionalData" @@ -3973,7 +4279,9 @@ "oneOf": [ { "type": "object", - "required": ["ach_bank_transfer"], + "required": [ + "ach_bank_transfer" + ], "properties": { "ach_bank_transfer": { "type": "object", @@ -3992,11 +4300,15 @@ }, { "type": "object", - "required": ["sepa_bank_transfer"], + "required": [ + "sepa_bank_transfer" + ], "properties": { "sepa_bank_transfer": { "type": "object", - "required": ["country"], + "required": [ + "country" + ], "properties": { "billing_details": { "allOf": [ @@ -4015,7 +4327,9 @@ }, { "type": "object", - "required": ["bacs_bank_transfer"], + "required": [ + "bacs_bank_transfer" + ], "properties": { "bacs_bank_transfer": { "type": "object", @@ -4034,7 +4348,9 @@ }, { "type": "object", - "required": ["multibanco_bank_transfer"], + "required": [ + "multibanco_bank_transfer" + ], "properties": { "multibanco_bank_transfer": { "type": "object", @@ -4053,7 +4369,9 @@ }, { "type": "object", - "required": ["permata_bank_transfer"], + "required": [ + "permata_bank_transfer" + ], "properties": { "permata_bank_transfer": { "type": "object", @@ -4072,8 +4390,10 @@ }, { "type": "object", - "required": ["bca_bank_transfer"], - "properties": { + "required": [ + "bca_bank_transfer" + ], + "properties": { "bca_bank_transfer": { "type": "object", "properties": { @@ -4091,7 +4411,9 @@ }, { "type": "object", - "required": ["bni_va_bank_transfer"], + "required": [ + "bni_va_bank_transfer" + ], "properties": { "bni_va_bank_transfer": { "type": "object", @@ -4110,7 +4432,9 @@ }, { "type": "object", - "required": ["bri_va_bank_transfer"], + "required": [ + "bri_va_bank_transfer" + ], "properties": { "bri_va_bank_transfer": { "type": "object", @@ -4129,7 +4453,9 @@ }, { "type": "object", - "required": ["cimb_va_bank_transfer"], + "required": [ + "cimb_va_bank_transfer" + ], "properties": { "cimb_va_bank_transfer": { "type": "object", @@ -4148,7 +4474,9 @@ }, { "type": "object", - "required": ["danamon_va_bank_transfer"], + "required": [ + "danamon_va_bank_transfer" + ], "properties": { "danamon_va_bank_transfer": { "type": "object", @@ -4167,7 +4495,9 @@ }, { "type": "object", - "required": ["mandiri_va_bank_transfer"], + "required": [ + "mandiri_va_bank_transfer" + ], "properties": { "mandiri_va_bank_transfer": { "type": "object", @@ -4186,7 +4516,9 @@ }, { "type": "object", - "required": ["pix"], + "required": [ + "pix" + ], "properties": { "pix": { "type": "object", @@ -4215,7 +4547,9 @@ }, { "type": "object", - "required": ["pse"], + "required": [ + "pse" + ], "properties": { "pse": { "type": "object" @@ -4224,7 +4558,9 @@ }, { "type": "object", - "required": ["local_bank_transfer"], + "required": [ + "local_bank_transfer" + ], "properties": { "local_bank_transfer": { "type": "object", @@ -4243,7 +4579,9 @@ "oneOf": [ { "type": "object", - "required": ["doku_bank_transfer_instructions"], + "required": [ + "doku_bank_transfer_instructions" + ], "properties": { "doku_bank_transfer_instructions": { "$ref": "#/components/schemas/DokuBankTransferInstructions" @@ -4252,7 +4590,9 @@ }, { "type": "object", - "required": ["ach_credit_transfer"], + "required": [ + "ach_credit_transfer" + ], "properties": { "ach_credit_transfer": { "$ref": "#/components/schemas/AchTransfer" @@ -4261,7 +4601,9 @@ }, { "type": "object", - "required": ["sepa_bank_instructions"], + "required": [ + "sepa_bank_instructions" + ], "properties": { "sepa_bank_instructions": { "$ref": "#/components/schemas/SepaBankTransferInstructions" @@ -4270,7 +4612,9 @@ }, { "type": "object", - "required": ["bacs_bank_instructions"], + "required": [ + "bacs_bank_instructions" + ], "properties": { "bacs_bank_instructions": { "$ref": "#/components/schemas/BacsBankTransferInstructions" @@ -4279,7 +4623,9 @@ }, { "type": "object", - "required": ["multibanco"], + "required": [ + "multibanco" + ], "properties": { "multibanco": { "$ref": "#/components/schemas/MultibancoTransferInstructions" @@ -4325,11 +4671,17 @@ }, "BankType": { "type": "string", - "enum": ["checking", "savings"] + "enum": [ + "checking", + "savings" + ] }, "BecsBankDebitAdditionalData": { "type": "object", - "required": ["account_number", "bsb_number"], + "required": [ + "account_number", + "bsb_number" + ], "properties": { "account_number": { "type": "string", @@ -4361,17 +4713,26 @@ }, "BlocklistDataKind": { "type": "string", - "enum": ["payment_method", "card_bin", "extended_card_bin"] + "enum": [ + "payment_method", + "card_bin", + "extended_card_bin" + ] }, "BlocklistRequest": { "oneOf": [ { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["card_bin"] + "enum": [ + "card_bin" + ] }, "data": { "type": "string" @@ -4380,11 +4741,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["fingerprint"] + "enum": [ + "fingerprint" + ] }, "data": { "type": "string" @@ -4393,11 +4759,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["extended_card_bin"] + "enum": [ + "extended_card_bin" + ] }, "data": { "type": "string" @@ -4411,7 +4782,11 @@ }, "BlocklistResponse": { "type": "object", - "required": ["fingerprint_id", "data_kind", "created_at"], + "required": [ + "fingerprint_id", + "data_kind", + "created_at" + ], "properties": { "fingerprint_id": { "type": "string" @@ -4506,7 +4881,9 @@ }, { "type": "object", - "required": ["enabled_payment_methods"], + "required": [ + "enabled_payment_methods" + ], "properties": { "enabled_payment_methods": { "type": "array", @@ -4527,7 +4904,9 @@ }, { "type": "object", - "required": ["allowed_domains"], + "required": [ + "allowed_domains" + ], "properties": { "domain_name": { "type": "string", @@ -4609,7 +4988,12 @@ "CaptureMethod": { "type": "string", "description": "Default value if not passed is set to 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors", - "enum": ["automatic", "manual", "manual_multiple", "scheduled"] + "enum": [ + "automatic", + "manual", + "manual_multiple", + "scheduled" + ] }, "CaptureResponse": { "type": "object", @@ -4685,7 +5069,12 @@ }, "CaptureStatus": { "type": "string", - "enum": ["started", "charged", "pending", "failed"] + "enum": [ + "started", + "charged", + "pending", + "failed" + ] }, "Card": { "type": "object", @@ -4762,7 +5151,11 @@ "CardAdditionalData": { "type": "object", "description": "Masked payout method details for card payout method", - "required": ["card_exp_month", "card_exp_year", "card_holder_name"], + "required": [ + "card_exp_month", + "card_exp_year", + "card_holder_name" + ], "properties": { "card_issuer": { "type": "string", @@ -4887,7 +5280,9 @@ }, "CardDetailFromLocker": { "type": "object", - "required": ["saved_to_locker"], + "required": [ + "saved_to_locker" + ], "properties": { "scheme": { "type": "string", @@ -4952,7 +5347,11 @@ }, "CardDetailUpdate": { "type": "object", - "required": ["card_exp_month", "card_exp_year", "card_holder_name"], + "required": [ + "card_exp_month", + "card_exp_year", + "card_holder_name" + ], "properties": { "card_exp_month": { "type": "string", @@ -5028,7 +5427,9 @@ "oneOf": [ { "type": "object", - "required": ["knet"], + "required": [ + "knet" + ], "properties": { "knet": { "type": "object" @@ -5037,7 +5438,9 @@ }, { "type": "object", - "required": ["benefit"], + "required": [ + "benefit" + ], "properties": { "benefit": { "type": "object" @@ -5046,7 +5449,9 @@ }, { "type": "object", - "required": ["momo_atm"], + "required": [ + "momo_atm" + ], "properties": { "momo_atm": { "type": "object" @@ -5055,7 +5460,9 @@ }, { "type": "object", - "required": ["card_redirect"], + "required": [ + "card_redirect" + ], "properties": { "card_redirect": { "type": "object" @@ -5136,7 +5543,9 @@ }, "CardToken": { "type": "object", - "required": ["card_holder_name"], + "required": [ + "card_holder_name" + ], "properties": { "card_holder_name": { "type": "string", @@ -5152,7 +5561,9 @@ }, "CardTokenAdditionalData": { "type": "object", - "required": ["card_holder_name"], + "required": [ + "card_holder_name" + ], "properties": { "card_holder_name": { "type": "string", @@ -5182,7 +5593,9 @@ "ChargeRefunds": { "type": "object", "description": "Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.", - "required": ["charge_id"], + "required": [ + "charge_id" + ], "properties": { "charge_id": { "type": "string", @@ -5203,7 +5616,12 @@ "Comparison": { "type": "object", "description": "Represents a single comparison condition.", - "required": ["lhs", "comparison", "value", "metadata"], + "required": [ + "lhs", + "comparison", + "value", + "metadata" + ], "properties": { "lhs": { "type": "string", @@ -5436,11 +5854,16 @@ "oneOf": [ { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["priority"] + "enum": [ + "priority" + ] }, "data": { "type": "array", @@ -5452,11 +5875,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["volume_split"] + "enum": [ + "volume_split" + ] }, "data": { "type": "array", @@ -5473,7 +5901,10 @@ }, "ConnectorStatus": { "type": "string", - "enum": ["inactive", "active"] + "enum": [ + "inactive", + "active" + ] }, "ConnectorType": { "type": "string", @@ -5494,7 +5925,10 @@ }, "ConnectorVolumeSplit": { "type": "object", - "required": ["connector", "split"], + "required": [ + "connector", + "split" + ], "properties": { "connector": { "$ref": "#/components/schemas/RoutableConnectorChoice" @@ -5789,7 +6223,10 @@ "CreateApiKeyRequest": { "type": "object", "description": "The request body for creating an API Key.", - "required": ["name", "expiration"], + "required": [ + "name", + "expiration" + ], "properties": { "name": { "type": "string", @@ -6057,7 +6494,9 @@ "CustomerAcceptance": { "type": "object", "description": "This \"CustomerAcceptance\" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.", - "required": ["acceptance_type"], + "required": [ + "acceptance_type" + ], "properties": { "acceptance_type": { "$ref": "#/components/schemas/AcceptanceType" @@ -6082,7 +6521,10 @@ }, "CustomerDefaultPaymentMethodResponse": { "type": "object", - "required": ["customer_id", "payment_method"], + "required": [ + "customer_id", + "payment_method" + ], "properties": { "default_payment_method_id": { "type": "string", @@ -6150,7 +6592,9 @@ "CustomerDetails": { "type": "object", "description": "Passing this object creates a new customer or attaches an existing customer to the payment", - "required": ["id"], + "required": [ + "id" + ], "properties": { "id": { "type": "string", @@ -6302,7 +6746,9 @@ "$ref": "#/components/schemas/PaymentExperience" }, "description": "Type of payment experience enabled with the connector", - "example": ["redirect_to_url"], + "example": [ + "redirect_to_url" + ], "nullable": true }, "card": { @@ -6378,7 +6824,9 @@ }, "CustomerPaymentMethodsListResponse": { "type": "object", - "required": ["customer_payment_methods"], + "required": [ + "customer_payment_methods" + ], "properties": { "customer_payment_methods": { "type": "array", @@ -6397,7 +6845,10 @@ "CustomerRequest": { "type": "object", "description": "The customer details", - "required": ["name", "email"], + "required": [ + "name", + "email" + ], "properties": { "merchant_reference_id": { "type": "string", @@ -6465,7 +6916,11 @@ }, "CustomerResponse": { "type": "object", - "required": ["merchant_reference_id", "created_at", "id"], + "required": [ + "merchant_reference_id", + "created_at", + "id" + ], "properties": { "merchant_reference_id": { "type": "string", @@ -6551,11 +7006,17 @@ }, "DecoupledAuthenticationType": { "type": "string", - "enum": ["challenge", "frictionless"] + "enum": [ + "challenge", + "frictionless" + ] }, "DefaultPaymentMethod": { "type": "object", - "required": ["customer_id", "payment_method_id"], + "required": [ + "customer_id", + "payment_method_id" + ], "properties": { "customer_id": { "type": "string", @@ -6571,11 +7032,18 @@ "DeviceChannel": { "type": "string", "description": "Device Channel indicating whether request is coming from App or Browser", - "enum": ["APP", "BRW"] + "enum": [ + "APP", + "BRW" + ] }, "DisplayAmountOnSdk": { "type": "object", - "required": ["net_amount", "order_tax_amount", "shipping_cost"], + "required": [ + "net_amount", + "order_tax_amount", + "shipping_cost" + ], "properties": { "net_amount": { "type": "string", @@ -6757,7 +7225,11 @@ "DisputeStage": { "type": "string", "description": "Stage of the dispute", - "enum": ["pre_dispute", "dispute", "pre_arbitration"] + "enum": [ + "pre_dispute", + "dispute", + "pre_arbitration" + ] }, "DisputeStatus": { "type": "string", @@ -6774,7 +7246,11 @@ }, "DokuBankTransferInstructions": { "type": "object", - "required": ["expires_at", "reference", "instructions_url"], + "required": [ + "expires_at", + "reference", + "instructions_url" + ], "properties": { "expires_at": { "type": "string", @@ -6815,12 +7291,18 @@ "EnablePaymentLinkRequest": { "type": "string", "description": "Whether payment link is requested to be enabled or not for this transaction", - "enum": ["Enable", "Skip"] + "enum": [ + "Enable", + "Skip" + ] }, "EnabledPaymentMethod": { "type": "object", "description": "Object for EnabledPaymentMethod", - "required": ["payment_method", "payment_method_types"], + "required": [ + "payment_method", + "payment_method_types" + ], "properties": { "payment_method": { "$ref": "#/components/schemas/PaymentMethod" @@ -6838,7 +7320,12 @@ "EphemeralKeyCreateResponse": { "type": "object", "description": "ephemeral_key for the customer_id mentioned", - "required": ["customer_id", "created_at", "expires", "secret"], + "required": [ + "customer_id", + "created_at", + "expires", + "secret" + ], "properties": { "customer_id": { "type": "string", @@ -6866,7 +7353,10 @@ "ErrorDetails": { "type": "object", "description": "Error details for the payment", - "required": ["code", "message"], + "required": [ + "code", + "message" + ], "properties": { "code": { "type": "string", @@ -6890,7 +7380,13 @@ }, "EventClass": { "type": "string", - "enum": ["payments", "refunds", "disputes", "mandates", "payouts"] + "enum": [ + "payments", + "refunds", + "disputes", + "mandates", + "payouts" + ] }, "EventListItemResponse": { "type": "object", @@ -6962,7 +7458,10 @@ }, { "type": "object", - "required": ["request", "response"], + "required": [ + "request", + "response" + ], "properties": { "request": { "$ref": "#/components/schemas/OutgoingWebhookRequestContent" @@ -7081,7 +7580,9 @@ }, "ExtendedCardInfoConfig": { "type": "object", - "required": ["public_key"], + "required": [ + "public_key" + ], "properties": { "public_key": { "type": "string", @@ -7099,7 +7600,9 @@ }, "ExtendedCardInfoResponse": { "type": "object", - "required": ["payload"], + "required": [ + "payload" + ], "properties": { "payload": { "type": "string" @@ -7109,12 +7612,17 @@ "External3dsAuthenticationRequest": { "type": "string", "description": "Whether 3ds authentication is requested or not", - "enum": ["Enable", "Skip"] + "enum": [ + "Enable", + "Skip" + ] }, "ExternalAuthenticationDetailsResponse": { "type": "object", "description": "Details of external authentication", - "required": ["status"], + "required": [ + "status" + ], "properties": { "authentication_flow": { "allOf": [ @@ -7180,43 +7688,63 @@ "oneOf": [ { "type": "string", - "enum": ["user_card_number"] + "enum": [ + "user_card_number" + ] }, { "type": "string", - "enum": ["user_card_expiry_month"] + "enum": [ + "user_card_expiry_month" + ] }, { "type": "string", - "enum": ["user_card_expiry_year"] + "enum": [ + "user_card_expiry_year" + ] }, { "type": "string", - "enum": ["user_card_cvc"] + "enum": [ + "user_card_cvc" + ] }, { "type": "string", - "enum": ["user_full_name"] + "enum": [ + "user_full_name" + ] }, { "type": "string", - "enum": ["user_email_address"] + "enum": [ + "user_email_address" + ] }, { "type": "string", - "enum": ["user_phone_number"] + "enum": [ + "user_phone_number" + ] }, { "type": "string", - "enum": ["user_phone_number_country_code"] + "enum": [ + "user_phone_number_country_code" + ] }, { "type": "object", - "required": ["user_country"], + "required": [ + "user_country" + ], "properties": { "user_country": { "type": "object", - "required": ["options"], + "required": [ + "options" + ], "properties": { "options": { "type": "array", @@ -7230,11 +7758,15 @@ }, { "type": "object", - "required": ["user_currency"], + "required": [ + "user_currency" + ], "properties": { "user_currency": { "type": "object", - "required": ["options"], + "required": [ + "options" + ], "properties": { "options": { "type": "array", @@ -7248,39 +7780,57 @@ }, { "type": "string", - "enum": ["user_crypto_currency_network"] + "enum": [ + "user_crypto_currency_network" + ] }, { "type": "string", - "enum": ["user_billing_name"] + "enum": [ + "user_billing_name" + ] }, { "type": "string", - "enum": ["user_address_line1"] + "enum": [ + "user_address_line1" + ] }, { "type": "string", - "enum": ["user_address_line2"] + "enum": [ + "user_address_line2" + ] }, { "type": "string", - "enum": ["user_address_city"] + "enum": [ + "user_address_city" + ] }, { "type": "string", - "enum": ["user_address_pincode"] + "enum": [ + "user_address_pincode" + ] }, { "type": "string", - "enum": ["user_address_state"] + "enum": [ + "user_address_state" + ] }, { "type": "object", - "required": ["user_address_country"], + "required": [ + "user_address_country" + ], "properties": { "user_address_country": { "type": "object", - "required": ["options"], + "required": [ + "options" + ], "properties": { "options": { "type": "array", @@ -7294,35 +7844,51 @@ }, { "type": "string", - "enum": ["user_shipping_name"] + "enum": [ + "user_shipping_name" + ] }, { "type": "string", - "enum": ["user_shipping_address_line1"] + "enum": [ + "user_shipping_address_line1" + ] }, { "type": "string", - "enum": ["user_shipping_address_line2"] + "enum": [ + "user_shipping_address_line2" + ] }, { "type": "string", - "enum": ["user_shipping_address_city"] + "enum": [ + "user_shipping_address_city" + ] }, { "type": "string", - "enum": ["user_shipping_address_pincode"] + "enum": [ + "user_shipping_address_pincode" + ] }, { "type": "string", - "enum": ["user_shipping_address_state"] + "enum": [ + "user_shipping_address_state" + ] }, { "type": "object", - "required": ["user_shipping_address_country"], + "required": [ + "user_shipping_address_country" + ], "properties": { "user_shipping_address_country": { "type": "object", - "required": ["options"], + "required": [ + "options" + ], "properties": { "options": { "type": "array", @@ -7336,27 +7902,39 @@ }, { "type": "string", - "enum": ["user_blik_code"] + "enum": [ + "user_blik_code" + ] }, { "type": "string", - "enum": ["user_bank"] + "enum": [ + "user_bank" + ] }, { "type": "string", - "enum": ["user_bank_account_number"] + "enum": [ + "user_bank_account_number" + ] }, { "type": "string", - "enum": ["text"] + "enum": [ + "text" + ] }, { "type": "object", - "required": ["drop_down"], + "required": [ + "drop_down" + ], "properties": { "drop_down": { "type": "object", - "required": ["options"], + "required": [ + "options" + ], "properties": { "options": { "type": "array", @@ -7370,19 +7948,27 @@ }, { "type": "string", - "enum": ["user_date_of_birth"] + "enum": [ + "user_date_of_birth" + ] }, { "type": "string", - "enum": ["user_vpa_id"] + "enum": [ + "user_vpa_id" + ] }, { "type": "object", - "required": ["language_preference"], + "required": [ + "language_preference" + ], "properties": { "language_preference": { "type": "object", - "required": ["options"], + "required": [ + "options" + ], "properties": { "options": { "type": "array", @@ -7396,39 +7982,58 @@ }, { "type": "string", - "enum": ["user_pix_key"] + "enum": [ + "user_pix_key" + ] }, { "type": "string", - "enum": ["user_cpf"] + "enum": [ + "user_cpf" + ] }, { "type": "string", - "enum": ["user_cnpj"] + "enum": [ + "user_cnpj" + ] }, { "type": "string", - "enum": ["user_iban"] + "enum": [ + "user_iban" + ] }, { "type": "string", - "enum": ["browser_language"] + "enum": [ + "browser_language" + ] }, { "type": "string", - "enum": ["browser_ip"] + "enum": [ + "browser_ip" + ] } ], "description": "Possible field type of required fields in payment_method_data" }, "FrmAction": { "type": "string", - "enum": ["cancel_txn", "auto_refund", "manual_review"] + "enum": [ + "cancel_txn", + "auto_refund", + "manual_review" + ] }, "FrmConfigs": { "type": "object", "description": "Details of FrmConfigs are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table", - "required": ["gateway", "payment_methods"], + "required": [ + "gateway", + "payment_methods" + ], "properties": { "gateway": { "$ref": "#/components/schemas/ConnectorType" @@ -7446,7 +8051,9 @@ "FrmMessage": { "type": "object", "description": "frm message is an object sent inside the payments response...when frm is invoked, its value is Some(...), else its None", - "required": ["frm_name"], + "required": [ + "frm_name" + ], "properties": { "frm_name": { "type": "string" @@ -7480,7 +8087,9 @@ "FrmPaymentMethod": { "type": "object", "description": "Details of FrmPaymentMethod are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table", - "required": ["payment_method"], + "required": [ + "payment_method" + ], "properties": { "payment_method": { "$ref": "#/components/schemas/PaymentMethod" @@ -7507,7 +8116,12 @@ "FrmPaymentMethodType": { "type": "object", "description": "Details of FrmPaymentMethodType are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table", - "required": ["payment_method_type", "card_networks", "flow", "action"], + "required": [ + "payment_method_type", + "card_networks", + "flow", + "action" + ], "properties": { "payment_method_type": { "$ref": "#/components/schemas/PaymentMethodType" @@ -7526,12 +8140,18 @@ }, "FrmPreferredFlowTypes": { "type": "string", - "enum": ["pre", "post"] + "enum": [ + "pre", + "post" + ] }, "FutureUsage": { "type": "string", "description": "Indicates that you intend to make future payments with the payment methods used for this Payment. Providing this parameter will attach the payment method to the Customer, if present, after the Payment is confirmed and any required actions from the user are complete.\n- On_session - Payment method saved only at hyperswitch when consent is provided by the user. CVV will asked during the returning user payment\n- Off_session - Payment method saved at both hyperswitch and Processor when consent is provided by the user. No input is required during the returning user payment.", - "enum": ["off_session", "on_session"] + "enum": [ + "off_session", + "on_session" + ] }, "GcashRedirection": { "type": "object" @@ -7567,7 +8187,9 @@ "oneOf": [ { "type": "object", - "required": ["givex"], + "required": [ + "givex" + ], "properties": { "givex": { "$ref": "#/components/schemas/GivexGiftCardAdditionalData" @@ -7576,7 +8198,9 @@ }, { "type": "object", - "required": ["pay_safe_card"], + "required": [ + "pay_safe_card" + ], "properties": { "pay_safe_card": { "type": "object" @@ -7589,7 +8213,9 @@ "oneOf": [ { "type": "object", - "required": ["givex"], + "required": [ + "givex" + ], "properties": { "givex": { "$ref": "#/components/schemas/GiftCardDetails" @@ -7598,7 +8224,9 @@ }, { "type": "object", - "required": ["pay_safe_card"], + "required": [ + "pay_safe_card" + ], "properties": { "pay_safe_card": { "type": "object" @@ -7609,7 +8237,10 @@ }, "GiftCardDetails": { "type": "object", - "required": ["number", "cvc"], + "required": [ + "number", + "cvc" + ], "properties": { "number": { "type": "string", @@ -7661,7 +8292,9 @@ }, "GivexGiftCardAdditionalData": { "type": "object", - "required": ["last4"], + "required": [ + "last4" + ], "properties": { "last4": { "type": "string", @@ -7675,7 +8308,10 @@ }, "GooglePayAssuranceDetails": { "type": "object", - "required": ["card_holder_authenticated", "account_verified"], + "required": [ + "card_holder_authenticated", + "account_verified" + ], "properties": { "card_holder_authenticated": { "type": "boolean", @@ -7689,7 +8325,10 @@ }, "GooglePayPaymentMethodInfo": { "type": "object", - "required": ["card_network", "card_details"], + "required": [ + "card_network", + "card_details" + ], "properties": { "card_network": { "type": "string", @@ -7773,7 +8412,11 @@ }, "GooglePayThirdPartySdk": { "type": "object", - "required": ["delayed_session_token", "connector", "sdk_next_action"], + "required": [ + "delayed_session_token", + "connector", + "sdk_next_action" + ], "properties": { "delayed_session_token": { "type": "boolean", @@ -7793,7 +8436,12 @@ }, "GooglePayWalletData": { "type": "object", - "required": ["type", "description", "info", "tokenization_data"], + "required": [ + "type", + "description", + "info", + "tokenization_data" + ], "properties": { "type": { "type": "string", @@ -7813,7 +8461,10 @@ }, "GpayAllowedMethodsParameters": { "type": "object", - "required": ["allowed_auth_methods", "allowed_card_networks"], + "required": [ + "allowed_auth_methods", + "allowed_card_networks" + ], "properties": { "allowed_auth_methods": { "type": "array", @@ -7851,7 +8502,11 @@ }, "GpayAllowedPaymentMethods": { "type": "object", - "required": ["type", "parameters", "tokenization_specification"], + "required": [ + "type", + "parameters", + "tokenization_specification" + ], "properties": { "type": { "type": "string", @@ -7867,11 +8522,17 @@ }, "GpayBillingAddressFormat": { "type": "string", - "enum": ["FULL", "MIN"] + "enum": [ + "FULL", + "MIN" + ] }, "GpayBillingAddressParameters": { "type": "object", - "required": ["phone_number_required", "format"], + "required": [ + "phone_number_required", + "format" + ], "properties": { "phone_number_required": { "type": "boolean", @@ -7884,7 +8545,9 @@ }, "GpayMerchantInfo": { "type": "object", - "required": ["merchant_name"], + "required": [ + "merchant_name" + ], "properties": { "merchant_id": { "type": "string", @@ -7909,7 +8572,9 @@ }, "GpayShippingAddressParameters": { "type": "object", - "required": ["phone_number_required"], + "required": [ + "phone_number_required" + ], "properties": { "phone_number_required": { "type": "boolean", @@ -7919,7 +8584,9 @@ }, "GpayTokenParameters": { "type": "object", - "required": ["gateway"], + "required": [ + "gateway" + ], "properties": { "gateway": { "type": "string", @@ -7942,7 +8609,10 @@ }, "GpayTokenizationData": { "type": "object", - "required": ["type", "token"], + "required": [ + "type", + "token" + ], "properties": { "type": { "type": "string", @@ -7956,7 +8626,10 @@ }, "GpayTokenizationSpecification": { "type": "object", - "required": ["type", "parameters"], + "required": [ + "type", + "parameters" + ], "properties": { "type": { "type": "string", @@ -8055,11 +8728,21 @@ }, "GsmDecision": { "type": "string", - "enum": ["retry", "requeue", "do_default"] + "enum": [ + "retry", + "requeue", + "do_default" + ] }, "GsmDeleteRequest": { "type": "object", - "required": ["connector", "flow", "sub_flow", "code", "message"], + "required": [ + "connector", + "flow", + "sub_flow", + "code", + "message" + ], "properties": { "connector": { "type": "string", @@ -8178,7 +8861,13 @@ }, "GsmRetrieveRequest": { "type": "object", - "required": ["connector", "flow", "sub_flow", "code", "message"], + "required": [ + "connector", + "flow", + "sub_flow", + "code", + "message" + ], "properties": { "connector": { "$ref": "#/components/schemas/Connector" @@ -8203,7 +8892,13 @@ }, "GsmUpdateRequest": { "type": "object", - "required": ["connector", "flow", "sub_flow", "code", "message"], + "required": [ + "connector", + "flow", + "sub_flow", + "code", + "message" + ], "properties": { "connector": { "type": "string", @@ -8263,7 +8958,9 @@ "IfStatement": { "type": "object", "description": "Represents an IF statement with conditions and optional nested IF statements\n\n```text\npayment.method = card {\npayment.method.cardtype = (credit, debit) {\npayment.method.network = (amex, rupay, diners)\n}\n}\n```", - "required": ["condition"], + "required": [ + "condition" + ], "properties": { "condition": { "type": "array", @@ -8400,7 +9097,10 @@ }, "KlarnaSessionTokenResponse": { "type": "object", - "required": ["session_token", "session_id"], + "required": [ + "session_token", + "session_id" + ], "properties": { "session_token": { "type": "string", @@ -8427,7 +9127,9 @@ }, "ListBlocklistQuery": { "type": "object", - "required": ["data_kind"], + "required": [ + "data_kind" + ], "properties": { "data_kind": { "$ref": "#/components/schemas/BlocklistDataKind" @@ -8457,7 +9159,10 @@ }, "MandateAmountData": { "type": "object", - "required": ["amount", "currency"], + "required": [ + "amount", + "currency" + ], "properties": { "amount": { "type": "integer", @@ -8639,7 +9344,10 @@ }, "MandateRevokedResponse": { "type": "object", - "required": ["mandate_id", "status"], + "required": [ + "mandate_id", + "status" + ], "properties": { "mandate_id": { "type": "string", @@ -8665,13 +9373,20 @@ "MandateStatus": { "type": "string", "description": "The status of the mandate, which indicates whether it can be used to initiate a payment.", - "enum": ["active", "inactive", "pending", "revoked"] + "enum": [ + "active", + "inactive", + "pending", + "revoked" + ] }, "MandateType": { "oneOf": [ { "type": "object", - "required": ["single_use"], + "required": [ + "single_use" + ], "properties": { "single_use": { "$ref": "#/components/schemas/MandateAmountData" @@ -8680,7 +9395,9 @@ }, { "type": "object", - "required": ["multi_use"], + "required": [ + "multi_use" + ], "properties": { "multi_use": { "allOf": [ @@ -8696,7 +9413,9 @@ }, "MaskedBankDetails": { "type": "object", - "required": ["mask"], + "required": [ + "mask" + ], "properties": { "mask": { "type": "string" @@ -8705,7 +9424,9 @@ }, "MbWayRedirection": { "type": "object", - "required": ["telephone_number"], + "required": [ + "telephone_number" + ], "properties": { "telephone_number": { "type": "string", @@ -8715,7 +9436,9 @@ }, "MerchantAccountCreate": { "type": "object", - "required": ["merchant_name"], + "required": [ + "merchant_name" + ], "properties": { "merchant_name": { "type": "string", @@ -8743,11 +9466,16 @@ "oneOf": [ { "type": "object", - "required": ["iban"], + "required": [ + "iban" + ], "properties": { "iban": { "type": "object", - "required": ["iban", "name"], + "required": [ + "iban", + "name" + ], "properties": { "iban": { "type": "string" @@ -8765,11 +9493,17 @@ }, { "type": "object", - "required": ["bacs"], + "required": [ + "bacs" + ], "properties": { "bacs": { "type": "object", - "required": ["account_number", "sort_code", "name"], + "required": [ + "account_number", + "sort_code", + "name" + ], "properties": { "account_number": { "type": "string" @@ -8792,7 +9526,10 @@ }, "MerchantAccountDeleteResponse": { "type": "object", - "required": ["merchant_id", "deleted"], + "required": [ + "merchant_id", + "deleted" + ], "properties": { "merchant_id": { "type": "string", @@ -8886,7 +9623,11 @@ "MerchantConnectorCreate": { "type": "object", "description": "Create a new Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.\"", - "required": ["connector_type", "connector_name", "profile_id"], + "required": [ + "connector_type", + "connector_name", + "profile_id" + ], "properties": { "connector_type": { "$ref": "#/components/schemas/ConnectorType" @@ -8922,20 +9663,36 @@ "example": [ { "accepted_countries": { - "list": ["FR", "DE", "IN"], + "list": [ + "FR", + "DE", + "IN" + ], "type": "disable_only" }, "accepted_currencies": { - "list": ["USD", "EUR"], + "list": [ + "USD", + "EUR" + ], "type": "enable_only" }, "installment_payment_enabled": true, "maximum_amount": 68607706, "minimum_amount": 1, "payment_method": "wallet", - "payment_method_issuers": ["labore magna ipsum", "aute"], - "payment_method_types": ["upi_collect", "upi_intent"], - "payment_schemes": ["Discover", "Discover"], + "payment_method_issuers": [ + "labore magna ipsum", + "aute" + ], + "payment_method_types": [ + "upi_collect", + "upi_intent" + ], + "payment_schemes": [ + "Discover", + "Discover" + ], "recurring_enabled": true } ], @@ -9004,7 +9761,11 @@ }, "MerchantConnectorDeleteResponse": { "type": "object", - "required": ["merchant_id", "id", "deleted"], + "required": [ + "merchant_id", + "id", + "deleted" + ], "properties": { "merchant_id": { "type": "string", @@ -9042,7 +9803,9 @@ "MerchantConnectorDetailsWrap": { "type": "object", "description": "Merchant connector details used to make payments.", - "required": ["creds_identifier"], + "required": [ + "creds_identifier" + ], "properties": { "creds_identifier": { "type": "string", @@ -9060,7 +9823,9 @@ }, "MerchantConnectorId": { "type": "object", - "required": ["id"], + "required": [ + "id" + ], "properties": { "id": { "type": "string" @@ -9108,20 +9873,36 @@ "example": [ { "accepted_countries": { - "list": ["FR", "DE", "IN"], + "list": [ + "FR", + "DE", + "IN" + ], "type": "disable_only" }, "accepted_currencies": { - "list": ["USD", "EUR"], + "list": [ + "USD", + "EUR" + ], "type": "enable_only" }, "installment_payment_enabled": true, "maximum_amount": 68607706, "minimum_amount": 1, "payment_method": "wallet", - "payment_method_issuers": ["labore magna ipsum", "aute"], - "payment_method_types": ["upi_collect", "upi_intent"], - "payment_schemes": ["Discover", "Discover"], + "payment_method_issuers": [ + "labore magna ipsum", + "aute" + ], + "payment_method_types": [ + "upi_collect", + "upi_intent" + ], + "payment_schemes": [ + "Discover", + "Discover" + ], "recurring_enabled": true } ], @@ -9232,20 +10013,36 @@ "example": [ { "accepted_countries": { - "list": ["FR", "DE", "IN"], + "list": [ + "FR", + "DE", + "IN" + ], "type": "disable_only" }, "accepted_currencies": { - "list": ["USD", "EUR"], + "list": [ + "USD", + "EUR" + ], "type": "enable_only" }, "installment_payment_enabled": true, "maximum_amount": 68607706, "minimum_amount": 1, "payment_method": "wallet", - "payment_method_issuers": ["labore magna ipsum", "aute"], - "payment_method_types": ["upi_collect", "upi_intent"], - "payment_schemes": ["Discover", "Discover"], + "payment_method_issuers": [ + "labore magna ipsum", + "aute" + ], + "payment_method_types": [ + "upi_collect", + "upi_intent" + ], + "payment_schemes": [ + "Discover", + "Discover" + ], "recurring_enabled": true } ], @@ -9318,7 +10115,11 @@ "MerchantConnectorUpdate": { "type": "object", "description": "Create a new Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.\"", - "required": ["connector_type", "status", "merchant_id"], + "required": [ + "connector_type", + "status", + "merchant_id" + ], "properties": { "connector_type": { "$ref": "#/components/schemas/ConnectorType" @@ -9346,20 +10147,36 @@ "example": [ { "accepted_countries": { - "list": ["FR", "DE", "IN"], + "list": [ + "FR", + "DE", + "IN" + ], "type": "disable_only" }, "accepted_currencies": { - "list": ["USD", "EUR"], + "list": [ + "USD", + "EUR" + ], "type": "enable_only" }, "installment_payment_enabled": true, "maximum_amount": 68607706, "minimum_amount": 1, "payment_method": "wallet", - "payment_method_issuers": ["labore magna ipsum", "aute"], - "payment_method_types": ["upi_collect", "upi_intent"], - "payment_schemes": ["Discover", "Discover"], + "payment_method_issuers": [ + "labore magna ipsum", + "aute" + ], + "payment_method_types": [ + "upi_collect", + "upi_intent" + ], + "payment_schemes": [ + "Discover", + "Discover" + ], "recurring_enabled": true } ], @@ -9430,7 +10247,10 @@ }, "MerchantConnectorWebhookDetails": { "type": "object", - "required": ["merchant_secret", "additional_secret"], + "required": [ + "merchant_secret", + "additional_secret" + ], "properties": { "merchant_secret": { "type": "string", @@ -9517,7 +10337,9 @@ "oneOf": [ { "type": "object", - "required": ["connector_recipient_id"], + "required": [ + "connector_recipient_id" + ], "properties": { "connector_recipient_id": { "type": "string", @@ -9527,7 +10349,9 @@ }, { "type": "object", - "required": ["wallet_id"], + "required": [ + "wallet_id" + ], "properties": { "wallet_id": { "type": "string", @@ -9537,7 +10361,9 @@ }, { "type": "object", - "required": ["account_data"], + "required": [ + "account_data" + ], "properties": { "account_data": { "$ref": "#/components/schemas/MerchantAccountData" @@ -9590,7 +10416,10 @@ }, "MetadataValue": { "type": "object", - "required": ["key", "value"], + "required": [ + "key", + "value" + ], "properties": { "key": { "type": "string" @@ -9602,7 +10431,9 @@ }, "MifinityData": { "type": "object", - "required": ["date_of_birth"], + "required": [ + "date_of_birth" + ], "properties": { "date_of_birth": { "type": "string", @@ -9621,7 +10452,10 @@ }, "MitExemptionRequest": { "type": "string", - "enum": ["Apply", "Skip"] + "enum": [ + "Apply", + "Skip" + ] }, "MobilePayRedirection": { "type": "object" @@ -9641,7 +10475,10 @@ }, "MultibancoTransferInstructions": { "type": "object", - "required": ["reference", "entity"], + "required": [ + "reference", + "entity" + ], "properties": { "reference": { "type": "string", @@ -9726,42 +10563,59 @@ }, "NextActionCall": { "type": "string", - "enum": ["post_session_tokens", "confirm", "sync", "complete_authorize"] + "enum": [ + "post_session_tokens", + "confirm", + "sync", + "complete_authorize" + ] }, "NextActionData": { "oneOf": [ { "type": "object", "description": "Contains the url for redirection flow", - "required": ["redirect_to_url", "type"], + "required": [ + "redirect_to_url", + "type" + ], "properties": { "redirect_to_url": { "type": "string" }, "type": { "type": "string", - "enum": ["redirect_to_url"] + "enum": [ + "redirect_to_url" + ] } } }, { "type": "object", "description": "Informs the next steps for bank transfer and also contains the charges details (ex: amount received, amount charged etc)", - "required": ["bank_transfer_steps_and_charges_details", "type"], + "required": [ + "bank_transfer_steps_and_charges_details", + "type" + ], "properties": { "bank_transfer_steps_and_charges_details": { "$ref": "#/components/schemas/BankTransferNextStepsData" }, "type": { "type": "string", - "enum": ["display_bank_transfer_information"] + "enum": [ + "display_bank_transfer_information" + ] } } }, { "type": "object", "description": "Contains third party sdk session token response", - "required": ["type"], + "required": [ + "type" + ], "properties": { "session_token": { "allOf": [ @@ -9773,14 +10627,20 @@ }, "type": { "type": "string", - "enum": ["third_party_sdk_session_token"] + "enum": [ + "third_party_sdk_session_token" + ] } } }, { "type": "object", "description": "Contains url for Qr code image, this qr code has to be shown in sdk", - "required": ["image_data_url", "qr_code_url", "type"], + "required": [ + "image_data_url", + "qr_code_url", + "type" + ], "properties": { "image_data_url": { "type": "string", @@ -9797,42 +10657,57 @@ }, "type": { "type": "string", - "enum": ["qr_code_information"] + "enum": [ + "qr_code_information" + ] } } }, { "type": "object", "description": "Contains url to fetch Qr code data", - "required": ["qr_code_fetch_url", "type"], + "required": [ + "qr_code_fetch_url", + "type" + ], "properties": { "qr_code_fetch_url": { "type": "string" }, "type": { "type": "string", - "enum": ["fetch_qr_code_information"] + "enum": [ + "fetch_qr_code_information" + ] } } }, { "type": "object", "description": "Contains the download url and the reference number for transaction", - "required": ["voucher_details", "type"], + "required": [ + "voucher_details", + "type" + ], "properties": { "voucher_details": { "type": "string" }, "type": { "type": "string", - "enum": ["display_voucher_information"] + "enum": [ + "display_voucher_information" + ] } } }, { "type": "object", "description": "Contains duration for displaying a wait screen, wait screen with timer is displayed by sdk", - "required": ["display_from_timestamp", "type"], + "required": [ + "display_from_timestamp", + "type" + ], "properties": { "display_from_timestamp": { "type": "integer" @@ -9843,34 +10718,46 @@ }, "type": { "type": "string", - "enum": ["wait_screen_information"] + "enum": [ + "wait_screen_information" + ] } } }, { "type": "object", "description": "Contains the information regarding three_ds_method_data submission, three_ds authentication, and authorization flows", - "required": ["three_ds_data", "type"], + "required": [ + "three_ds_data", + "type" + ], "properties": { "three_ds_data": { "$ref": "#/components/schemas/ThreeDsData" }, "type": { "type": "string", - "enum": ["three_ds_invoke"] + "enum": [ + "three_ds_invoke" + ] } } }, { "type": "object", - "required": ["next_action_data", "type"], + "required": [ + "next_action_data", + "type" + ], "properties": { "next_action_data": { "$ref": "#/components/schemas/SdkNextActionData" }, "type": { "type": "string", - "enum": ["invoke_sdk_client"] + "enum": [ + "invoke_sdk_client" + ] } } } @@ -9971,7 +10858,10 @@ "NumberComparison": { "type": "object", "description": "Represents a number comparison for \"NumberComparisonArrayValue\"", - "required": ["comparisonType", "number"], + "required": [ + "comparisonType", + "number" + ], "properties": { "comparisonType": { "$ref": "#/components/schemas/ComparisonType" @@ -9983,7 +10873,10 @@ }, "OnlineMandate": { "type": "object", - "required": ["ip_address", "user_agent"], + "required": [ + "ip_address", + "user_agent" + ], "properties": { "ip_address": { "type": "string", @@ -10001,7 +10894,9 @@ "oneOf": [ { "type": "object", - "required": ["open_banking_pis"], + "required": [ + "open_banking_pis" + ], "properties": { "open_banking_pis": { "type": "object" @@ -10027,7 +10922,9 @@ }, "OpenBankingSessionToken": { "type": "object", - "required": ["open_banking_session_token"], + "required": [ + "open_banking_session_token" + ], "properties": { "open_banking_session_token": { "type": "string", @@ -10037,7 +10934,10 @@ }, "OrderDetails": { "type": "object", - "required": ["product_name", "quantity"], + "required": [ + "product_name", + "quantity" + ], "properties": { "product_name": { "type": "string", @@ -10098,7 +10998,11 @@ }, "OrderDetailsWithAmount": { "type": "object", - "required": ["product_name", "quantity", "amount"], + "required": [ + "product_name", + "quantity", + "amount" + ], "properties": { "product_name": { "type": "string", @@ -10162,11 +11066,16 @@ }, "OrderFulfillmentTimeOrigin": { "type": "string", - "enum": ["create", "confirm"] + "enum": [ + "create", + "confirm" + ] }, "OrganizationCreateRequest": { "type": "object", - "required": ["organization_name"], + "required": [ + "organization_name" + ], "properties": { "organization_name": { "type": "string" @@ -10184,7 +11093,11 @@ }, "OrganizationResponse": { "type": "object", - "required": ["organization_id", "modified_at", "created_at"], + "required": [ + "organization_id", + "modified_at", + "created_at" + ], "properties": { "organization_id": { "type": "string", @@ -10234,7 +11147,12 @@ }, "OutgoingWebhook": { "type": "object", - "required": ["merchant_id", "event_id", "event_type", "content"], + "required": [ + "merchant_id", + "event_id", + "event_type", + "content" + ], "properties": { "merchant_id": { "type": "string", @@ -10262,11 +11180,16 @@ { "type": "object", "title": "PaymentsResponse", - "required": ["type", "object"], + "required": [ + "type", + "object" + ], "properties": { "type": { "type": "string", - "enum": ["payment_details"] + "enum": [ + "payment_details" + ] }, "object": { "$ref": "#/components/schemas/PaymentsResponse" @@ -10276,11 +11199,16 @@ { "type": "object", "title": "RefundResponse", - "required": ["type", "object"], + "required": [ + "type", + "object" + ], "properties": { "type": { "type": "string", - "enum": ["refund_details"] + "enum": [ + "refund_details" + ] }, "object": { "$ref": "#/components/schemas/RefundResponse" @@ -10290,11 +11218,16 @@ { "type": "object", "title": "DisputeResponse", - "required": ["type", "object"], + "required": [ + "type", + "object" + ], "properties": { "type": { "type": "string", - "enum": ["dispute_details"] + "enum": [ + "dispute_details" + ] }, "object": { "$ref": "#/components/schemas/DisputeResponse" @@ -10304,11 +11237,16 @@ { "type": "object", "title": "MandateResponse", - "required": ["type", "object"], + "required": [ + "type", + "object" + ], "properties": { "type": { "type": "string", - "enum": ["mandate_details"] + "enum": [ + "mandate_details" + ] }, "object": { "$ref": "#/components/schemas/MandateResponse" @@ -10318,11 +11256,16 @@ { "type": "object", "title": "PayoutCreateResponse", - "required": ["type", "object"], + "required": [ + "type", + "object" + ], "properties": { "type": { "type": "string", - "enum": ["payout_details"] + "enum": [ + "payout_details" + ] }, "object": { "$ref": "#/components/schemas/PayoutCreateResponse" @@ -10337,7 +11280,10 @@ "OutgoingWebhookRequestContent": { "type": "object", "description": "The request information (headers and body) sent in the webhook.", - "required": ["body", "headers"], + "required": [ + "body", + "headers" + ], "properties": { "body": { "type": "string", @@ -10360,8 +11306,14 @@ }, "description": "The request headers sent in the webhook.", "example": [ - ["content-type", "application/json"], - ["content-length", "1024"] + [ + "content-type", + "application/json" + ], + [ + "content-length", + "1024" + ] ] } } @@ -10392,8 +11344,14 @@ }, "description": "The response headers received for the webhook sent.", "example": [ - ["content-type", "application/json"], - ["content-length", "1024"] + [ + "content-type", + "application/json" + ], + [ + "content-length", + "1024" + ] ], "nullable": true }, @@ -10417,7 +11375,9 @@ "oneOf": [ { "type": "object", - "required": ["klarna_redirect"], + "required": [ + "klarna_redirect" + ], "properties": { "klarna_redirect": { "type": "object", @@ -10442,12 +11402,16 @@ }, { "type": "object", - "required": ["klarna_sdk"], + "required": [ + "klarna_sdk" + ], "properties": { "klarna_sdk": { "type": "object", "description": "For Klarna Sdk as PayLater Option", - "required": ["token"], + "required": [ + "token" + ], "properties": { "token": { "type": "string", @@ -10459,7 +11423,9 @@ }, { "type": "object", - "required": ["affirm_redirect"], + "required": [ + "affirm_redirect" + ], "properties": { "affirm_redirect": { "type": "object", @@ -10469,7 +11435,9 @@ }, { "type": "object", - "required": ["afterpay_clearpay_redirect"], + "required": [ + "afterpay_clearpay_redirect" + ], "properties": { "afterpay_clearpay_redirect": { "type": "object", @@ -10491,7 +11459,9 @@ }, { "type": "object", - "required": ["pay_bright_redirect"], + "required": [ + "pay_bright_redirect" + ], "properties": { "pay_bright_redirect": { "type": "object", @@ -10501,7 +11471,9 @@ }, { "type": "object", - "required": ["walley_redirect"], + "required": [ + "walley_redirect" + ], "properties": { "walley_redirect": { "type": "object", @@ -10511,7 +11483,9 @@ }, { "type": "object", - "required": ["alma_redirect"], + "required": [ + "alma_redirect" + ], "properties": { "alma_redirect": { "type": "object", @@ -10521,7 +11495,9 @@ }, { "type": "object", - "required": ["atome_redirect"], + "required": [ + "atome_redirect" + ], "properties": { "atome_redirect": { "type": "object" @@ -10532,7 +11508,9 @@ }, "PayPalWalletData": { "type": "object", - "required": ["token"], + "required": [ + "token" + ], "properties": { "token": { "type": "string", @@ -10707,7 +11685,11 @@ "PaymentChargeRequest": { "type": "object", "description": "Fee information to be charged on the payment being collected", - "required": ["charge_type", "fees", "transfer_account_id"], + "required": [ + "charge_type", + "fees", + "transfer_account_id" + ], "properties": { "charge_type": { "$ref": "#/components/schemas/PaymentChargeType" @@ -10727,7 +11709,11 @@ "PaymentChargeResponse": { "type": "object", "description": "Fee information to be charged on the payment being collected", - "required": ["charge_type", "application_fees", "transfer_account_id"], + "required": [ + "charge_type", + "application_fees", + "transfer_account_id" + ], "properties": { "charge_id": { "type": "string", @@ -10753,7 +11739,9 @@ "oneOf": [ { "type": "object", - "required": ["Stripe"], + "required": [ + "Stripe" + ], "properties": { "Stripe": { "$ref": "#/components/schemas/StripeChargeType" @@ -10902,7 +11890,10 @@ }, "PaymentLinkInitiateRequest": { "type": "object", - "required": ["merchant_id", "payment_id"], + "required": [ + "merchant_id", + "payment_id" + ], "properties": { "merchant_id": { "type": "string" @@ -10914,7 +11905,10 @@ }, "PaymentLinkResponse": { "type": "object", - "required": ["link", "payment_link_id"], + "required": [ + "link", + "payment_link_id" + ], "properties": { "link": { "type": "string", @@ -10934,11 +11928,17 @@ "PaymentLinkStatus": { "type": "string", "description": "Status Of the Payment Link", - "enum": ["active", "expired"] + "enum": [ + "active", + "expired" + ] }, "PaymentLinkTransactionDetails": { "type": "object", - "required": ["key", "value"], + "required": [ + "key", + "value" + ], "properties": { "key": { "type": "string", @@ -11033,7 +12033,10 @@ }, "PaymentListResponse": { "type": "object", - "required": ["size", "data"], + "required": [ + "size", + "data" + ], "properties": { "size": { "type": "integer", @@ -11080,7 +12083,9 @@ }, { "type": "object", - "required": ["customer_id"], + "required": [ + "customer_id" + ], "properties": { "pm_collect_link_id": { "type": "string", @@ -11127,7 +12132,12 @@ }, { "type": "object", - "required": ["pm_collect_link_id", "customer_id", "expiry", "link"], + "required": [ + "pm_collect_link_id", + "customer_id", + "expiry", + "link" + ], "properties": { "pm_collect_link_id": { "type": "string", @@ -11171,7 +12181,9 @@ }, "PaymentMethodCreate": { "type": "object", - "required": ["payment_method"], + "required": [ + "payment_method" + ], "properties": { "payment_method": { "$ref": "#/components/schemas/PaymentMethod" @@ -11269,7 +12281,9 @@ "oneOf": [ { "type": "object", - "required": ["card"], + "required": [ + "card" + ], "properties": { "card": { "$ref": "#/components/schemas/CardDetail" @@ -11283,7 +12297,9 @@ { "type": "object", "title": "Card", - "required": ["card"], + "required": [ + "card" + ], "properties": { "card": { "$ref": "#/components/schemas/Card" @@ -11293,7 +12309,9 @@ { "type": "object", "title": "CardRedirect", - "required": ["card_redirect"], + "required": [ + "card_redirect" + ], "properties": { "card_redirect": { "$ref": "#/components/schemas/CardRedirectData" @@ -11303,7 +12321,9 @@ { "type": "object", "title": "Wallet", - "required": ["wallet"], + "required": [ + "wallet" + ], "properties": { "wallet": { "$ref": "#/components/schemas/WalletData" @@ -11313,8 +12333,10 @@ { "type": "object", "title": "PayLater", - "required": ["pay_later"], - "properties": { + "required": [ + "pay_later" + ], + "properties": { "pay_later": { "$ref": "#/components/schemas/PayLaterData" } @@ -11323,7 +12345,9 @@ { "type": "object", "title": "BankRedirect", - "required": ["bank_redirect"], + "required": [ + "bank_redirect" + ], "properties": { "bank_redirect": { "$ref": "#/components/schemas/BankRedirectData" @@ -11333,7 +12357,9 @@ { "type": "object", "title": "BankDebit", - "required": ["bank_debit"], + "required": [ + "bank_debit" + ], "properties": { "bank_debit": { "$ref": "#/components/schemas/BankDebitData" @@ -11343,7 +12369,9 @@ { "type": "object", "title": "BankTransfer", - "required": ["bank_transfer"], + "required": [ + "bank_transfer" + ], "properties": { "bank_transfer": { "$ref": "#/components/schemas/BankTransferData" @@ -11353,7 +12381,9 @@ { "type": "object", "title": "RealTimePayment", - "required": ["real_time_payment"], + "required": [ + "real_time_payment" + ], "properties": { "real_time_payment": { "$ref": "#/components/schemas/RealTimePaymentData" @@ -11363,7 +12393,9 @@ { "type": "object", "title": "Crypto", - "required": ["crypto"], + "required": [ + "crypto" + ], "properties": { "crypto": { "$ref": "#/components/schemas/CryptoData" @@ -11373,17 +12405,23 @@ { "type": "string", "title": "MandatePayment", - "enum": ["mandate_payment"] + "enum": [ + "mandate_payment" + ] }, { "type": "string", "title": "Reward", - "enum": ["reward"] + "enum": [ + "reward" + ] }, { "type": "object", "title": "Upi", - "required": ["upi"], + "required": [ + "upi" + ], "properties": { "upi": { "$ref": "#/components/schemas/UpiData" @@ -11393,7 +12431,9 @@ { "type": "object", "title": "Voucher", - "required": ["voucher"], + "required": [ + "voucher" + ], "properties": { "voucher": { "$ref": "#/components/schemas/VoucherData" @@ -11403,7 +12443,9 @@ { "type": "object", "title": "GiftCard", - "required": ["gift_card"], + "required": [ + "gift_card" + ], "properties": { "gift_card": { "$ref": "#/components/schemas/GiftCardData" @@ -11413,7 +12455,9 @@ { "type": "object", "title": "CardToken", - "required": ["card_token"], + "required": [ + "card_token" + ], "properties": { "card_token": { "$ref": "#/components/schemas/CardToken" @@ -11423,7 +12467,9 @@ { "type": "object", "title": "OpenBanking", - "required": ["open_banking"], + "required": [ + "open_banking" + ], "properties": { "open_banking": { "$ref": "#/components/schemas/OpenBankingData" @@ -11462,7 +12508,9 @@ "oneOf": [ { "type": "object", - "required": ["card"], + "required": [ + "card" + ], "properties": { "card": { "$ref": "#/components/schemas/CardResponse" @@ -11471,7 +12519,9 @@ }, { "type": "object", - "required": ["bank_transfer"], + "required": [ + "bank_transfer" + ], "properties": { "bank_transfer": { "$ref": "#/components/schemas/BankTransferResponse" @@ -11480,7 +12530,9 @@ }, { "type": "object", - "required": ["wallet"], + "required": [ + "wallet" + ], "properties": { "wallet": { "$ref": "#/components/schemas/WalletResponse" @@ -11489,7 +12541,9 @@ }, { "type": "object", - "required": ["pay_later"], + "required": [ + "pay_later" + ], "properties": { "pay_later": { "$ref": "#/components/schemas/PaylaterResponse" @@ -11498,7 +12552,9 @@ }, { "type": "object", - "required": ["bank_redirect"], + "required": [ + "bank_redirect" + ], "properties": { "bank_redirect": { "$ref": "#/components/schemas/BankRedirectResponse" @@ -11507,7 +12563,9 @@ }, { "type": "object", - "required": ["crypto"], + "required": [ + "crypto" + ], "properties": { "crypto": { "$ref": "#/components/schemas/CryptoResponse" @@ -11516,7 +12574,9 @@ }, { "type": "object", - "required": ["bank_debit"], + "required": [ + "bank_debit" + ], "properties": { "bank_debit": { "$ref": "#/components/schemas/BankDebitResponse" @@ -11525,7 +12585,9 @@ }, { "type": "object", - "required": ["mandate_payment"], + "required": [ + "mandate_payment" + ], "properties": { "mandate_payment": { "type": "object" @@ -11534,7 +12596,9 @@ }, { "type": "object", - "required": ["reward"], + "required": [ + "reward" + ], "properties": { "reward": { "type": "object" @@ -11543,7 +12607,9 @@ }, { "type": "object", - "required": ["real_time_payment"], + "required": [ + "real_time_payment" + ], "properties": { "real_time_payment": { "$ref": "#/components/schemas/RealTimePaymentDataResponse" @@ -11552,7 +12618,9 @@ }, { "type": "object", - "required": ["upi"], + "required": [ + "upi" + ], "properties": { "upi": { "$ref": "#/components/schemas/UpiResponse" @@ -11561,7 +12629,9 @@ }, { "type": "object", - "required": ["voucher"], + "required": [ + "voucher" + ], "properties": { "voucher": { "$ref": "#/components/schemas/VoucherResponse" @@ -11570,7 +12640,9 @@ }, { "type": "object", - "required": ["gift_card"], + "required": [ + "gift_card" + ], "properties": { "gift_card": { "$ref": "#/components/schemas/GiftCardResponse" @@ -11579,7 +12651,9 @@ }, { "type": "object", - "required": ["card_redirect"], + "required": [ + "card_redirect" + ], "properties": { "card_redirect": { "$ref": "#/components/schemas/CardRedirectResponse" @@ -11588,7 +12662,9 @@ }, { "type": "object", - "required": ["card_token"], + "required": [ + "card_token" + ], "properties": { "card_token": { "$ref": "#/components/schemas/CardTokenResponse" @@ -11597,7 +12673,9 @@ }, { "type": "object", - "required": ["open_banking"], + "required": [ + "open_banking" + ], "properties": { "open_banking": { "$ref": "#/components/schemas/OpenBankingResponse" @@ -11633,7 +12711,10 @@ }, "PaymentMethodDeleteResponse": { "type": "object", - "required": ["payment_method_id", "deleted"], + "required": [ + "payment_method_id", + "deleted" + ], "properties": { "payment_method_id": { "type": "string", @@ -11664,7 +12745,9 @@ }, "PaymentMethodList": { "type": "object", - "required": ["payment_method"], + "required": [ + "payment_method" + ], "properties": { "payment_method": { "$ref": "#/components/schemas/PaymentMethod" @@ -11675,7 +12758,9 @@ "$ref": "#/components/schemas/PaymentMethodType" }, "description": "This is a sub-category of payment method.", - "example": ["credit"], + "example": [ + "credit" + ], "nullable": true } } @@ -11710,7 +12795,10 @@ { "payment_experience": null, "payment_method": "wallet", - "payment_method_issuers": ["labore magna ipsum", "aute"] + "payment_method_issuers": [ + "labore magna ipsum", + "aute" + ] } ] }, @@ -11817,7 +12905,9 @@ "$ref": "#/components/schemas/PaymentExperience" }, "description": "Type of payment experience enabled with the connector", - "example": ["redirect_to_url"], + "example": [ + "redirect_to_url" + ], "nullable": true }, "metadata": { @@ -11856,7 +12946,12 @@ "PaymentMethodStatus": { "type": "string", "description": "Payment Method Status", - "enum": ["active", "inactive", "processing", "awaiting_data"] + "enum": [ + "active", + "inactive", + "processing", + "awaiting_data" + ] }, "PaymentMethodType": { "type": "string", @@ -11983,7 +13078,9 @@ "PaymentMethodsEnabled": { "type": "object", "description": "Details of all the payment methods enabled for the connector for the given merchant account", - "required": ["payment_method"], + "required": [ + "payment_method" + ], "properties": { "payment_method": { "$ref": "#/components/schemas/PaymentMethod" @@ -11994,7 +13091,9 @@ "$ref": "#/components/schemas/RequestPaymentMethodTypes" }, "description": "Subtype of payment method", - "example": ["credit"], + "example": [ + "credit" + ], "nullable": true } }, @@ -12024,11 +13123,15 @@ }, { "type": "object", - "required": ["payment_processing_details_at"], + "required": [ + "payment_processing_details_at" + ], "properties": { "payment_processing_details_at": { "type": "string", - "enum": ["Hyperswitch"] + "enum": [ + "Hyperswitch" + ] } } } @@ -12036,11 +13139,15 @@ }, { "type": "object", - "required": ["payment_processing_details_at"], + "required": [ + "payment_processing_details_at" + ], "properties": { "payment_processing_details_at": { "type": "string", - "enum": ["Connector"] + "enum": [ + "Connector" + ] } } } @@ -12082,7 +13189,12 @@ "PaymentType": { "type": "string", "description": "The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.", - "enum": ["normal", "new_mandate", "setup_mandate", "recurring_mandate"] + "enum": [ + "normal", + "new_mandate", + "setup_mandate", + "recurring_mandate" + ] }, "PaymentsCancelRequest": { "type": "object", @@ -12104,7 +13216,9 @@ }, "PaymentsCaptureRequest": { "type": "object", - "required": ["amount_to_capture"], + "required": [ + "amount_to_capture" + ], "properties": { "merchant_id": { "type": "string", @@ -12144,7 +13258,9 @@ }, "PaymentsCompleteAuthorizeRequest": { "type": "object", - "required": ["client_secret"], + "required": [ + "client_secret" + ], "properties": { "shipping": { "allOf": [ @@ -12303,7 +13419,9 @@ }, "PaymentsCreateIntentRequest": { "type": "object", - "required": ["amount_details"], + "required": [ + "amount_details" + ], "properties": { "amount_details": { "$ref": "#/components/schemas/AmountDetails" @@ -13032,7 +14150,11 @@ }, "PaymentsDynamicTaxCalculationRequest": { "type": "object", - "required": ["shipping", "client_secret", "payment_method_type"], + "required": [ + "shipping", + "client_secret", + "payment_method_type" + ], "properties": { "shipping": { "$ref": "#/components/schemas/Address" @@ -13053,7 +14175,11 @@ }, "PaymentsDynamicTaxCalculationResponse": { "type": "object", - "required": ["payment_id", "net_amount", "display_amount"], + "required": [ + "payment_id", + "net_amount", + "display_amount" + ], "properties": { "payment_id": { "type": "string", @@ -13113,7 +14239,10 @@ }, "PaymentsExternalAuthenticationResponse": { "type": "object", - "required": ["trans_status", "three_ds_requestor_url"], + "required": [ + "trans_status", + "three_ds_requestor_url" + ], "properties": { "trans_status": { "$ref": "#/components/schemas/TransactionStatus" @@ -13156,7 +14285,9 @@ }, "PaymentsIncrementalAuthorizationRequest": { "type": "object", - "required": ["amount"], + "required": [ + "amount" + ], "properties": { "amount": { "type": "integer", @@ -13175,6 +14306,7 @@ "type": "object", "required": [ "id", + "status", "amount_details", "client_secret", "capture_method", @@ -13192,6 +14324,9 @@ "type": "string", "description": "Global Payment Id for the payment" }, + "status": { + "$ref": "#/components/schemas/IntentStatus" + }, "amount_details": { "$ref": "#/components/schemas/AmountDetailsResponse" }, @@ -13923,7 +15058,11 @@ }, "PaymentsSessionResponse": { "type": "object", - "required": ["payment_id", "client_secret", "session_token"], + "required": [ + "payment_id", + "client_secret", + "session_token" + ], "properties": { "payment_id": { "type": "string", @@ -13947,7 +15086,11 @@ }, "PayoutAttemptResponse": { "type": "object", - "required": ["attempt_id", "status", "amount"], + "required": [ + "attempt_id", + "status", + "amount" + ], "properties": { "attempt_id": { "type": "string", @@ -14135,7 +15278,10 @@ "$ref": "#/components/schemas/PayoutConnectors" }, "description": "This field allows the merchant to manually select a connector with which the payout can go through.", - "example": ["wise", "adyen"], + "example": [ + "wise", + "adyen" + ], "nullable": true }, "confirm": { @@ -14575,7 +15721,10 @@ }, "PayoutLinkInitiateRequest": { "type": "object", - "required": ["merchant_id", "payout_id"], + "required": [ + "merchant_id", + "payout_id" + ], "properties": { "merchant_id": { "type": "string" @@ -14587,7 +15736,10 @@ }, "PayoutLinkResponse": { "type": "object", - "required": ["payout_link_id", "link"], + "required": [ + "payout_link_id", + "link" + ], "properties": { "payout_link_id": { "type": "string" @@ -14659,7 +15811,10 @@ }, { "type": "object", - "required": ["currency", "entity_type"], + "required": [ + "currency", + "entity_type" + ], "properties": { "payout_id": { "type": "string", @@ -14699,7 +15854,10 @@ "$ref": "#/components/schemas/PayoutConnectors" }, "description": "The list of connectors to filter payouts list", - "example": ["wise", "adyen"], + "example": [ + "wise", + "adyen" + ], "nullable": true }, "currency": { @@ -14711,7 +15869,10 @@ "$ref": "#/components/schemas/PayoutStatus" }, "description": "The list of payout status to filter payouts list", - "example": ["pending", "failed"], + "example": [ + "pending", + "failed" + ], "nullable": true }, "payout_method": { @@ -14720,7 +15881,10 @@ "$ref": "#/components/schemas/PayoutType" }, "description": "The list of payout methods to filter payouts list", - "example": ["bank", "card"], + "example": [ + "bank", + "card" + ], "nullable": true }, "entity_type": { @@ -14732,7 +15896,10 @@ }, "PayoutListResponse": { "type": "object", - "required": ["size", "data"], + "required": [ + "size", + "data" + ], "properties": { "size": { "type": "integer", @@ -14758,7 +15925,9 @@ "oneOf": [ { "type": "object", - "required": ["card"], + "required": [ + "card" + ], "properties": { "card": { "$ref": "#/components/schemas/CardPayout" @@ -14767,7 +15936,9 @@ }, { "type": "object", - "required": ["bank"], + "required": [ + "bank" + ], "properties": { "bank": { "$ref": "#/components/schemas/Bank" @@ -14776,7 +15947,9 @@ }, { "type": "object", - "required": ["wallet"], + "required": [ + "wallet" + ], "properties": { "wallet": { "$ref": "#/components/schemas/Wallet" @@ -14790,7 +15963,9 @@ "oneOf": [ { "type": "object", - "required": ["card"], + "required": [ + "card" + ], "properties": { "card": { "$ref": "#/components/schemas/CardAdditionalData" @@ -14799,7 +15974,9 @@ }, { "type": "object", - "required": ["bank"], + "required": [ + "bank" + ], "properties": { "bank": { "$ref": "#/components/schemas/BankAdditionalData" @@ -14808,7 +15985,9 @@ }, { "type": "object", - "required": ["wallet"], + "required": [ + "wallet" + ], "properties": { "wallet": { "$ref": "#/components/schemas/WalletAdditionalData" @@ -14822,7 +16001,9 @@ "oneOf": [ { "type": "object", - "required": ["PayoutActionRequest"], + "required": [ + "PayoutActionRequest" + ], "properties": { "PayoutActionRequest": { "$ref": "#/components/schemas/PayoutActionRequest" @@ -14831,7 +16012,9 @@ }, { "type": "object", - "required": ["PayoutCreateRequest"], + "required": [ + "PayoutCreateRequest" + ], "properties": { "PayoutCreateRequest": { "$ref": "#/components/schemas/PayoutCreateRequest" @@ -14840,7 +16023,9 @@ }, { "type": "object", - "required": ["PayoutRetrieveRequest"], + "required": [ + "PayoutRetrieveRequest" + ], "properties": { "PayoutRetrieveRequest": { "$ref": "#/components/schemas/PayoutRetrieveRequest" @@ -14864,7 +16049,9 @@ }, "PayoutRetrieveRequest": { "type": "object", - "required": ["payout_id"], + "required": [ + "payout_id" + ], "properties": { "payout_id": { "type": "string", @@ -14920,11 +16107,19 @@ "PayoutType": { "type": "string", "description": "The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.", - "enum": ["card", "bank", "wallet"] + "enum": [ + "card", + "bank", + "wallet" + ] }, "Paypal": { "type": "object", - "required": ["email", "telephone_number", "paypal_id"], + "required": [ + "email", + "telephone_number", + "paypal_id" + ], "properties": { "email": { "type": "string", @@ -14981,7 +16176,11 @@ }, "PaypalSessionTokenResponse": { "type": "object", - "required": ["connector", "session_token", "sdk_next_action"], + "required": [ + "connector", + "session_token", + "sdk_next_action" + ], "properties": { "connector": { "type": "string", @@ -15037,7 +16236,9 @@ }, "PazeWalletData": { "type": "object", - "required": ["complete_response"], + "required": [ + "complete_response" + ], "properties": { "complete_response": { "type": "string" @@ -15063,7 +16264,10 @@ }, "PixBankTransfer": { "type": "object", - "required": ["bank_account_number", "pix_key"], + "required": [ + "bank_account_number", + "pix_key" + ], "properties": { "bank_name": { "type": "string", @@ -15120,7 +16324,11 @@ }, "PollConfigResponse": { "type": "object", - "required": ["poll_id", "delay_in_secs", "frequency"], + "required": [ + "poll_id", + "delay_in_secs", + "frequency" + ], "properties": { "poll_id": { "type": "string", @@ -15140,7 +16348,10 @@ }, "PollResponse": { "type": "object", - "required": ["poll_id", "status"], + "required": [ + "poll_id", + "status" + ], "properties": { "poll_id": { "type": "string", @@ -15153,16 +16364,26 @@ }, "PollStatus": { "type": "string", - "enum": ["pending", "completed", "not_found"] + "enum": [ + "pending", + "completed", + "not_found" + ] }, "PresenceOfCustomerDuringPayment": { "type": "string", "description": "Set to true to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be false when merchant's doing merchant initiated payments and customer is not present while doing the payment.", - "enum": ["Present", "Absent"] + "enum": [ + "Present", + "Absent" + ] }, "PrimaryBusinessDetails": { "type": "object", - "required": ["country", "business"], + "required": [ + "country", + "business" + ], "properties": { "country": { "$ref": "#/components/schemas/CountryAlpha2" @@ -15177,7 +16398,9 @@ "ProcessorPaymentToken": { "type": "object", "description": "Processor payment token for MIT payments where payment_method_data is not available", - "required": ["processor_payment_token"], + "required": [ + "processor_payment_token" + ], "properties": { "processor_payment_token": { "type": "string" @@ -15201,7 +16424,9 @@ }, "ProfileCreate": { "type": "object", - "required": ["profile_name"], + "required": [ + "profile_name" + ], "properties": { "profile_name": { "type": "string", @@ -15364,7 +16589,10 @@ }, "ProfileDefaultRoutingConfig": { "type": "object", - "required": ["profile_id", "connectors"], + "required": [ + "profile_id", + "connectors" + ], "properties": { "profile_id": { "type": "string" @@ -15568,7 +16796,11 @@ "ProgramConnectorSelection": { "type": "object", "description": "The program, having a default connector selection and\na bunch of rules. Also can hold arbitrary metadata.", - "required": ["defaultSelection", "rules", "metadata"], + "required": [ + "defaultSelection", + "rules", + "metadata" + ], "properties": { "defaultSelection": { "$ref": "#/components/schemas/ConnectorSelection" @@ -15586,7 +16818,9 @@ "oneOf": [ { "type": "object", - "required": ["fps"], + "required": [ + "fps" + ], "properties": { "fps": { "type": "object" @@ -15595,7 +16829,9 @@ }, { "type": "object", - "required": ["duit_now"], + "required": [ + "duit_now" + ], "properties": { "duit_now": { "type": "object" @@ -15604,7 +16840,9 @@ }, { "type": "object", - "required": ["prompt_pay"], + "required": [ + "prompt_pay" + ], "properties": { "prompt_pay": { "type": "object" @@ -15613,7 +16851,9 @@ }, { "type": "object", - "required": ["viet_qr"], + "required": [ + "viet_qr" + ], "properties": { "viet_qr": { "type": "object" @@ -15639,7 +16879,9 @@ }, "ReceiverDetails": { "type": "object", - "required": ["amount_received"], + "required": [ + "amount_received" + ], "properties": { "amount_received": { "type": "integer", @@ -15662,17 +16904,27 @@ }, "ReconStatus": { "type": "string", - "enum": ["not_requested", "requested", "active", "disabled"] + "enum": [ + "not_requested", + "requested", + "active", + "disabled" + ] }, "RecurringDetails": { "oneOf": [ { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["mandate_id"] + "enum": [ + "mandate_id" + ] }, "data": { "type": "string" @@ -15681,11 +16933,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["payment_method_id"] + "enum": [ + "payment_method_id" + ] }, "data": { "type": "string" @@ -15694,11 +16951,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["processor_payment_token"] + "enum": [ + "processor_payment_token" + ] }, "data": { "$ref": "#/components/schemas/ProcessorPaymentToken" @@ -15707,11 +16969,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["network_transaction_id_and_card_details"] + "enum": [ + "network_transaction_id_and_card_details" + ] }, "data": { "$ref": "#/components/schemas/NetworkTransactionIdAndCardDetails" @@ -15739,7 +17006,9 @@ }, "RefundAggregateResponse": { "type": "object", - "required": ["status_with_count"], + "required": [ + "status_with_count" + ], "properties": { "status_with_count": { "type": "object", @@ -15753,7 +17022,10 @@ }, "RefundErrorDetails": { "type": "object", - "required": ["code", "message"], + "required": [ + "code", + "message" + ], "properties": { "code": { "type": "string" @@ -15849,7 +17121,11 @@ }, "RefundListResponse": { "type": "object", - "required": ["count", "total_count", "data"], + "required": [ + "count", + "total_count", + "data" + ], "properties": { "count": { "type": "integer", @@ -15872,7 +17148,9 @@ }, "RefundRequest": { "type": "object", - "required": ["payment_id"], + "required": [ + "payment_id" + ], "properties": { "payment_id": { "type": "string", @@ -16037,12 +17315,20 @@ "RefundStatus": { "type": "string", "description": "The status for refunds", - "enum": ["succeeded", "failed", "pending", "review"] + "enum": [ + "succeeded", + "failed", + "pending", + "review" + ] }, "RefundType": { "type": "string", "description": "To indicate whether to refund needs to be instant or scheduled", - "enum": ["scheduled", "instant"] + "enum": [ + "scheduled", + "instant" + ] }, "RefundUpdateRequest": { "type": "object", @@ -16064,7 +17350,9 @@ }, "RefundsCreateRequest": { "type": "object", - "required": ["payment_id"], + "required": [ + "payment_id" + ], "properties": { "payment_id": { "type": "string", @@ -16115,7 +17403,11 @@ }, "RequestIncrementalAuthorization": { "type": "string", - "enum": ["true", "false", "default"] + "enum": [ + "true", + "false", + "default" + ] }, "RequestPaymentMethodTypes": { "type": "object", @@ -16192,7 +17484,9 @@ "RequestSurchargeDetails": { "type": "object", "description": "Details of surcharge applied on this payment, if applicable", - "required": ["surcharge_amount"], + "required": [ + "surcharge_amount" + ], "properties": { "surcharge_amount": { "type": "integer", @@ -16212,7 +17506,11 @@ "RequiredFieldInfo": { "type": "object", "description": "Required fields info used while listing the payment_method_data", - "required": ["required_field", "display_name", "field_type"], + "required": [ + "required_field", + "display_name", + "field_type" + ], "properties": { "required_field": { "type": "string", @@ -16360,12 +17658,19 @@ "RetryAction": { "type": "string", "description": "Denotes the retry action", - "enum": ["manual_retry", "requeue"] + "enum": [ + "manual_retry", + "requeue" + ] }, "RevokeApiKeyResponse": { "type": "object", "description": "The response body for revoking an API Key.", - "required": ["merchant_id", "key_id", "revoked"], + "required": [ + "merchant_id", + "key_id", + "revoked" + ], "properties": { "merchant_id": { "type": "string", @@ -16388,7 +17693,9 @@ }, "RewardData": { "type": "object", - "required": ["merchant_id"], + "required": [ + "merchant_id" + ], "properties": { "merchant_id": { "type": "string", @@ -16398,12 +17705,17 @@ }, "RoutableChoiceKind": { "type": "string", - "enum": ["OnlyConnector", "FullStruct"] + "enum": [ + "OnlyConnector", + "FullStruct" + ] }, "RoutableConnectorChoice": { "type": "object", "description": "Routable Connector chosen for a payment", - "required": ["connector"], + "required": [ + "connector" + ], "properties": { "connector": { "$ref": "#/components/schemas/RoutableConnectors" @@ -16500,11 +17812,16 @@ "oneOf": [ { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["single"] + "enum": [ + "single" + ] }, "data": { "$ref": "#/components/schemas/RoutableConnectorChoice" @@ -16513,11 +17830,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["priority"] + "enum": [ + "priority" + ] }, "data": { "type": "array", @@ -16529,11 +17851,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["volume_split"] + "enum": [ + "volume_split" + ] }, "data": { "type": "array", @@ -16545,11 +17872,16 @@ }, { "type": "object", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["advanced"] + "enum": [ + "advanced" + ] }, "data": { "$ref": "#/components/schemas/ProgramConnectorSelection" @@ -16564,7 +17896,9 @@ }, "RoutingAlgorithmId": { "type": "object", - "required": ["routing_algorithm_id"], + "required": [ + "routing_algorithm_id" + ], "properties": { "routing_algorithm_id": { "type": "string" @@ -16573,11 +17907,22 @@ }, "RoutingAlgorithmKind": { "type": "string", - "enum": ["single", "priority", "volume_split", "advanced", "dynamic"] + "enum": [ + "single", + "priority", + "volume_split", + "advanced", + "dynamic" + ] }, "RoutingConfigRequest": { "type": "object", - "required": ["name", "description", "algorithm", "profile_id"], + "required": [ + "name", + "description", + "algorithm", + "profile_id" + ], "properties": { "name": { "type": "string" @@ -16595,7 +17940,10 @@ }, "RoutingDictionary": { "type": "object", - "required": ["merchant_id", "records"], + "required": [ + "merchant_id", + "records" + ], "properties": { "merchant_id": { "type": "string" @@ -16687,7 +18035,11 @@ "RuleConnectorSelection": { "type": "object", "description": "Represents a rule\n\n```text\nrule_name: [stripe, adyen, checkout]\n{\npayment.method = card {\npayment.method.cardtype = (credit, debit) {\npayment.method.network = (amex, rupay, diners)\n}\n\npayment.method.cardtype = credit\n}\n}\n```", - "required": ["name", "connectorSelection", "statements"], + "required": [ + "name", + "connectorSelection", + "statements" + ], "properties": { "name": { "type": "string" @@ -16705,7 +18057,11 @@ }, "SamsungPayAmountDetails": { "type": "object", - "required": ["option", "currency_code", "total"], + "required": [ + "option", + "currency_code", + "total" + ], "properties": { "option": { "$ref": "#/components/schemas/SamsungPayAmountFormat" @@ -16722,7 +18078,10 @@ }, "SamsungPayAmountFormat": { "type": "string", - "enum": ["FORMAT_TOTAL_PRICE_ONLY", "FORMAT_TOTAL_ESTIMATED_AMOUNT"] + "enum": [ + "FORMAT_TOTAL_PRICE_ONLY", + "FORMAT_TOTAL_ESTIMATED_AMOUNT" + ] }, "SamsungPayAppWalletData": { "type": "object", @@ -16771,11 +18130,20 @@ }, "SamsungPayCardBrand": { "type": "string", - "enum": ["visa", "mastercard", "amex", "discover", "unknown"] + "enum": [ + "visa", + "mastercard", + "amex", + "discover", + "unknown" + ] }, "SamsungPayMerchantPaymentInformation": { "type": "object", - "required": ["name", "country_code"], + "required": [ + "name", + "country_code" + ], "properties": { "name": { "type": "string", @@ -16793,7 +18161,9 @@ }, "SamsungPayProtocolType": { "type": "string", - "enum": ["PROTOCOL3DS"] + "enum": [ + "PROTOCOL3DS" + ] }, "SamsungPaySessionTokenResponse": { "type": "object", @@ -16839,7 +18209,10 @@ }, "SamsungPayTokenData": { "type": "object", - "required": ["version", "data"], + "required": [ + "version", + "data" + ], "properties": { "type": { "type": "string", @@ -16868,7 +18241,9 @@ }, "SamsungPayWalletData": { "type": "object", - "required": ["payment_credential"], + "required": [ + "payment_credential" + ], "properties": { "payment_credential": { "$ref": "#/components/schemas/SamsungPayWalletCredentials" @@ -16877,7 +18252,11 @@ }, "SamsungPayWebWalletData": { "type": "object", - "required": ["card_brand", "card_last4digits", "3_d_s"], + "required": [ + "card_brand", + "card_last4digits", + "3_d_s" + ], "properties": { "method": { "type": "string", @@ -16946,7 +18325,9 @@ }, "SdkNextAction": { "type": "object", - "required": ["next_action"], + "required": [ + "next_action" + ], "properties": { "next_action": { "$ref": "#/components/schemas/NextActionCall" @@ -16955,7 +18336,9 @@ }, "SdkNextActionData": { "type": "object", - "required": ["next_action"], + "required": [ + "next_action" + ], "properties": { "next_action": { "$ref": "#/components/schemas/NextActionCall" @@ -16968,7 +18351,10 @@ }, "SecretInfoToInitiateSdk": { "type": "object", - "required": ["display", "payment"], + "required": [ + "display", + "payment" + ], "properties": { "display": { "type": "string" @@ -16997,7 +18383,9 @@ }, "SepaBankDebitAdditionalData": { "type": "object", - "required": ["iban"], + "required": [ + "iban" + ], "properties": { "iban": { "type": "string", @@ -17014,7 +18402,10 @@ }, "SepaBankTransfer": { "type": "object", - "required": ["iban", "bic"], + "required": [ + "iban", + "bic" + ], "properties": { "bank_name": { "type": "string", @@ -17051,7 +18442,9 @@ "SepaBankTransferAdditionalData": { "type": "object", "description": "Masked payout method details for sepa bank transfer payout method", - "required": ["iban"], + "required": [ + "iban" + ], "properties": { "iban": { "type": "string", @@ -17126,11 +18519,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["google_pay"] + "enum": [ + "google_pay" + ] } } } @@ -17143,11 +18540,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["samsung_pay"] + "enum": [ + "samsung_pay" + ] } } } @@ -17160,11 +18561,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["klarna"] + "enum": [ + "klarna" + ] } } } @@ -17177,11 +18582,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["paypal"] + "enum": [ + "paypal" + ] } } } @@ -17194,11 +18603,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["apple_pay"] + "enum": [ + "apple_pay" + ] } } } @@ -17211,11 +18624,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["open_banking"] + "enum": [ + "open_banking" + ] } } } @@ -17228,11 +18645,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["paze"] + "enum": [ + "paze" + ] } } } @@ -17240,11 +18661,15 @@ }, { "type": "object", - "required": ["wallet_name"], + "required": [ + "wallet_name" + ], "properties": { "wallet_name": { "type": "string", - "enum": ["no_session_token_received"] + "enum": [ + "no_session_token_received" + ] } } } @@ -17309,11 +18734,16 @@ { "type": "object", "title": "Single", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["single"] + "enum": [ + "single" + ] }, "data": { "$ref": "#/components/schemas/RoutableConnectorChoice" @@ -17323,11 +18753,16 @@ { "type": "object", "title": "Priority", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["priority"] + "enum": [ + "priority" + ] }, "data": { "type": "array", @@ -17340,11 +18775,16 @@ { "type": "object", "title": "VolumeSplit", - "required": ["type", "data"], + "required": [ + "type", + "data" + ], "properties": { "type": { "type": "string", - "enum": ["volume_split"] + "enum": [ + "volume_split" + ] }, "data": { "type": "array", @@ -17361,11 +18801,17 @@ }, "StripeChargeType": { "type": "string", - "enum": ["direct", "destination"] + "enum": [ + "direct", + "destination" + ] }, "SurchargeCalculationOverride": { "type": "string", - "enum": ["Skip", "Calculate"] + "enum": [ + "Skip", + "Calculate" + ] }, "SurchargeDetailsResponse": { "type": "object", @@ -17406,7 +18852,9 @@ }, "SurchargePercentage": { "type": "object", - "required": ["percentage"], + "required": [ + "percentage" + ], "properties": { "percentage": { "type": "number", @@ -17418,11 +18866,16 @@ "oneOf": [ { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["fixed"] + "enum": [ + "fixed" + ] }, "value": { "$ref": "#/components/schemas/MinorUnit" @@ -17431,11 +18884,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["rate"] + "enum": [ + "rate" + ] }, "value": { "$ref": "#/components/schemas/SurchargePercentage" @@ -17452,11 +18910,16 @@ }, "TaxCalculationOverride": { "type": "string", - "enum": ["Skip", "Calculate"] + "enum": [ + "Skip", + "Calculate" + ] }, "ThirdPartySdkSessionResponse": { "type": "object", - "required": ["secrets"], + "required": [ + "secrets" + ], "properties": { "secrets": { "$ref": "#/components/schemas/SecretInfoToInitiateSdk" @@ -17465,7 +18928,11 @@ }, "ThreeDsCompletionIndicator": { "type": "string", - "enum": ["Y", "N", "U"] + "enum": [ + "Y", + "N", + "U" + ] }, "ThreeDsData": { "type": "object", @@ -17527,7 +18994,9 @@ }, "three_ds_method_key": { "type": "string", - "enum": ["threeDSMethodData"] + "enum": [ + "threeDSMethodData" + ] } } } @@ -17539,7 +19008,9 @@ "TimeRange": { "type": "object", "description": "A type representing a range of time for filtering, including a mandatory start time and an optional end time.", - "required": ["start_time"], + "required": [ + "start_time" + ], "properties": { "start_time": { "type": "string", @@ -17556,7 +19027,9 @@ }, "ToggleBlocklistResponse": { "type": "object", - "required": ["blocklist_guard_status"], + "required": [ + "blocklist_guard_status" + ], "properties": { "blocklist_guard_status": { "type": "string" @@ -17565,7 +19038,9 @@ }, "ToggleKVRequest": { "type": "object", - "required": ["kv_enabled"], + "required": [ + "kv_enabled" + ], "properties": { "kv_enabled": { "type": "boolean", @@ -17576,7 +19051,10 @@ }, "ToggleKVResponse": { "type": "object", - "required": ["merchant_id", "kv_enabled"], + "required": [ + "merchant_id", + "kv_enabled" + ], "properties": { "merchant_id": { "type": "string", @@ -17623,15 +19101,30 @@ "TransactionStatus": { "type": "string", "description": "Indicates the transaction status", - "enum": ["Y", "N", "U", "A", "R", "C", "D", "I"] + "enum": [ + "Y", + "N", + "U", + "A", + "R", + "C", + "D", + "I" + ] }, "TransactionType": { "type": "string", - "enum": ["payment", "payout"] + "enum": [ + "payment", + "payout" + ] }, "UIWidgetFormLayout": { "type": "string", - "enum": ["tabs", "journey"] + "enum": [ + "tabs", + "journey" + ] }, "UpdateApiKeyRequest": { "type": "object", @@ -17666,7 +19159,9 @@ "oneOf": [ { "type": "object", - "required": ["upi_collect"], + "required": [ + "upi_collect" + ], "properties": { "upi_collect": { "$ref": "#/components/schemas/UpiCollectAdditionalData" @@ -17675,7 +19170,9 @@ }, { "type": "object", - "required": ["upi_intent"], + "required": [ + "upi_intent" + ], "properties": { "upi_intent": { "$ref": "#/components/schemas/UpiIntentData" @@ -17709,7 +19206,9 @@ "oneOf": [ { "type": "object", - "required": ["upi_collect"], + "required": [ + "upi_collect" + ], "properties": { "upi_collect": { "$ref": "#/components/schemas/UpiCollectData" @@ -17718,7 +19217,9 @@ }, { "type": "object", - "required": ["upi_intent"], + "required": [ + "upi_intent" + ], "properties": { "upi_intent": { "$ref": "#/components/schemas/UpiIntentData" @@ -17749,11 +19250,16 @@ "oneOf": [ { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["number"] + "enum": [ + "number" + ] }, "value": { "$ref": "#/components/schemas/MinorUnit" @@ -17762,11 +19268,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["enum_variant"] + "enum": [ + "enum_variant" + ] }, "value": { "type": "string", @@ -17776,11 +19287,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["metadata_variant"] + "enum": [ + "metadata_variant" + ] }, "value": { "$ref": "#/components/schemas/MetadataValue" @@ -17789,11 +19305,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["str_value"] + "enum": [ + "str_value" + ] }, "value": { "type": "string", @@ -17803,11 +19324,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["number_array"] + "enum": [ + "number_array" + ] }, "value": { "type": "array", @@ -17820,11 +19346,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["enum_variant_array"] + "enum": [ + "enum_variant_array" + ] }, "value": { "type": "array", @@ -17837,11 +19368,16 @@ }, { "type": "object", - "required": ["type", "value"], + "required": [ + "type", + "value" + ], "properties": { "type": { "type": "string", - "enum": ["number_comparison_array"] + "enum": [ + "number_comparison_array" + ] }, "value": { "type": "array", @@ -17860,7 +19396,9 @@ }, "Venmo": { "type": "object", - "required": ["telephone_number"], + "required": [ + "telephone_number" + ], "properties": { "telephone_number": { "type": "string", @@ -17885,7 +19423,9 @@ "oneOf": [ { "type": "object", - "required": ["boleto"], + "required": [ + "boleto" + ], "properties": { "boleto": { "$ref": "#/components/schemas/BoletoVoucherData" @@ -17894,23 +19434,33 @@ }, { "type": "string", - "enum": ["efecty"] + "enum": [ + "efecty" + ] }, { "type": "string", - "enum": ["pago_efectivo"] + "enum": [ + "pago_efectivo" + ] }, { "type": "string", - "enum": ["red_compra"] + "enum": [ + "red_compra" + ] }, { "type": "string", - "enum": ["red_pagos"] + "enum": [ + "red_pagos" + ] }, { "type": "object", - "required": ["alfamart"], + "required": [ + "alfamart" + ], "properties": { "alfamart": { "$ref": "#/components/schemas/AlfamartVoucherData" @@ -17919,7 +19469,9 @@ }, { "type": "object", - "required": ["indomaret"], + "required": [ + "indomaret" + ], "properties": { "indomaret": { "$ref": "#/components/schemas/IndomaretVoucherData" @@ -17928,11 +19480,15 @@ }, { "type": "string", - "enum": ["oxxo"] + "enum": [ + "oxxo" + ] }, { "type": "object", - "required": ["seven_eleven"], + "required": [ + "seven_eleven" + ], "properties": { "seven_eleven": { "$ref": "#/components/schemas/JCSVoucherData" @@ -17941,7 +19497,9 @@ }, { "type": "object", - "required": ["lawson"], + "required": [ + "lawson" + ], "properties": { "lawson": { "$ref": "#/components/schemas/JCSVoucherData" @@ -17950,7 +19508,9 @@ }, { "type": "object", - "required": ["mini_stop"], + "required": [ + "mini_stop" + ], "properties": { "mini_stop": { "$ref": "#/components/schemas/JCSVoucherData" @@ -17959,7 +19519,9 @@ }, { "type": "object", - "required": ["family_mart"], + "required": [ + "family_mart" + ], "properties": { "family_mart": { "$ref": "#/components/schemas/JCSVoucherData" @@ -17968,7 +19530,9 @@ }, { "type": "object", - "required": ["seicomart"], + "required": [ + "seicomart" + ], "properties": { "seicomart": { "$ref": "#/components/schemas/JCSVoucherData" @@ -17977,7 +19541,9 @@ }, { "type": "object", - "required": ["pay_easy"], + "required": [ + "pay_easy" + ], "properties": { "pay_easy": { "$ref": "#/components/schemas/JCSVoucherData" @@ -18005,7 +19571,9 @@ "oneOf": [ { "type": "object", - "required": ["paypal"], + "required": [ + "paypal" + ], "properties": { "paypal": { "$ref": "#/components/schemas/Paypal" @@ -18014,7 +19582,9 @@ }, { "type": "object", - "required": ["venmo"], + "required": [ + "venmo" + ], "properties": { "venmo": { "$ref": "#/components/schemas/Venmo" @@ -18036,7 +19606,11 @@ }, "WalletAdditionalDataForCard": { "type": "object", - "required": ["last4", "card_network", "type"], + "required": [ + "last4", + "card_network", + "type" + ], "properties": { "last4": { "type": "string", @@ -18056,7 +19630,9 @@ "oneOf": [ { "type": "object", - "required": ["ali_pay_qr"], + "required": [ + "ali_pay_qr" + ], "properties": { "ali_pay_qr": { "$ref": "#/components/schemas/AliPayQr" @@ -18065,7 +19641,9 @@ }, { "type": "object", - "required": ["ali_pay_redirect"], + "required": [ + "ali_pay_redirect" + ], "properties": { "ali_pay_redirect": { "$ref": "#/components/schemas/AliPayRedirection" @@ -18074,7 +19652,9 @@ }, { "type": "object", - "required": ["ali_pay_hk_redirect"], + "required": [ + "ali_pay_hk_redirect" + ], "properties": { "ali_pay_hk_redirect": { "$ref": "#/components/schemas/AliPayHkRedirection" @@ -18083,7 +19663,9 @@ }, { "type": "object", - "required": ["momo_redirect"], + "required": [ + "momo_redirect" + ], "properties": { "momo_redirect": { "$ref": "#/components/schemas/MomoRedirection" @@ -18092,7 +19674,9 @@ }, { "type": "object", - "required": ["kakao_pay_redirect"], + "required": [ + "kakao_pay_redirect" + ], "properties": { "kakao_pay_redirect": { "$ref": "#/components/schemas/KakaoPayRedirection" @@ -18101,7 +19685,9 @@ }, { "type": "object", - "required": ["go_pay_redirect"], + "required": [ + "go_pay_redirect" + ], "properties": { "go_pay_redirect": { "$ref": "#/components/schemas/GoPayRedirection" @@ -18110,7 +19696,9 @@ }, { "type": "object", - "required": ["gcash_redirect"], + "required": [ + "gcash_redirect" + ], "properties": { "gcash_redirect": { "$ref": "#/components/schemas/GcashRedirection" @@ -18119,7 +19707,9 @@ }, { "type": "object", - "required": ["apple_pay"], + "required": [ + "apple_pay" + ], "properties": { "apple_pay": { "$ref": "#/components/schemas/ApplePayWalletData" @@ -18128,7 +19718,9 @@ }, { "type": "object", - "required": ["apple_pay_redirect"], + "required": [ + "apple_pay_redirect" + ], "properties": { "apple_pay_redirect": { "$ref": "#/components/schemas/ApplePayRedirectData" @@ -18137,7 +19729,9 @@ }, { "type": "object", - "required": ["apple_pay_third_party_sdk"], + "required": [ + "apple_pay_third_party_sdk" + ], "properties": { "apple_pay_third_party_sdk": { "$ref": "#/components/schemas/ApplePayThirdPartySdkData" @@ -18146,7 +19740,9 @@ }, { "type": "object", - "required": ["dana_redirect"], + "required": [ + "dana_redirect" + ], "properties": { "dana_redirect": { "type": "object", @@ -18156,7 +19752,9 @@ }, { "type": "object", - "required": ["google_pay"], + "required": [ + "google_pay" + ], "properties": { "google_pay": { "$ref": "#/components/schemas/GooglePayWalletData" @@ -18165,7 +19763,9 @@ }, { "type": "object", - "required": ["google_pay_redirect"], + "required": [ + "google_pay_redirect" + ], "properties": { "google_pay_redirect": { "$ref": "#/components/schemas/GooglePayRedirectData" @@ -18174,7 +19774,9 @@ }, { "type": "object", - "required": ["google_pay_third_party_sdk"], + "required": [ + "google_pay_third_party_sdk" + ], "properties": { "google_pay_third_party_sdk": { "$ref": "#/components/schemas/GooglePayThirdPartySdkData" @@ -18183,7 +19785,9 @@ }, { "type": "object", - "required": ["mb_way_redirect"], + "required": [ + "mb_way_redirect" + ], "properties": { "mb_way_redirect": { "$ref": "#/components/schemas/MbWayRedirection" @@ -18192,7 +19796,9 @@ }, { "type": "object", - "required": ["mobile_pay_redirect"], + "required": [ + "mobile_pay_redirect" + ], "properties": { "mobile_pay_redirect": { "$ref": "#/components/schemas/MobilePayRedirection" @@ -18201,7 +19807,9 @@ }, { "type": "object", - "required": ["paypal_redirect"], + "required": [ + "paypal_redirect" + ], "properties": { "paypal_redirect": { "$ref": "#/components/schemas/PaypalRedirection" @@ -18210,7 +19818,9 @@ }, { "type": "object", - "required": ["paypal_sdk"], + "required": [ + "paypal_sdk" + ], "properties": { "paypal_sdk": { "$ref": "#/components/schemas/PayPalWalletData" @@ -18219,7 +19829,9 @@ }, { "type": "object", - "required": ["paze"], + "required": [ + "paze" + ], "properties": { "paze": { "$ref": "#/components/schemas/PazeWalletData" @@ -18228,7 +19840,9 @@ }, { "type": "object", - "required": ["samsung_pay"], + "required": [ + "samsung_pay" + ], "properties": { "samsung_pay": { "$ref": "#/components/schemas/SamsungPayWalletData" @@ -18237,7 +19851,9 @@ }, { "type": "object", - "required": ["twint_redirect"], + "required": [ + "twint_redirect" + ], "properties": { "twint_redirect": { "type": "object", @@ -18247,7 +19863,9 @@ }, { "type": "object", - "required": ["vipps_redirect"], + "required": [ + "vipps_redirect" + ], "properties": { "vipps_redirect": { "type": "object", @@ -18257,7 +19875,9 @@ }, { "type": "object", - "required": ["touch_n_go_redirect"], + "required": [ + "touch_n_go_redirect" + ], "properties": { "touch_n_go_redirect": { "$ref": "#/components/schemas/TouchNGoRedirection" @@ -18266,7 +19886,9 @@ }, { "type": "object", - "required": ["we_chat_pay_redirect"], + "required": [ + "we_chat_pay_redirect" + ], "properties": { "we_chat_pay_redirect": { "$ref": "#/components/schemas/WeChatPayRedirection" @@ -18275,7 +19897,9 @@ }, { "type": "object", - "required": ["we_chat_pay_qr"], + "required": [ + "we_chat_pay_qr" + ], "properties": { "we_chat_pay_qr": { "$ref": "#/components/schemas/WeChatPayQr" @@ -18284,7 +19908,9 @@ }, { "type": "object", - "required": ["cashapp_qr"], + "required": [ + "cashapp_qr" + ], "properties": { "cashapp_qr": { "$ref": "#/components/schemas/CashappQr" @@ -18293,7 +19919,9 @@ }, { "type": "object", - "required": ["swish_qr"], + "required": [ + "swish_qr" + ], "properties": { "swish_qr": { "$ref": "#/components/schemas/SwishQrData" @@ -18302,7 +19930,9 @@ }, { "type": "object", - "required": ["mifinity"], + "required": [ + "mifinity" + ], "properties": { "mifinity": { "$ref": "#/components/schemas/MifinityData" @@ -18330,7 +19960,9 @@ "oneOf": [ { "type": "object", - "required": ["apple_pay"], + "required": [ + "apple_pay" + ], "properties": { "apple_pay": { "$ref": "#/components/schemas/WalletAdditionalDataForCard" @@ -18339,7 +19971,9 @@ }, { "type": "object", - "required": ["google_pay"], + "required": [ + "google_pay" + ], "properties": { "google_pay": { "$ref": "#/components/schemas/WalletAdditionalDataForCard" @@ -18360,7 +19994,11 @@ }, "WebhookDeliveryAttempt": { "type": "string", - "enum": ["initial_attempt", "automatic_retry", "manual_retry"] + "enum": [ + "initial_attempt", + "automatic_retry", + "manual_retry" + ] }, "WebhookDetails": { "type": "object", @@ -18499,4 +20137,4 @@ "description": "Manage events" } ] -} +} \ No newline at end of file