mirror of
https://github.com/juspay/hyperswitch.git
synced 2025-10-29 00:49:42 +08:00
feat(payment_method_session): implement payment methods session confirm (#7248)
Co-authored-by: Sanchith Hegde <sanchith.hegde@juspay.in> Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Anurag Thakur <anurag.thakur@juspay.in> Co-authored-by: Pa1NarK <69745008+pixincreate@users.noreply.github.com> Co-authored-by: Shankar Singh C <83439957+ShankarSinghC@users.noreply.github.com> Co-authored-by: Sai Harsha Vardhan <56996463+sai-harsha-vardhan@users.noreply.github.com> Co-authored-by: hrithikesh026 <hrithikesh.vm@juspay.in> Co-authored-by: Debarati Ghatak <88573135+cookieg13@users.noreply.github.com> Co-authored-by: awasthi21 <107559116+awasthi21@users.noreply.github.com> Co-authored-by: Gnanasundari24 <118818938+Gnanasundari24@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Arindam Sahoo <88739246+arindam-sahoo@users.noreply.github.com> Co-authored-by: Arindam Sahoo <arindam.sahoo@Arindam-Sahoo-F565040VFJ.local> Co-authored-by: Sakil Mostak <73734619+Sakilmostak@users.noreply.github.com> Co-authored-by: AkshayaFoiger <131388445+AkshayaFoiger@users.noreply.github.com> Co-authored-by: Riddhiagrawal001 <50551695+Riddhiagrawal001@users.noreply.github.com> Co-authored-by: Suman Maji <77887221+sumanmaji4@users.noreply.github.com> Co-authored-by: Sandeep Kumar <83278309+tsdk02@users.noreply.github.com> Co-authored-by: Debarshi Gupta <debarshigupta47@gmail.com> Co-authored-by: Debarshi Gupta <debarshi.gupta@Debarshi-Gupta-CM92YWDXFD.local> Co-authored-by: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> Co-authored-by: Swangi Kumari <85639103+swangi-kumari@users.noreply.github.com> Co-authored-by: pranav-arjunan <pranav.arjunan@juspay.in> Co-authored-by: Kashif <kashif.dev@protonmail.com> Co-authored-by: Sagnik Mitra <83326850+ImSagnik007@users.noreply.github.com> Co-authored-by: sweta-kumari-sharma <77436883+Sweta-Kumari-Sharma@users.noreply.github.com> Co-authored-by: shivansh.mathur <shivansh.mathur@juspay.in>
This commit is contained in:
Narayan Bhat
@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /v2/payment-method-session/:id/confirm
|
||||
---
|
||||
@ -66,7 +66,8 @@
|
||||
"api-reference/payment-method-session/payment-method-session--create",
|
||||
"api-reference/payment-method-session/payment-method-session--retrieve",
|
||||
"api-reference/payment-method-session/payment-method-session--list-payment-methods",
|
||||
"api-reference/payment-method-session/payment-method-session--update-a-saved-payment-method"
|
||||
"api-reference/payment-method-session/payment-method-session--update-a-saved-payment-method",
|
||||
"api-reference/payment-method-session/payment-method-session--confirm-a-payment-method-session"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
@ -2005,7 +2005,7 @@
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaymentsConfirmIntentResponse"
|
||||
"$ref": "#/components/schemas/PaymentsResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -2055,7 +2055,7 @@
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaymentsRetrieveResponse"
|
||||
"$ref": "#/components/schemas/PaymentsResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -2905,7 +2905,7 @@
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaymentMethodsSessionResponse"
|
||||
"$ref": "#/components/schemas/PaymentMethodSessionResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -2946,7 +2946,7 @@
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaymentMethodsSessionResponse"
|
||||
"$ref": "#/components/schemas/PaymentMethodSessionResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -3066,6 +3066,83 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v2/payment-method-session/:id/confirm": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Payment Method Session"
|
||||
],
|
||||
"summary": "Payment Method Session - Confirm a payment method session",
|
||||
"description": "**Confirms a payment method session object with the payment method data**",
|
||||
"operationId": "Confirm the payment method session",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"description": "The unique identifier for the Payment Method Session",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "X-Profile-Id",
|
||||
"in": "header",
|
||||
"description": "Profile ID associated to the payment intent",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "pro_abcdefghijklmnop"
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaymentMethodSessionConfirmRequest"
|
||||
},
|
||||
"examples": {
|
||||
"Confirm the payment method session with card details": {
|
||||
"value": {
|
||||
"payment_method_data": {
|
||||
"card": {
|
||||
"card_cvc": "123",
|
||||
"card_exp_month": "10",
|
||||
"card_exp_year": "25",
|
||||
"card_number": "4242424242424242"
|
||||
}
|
||||
},
|
||||
"payment_method_subtype": "credit",
|
||||
"payment_method_type": "card"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Payment Method created",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaymentMethodResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Missing Mandatory fields"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"publishable_key": []
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v2/refunds": {
|
||||
"post": {
|
||||
"tags": [
|
||||
@ -6735,7 +6812,8 @@
|
||||
"card_exp_month",
|
||||
"card_exp_year",
|
||||
"card_holder_name",
|
||||
"card_issuing_country"
|
||||
"card_issuing_country",
|
||||
"card_cvc"
|
||||
],
|
||||
"properties": {
|
||||
"card_number": {
|
||||
@ -6787,6 +6865,11 @@
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"card_cvc": {
|
||||
"type": "string",
|
||||
"description": "The CVC number for the card\nThis is optional in case the card needs to be vaulted",
|
||||
"example": "242"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
@ -7637,6 +7720,11 @@
|
||||
"type": "string",
|
||||
"description": "A token that can be used to make payments directly with the connector.",
|
||||
"example": "pm_9UhMqBMEOooRIvJFFdeW"
|
||||
},
|
||||
"connector_token_request_reference_id": {
|
||||
"type": "string",
|
||||
"description": "The reference id sent to the connector when creating the token",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -13013,7 +13101,7 @@
|
||||
]
|
||||
},
|
||||
"object": {
|
||||
"$ref": "#/components/schemas/PaymentsRetrieveResponse"
|
||||
"$ref": "#/components/schemas/PaymentsResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -14240,6 +14328,14 @@
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"psp_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PspTokenization"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"network_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
@ -14988,6 +15084,7 @@
|
||||
"last_used_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "A timestamp (ISO 8601 code) that determines when the payment method was last used",
|
||||
"example": "2024-02-24T11:04:09.922Z",
|
||||
"nullable": true
|
||||
},
|
||||
@ -14998,6 +15095,14 @@
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"connector_tokens": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/ConnectorTokenDetails"
|
||||
},
|
||||
"description": "The connector token details if available",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -15016,6 +15121,30 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"PaymentMethodSessionConfirmRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"payment_method_type",
|
||||
"payment_method_subtype",
|
||||
"payment_method_data"
|
||||
],
|
||||
"properties": {
|
||||
"payment_method_type": {
|
||||
"$ref": "#/components/schemas/PaymentMethod"
|
||||
},
|
||||
"payment_method_subtype": {
|
||||
"$ref": "#/components/schemas/PaymentMethodType"
|
||||
},
|
||||
"payment_method_data": {
|
||||
"$ref": "#/components/schemas/PaymentMethodDataRequest"
|
||||
},
|
||||
"return_url": {
|
||||
"type": "string",
|
||||
"description": "The return url to which the customer should be redirected to after adding the payment method",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentMethodSessionRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -15035,6 +15164,11 @@
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"return_url": {
|
||||
"type": "string",
|
||||
"description": "The return url to which the customer should be redirected to after adding the payment method",
|
||||
"nullable": true
|
||||
},
|
||||
"psp_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
@ -15062,6 +15196,73 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentMethodSessionResponse": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"customer_id",
|
||||
"expires_at",
|
||||
"client_secret"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"example": "12345_pms_01926c58bc6e77c09e809964e72af8c8"
|
||||
},
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "The customer id for which the payment methods session is to be created",
|
||||
"example": "12345_cus_01926c58bc6e77c09e809964e72af8c8"
|
||||
},
|
||||
"billing": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Address"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"psp_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PspTokenization"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"network_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/NetworkTokenization"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"expires_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The iso timestamp when the session will expire\nTrying to retrieve the session or any operations on the session after this time will result in an error",
|
||||
"example": "2023-01-18T11:04:09.922Z"
|
||||
},
|
||||
"client_secret": {
|
||||
"type": "string",
|
||||
"description": "Client Secret"
|
||||
},
|
||||
"return_url": {
|
||||
"type": "string",
|
||||
"description": "The return url to which the user should be redirected to",
|
||||
"nullable": true
|
||||
},
|
||||
"associated_payment": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PaymentsResponse"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentMethodSessionUpdateSavedPaymentMethod": {
|
||||
"allOf": [
|
||||
{
|
||||
@ -15237,12 +15438,22 @@
|
||||
},
|
||||
"PaymentMethodUpdate": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"payment_method_data"
|
||||
],
|
||||
"properties": {
|
||||
"payment_method_data": {
|
||||
"$ref": "#/components/schemas/PaymentMethodUpdateData"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PaymentMethodUpdateData"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"connector_token_details": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/ConnectorTokenDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
@ -15337,6 +15548,35 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentMethodsSessionUpdateRequest": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"billing": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Address"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"psp_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PspTokenization"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"network_tokenization": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/NetworkTokenization"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentProcessingDetails": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -15574,137 +15814,15 @@
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payment_method_id": {
|
||||
"type": "string",
|
||||
"description": "The payment_method_id to be associated with the payment",
|
||||
"nullable": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"PaymentsConfirmIntentResponse": {
|
||||
"type": "object",
|
||||
"description": "Response for Payment Intent Confirm",
|
||||
"required": [
|
||||
"id",
|
||||
"status",
|
||||
"amount",
|
||||
"customer_id",
|
||||
"connector",
|
||||
"client_secret",
|
||||
"created",
|
||||
"payment_method_type",
|
||||
"payment_method_subtype",
|
||||
"merchant_connector_id",
|
||||
"applied_authentication_type"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant.",
|
||||
"example": "12345_pay_01926c58bc6e77c09e809964e72af8c8",
|
||||
"maxLength": 64,
|
||||
"minLength": 32
|
||||
},
|
||||
"status": {
|
||||
"$ref": "#/components/schemas/IntentStatus"
|
||||
},
|
||||
"amount": {
|
||||
"$ref": "#/components/schemas/PaymentAmountDetailsResponse"
|
||||
},
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the customer",
|
||||
"example": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
|
||||
"maxLength": 64,
|
||||
"minLength": 32
|
||||
},
|
||||
"connector": {
|
||||
"type": "string",
|
||||
"description": "The connector used for the payment",
|
||||
"example": "stripe"
|
||||
},
|
||||
"client_secret": {
|
||||
"type": "string",
|
||||
"description": "It's a token used for client side verification."
|
||||
},
|
||||
"created": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Time when the payment was created",
|
||||
"example": "2022-09-10T10:11:12Z"
|
||||
},
|
||||
"payment_method_data": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PaymentMethodDataResponseWithBilling"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payment_method_type": {
|
||||
"$ref": "#/components/schemas/PaymentMethod"
|
||||
},
|
||||
"payment_method_subtype": {
|
||||
"$ref": "#/components/schemas/PaymentMethodType"
|
||||
},
|
||||
"next_action": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/NextActionData"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"connector_transaction_id": {
|
||||
"type": "string",
|
||||
"description": "A unique identifier for a payment provided by the connector",
|
||||
"example": "993672945374576J",
|
||||
"nullable": true
|
||||
},
|
||||
"connector_reference_id": {
|
||||
"type": "string",
|
||||
"description": "reference(Identifier) to the payment at connector side",
|
||||
"example": "993672945374576J",
|
||||
"nullable": true
|
||||
},
|
||||
"connector_token_details": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/ConnectorTokenDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"merchant_connector_id": {
|
||||
"type": "string",
|
||||
"description": "Identifier of the connector ( merchant connector account ) which was chosen to make the payment"
|
||||
},
|
||||
"browser_info": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/BrowserInformation"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"error": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/ErrorDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"authentication_type": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/AuthenticationType"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"applied_authentication_type": {
|
||||
"$ref": "#/components/schemas/AuthenticationType"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentsCreateIntentRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -16659,146 +16777,18 @@
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payment_method_id": {
|
||||
"type": "string",
|
||||
"description": "The payment_method_id to be associated with the payment",
|
||||
"nullable": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"PaymentsResponse": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id",
|
||||
"status",
|
||||
"amount",
|
||||
"customer_id",
|
||||
"connector",
|
||||
"client_secret",
|
||||
"created",
|
||||
"payment_method_type",
|
||||
"payment_method_subtype",
|
||||
"merchant_connector_id"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant.",
|
||||
"example": "12345_pay_01926c58bc6e77c09e809964e72af8c8",
|
||||
"maxLength": 64,
|
||||
"minLength": 32
|
||||
},
|
||||
"status": {
|
||||
"$ref": "#/components/schemas/IntentStatus"
|
||||
},
|
||||
"amount": {
|
||||
"$ref": "#/components/schemas/PaymentAmountDetailsResponse"
|
||||
},
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the customer",
|
||||
"example": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
|
||||
"maxLength": 64,
|
||||
"minLength": 32
|
||||
},
|
||||
"connector": {
|
||||
"type": "string",
|
||||
"description": "The connector used for the payment",
|
||||
"example": "stripe"
|
||||
},
|
||||
"client_secret": {
|
||||
"type": "string",
|
||||
"description": "It's a token used for client side verification."
|
||||
},
|
||||
"created": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "Time when the payment was created",
|
||||
"example": "2022-09-10T10:11:12Z"
|
||||
},
|
||||
"payment_method_data": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/PaymentMethodDataResponseWithBilling"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payment_method_type": {
|
||||
"$ref": "#/components/schemas/PaymentMethod"
|
||||
},
|
||||
"payment_method_subtype": {
|
||||
"$ref": "#/components/schemas/PaymentMethodType"
|
||||
},
|
||||
"next_action": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/NextActionData"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"connector_transaction_id": {
|
||||
"type": "string",
|
||||
"description": "A unique identifier for a payment provided by the connector",
|
||||
"example": "993672945374576J",
|
||||
"nullable": true
|
||||
},
|
||||
"connector_reference_id": {
|
||||
"type": "string",
|
||||
"description": "reference(Identifier) to the payment at connector side",
|
||||
"example": "993672945374576J",
|
||||
"nullable": true
|
||||
},
|
||||
"connector_token_details": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/ConnectorTokenDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"merchant_connector_id": {
|
||||
"type": "string",
|
||||
"description": "Identifier of the connector ( merchant connector account ) which was chosen to make the payment"
|
||||
},
|
||||
"browser_info": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/BrowserInformation"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"error": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/ErrorDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentsRetrieveRequest": {
|
||||
"type": "object",
|
||||
"description": "Request for Payment Status",
|
||||
"properties": {
|
||||
"force_sync": {
|
||||
"type": "boolean",
|
||||
"description": "A boolean used to indicate if the payment status should be fetched from the connector\nIf this is set to true, the status will be fetched from the connector"
|
||||
},
|
||||
"expand_attempts": {
|
||||
"type": "boolean",
|
||||
"description": "A boolean used to indicate if all the attempts needs to be fetched for the intent.\nIf this is set to true, attempts list will be available in the response."
|
||||
},
|
||||
"param": {
|
||||
"type": "string",
|
||||
"description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentsRetrieveResponse": {
|
||||
"type": "object",
|
||||
"description": "Response for Payment Intent Confirm",
|
||||
"description": "Response for Payment Intent Confirm\nFew fields should be expandable, we need not return these in the normal response\nBut when explictly requested for expanded objects, these can be returned\nFor example\nshipping, billing, customer, payment_method",
|
||||
"required": [
|
||||
"id",
|
||||
"status",
|
||||
@ -16924,6 +16914,69 @@
|
||||
},
|
||||
"description": "List of payment attempts associated with payment intent",
|
||||
"nullable": true
|
||||
},
|
||||
"connector_token_details": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/ConnectorTokenDetails"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"payment_method_id": {
|
||||
"type": "string",
|
||||
"description": "The payment_method_id associated with the payment",
|
||||
"nullable": true
|
||||
},
|
||||
"next_action": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/NextActionData"
|
||||
}
|
||||
],
|
||||
"nullable": true
|
||||
},
|
||||
"return_url": {
|
||||
"type": "string",
|
||||
"description": "The url to which user must be redirected to after completion of the purchase",
|
||||
"nullable": true
|
||||
},
|
||||
"authentication_type": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/AuthenticationType"
|
||||
}
|
||||
],
|
||||
"default": "no_three_ds",
|
||||
"nullable": true
|
||||
},
|
||||
"authentication_type_applied": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/AuthenticationType"
|
||||
}
|
||||
],
|
||||
"default": "no_three_ds",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaymentsRetrieveRequest": {
|
||||
"type": "object",
|
||||
"description": "Request for Payment Status",
|
||||
"properties": {
|
||||
"force_sync": {
|
||||
"type": "boolean",
|
||||
"description": "A boolean used to indicate if the payment status should be fetched from the connector\nIf this is set to true, the status will be fetched from the connector"
|
||||
},
|
||||
"expand_attempts": {
|
||||
"type": "boolean",
|
||||
"description": "A boolean used to indicate if all the attempts needs to be fetched for the intent.\nIf this is set to true, attempts list will be available in the response."
|
||||
},
|
||||
"param": {
|
||||
"type": "string",
|
||||
"description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -18912,8 +18965,7 @@
|
||||
"type": "object",
|
||||
"description": "The Payment Service Provider Configuration for payment methods that are created using the payment method session",
|
||||
"required": [
|
||||
"tokenization_type",
|
||||
"connector_id"
|
||||
"tokenization_type"
|
||||
],
|
||||
"properties": {
|
||||
"tokenization_type": {
|
||||
@ -18921,7 +18973,8 @@
|
||||
},
|
||||
"connector_id": {
|
||||
"type": "string",
|
||||
"description": "The merchant connector id to be used for tokenization"
|
||||
"description": "The merchant connector id to be used for tokenization",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user