mirror of
https://github.com/juspay/hyperswitch.git
synced 2025-10-29 00:49:42 +08:00
refactor(core): Adapt the usage of routing_algorithm_id in routing and payments core for v2 (#5533)
Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
This commit is contained in:
Amisha Prabhat
@ -13299,19 +13299,7 @@
|
||||
}
|
||||
},
|
||||
"PayoutActionRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"payout_id"
|
||||
],
|
||||
"properties": {
|
||||
"payout_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
|
||||
"example": "payout_mbabizu24mvu3mela5njyhpit4",
|
||||
"maxLength": 30,
|
||||
"minLength": 30
|
||||
}
|
||||
}
|
||||
"type": "object"
|
||||
},
|
||||
"PayoutAttemptResponse": {
|
||||
"type": "object",
|
||||
@ -13443,23 +13431,11 @@
|
||||
},
|
||||
"PayoutCreateRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"currency",
|
||||
"confirm",
|
||||
"payout_type",
|
||||
"auto_fulfill",
|
||||
"client_secret",
|
||||
"return_url",
|
||||
"business_country",
|
||||
"description",
|
||||
"entity_type",
|
||||
"priority"
|
||||
],
|
||||
"properties": {
|
||||
"payout_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response, **not required to be included in the Payout Create/Update Request.**",
|
||||
"example": "payout_mbabizu24mvu3mela5njyhpit4",
|
||||
"example": "187282ab-40ef-47a9-9206-5099ba31e432",
|
||||
"nullable": true,
|
||||
"maxLength": 30,
|
||||
"minLength": 30
|
||||
@ -13475,10 +13451,17 @@
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
|
||||
"example": 1000
|
||||
"example": 1000,
|
||||
"nullable": true,
|
||||
"minimum": 0
|
||||
},
|
||||
"currency": {
|
||||
"$ref": "#/components/schemas/Currency"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Currency"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"routing": {
|
||||
"allOf": [
|
||||
@ -13504,10 +13487,16 @@
|
||||
"type": "boolean",
|
||||
"description": "This field is used when merchant wants to confirm the payout, thus useful for the payout _Confirm_ request. Ideally merchants should _Create_ a payout, _Update_ it (if required), then _Confirm_ it.",
|
||||
"default": false,
|
||||
"example": true
|
||||
"example": true,
|
||||
"nullable": true
|
||||
},
|
||||
"payout_type": {
|
||||
"$ref": "#/components/schemas/PayoutType"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PayoutType"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payout_method_data": {
|
||||
"allOf": [
|
||||
@ -13518,77 +13507,76 @@
|
||||
"nullable": true
|
||||
},
|
||||
"billing": {
|
||||
"type": "object",
|
||||
"description": "The billing address for the payout",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Address"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.",
|
||||
"example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"auto_fulfill": {
|
||||
"type": "boolean",
|
||||
"description": "Set to true to confirm the payout without review, no further action required",
|
||||
"default": false,
|
||||
"example": true
|
||||
"example": true,
|
||||
"nullable": true
|
||||
},
|
||||
"email": {
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "description: The customer's email address",
|
||||
"example": "johntest@test.com",
|
||||
"description": "The identifier for the customer object. If not provided the customer ID will be autogenerated. _Deprecated: Use customer_id instead._",
|
||||
"deprecated": true,
|
||||
"example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "description: The customer's name",
|
||||
"example": "John Test",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone": {
|
||||
"type": "string",
|
||||
"description": "The customer's phone number",
|
||||
"example": "9123456789",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone_country_code": {
|
||||
"type": "string",
|
||||
"description": "The country code for the customer phone number",
|
||||
"example": "+1",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
"customer": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/CustomerDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"client_secret": {
|
||||
"type": "string",
|
||||
"description": "It's a token used for client side verification.",
|
||||
"example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo"
|
||||
"example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
|
||||
"nullable": true
|
||||
},
|
||||
"return_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to redirect after the completion of the operation",
|
||||
"example": "https://hyperswitch.io"
|
||||
"example": "https://hyperswitch.io",
|
||||
"nullable": true
|
||||
},
|
||||
"business_country": {
|
||||
"$ref": "#/components/schemas/CountryAlpha2"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/CountryAlpha2"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"business_label": {
|
||||
"type": "string",
|
||||
"description": "Business label of the merchant for this payout",
|
||||
"description": "Business label of the merchant for this payout. _Deprecated: Use profile_id instead._",
|
||||
"deprecated": true,
|
||||
"example": "food",
|
||||
"nullable": true
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "A description of the payout",
|
||||
"example": "It's my first payout request"
|
||||
"example": "It's my first payout request",
|
||||
"nullable": true
|
||||
},
|
||||
"entity_type": {
|
||||
"$ref": "#/components/schemas/PayoutEntityType"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PayoutEntityType"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"recurring": {
|
||||
"type": "boolean",
|
||||
@ -13613,7 +13601,12 @@
|
||||
"nullable": true
|
||||
},
|
||||
"priority": {
|
||||
"$ref": "#/components/schemas/PayoutSendPriority"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PayoutSendPriority"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payout_link": {
|
||||
"type": "boolean",
|
||||
@ -13637,6 +13630,38 @@
|
||||
"example": 900,
|
||||
"nullable": true,
|
||||
"minimum": 0
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"description": "Customer's email. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "johntest@test.com",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Customer's name. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "John Test",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone": {
|
||||
"type": "string",
|
||||
"description": "Customer's phone. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "9123456789",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone_country_code": {
|
||||
"type": "string",
|
||||
"description": "Customer's phone country code. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "+1",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
@ -13648,23 +13673,21 @@
|
||||
"merchant_id",
|
||||
"amount",
|
||||
"currency",
|
||||
"customer_id",
|
||||
"auto_fulfill",
|
||||
"customer_id",
|
||||
"client_secret",
|
||||
"return_url",
|
||||
"business_country",
|
||||
"description",
|
||||
"entity_type",
|
||||
"recurring",
|
||||
"status",
|
||||
"error_message",
|
||||
"error_code",
|
||||
"profile_id"
|
||||
],
|
||||
"properties": {
|
||||
"payout_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
|
||||
"example": "payout_mbabizu24mvu3mela5njyhpit4",
|
||||
"example": "187282ab-40ef-47a9-9206-5099ba31e432",
|
||||
"maxLength": 30,
|
||||
"minLength": 30
|
||||
},
|
||||
@ -13702,45 +13725,25 @@
|
||||
"description": "The billing address for the payout",
|
||||
"nullable": true
|
||||
},
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.",
|
||||
"example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
|
||||
"maxLength": 255
|
||||
},
|
||||
"auto_fulfill": {
|
||||
"type": "boolean",
|
||||
"description": "Set to true to confirm the payout without review, no further action required",
|
||||
"default": false,
|
||||
"example": true
|
||||
},
|
||||
"email": {
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "description: The customer's email address",
|
||||
"example": "johntest@test.com",
|
||||
"nullable": true,
|
||||
"description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.",
|
||||
"example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
|
||||
"maxLength": 255
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "description: The customer's name",
|
||||
"example": "John Test",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone": {
|
||||
"type": "string",
|
||||
"description": "The customer's phone number",
|
||||
"example": "9123456789",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone_country_code": {
|
||||
"type": "string",
|
||||
"description": "The country code for the customer phone number",
|
||||
"example": "+1",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
"customer": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/CustomerDetailsResponse"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"client_secret": {
|
||||
"type": "string",
|
||||
@ -13764,7 +13767,8 @@
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "A description of the payout",
|
||||
"example": "It's my first payout request"
|
||||
"example": "It's my first payout request",
|
||||
"nullable": true
|
||||
},
|
||||
"entity_type": {
|
||||
"$ref": "#/components/schemas/PayoutEntityType"
|
||||
@ -13772,8 +13776,7 @@
|
||||
"recurring": {
|
||||
"type": "boolean",
|
||||
"description": "Specifies whether or not the payout request is recurring",
|
||||
"default": false,
|
||||
"nullable": true
|
||||
"default": false
|
||||
},
|
||||
"metadata": {
|
||||
"type": "object",
|
||||
@ -13786,12 +13789,14 @@
|
||||
"error_message": {
|
||||
"type": "string",
|
||||
"description": "If there was an error while calling the connector the error message is received here",
|
||||
"example": "Failed while verifying the card"
|
||||
"example": "Failed while verifying the card",
|
||||
"nullable": true
|
||||
},
|
||||
"error_code": {
|
||||
"type": "string",
|
||||
"description": "If there was an error while calling the connectors the code is received here",
|
||||
"example": "E0001"
|
||||
"example": "E0001",
|
||||
"nullable": true
|
||||
},
|
||||
"profile_id": {
|
||||
"type": "string",
|
||||
@ -13833,6 +13838,38 @@
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"description": "Customer's email. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "johntest@test.com",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "Customer's name. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "John Test",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone": {
|
||||
"type": "string",
|
||||
"description": "Customer's phone. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "9123456789",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
},
|
||||
"phone_country_code": {
|
||||
"type": "string",
|
||||
"description": "Customer's phone country code. _Deprecated: Use customer object instead._",
|
||||
"deprecated": true,
|
||||
"example": "+1",
|
||||
"nullable": true,
|
||||
"maxLength": 255
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
@ -13950,7 +13987,7 @@
|
||||
"payout_id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for payout",
|
||||
"example": "payout_mbabizu24mvu3mela5njyhpit4",
|
||||
"example": "187282ab-40ef-47a9-9206-5099ba31e432",
|
||||
"nullable": true,
|
||||
"maxLength": 30,
|
||||
"minLength": 30
|
||||
@ -14142,7 +14179,7 @@
|
||||
"payout_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
|
||||
"example": "payout_mbabizu24mvu3mela5njyhpit4",
|
||||
"example": "187282ab-40ef-47a9-9206-5099ba31e432",
|
||||
"maxLength": 30,
|
||||
"minLength": 30
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user