Skip to main content

API Change Log - Payment

🧩 Service: Payment​

🔧 Operation: getBrandPaymentGatewayConfig​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.parameters.3.required

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.aggregators.items.properties
  • New Schema:
{
"is_active": {
"type": "boolean"
},
"config_type": {
"type": "string",
"x-not-enum": true
},
"display": {
"$ref": "#/components/schemas/DisplayDetails"
},
"aggregator": {
"type": "string"
},
"logo": {
"type": "string"
},
"display_name": {
"type": "string"
}
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorCodeDescription
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.description

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorCodeDescription
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.code

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error message"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/ErrorCodeAndDescription"
}

🔹 Change 8​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0
  • New Schema:
"error"

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorCodeDescription
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.500

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBrandPaymentGatewayConfig.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: saveBrandPaymentGatewayConfig​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayConfigRequest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.aggregator_name

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayConfigCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.ccavenue
  • New Schema:
{
"$ref": "#/components/schemas/PaymentGatewayConfig"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayConfigCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.razorpay
  • New Schema:
{
"$ref": "#/components/schemas/PaymentGatewayConfig"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayConfigCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.juspay
  • New Schema:
{
"$ref": "#/components/schemas/PaymentGatewayConfig"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayToBeReviewed
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.aggregator

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayToBeReviewed
  • Schema Action: PROPERTY_ADDED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.aggregators
  • New Schema:
{
"type": "array",
"description": "List of added payment gateway",
"items": {
"type": "string"
}
}

🔹 Change 7​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentGatewayToBeReviewed
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.required.0
  • New Schema:
"aggregators"

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error message"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.responses.500

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveBrandPaymentGatewayConfig.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getPaymentModeRoutes​

🔹 Change 1​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.parameters.6.required
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList --> ProductCODData
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.product_cod_data.nullable
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.logo
  • New Schema:
{
"type": "string"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.bank_name
  • New Schema:
{
"type": "string"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.bank_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.url
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.wallet_name
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.wallet_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.wallet_id
  • New Schema:
{
"type": "integer"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.collect_flow
  • New Schema:
{
"type": "boolean"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.provider
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.meta
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.payment_mode_id
  • New Schema:
{
"type": "integer",
"nullable": true,
"description": "payment mode id"
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.logo_url
  • New Schema:
{
"$ref": "#/components/schemas/PaymentModeLogo"
}

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.version
  • New Schema:
{
"$ref": "#/components/schemas/Version"
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.meta
  • New Schema:
{
"$ref": "#/components/schemas/PaymentOptionsMeta"
}

🔹 Change 17​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 20​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 21​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.responses.500

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeRoutes.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: getAllPayouts​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PayoutsResponse --> Payout
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getAllPayouts.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.2

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getAllPayouts.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAllPayouts.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getAllPayouts.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getAllPayouts.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllPayouts.methodTypePlaceHolder.responses.500

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getAllPayouts.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/finance/read"
]
}
]

🔧 Operation: savePayout​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.savePayout.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.users.properties
  • New Schema:
{
"unique_external_id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"mobile": {
"type": "string"
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.savePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users.properties
  • New Schema:
{
"unique_external_id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"mobile": {
"type": "string"
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.savePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.bank_details.properties
  • New Schema:
{
"ifsc_code": {
"x-not-enum": true,
"type": "string"
},
"account_holder": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"account_type": {
"x-not-enum": true,
"type": "string"
},
"account_no": {
"type": "string"
},
"city": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"branch_name": {
"type": "string"
},
"pincode": {
"type": "integer",
"format": "int32"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PayoutDetails --> PayoutBankDetails
  • Schema Action: REQUIRED_ADDED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.bank_details.required
  • New Schema:
[
"account_type",
"ifsc_code"
]

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.savePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payouts.properties
  • New Schema:
{
"more_attributes": {
"$ref": "#/components/schemas/BankDetails"
},
"aggregator_fund_id": {
"type": "string",
"nullable": true
}
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PayoutResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.required.4

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PayoutResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage --> EDCError
  • Schema Action: PROPERTY_ADDED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.error
  • New Schema:
{
"type": "string",
"description": "Error human understandable description."
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Response message"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.data
  • New Schema:
{
"$ref": "#/components/schemas/IFSCErrorData"
}

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.savePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.savePayout.methodTypePlaceHolder.responses.500

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.savePayout.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/finance/write"
]
}
]

🔧 Operation: updatePayout​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePayout.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.users.properties
  • New Schema:
{
"unique_external_id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"mobile": {
"type": "string"
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.bank_details
  • New Schema:
{
"$ref": "#/components/schemas/PayoutBankDetails"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.transfer_type
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.aggregator
  • New Schema:
{
"type": "string"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users
  • New Schema:
{
"$ref": "#/components/schemas/PayoutUserDetails"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.unique_transfer_no
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated
  • New Schema:
{
"type": "boolean"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_status
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payouts
  • New Schema:
{
"$ref": "#/components/schemas/Payouts"
}

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.required.0

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePayout.methodTypePlaceHolder.responses.500

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePayout.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/finance/write"
]
}
]

🔧 Operation: activateAndDectivatePayout​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.requestBody.content.application/json.schema.required.1

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.bank_details
  • New Schema:
{
"$ref": "#/components/schemas/PayoutBankDetails"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.transfer_type
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.aggregator
  • New Schema:
{
"type": "string"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.users
  • New Schema:
{
"$ref": "#/components/schemas/PayoutUserDetails"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.unique_transfer_no
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated
  • New Schema:
{
"type": "boolean"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_status
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payouts
  • New Schema:
{
"$ref": "#/components/schemas/Payouts"
}

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.required.0

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: UpdatePayoutResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.responses.500

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.activateAndDectivatePayout.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/finance/write"
]
}
]

🔧 Operation: deletePayout​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DeletePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.delete
  • New Schema:
{
"type": "boolean",
"description": "delete is successful or not"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: DeletePayoutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.unique_transfer_no
  • New Schema:
{
"type": "string",
"description": "unique transafer no of payout"
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deletePayout.methodTypePlaceHolder.responses.500

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deletePayout.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/finance/write"
]
}
]

🔧 Operation: getSubscriptionPaymentMethod​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getSubscriptionPaymentMethod

🔧 Operation: deleteSubscriptionPaymentMethod​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.deleteSubscriptionPaymentMethod

🔧 Operation: getSubscriptionConfig​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getSubscriptionConfig

🔧 Operation: saveSubscriptionSetupIntent​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.saveSubscriptionSetupIntent

🔧 Operation: getBankAccountDetailsOpenAPI​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBankAccountDetailsOpenAPI.methodTypePlaceHolder.parameters.1.required

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetRefundAccountDetails
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getBankAccountDetailsOpenAPI.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.type
  • New Schema:
"array"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetRefundAccountDetails
  • Schema Action: ITEMS_ADDED
  • Path: paths.getBankAccountDetailsOpenAPI.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items
  • New Schema:
{
"$ref": "#/components/schemas/BankDetailsForOTP"
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBankAccountDetailsOpenAPI.methodTypePlaceHolder.responses.500

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getBankAccountDetailsOpenAPI.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: addRefundBankAccountUsingOTP​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation --> BankDetailsForOTP
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.details.properties.address
  • New Schema:
{
"type": "string",
"description": "address of account"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation --> BankDetailsForOTP
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.details.properties.comment
  • New Schema:
{
"type": "string",
"description": "comment for account"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation --> BankDetailsForOTP
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.details.properties.email
  • New Schema:
{
"type": "string",
"description": "email address of account"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation --> BankDetailsForOTP
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.details.properties.mobile
  • New Schema:
{
"type": "string",
"description": "mobile number of account"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation --> BankDetailsForOTP
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.details.properties.beneficiary_id
  • New Schema:
{
"type": "string",
"description": "beneficiary id of account"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.transfer_mode
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.shipment_id
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AddBeneficiaryDetailsOTPCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.delights
  • New Schema:
{
"type": "boolean"
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundAccountResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.responses.500

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addRefundBankAccountUsingOTP.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: verifyIfscCode​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyIfscCode.methodTypePlaceHolder.responses.400

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyIfscCode.methodTypePlaceHolder.responses.500

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyIfscCode.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"company/finance/read"
]
}
]

🔧 Operation: getUserOrderBeneficiaries​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.mobile.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.aggregator_id
  • New Schema:
{
"type": "integer",
"nullable": true
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.is_verified
  • New Schema:
{
"type": "boolean",
"nullable": true
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.status
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.txn_id
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.meta
  • New Schema:
{
"type": "object",
"nullable": true,
"additionalProperties": true
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.default_beneficiary
  • New Schema:
{
"type": "boolean",
"nullable": true
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.bank
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderBeneficiaryDetails"
}
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.400

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.responses.500

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserOrderBeneficiaries.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: getUserBeneficiaries​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.mobile.nullable
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.aggregator_id
  • New Schema:
{
"type": "integer",
"nullable": true
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.is_verified
  • New Schema:
{
"type": "boolean",
"nullable": true
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.status
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.txn_id
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.meta
  • New Schema:
{
"type": "object",
"nullable": true,
"additionalProperties": true
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults --> OrderBeneficiaryDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.beneficiaries.items.properties.default_beneficiary
  • New Schema:
{
"type": "boolean",
"nullable": true
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: OrderBeneficiaryFetchResults
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.bank
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderBeneficiaryDetails"
}
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.description

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.code

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Response message"
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.data
  • New Schema:
{
"$ref": "#/components/schemas/IFSCErrorData"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/EDCError"
}

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.responses.500

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserBeneficiaries.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: confirmPayment​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentConfirmationCreation --> MultiTenderPaymentMethod --> MultiTenderPaymentMeta
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.confirmPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_methods.items.properties.meta.properties.extra_meta.additionalProperties
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentConfirmationCreation --> MultiTenderPaymentMethod --> MultiTenderPaymentMeta
  • Schema Action: PROPERTY_ADDED
  • Path: paths.confirmPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_methods.items.properties.meta.properties.key
  • New Schema:
{
"type": "string",
"description": "Specifies the name or identifier of the payment gateway. This will deprecated in future version. We recommend switching to `payment_gateway_slug` to ensure uninterrupted payment processing."
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentConfirmationDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.confirmPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.errors
  • New Schema:
{
"type": "string"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentConfirmationDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.confirmPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.return_url
  • New Schema:
{
"type": "string"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentConfirmationResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.confirmPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.confirmPayment.methodTypePlaceHolder.responses.400

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.confirmPayment.methodTypePlaceHolder.responses.500

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.confirmPayment.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getUserCODlimitRoutes​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.business_unit

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.is_active

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.usages

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.user_id

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.merchant_user_id

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.remaining_limit

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.limit

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitDetails --> GetUserBULimitDetails --> UserPaymentLimitConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.advance
  • New Schema:
{
"$ref": "#/components/schemas/AdvancePaymentLimitConfig"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitDetails --> GetUserBULimitDetails --> UserPaymentLimitConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.properties.cod
  • New Schema:
{
"$ref": "#/components/schemas/CODPaymentLimitConfig"
}

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse --> CODPaymentLimitConfig
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.config.required

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitDetails --> GetUserBULimitDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.buisness_unit
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse --> GetUserBULimitResponse
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.400

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.responses.500

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserCODlimitRoutes.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: setUserCODlimitRoutes​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SetCODForUserRequest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.business_unit

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SetCODForUserRequest
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.mobileno

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: SetCODForUserCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.mobile_no
  • New Schema:
{
"type": "string",
"description": "Mobile No. of User"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: SetCODForUserCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SetBUPaymentLimit"
}
}

🔹 Change 5​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: SetCODForUserCreation
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.required.2
  • New Schema:
"items"

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetUserCODLimitDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GetUserBULimitDetails"
}
}

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: SetCODOptionResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.responses.400

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.responses.500

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setUserCODlimitRoutes.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: edcAggregatorsAndModelList​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcAggregatorsAndModelList.methodTypePlaceHolder.responses.500

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcAggregatorsAndModelList.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: edcDeviceStats​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceStats.methodTypePlaceHolder.responses.400

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceStats.methodTypePlaceHolder.responses.500

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceStats.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: updateEdcDevice​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateEdcDevice.methodTypePlaceHolder.responses.400

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateEdcDevice.methodTypePlaceHolder.responses.500

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateEdcDevice.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getEdcDevice​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.description

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.code

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Response message"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.data
  • New Schema:
{
"$ref": "#/components/schemas/IFSCErrorData"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/EDCError"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: NotFoundResourceError
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getEdcDevice.methodTypePlaceHolder.responses.500

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getEdcDevice.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: addEdcDevice​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addEdcDevice.methodTypePlaceHolder.responses.500

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.addEdcDevice.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: edcDeviceList​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.parameters.0.required

🔹 Change 2​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.parameters.1.required

🔹 Change 3​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.parameters.2.required

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.parameters.3.required

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.parameters.4.required

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: EdcDeviceListDetails --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.edcDeviceList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 1
}

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.responses.500

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.edcDeviceList.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: getPosPaymentModeRoutes​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.parameters.3.required

🔹 Change 2​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.parameters.5.required

🔹 Change 3​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.parameters.7.required

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.parameters.13.required

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList --> ProductCODData
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.product_cod_data.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.logo
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.bank_name
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.bank_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.url
  • New Schema:
{
"type": "string"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.wallet_name
  • New Schema:
{
"type": "string"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.wallet_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.wallet_id
  • New Schema:
{
"type": "integer"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.collect_flow
  • New Schema:
{
"type": "boolean"
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.provider
  • New Schema:
{
"type": "string"
}

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.list.items.properties.meta
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.payment_mode_id
  • New Schema:
{
"type": "integer",
"nullable": true,
"description": "payment mode id"
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.logo_url
  • New Schema:
{
"$ref": "#/components/schemas/PaymentModeLogo"
}

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_option.items.properties.version
  • New Schema:
{
"$ref": "#/components/schemas/Version"
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.bqr_razorpay.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.bqr_razorpay.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.fynd.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.fynd.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.epaylater.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.epaylater.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.razorpay.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.razorpay.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.juspay.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 28​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.juspay.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 29​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.ajiodhan.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 30​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.ajiodhan.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 31​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.simpl.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 32​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.simpl.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 33​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.rupifi.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 34​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.rupifi.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 35​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.mswipe.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 36​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.mswipe.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 37​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.stripe.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 38​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.stripe.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 39​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.ccavenue.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 40​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.ccavenue.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 41​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.payubiz.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 42​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.payubiz.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 43​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.jiopay.properties.data.properties
  • New Schema:
{
"gateway": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow_data": {
"$ref": "#/components/schemas/PaymentFlowData"
},
"data": {
"$ref": "#/components/schemas/GatewayData"
},
"payment_flow": {
"type": "string",
"nullable": true
},
"api_link": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"is_customer_validation_required": {
"type": "boolean"
},
"cust_validation_url": {
"type": "string",
"nullable": true
},
"sdk": {
"$ref": "#/components/schemas/SDKDetails"
},
"return_url": {
"type": "string",
"nullable": true
},
"user_email": {
"type": "string",
"nullable": true
},
"user_phone": {
"type": "string",
"nullable": true
}
}

🔹 Change 44​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow --> AggregatorRoute
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.jiopay.properties.type
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 45​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.jio
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 46​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.payumoney
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 47​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.openapi
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 48​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.potlee
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 49​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.upi_razorpay
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 50​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.creditnote
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 51​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.pinelabs
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 52​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.checkout
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 53​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.cashfree
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 54​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.properties.jio_extension
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorRoute"
}

🔹 Change 55​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> PaymentOptionAndFlow --> PaymentFlow
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_flows.nullable
  • New Schema:
true

🔹 Change 56​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteResponse --> PaymentOptionAndFlow
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_options.properties.payment_default_selection

🔹 Change 57​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList --> ProductCODData
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.product_cod_data.nullable
  • New Schema:
true

🔹 Change 58​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.logo
  • New Schema:
{
"type": "string"
}

🔹 Change 59​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.bank_name
  • New Schema:
{
"type": "string"
}

🔹 Change 60​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.bank_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 61​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.url
  • New Schema:
{
"type": "string"
}

🔹 Change 62​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.wallet_name
  • New Schema:
{
"type": "string"
}

🔹 Change 63​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.wallet_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 64​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.wallet_id
  • New Schema:
{
"type": "integer"
}

🔹 Change 65​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.collect_flow
  • New Schema:
{
"type": "boolean"
}

🔹 Change 66​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.provider
  • New Schema:
{
"type": "string"
}

🔹 Change 67​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionsDetails --> PaymentOptions --> RootPaymentMode --> PaymentModeList
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.list.items.properties.meta
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 68​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> AdvancePaymentObject --> AdvanceObject
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.advance.properties.all_cancellation_type
  • New Schema:
{
"x-not-enum": true,
"nullable": true,
"description": "All available types of cancellation",
"type": "array",
"items": {
"x-not-enum": true,
"type": "string",
"nullable": true,
"description": "Contains a valid cancellation type"
}
}

🔹 Change 69​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails --> AdvancePaymentObject
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.advance_payment.items.properties.version
  • New Schema:
{
"$ref": "#/components/schemas/Version"
}

🔹 Change 70​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.delivery_charges
  • New Schema:
{
"type": "number"
}

🔹 Change 71​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_code
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 72​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.order_id
  • New Schema:
{
"type": "string"
}

🔹 Change 73​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cod_message
  • New Schema:
{
"type": "string"
}

🔹 Change 74​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.delivery_slots
  • New Schema:
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliverySlot"
}
}

🔹 Change 75​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user_type
  • New Schema:
{
"type": "string",
"x-not-enum": true
}

🔹 Change 76​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cod_available
  • New Schema:
{
"type": "boolean"
}

🔹 Change 77​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cod_charges
  • New Schema:
{
"type": "integer"
}

🔹 Change 78​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.max_cart_value
  • New Schema:
{
"type": "integer"
}

🔹 Change 79​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.min_cart_value
  • New Schema:
{
"type": "integer"
}

🔹 Change 80​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_emp_list
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 81​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.delivery_charge_order_value
  • New Schema:
{
"type": "integer"
}

🔹 Change 82​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cod_limit
  • New Schema:
{
"type": "integer"
}

🔹 Change 83​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.remaining_limit
  • New Schema:
{
"type": "number"
}

🔹 Change 84​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cod_limit_per_order
  • New Schema:
{
"type": "integer"
}

🔹 Change 85​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.product_cod_data
  • New Schema:
{
"type": "object",
"additionalProperties": true
}

🔹 Change 86​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_product_cod_available
  • New Schema:
{
"type": "boolean"
}

🔹 Change 87​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_pincode_cod_available
  • New Schema:
{
"type": "boolean"
}

🔹 Change 88​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentModeRouteDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.meta
  • New Schema:
{
"$ref": "#/components/schemas/PaymentOptionsMeta"
}

🔹 Change 89​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionErrorCodeAndMessage
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.type
  • New Schema:
"array"

🔹 Change 90​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties

🔹 Change 91​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required

🔹 Change 92​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionErrorCodeAndMessage
  • Schema Action: ITEMS_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.items
  • New Schema:
{
"type": "string"
}

🔹 Change 93​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOptionErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string"
}

🔹 Change 94​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 95​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.responses.500

🔹 Change 96​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPosPaymentModeRoutes.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: initialisePayment​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email.format

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.amount.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.merchant_transaction_id
  • New Schema:
{
"type": "string",
"description": "Unique fynd transaction id"
}

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.required.0

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.required.1

🔹 Change 6​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.required.2

🔹 Change 7​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.required.3

🔹 Change 8​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.required.5

🔹 Change 9​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.requestBody.content.application/json.schema.required.8

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentInitializationDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.initialisePayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.merchant_transaction_id
  • New Schema:
{
"type": "string",
"description": "Unique fynd transaction id"
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.initialisePayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.initialisePayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.initialisePayment.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.initialisePayment.methodTypePlaceHolder.responses.500

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.initialisePayment.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: checkAndUpdatePaymentStatus​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.email.format

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateRequest
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.amount.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.unique_link_id
  • New Schema:
{
"type": "string",
"description": "Unique payment link id"
}

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.required.2

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.required.3

🔹 Change 6​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.required.4

🔹 Change 7​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.required.5

🔹 Change 8​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.required.7

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusUpdateResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.responses.500

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.checkAndUpdatePaymentStatus.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: resendOrCancelPayment​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ResendOrCancelPaymentResponse --> LinkStatus
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.is_payment_done

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ResendOrCancelPaymentResponse --> LinkStatus
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.required.0

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.responses.500

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.resendOrCancelPayment.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: paymentStatusBulk​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentStatusBulkHandlerDetails
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.success.type
  • New Schema:
"boolean"

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.responses.500

🔹 Change 7​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/payment-status-bulk"

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.paymentStatusBulk.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: oauthGetUrl​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.responses.500

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/onboard/{aggregator}"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.oauthGetUrl.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: revokeOauthToken​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.responses.500

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/revoke/{aggregator}"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.revokeOauthToken.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: repaymentDetails​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RepaymentDetailsSerialiserPayAll
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.repaymentDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.extension_order_id.nullable

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RepaymentResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.repaymentDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.required.0

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.repaymentDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.repaymentDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.repaymentDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.repaymentDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.repaymentDetails.methodTypePlaceHolder.responses.500

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.repaymentDetails.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: merchantOnBoarding​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties
  • New Schema:
{
"status_code": {
"type": "integer",
"description": "HTTP status code",
"x-not-enum": true
},
"message": {
"type": "string",
"description": "Message"
},
"status": {
"type": "boolean",
"description": "Successful or failure"
}
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.responses.500

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.merchantOnBoarding.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: verifyCustomerForPayment​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.delivery_address.properties
  • New Schema:
{
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"google_map_point": {
"$ref": "#/components/schemas/GoogleMapPoint"
},
"landmark": {
"type": "string",
"description": "landmark"
},
"phone": {
"type": "string",
"description": "phone number"
},
"country_iso_code": {
"x-not-enum": true,
"type": "string",
"description": "country's code name e.g. `IN`, `GB`"
},
"area_code": {
"x-not-enum": true,
"type": "string",
"description": "customer pin/zip code"
},
"country": {
"type": "string",
"description": "country name"
},
"expire_at": {
"format": "date-time",
"type": "string",
"description": "address expiry timestamp"
},
"geo_location": {
"additionalProperties": true,
"type": "object",
"description": "location latitude and logitude"
},
"state": {
"type": "string",
"description": "state of the customer"
},
"area": {
"type": "string",
"description": "area details"
},
"g_address_id": {
"type": "string",
"description": "unique address id generated by Fynd platform"
},
"area_code_slug": {
"type": "string",
"description": "area slug code, use pin or zip code if not available"
},
"country_phone_code": {
"x-not-enum": true,
"type": "string",
"description": "country's phone code"
},
"name": {
"type": "string",
"description": "customer name"
},
"address_type": {
"x-not-enum": true,
"type": "string",
"nullable": true,
"description": "address type e.g. home, office"
},
"address": {
"type": "string",
"description": "address details"
},
"email": {
"type": "string",
"description": "customer email"
},
"city": {
"type": "string",
"description": "city name"
},
"tags": {
"type": "array",
"description": "optional address tag",
"items": {
"type": "object"
}
},
"pincode": {
"type": "string"
},
"type": {
"type": "string"
}
}

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ValidateCustomerCreation --> AddressDetail
  • Schema Action: REQUIRED_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.delivery_address.required
  • New Schema:
[
"city",
"country",
"state"
]

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.order_items.items.properties
  • New Schema:
{
"sku": {
"type": "string"
},
"price": {
"type": "integer",
"format": "int32"
},
"quantity": {
"type": "integer",
"format": "int32"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.merchant_params.properties
  • New Schema:
{
"source": {
"type": "string"
}
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.billing_address.properties
  • New Schema:
{
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"google_map_point": {
"$ref": "#/components/schemas/GoogleMapPoint"
},
"landmark": {
"type": "string",
"description": "landmark"
},
"phone": {
"type": "string",
"description": "phone number"
},
"country_iso_code": {
"x-not-enum": true,
"type": "string",
"description": "country's code name e.g. `IN`, `GB`"
},
"area_code": {
"x-not-enum": true,
"type": "string",
"description": "customer pin/zip code"
},
"country": {
"type": "string",
"description": "country name"
},
"expire_at": {
"format": "date-time",
"type": "string",
"description": "address expiry timestamp"
},
"geo_location": {
"additionalProperties": true,
"type": "object",
"description": "location latitude and logitude"
},
"state": {
"type": "string",
"description": "state of the customer"
},
"area": {
"type": "string",
"description": "area details"
},
"g_address_id": {
"type": "string",
"description": "unique address id generated by Fynd platform"
},
"area_code_slug": {
"type": "string",
"description": "area slug code, use pin or zip code if not available"
},
"country_phone_code": {
"x-not-enum": true,
"type": "string",
"description": "country's phone code"
},
"name": {
"type": "string",
"description": "customer name"
},
"address_type": {
"x-not-enum": true,
"type": "string",
"nullable": true,
"description": "address type e.g. home, office"
},
"address": {
"type": "string",
"description": "address details"
},
"email": {
"type": "string",
"description": "customer email"
},
"city": {
"type": "string",
"description": "city name"
},
"tags": {
"type": "array",
"description": "optional address tag",
"items": {
"type": "object"
}
},
"pincode": {
"type": "string"
},
"type": {
"type": "string"
}
}

🔹 Change 6​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ValidateCustomerCreation --> AddressDetail
  • Schema Action: REQUIRED_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.billing_address.required
  • New Schema:
[
"city",
"country",
"state"
]

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties
  • New Schema:
{
"data": {
"$ref": "#/components/schemas/ValidateCustomerData"
},
"aggregator": {
"type": "string"
},
"api_version": {
"type": "integer"
}
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ValidateCustomerDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/ValidateCustomer"
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.code

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentErrorCodeAndMessage --> PaymentError
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.order_id
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentErrorCodeAndMessage --> PaymentError
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.order_type
  • New Schema:
{
"type": "array",
"items": {
"x-not-enum": true,
"type": "string"
}
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentErrorCodeAndMessage --> PaymentError
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.transaction_amount_in_paise
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error_msg
  • New Schema:
{
"type": "string"
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.status
  • New Schema:
{
"type": "string"
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string"
}

🔹 Change 18​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.400.content.application/json.schema.required

🔹 Change 19​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.responses.500

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.verifyCustomerForPayment.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentLinkDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.currency
  • New Schema:
{
"type": "string",
"description": "currency"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentLinkDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/ErrorDescription"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ErrorDetails --> ErrorDescription
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentLink.methodTypePlaceHolder.responses.500

🔹 Change 7​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentLink.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link"

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentLink.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreatePaymentLinkCreation --> CreatePaymentLinkMeta
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentLink.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.pincode
  • New Schema:
{
"type": "string",
"nullable": true,
"description": "pincode of customer"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreatePaymentLinkCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentLink.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.success_redirection_url
  • New Schema:
{
"type": "string",
"description": "URL to which the user will be redirected after a successful payment."
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreatePaymentLinkCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentLink.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.failure_redirection_url
  • New Schema:
{
"type": "string",
"description": "URL to which the user will be redirected if the payment fails."
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ErrorDetails --> ErrorDescription
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createPaymentLink.methodTypePlaceHolder.responses.500

🔹 Change 8​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createPaymentLink.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link"

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createPaymentLink.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PollingPaymentLinkDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"type": "string"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ErrorDetails --> ErrorDescription
  • Schema Action: PROPERTY_ADDED
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.responses.500

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/polling-payment-link"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.pollingPaymentLink.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ResendPaymentLinkDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/PaymentLinkError"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ErrorDetails --> ErrorDescription
  • Schema Action: PROPERTY_ADDED
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.responses.500

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/resend-payment-link"

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.resendPaymentLink.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CancelPaymentLinkDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.cancelPaymentLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/PaymentLinkError"
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.cancelPaymentLink.methodTypePlaceHolder.responses.400

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.cancelPaymentLink.methodTypePlaceHolder.responses.500

🔹 Change 4​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.cancelPaymentLink.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/cancel-payment-link"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.cancelPaymentLink.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getPaymentModeControlRoutes​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message.nullable

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"display_name": {
"type": "string",
"description": "Display name for the payment configuration."
},
"business_unit": {
"type": "string",
"description": "Business unit identifier."
},
"config": {
"$ref": "#/components/schemas/OfflineAdvanceConfig"
},
"device": {
"$ref": "#/components/schemas/OfflineAdvanceDevice"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_active
  • New Schema:
{
"type": "boolean",
"description": "Indicates if the payment option is active."
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.errors
  • New Schema:
{
"$ref": "#/components/schemas/ErrorCodeAndDescription"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/ErrorCodeAndDescription"
}

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.responses.500

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeControlRoutes.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: setMerchantModeControlRoutes​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchantPaymentModeRequest
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.business_unit.nullable

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchantPaymentModeRequest
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.items.nullable

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvance --> OfflineAdvanceConfig
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.items.items.additionalProperties
  • New Schema:
true

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"anonymous": {
"type": "boolean",
"description": "Indicates if the payment is anonymous."
},
"user_limit": {
"nullable": true,
"type": "integer",
"description": "User limit for the payment configuration."
},
"charges": {
"type": "integer",
"description": "Charges for the payment configuration."
},
"charges_max_value": {
"type": "integer",
"description": "Maximum value for charges."
},
"charges_min_value": {
"type": "integer",
"description": "Minimum value for charges."
},
"max_order_value": {
"type": "integer",
"description": "Maximum order value."
},
"min_order_value": {
"type": "integer",
"description": "Minimum order value."
},
"is_active": {
"type": "boolean",
"description": "Indicates if the payment configuration is active.",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the payment configuration."
},
"number_of_split": {
"type": "number",
"description": "Number of split allowed for the payment configuration."
},
"slug": {
"type": "string",
"description": "Slug for the payment configuration."
},
"save_allowed": {
"type": "boolean",
"description": "Indicates if saving is allowed."
},
"prepayment_type": {
"type": "string",
"description": "Indicates if Fixed or percentage amount.",
"x-not-enum": true
},
"prepayment_value": {
"type": "integer",
"description": "Value in case of fixed amount else in percentage eg. 5% is 5 for a prepayment_value of 100"
},
"refund_time_limit": {
"type": "integer",
"description": "Time limit for refund of a payment."
},
"time_unit": {
"type": "string",
"description": "It indicates the time_unit for refund_time_limit possible values hours/days/weeks"
},
"cancellation_type": {
"type": "string",
"description": "It indicates type of cancellation for an advance payment order, possible values MANUAL / AUTO",
"x-not-enum": true
},
"all_cancellation_type": {
"description": "All available types of cancellation",
"type": "array",
"items": {
"type": "string",
"nullable": true,
"x-not-enum": true,
"description": "Contains a valid cancellation type"
}
},
"allow_custom_advance_amount": {
"type": "boolean",
"description": "Is custom advance amount allowed?"
},
"description": {
"type": "string",
"description": "Description of the payment configuration."
},
"display_name": {
"type": "string",
"description": "display name e.g Advance Payment"
}
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchantPaymentModeRequest
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.device.nullable

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.device.properties
  • New Schema:
{
"android": {
"type": "boolean",
"description": "Indicates if available on Android devices."
},
"ios": {
"type": "boolean",
"description": "Indicates if available on iOS devices."
},
"desktop": {
"type": "boolean",
"description": "Indicates if available on desktop devices."
}
}

🔹 Change 7​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: MerchantPaymentModeRequest
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.requestBody.content.application/json.schema.required

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message.nullable

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"display_name": {
"type": "string",
"description": "Display name for the payment configuration."
},
"business_unit": {
"type": "string",
"description": "Business unit identifier."
},
"config": {
"$ref": "#/components/schemas/OfflineAdvanceConfig"
},
"device": {
"$ref": "#/components/schemas/OfflineAdvanceDevice"
}
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_active
  • New Schema:
{
"type": "boolean",
"description": "Indicates if the payment option is active."
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.errors
  • New Schema:
{
"$ref": "#/components/schemas/ErrorCodeAndDescription"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"$ref": "#/components/schemas/ErrorCodeAndDescription"
}

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.is_active
  • New Schema:
{
"type": "boolean",
"description": "Indicates if the payment option is active."
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Indicates if the payment option is active."
}

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "List of all aggregator and payment mode details.",
"items": {
"$ref": "#/components/schemas/OfflineAdvanceConfigurationItem"
}
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformOfflineAdvanceDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.errors
  • New Schema:
{
"$ref": "#/components/schemas/ErrorCodeAndDescription"
}

🔹 Change 20​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.400.content.application/json.schema.required

🔹 Change 21​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.responses.500

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setMerchantModeControlRoutes.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getPaymentModeCustomConfig​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema --> PaymentCustomConfigDetailsSchema
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.required

🔹 Change 3​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema --> PaymentCustomConfigDetailsSchema --> PaymentCustomConfigModeSchema
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.payment_mode.type

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema --> PaymentCustomConfigDetailsSchema --> PaymentCustomConfigModeSchema
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.payment_mode.required

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.payment_mode.properties

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.available
  • New Schema:
{
"type": "boolean"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.pre_order
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.post_order
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error message"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.responses.500

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentModeCustomConfig.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: setPaymentModeCustomConfig​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema --> PaymentCustomConfigDetailsSchema
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.required

🔹 Change 3​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema --> PaymentCustomConfigDetailsSchema --> PaymentCustomConfigModeSchema
  • Schema Action: DATA_TYPE_REMOVED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.payment_mode.type

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema --> PaymentCustomConfigDetailsSchema --> PaymentCustomConfigModeSchema
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.payment_mode.required

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.payment_mode.properties

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.available
  • New Schema:
{
"type": "boolean"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.pre_order
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentCustomConfigResponseSchema --> PaymentModeCustomConfigSchema
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.custom_config.properties.post_order
  • New Schema:
{
"type": "array",
"items": {
"type": "string"
}
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.responses.500

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setPaymentModeCustomConfig.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getPaymentCodeOption​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeResponse --> GetPaymentCode
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.method_code

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.cod
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.nb
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.wl
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.card
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.pl
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.ps
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.op
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.upi
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.qr
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.fc
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.pac
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.stripepg
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.payumoneypg
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.rupifipg
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.cas
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.csas
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.ccavenuepg
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.cardless_emi
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.cashback
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 21​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.loyalty
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.employee_discount
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.paymentlink
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.epaylater
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.udhaari
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.creditnote
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 27​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.checkout
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 28​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.rone
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 29​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.emi
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 30​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.sodexo
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 31​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeDetails --> GetPaymentCode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.jm_wallet
  • New Schema:
{
"$ref": "#/components/schemas/PaymentCode"
}

🔹 Change 32​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentCodeResponse --> GetPaymentCode
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.required

🔹 Change 33​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.responses.500

🔹 Change 34​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentCodeOption.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: getPaymentSession​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionSerializer
  • Schema Action: ITEMS_REMOVED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_details.items

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails --> PaymentSessionDetail
  • Schema Action: DATA_TYPE_ADDED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_details.type
  • New Schema:
"object"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_details.properties
  • New Schema:
{
"payment_id": {
"type": "string",
"description": "unique transaction id generated by payment gateway"
},
"mode": {
"type": "string",
"description": "test or live, test mode uses test credentials so that actual payment is not created."
},
"amount": {
"type": "integer",
"format": "int32",
"description": "amount paid."
},
"success_url": {
"type": "string",
"description": "success url sent by Fynd platform at the time of payment creation"
},
"shipping_address": {
"description": "shipping address",
"allOf": [
{
"$ref": "#/components/schemas/AddressDetail"
}
]
},
"amount_captured": {
"type": "integer",
"format": "int32",
"description": "amount which is captured or credited to merchant account"
},
"amount_refunded": {
"type": "integer",
"format": "int32",
"description": "amount refunded or credited back to customer accout"
},
"aggregator_customer_id": {
"type": "string",
"description": "unique customer id generated by payment gateway, not required for standard checkout."
},
"cancel_url": {
"type": "string",
"description": "cancel url sent by Fynd platform at the time of payment creation"
},
"payment_methods": {
"type": "array",
"description": "method of payment",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"created": {
"type": "string",
"description": "timestamp in epoch"
},
"g_user_id": {
"type": "string",
"description": "global user identifier - unique user id generated by Fynd platform"
},
"currency": {
"type": "string",
"description": "currency of the payment."
},
"merchant_locale": {
"type": "string",
"description": "merchant's locale"
},
"locale": {
"type": "string",
"description": "user's locale"
},
"aggregator_order_id": {
"type": "string",
"description": "unique order id or payment request id generated by payment gateway"
},
"gid": {
"type": "string",
"description": "Global identifier of the entity (e.g. order, cart etc.) against which payment_session was initiated. This is generated by Fynd payments platform and is unique."
},
"kind": {
"type": "string",
"description": "optional kind of purchase or payment - one time payment (sale) or subcription. defaults to sale."
},
"billing_address": {
"description": "billing address",
"allOf": [
{
"$ref": "#/components/schemas/AddressDetail"
}
]
},
"captured": {
"type": "boolean",
"description": "whether the payment is captured (credited to merchant account) by payment gateway."
},
"meta": {
"additionalProperties": true,
"type": "object",
"description": "Extra meta data specific to extension"
},
"status": {
"type": "string",
"description": "status of the payment"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails --> PaymentSessionDetail
  • Schema Action: REQUIRED_ADDED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.payment_details.required
  • New Schema:
[
"aggregator_order_id",
"amount",
"amount_captured",
"cancel_url",
"currency",
"g_user_id",
"gid",
"mode",
"payment_id",
"payment_methods",
"status",
"success_url"
]

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionSerializer
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.currency.nullable

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionSerializer
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.gid.nullable

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionSerializer --> CartDetailsSerializer
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cart_details.properties.custom_cart_meta

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails --> CartDetailsSerializerData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cart_details.properties.cart_charges
  • New Schema:
{
"type": "array",
"description": "contains all the charges that are applicable on cart",
"items": {
"$ref": "#/components/schemas/CartChargesSerializerData"
}
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.meta
  • New Schema:
{
"type": "object",
"description": "meta",
"additionalProperties": true
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.applied_payment_offers
  • New Schema:
{
"$ref": "#/components/schemas/AppliedOfferSerializerData"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.checksum
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: GetPaymentSessionDetails
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1
  • New Schema:
"currency"

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.400

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentSession.methodTypePlaceHolder.responses.500

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPaymentSession.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: updatePaymentSession​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.order_details.allOf.0.properties.aggregator_order_details.properties
  • New Schema:
{
"aggregator_order_id": {
"type": "string"
},
"amount": {
"type": "integer"
},
"currency": {
"type": "string"
},
"aggregator": {
"type": "string"
},
"status": {
"type": "string"
}
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.google_map_point.properties
  • New Schema:
{
"address": {
"type": "string"
},
"sub_locality": {
"type": "string"
}
}

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.expire_at.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.geo_location.additionalProperties
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.line1
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.line2
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.pincode
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 10​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.0

🔹 Change 11​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.1

🔹 Change 12​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.2

🔹 Change 13​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.3

🔹 Change 14​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.6

🔹 Change 15​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.7

🔹 Change 16​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.8

🔹 Change 17​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.9

🔹 Change 18​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.shipping_address.allOf.0.required.10

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.payment_methods.items.properties
  • New Schema:
{
"id": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"display_name": {
"type": "string"
},
"slug": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"merchant_transaction_id": {
"type": "string"
},
"amount": {
"type": "number",
"format": "float"
},
"payment_id": {
"type": "string"
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"sub_payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubPaymentMode"
}
}
}

🔹 Change 20​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.google_map_point.properties
  • New Schema:
{
"address": {
"type": "string"
},
"sub_locality": {
"type": "string"
}
}

🔹 Change 21​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.expire_at.format
  • New Schema:
"date-time"

🔹 Change 22​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.geo_location.additionalProperties
  • New Schema:
true

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.line1
  • New Schema:
{
"type": "string"
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.line2
  • New Schema:
{
"type": "string"
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.pincode
  • New Schema:
{
"type": "string"
}

🔹 Change 26​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 27​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.0

🔹 Change 28​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.1

🔹 Change 29​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.2

🔹 Change 30​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.3

🔹 Change 31​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.6

🔹 Change 32​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.7

🔹 Change 33​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.8

🔹 Change 34​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.9

🔹 Change 35​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.billing_address.allOf.0.required.10

🔹 Change 36​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.items.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 37​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.applied_payment_offers
  • New Schema:
{
"$ref": "#/components/schemas/AppliedOfferSerializerData"
}

🔹 Change 38​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.requestBody.content.application/json.schema.required.6

🔹 Change 39​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionPutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.error
  • New Schema:
{
"type": "string"
}

🔹 Change 40​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionPutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.success
  • New Schema:
{
"type": "boolean"
}

🔹 Change 41​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionPutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string"
}

🔹 Change 42​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionPutDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.transaction_details
  • New Schema:
{
"type": "array",
"description": "list of all payment mode and transaction id",
"items": {
"$ref": "#/components/schemas/TransactionDetail"
}
}

🔹 Change 43​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionResponseSerializer
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 44​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionError --> PaymentErrorCodeDescription --> PaymentOptionError
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description.type
  • New Schema:
"object"

🔹 Change 45​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description.properties
  • New Schema:
{
"option_type": {
"type": "array",
"items": {
"x-not-enum": true,
"type": "string"
}
},
"order_type": {
"type": "array",
"items": {
"x-not-enum": true,
"type": "string"
}
},
"checksum": {
"type": "array",
"items": {
"type": "string"
}
}
}

🔹 Change 46​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required

🔹 Change 47​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.400.content.application/json.schema.required

🔹 Change 48​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.responses.500

🔹 Change 49​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updatePaymentSession.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: updateRefundSession​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionCreation
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.google_map_point.properties
  • New Schema:
{
"address": {
"type": "string"
},
"sub_locality": {
"type": "string"
}
}

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.expire_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.geo_location.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.line1
  • New Schema:
{
"type": "string"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.line2
  • New Schema:
{
"type": "string"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.pincode
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.0

🔹 Change 10​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.1

🔹 Change 11​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.2

🔹 Change 12​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.3

🔹 Change 13​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.6

🔹 Change 14​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.7

🔹 Change 15​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.8

🔹 Change 16​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.9

🔹 Change 17​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.shipping_address.allOf.0.required.10

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.payment_methods.items.properties
  • New Schema:
{
"id": {
"type": "integer"
},
"priority": {
"type": "integer"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"display_name": {
"type": "string"
},
"slug": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"merchant_transaction_id": {
"type": "string"
},
"amount": {
"type": "number",
"format": "float"
},
"payment_id": {
"type": "string"
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"sub_payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubPaymentMode"
}
}
}

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.google_map_point.properties
  • New Schema:
{
"address": {
"type": "string"
},
"sub_locality": {
"type": "string"
}
}

🔹 Change 20​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.expire_at.format
  • New Schema:
"date-time"

🔹 Change 21​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.geo_location.additionalProperties
  • New Schema:
true

🔹 Change 22​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.line1
  • New Schema:
{
"type": "string"
}

🔹 Change 23​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.line2
  • New Schema:
{
"type": "string"
}

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.pincode
  • New Schema:
{
"type": "string"
}

🔹 Change 25​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail --> AddressDetail
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.properties.type
  • New Schema:
{
"type": "string"
}

🔹 Change 26​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.0

🔹 Change 27​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.1

🔹 Change 28​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.2

🔹 Change 29​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.3

🔹 Change 30​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.6

🔹 Change 31​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.7

🔹 Change 32​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.8

🔹 Change 33​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.9

🔹 Change 34​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionRequestSerializer --> PaymentSessionDetail --> AddressDetail
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.billing_address.allOf.0.required.10

🔹 Change 35​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentSessionCreation --> PaymentSessionDetail
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_details.allOf.0.properties.meta.additionalProperties
  • New Schema:
true

🔹 Change 36​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionRequestSerializer --> RefundSessionDetail
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.refund_details.items.properties.receipt_number

🔹 Change 37​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionRequestSerializer --> RefundSessionDetail
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.refund_details.items.properties.pg_refund_id

🔹 Change 38​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ErrorDetails --> ErrorDescription
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.error.properties.description
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 39​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionRequestSerializer
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.requestBody.content.application/json.schema.required.3

🔹 Change 40​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.success
  • New Schema:
{
"type": "boolean"
}

🔹 Change 41​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string"
}

🔹 Change 42​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionDetails
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required.0
  • New Schema:
"success"

🔹 Change 43​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionDetails
  • Schema Action: REQUIRED_FIELD_UPDATED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1
  • New Schema:
"message"

🔹 Change 44​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionResponseSerializer
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required.2

🔹 Change 45​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionResponseSerializer
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required.3

🔹 Change 46​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: RefundSessionResponseSerializer
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.200.content.application/json.schema.required.4

🔹 Change 47​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.400

🔹 Change 48​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.responses.500

🔹 Change 49​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateRefundSession.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getMerchantPaymentOption​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.parameters.2
  • New Schema:
{
"name": "payment_option_type",
"in": "query",
"description": "Payment Option Type, Expected value - advance (Optional)",
"schema": {
"type": "string",
"x-not-enum": true
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"name": "cod_refund_agg",
"in": "query",
"required": false,
"description": "Flag to filter and return only aggregators eligible for COD refunds.",
"schema": {
"type": "boolean"
}
}

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformOnlineOfflinePaymentDetails --> PlatformOnlineOfflineItem
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.type
  • New Schema:
"object"

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: ITEMS_REMOVED
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.properties
  • New Schema:
{
"online": {
"$ref": "#/components/schemas/OnlinePaymentDetails"
},
"offline": {
"$ref": "#/components/schemas/OfflinePaymentDetails"
},
"advance": {
"$ref": "#/components/schemas/PlatformOfflineAdvanceDetails"
}
}

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.responses.400

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.responses.500

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantPaymentOption.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: patchMerchantPaymentOption​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchnatPaymentModeRequest
  • Schema Action: ITEMS_REMOVED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.offline.items

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchnatPaymentModeCreation
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.offline.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchnatPaymentModeRequest
  • Schema Action: ITEMS_REMOVED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.online.items

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: MerchnatPaymentModeCreation
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.online.additionalProperties
  • New Schema:
true

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"online": {
"$ref": "#/components/schemas/OnlinePaymentDetails"
},
"offline": {
"$ref": "#/components/schemas/OfflinePaymentDetails"
},
"advance": {
"$ref": "#/components/schemas/PlatformOfflineAdvanceDetails"
}
}

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error message"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.responses.500

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantPaymentOption.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getMerchantAggregatorPaymentModeDetails​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message.nullable

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"priority": {
"type": "integer"
},
"display_name": {
"type": "string"
},
"slug": {
"type": "string"
},
"integration_type": {
"type": "string",
"x-not-enum": true
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"is_active": {
"type": "boolean"
},
"config": {
"type": "array",
"items": {
"type": "string"
}
},
"payment_modes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"checkout_type": {
"type": "string",
"x-not-enum": true
},
"country": {
"type": "array",
"items": {
"type": "string"
}
},
"currency": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"save_allowed": {
"type": "boolean",
"description": "Indicates if saving is allowed."
},
"extension_id": {
"nullable": true,
"type": "string"
},
"is_cod_refund_agg": {
"type": "boolean"
}
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorPlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.business_unit
  • New Schema:
{
"type": "string",
"description": "Business unit identifier."
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorPlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.device
  • New Schema:
{
"type": "string",
"description": "Device identifier."
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorPlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_active
  • New Schema:
{
"type": "boolean",
"description": "Indicates if the payment option is active."
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorPlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.save_allowed
  • New Schema:
{
"type": "boolean",
"description": "Indicates if saving is allowed."
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorPlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_id
  • New Schema:
{
"nullable": true,
"type": "string"
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 13​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.500

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: patchMerchantAggregatorPaymentModeDetails​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.message

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.items.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"id": {
"type": "integer",
"description": "Identifier for the payment mode."
},
"name": {
"type": "string",
"description": "Name of the payment mode."
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"is_active": {
"type": "boolean",
"description": "Indicates if the payment mode is active."
},
"priority": {
"type": "integer"
},
"sub_payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubPaymentMode"
},
"description": "List of sub-payment modes."
}
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.success

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.business_unit
  • New Schema:
{
"type": "string",
"description": "Business unit identifier."
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.device
  • New Schema:
{
"type": "string",
"description": "Device identifier."
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentMode
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.is_active
  • New Schema:
{
"type": "boolean",
"description": "Indicates if the payment option is active."
}

🔹 Change 8​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.requestBody.content.application/json.schema.required

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message.nullable

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"priority": {
"type": "integer"
},
"display_name": {
"type": "string"
},
"slug": {
"type": "string"
},
"integration_type": {
"type": "string",
"x-not-enum": true
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"is_active": {
"type": "boolean"
},
"config": {
"type": "array",
"items": {
"type": "string"
}
},
"payment_modes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"checkout_type": {
"type": "string",
"x-not-enum": true
},
"country": {
"type": "array",
"items": {
"type": "string"
}
},
"currency": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"save_allowed": {
"type": "boolean",
"description": "Indicates if saving is allowed."
},
"extension_id": {
"nullable": true,
"type": "string"
},
"is_cod_refund_agg": {
"type": "boolean"
}
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.business_unit
  • New Schema:
{
"type": "string",
"description": "Business unit identifier."
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.device
  • New Schema:
{
"type": "string",
"description": "Device identifier."
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.is_active
  • New Schema:
{
"type": "boolean",
"description": "Indicates if the payment option is active."
}

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 16​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.400

🔹 Change 17​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.responses.500

🔹 Change 18​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantAggregatorPaymentModeDetails.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getPGConfigAggregators​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message.nullable

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"priority": {
"type": "integer"
},
"display_name": {
"type": "string"
},
"slug": {
"type": "string"
},
"integration_type": {
"type": "string",
"x-not-enum": true
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"is_active": {
"type": "boolean"
},
"config": {
"type": "array",
"items": {
"type": "string"
}
},
"payment_modes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"checkout_type": {
"type": "string",
"x-not-enum": true
},
"country": {
"type": "array",
"items": {
"type": "string"
}
},
"currency": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"save_allowed": {
"type": "boolean",
"description": "Indicates if saving is allowed."
},
"extension_id": {
"nullable": true,
"type": "string"
},
"is_cod_refund_agg": {
"type": "boolean"
}
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.responses.500

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPGConfigAggregators.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: getMerchantRefundPriority​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"name": "business_unit",
"in": "path",
"description": "Business unit storefront or pos",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"refund_success": {
"summary": "Business Unit valid",
"value": "storefront"
},
"refund_fail": {
"summary": "Business Unit Invalid",
"value": "xyz"
}
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails --> RefundSourcesPriority
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.refund_sources_priority.items.properties.enabled
  • New Schema:
{
"type": "boolean",
"description": "refund source is enabled or not"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.business_unit
  • New Schema:
{
"type": "string",
"description": "Business unit either pos or storefront"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.settle_offline
  • New Schema:
{
"type": "boolean",
"description": "settle offline refund option is enabled or not"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.required.4
  • New Schema:
"business_unit"

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 9​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 10​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.responses.500

🔹 Change 11​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}/{business_unit}"

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantRefundPriority.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: createMerchantRefundPriority​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"name": "business_unit",
"in": "path",
"description": "Business unit storefront or pos",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"create_refund_config": {
"summary": "Business Unit valid",
"value": "storefront"
},
"config_failed": {
"summary": "Business Unit Invalid",
"value": "xyz"
}
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails --> RefundSourcesPriority
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.refund_sources_priority.items.properties.enabled
  • New Schema:
{
"type": "boolean",
"description": "refund source is enabled or not"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.settle_offline
  • New Schema:
{
"type": "boolean",
"description": "Settle Offline flag"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails --> RefundSourcesPriority
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.refund_sources_priority.items.properties.enabled
  • New Schema:
{
"type": "boolean",
"description": "refund source is enabled or not"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.business_unit
  • New Schema:
{
"type": "string",
"description": "Business unit either pos or storefront"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.settle_offline
  • New Schema:
{
"type": "boolean",
"description": "settle offline refund option is enabled or not"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.required.4
  • New Schema:
"business_unit"

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.responses.500

🔹 Change 13​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}/{business_unit}"

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createMerchantRefundPriority.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: updateMerchantRefundPriority​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.parameters.3
  • New Schema:
{
"name": "business_unit",
"in": "path",
"description": "Business unit storefront or pos",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"config_success": {
"summary": "Business Unit valid",
"value": "storefront"
},
"config_failed": {
"summary": "Business Unit Invalid",
"value": "xyz"
}
}
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails --> RefundSourcesPriority
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.refund_sources_priority.items.properties.enabled
  • New Schema:
{
"type": "boolean",
"description": "refund source is enabled or not"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.settle_offline
  • New Schema:
{
"type": "boolean",
"description": "Settle Offline flag"
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails --> RefundSourcesPriority
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.refund_sources_priority.items.properties.enabled
  • New Schema:
{
"type": "boolean",
"description": "refund source is enabled or not"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.business_unit
  • New Schema:
{
"type": "string",
"description": "Business unit either pos or storefront"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.settle_offline
  • New Schema:
{
"type": "boolean",
"description": "settle offline refund option is enabled or not"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: RefundPriorityDetails
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.200.content.application/json.schema.required.4
  • New Schema:
"business_unit"

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorDetails
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error description message"
}

🔹 Change 11​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 12​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.responses.500

🔹 Change 13​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund_priority/config/{config_type}/{business_unit}"

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateMerchantRefundPriority.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: createPaymentOrder​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderCreation --> PaymentOrderMethods --> PaymentMethodsMetaOrder
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_methods.items.properties.meta.properties.payment_extra_identifiers
  • New Schema:
{
"type": "object",
"description": "Extra Payment identifiers",
"additionalProperties": true
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderCreation --> PaymentOrderMethods --> PaymentMethodsMetaOrder
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_methods.items.properties.meta.properties.logo_url
  • New Schema:
{
"$ref": "#/components/schemas/PaymentModeLogo"
}

🔹 Change 3​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderRequest --> PaymentOrderMethods --> PaymentMethodsMetaOrder
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_methods.items.properties.meta.required.0

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderRequest --> PaymentOrderMethods --> PaymentMethodsMetaOrder
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.payment_methods.items.properties.meta.required.2

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderCreation
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.customer_details
  • New Schema:
{
"$ref": "#/components/schemas/CustomerDetails"
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.url
  • New Schema:
{
"type": "string",
"format": "uri"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.encdata
  • New Schema:
{
"type": "string"
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.checksum
  • New Schema:
{
"type": "string"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.mcode
  • New Schema:
{
"type": "string"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.success
  • New Schema:
{
"type": "boolean"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.status
  • New Schema:
{
"type": "string"
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.id
  • New Schema:
{
"type": "string"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.mobile
  • New Schema:
{
"type": "string"
}

🔹 Change 14​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.user
  • New Schema:
{
"type": "string"
}

🔹 Change 15​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.merchant_transaction_id
  • New Schema:
{
"type": "string"
}

🔹 Change 16​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.payment_mode_identifier
  • New Schema:
{
"type": "string"
}

🔹 Change 17​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderDetails --> PaymentOrderData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties.bank
  • New Schema:
{
"type": "string",
"nullable": true,
"description": "bank"
}

🔹 Change 18​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PaymentOrderResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.200.content.application/json.schema.required.1

🔹 Change 19​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ErrorDetails --> ErrorDescription
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.properties.description
  • New Schema:
{
"type": "string",
"nullable": true
}

🔹 Change 20​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.400.content.application/json.schema.required.0

🔹 Change 21​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ErrorResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.400.content.application/json.schema.required.1

🔹 Change 22​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.responses.500

🔹 Change 23​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment-orders"

🔹 Change 24​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createPaymentOrder.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: getMerchantAggregatorAppVersion​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.parameters.5.required

🔹 Change 2​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.parameters.6.required

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: AggregatorVersionDetails
  • Schema Action: DATA_TYPE_UPDATED
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.type
  • New Schema:
"array"

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.properties

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorVersionDetails
  • Schema Action: NULLABLE_ADDED
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable
  • New Schema:
true

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: AggregatorVersionDetails
  • Schema Action: ITEMS_ADDED
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items
  • New Schema:
{
"$ref": "#/components/schemas/AggregatorVersionItemSchema"
}

🔹 Change 7​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.responses.400

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.responses.500

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getMerchantAggregatorAppVersion.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/read"
]
}
]

🔧 Operation: patchMerchantPaymentOptionVersion​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.message.nullable

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: NULLABLE_REMOVED
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.nullable

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties
  • New Schema:
{
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"priority": {
"type": "integer"
},
"display_name": {
"type": "string"
},
"slug": {
"type": "string"
},
"integration_type": {
"type": "string",
"x-not-enum": true
},
"logos": {
"$ref": "#/components/schemas/PaymentModeLogo"
},
"is_active": {
"type": "boolean"
},
"config": {
"type": "array",
"items": {
"type": "string"
}
},
"payment_modes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"payment_mode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMode"
}
},
"checkout_type": {
"type": "string",
"x-not-enum": true
},
"country": {
"type": "array",
"items": {
"type": "string"
}
},
"currency": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"save_allowed": {
"type": "boolean",
"description": "Indicates if saving is allowed."
},
"extension_id": {
"nullable": true,
"type": "string"
},
"is_cod_refund_agg": {
"type": "boolean"
}
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: PlatformPaymentModeResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.200.content.application/json.schema.required

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndResponse --> ErrorCodeAndDescription
  • Schema Action: REQUIRED_FIELD_REMOVED
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.error.required.0

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.message
  • New Schema:
{
"type": "string",
"description": "Error message"
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: HttpErrorCodeAndMessage
  • Schema Action: PROPERTY_ADDED
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.400.content.application/json.schema.properties.items
  • New Schema:
{
"type": "array",
"description": "return empty array in error response",
"items": {
"type": "string"
}
}

🔹 Change 8​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.responses.500

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.patchMerchantPaymentOptionVersion.methodTypePlaceHolder.security
  • New Schema:
[
{
"oauth2": [
"application/payments/write"
]
}
]

🔧 Operation: updatePayouts​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.updatePayouts
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update payout.",
"description": "Modify the details of a payout transaction.",
"tags": [
"Payment"
],
"operationId": "updatePayouts",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid company id",
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PayoutCreation"
},
"examples": {
"payout_success": {
"value": {
"unique_external_id": "company:1",
"transfer_type": "bank",
"aggregator": "Razorpay",
"is_active": true,
"users": {
"unique_external_id": "company:1",
"name": "reliance retail",
"email": "reliance@gmail.com",
"mobile": "1234567890"
},
"bank_details": {
"country": "",
"state": "",
"city": "",
"account_no": "9876543210",
"bank_name": "SBI",
"branch_name": "Mumbai",
"account_holder": "Vikas Kumar",
"ifsc_code": "SBIN0011513",
"account_type": "saving"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "save payout response object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePayoutDetails"
},
"examples": {
"payout_success": {
"value": {
"success": true,
"is_active": true
}
}
}
}
}
}
},
"x-groups": [
"Payout"
],
"security": [
{
"oauth2": [
"company/finance/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/payouts",
"methodType": "put"
}
}

🔧 Operation: activateAndDectivatePayouts​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.activateAndDectivatePayouts
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Activate/Deactivate payout.",
"description": "Enable or disable payout functionality.",
"tags": [
"Payment"
],
"operationId": "activateAndDectivatePayouts",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid company id",
"value": 1
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePayoutCreation"
},
"examples": {
"payout_success": {
"value": {
"is_active": true,
"unique_external_id": "company:1"
}
}
}
}
}
},
"responses": {
"200": {
"description": "save payout response object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePayoutDetails"
},
"examples": {
"payout_success": {
"value": {
"success": true
}
}
}
}
}
}
},
"x-groups": [
"Payout"
],
"security": [
{
"oauth2": [
"company/finance/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/payouts",
"methodType": "patch"
}
}

🔧 Operation: deletePayouts​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.deletePayouts
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Delete payout.",
"description": "Remove a payout transaction from the system.",
"tags": [
"Payment"
],
"operationId": "deletePayouts",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "unique_transfer_no",
"in": "query",
"description": "Unique transfer id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid unique_transfer_no",
"value": "123232321"
}
}
}
],
"responses": {
"200": {
"description": "delete payout response object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePayoutDetails"
},
"examples": {
"payout_success": {
"value": {
"success": true
}
}
}
}
}
}
},
"x-groups": [
"Payout"
],
"security": [
{
"oauth2": [
"company/finance/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/payouts",
"methodType": "delete"
}
}

🔧 Operation: getAllPayout​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getAllPayout
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get All Payouts",
"description": "Get All Payouts",
"tags": [
"Payment"
],
"operationId": "getAllPayout",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "unique_transfer_no",
"in": "path",
"description": "Unique transfer id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid unique_transfer_no",
"value": "12323232"
}
}
},
{
"name": "unique_external_id",
"in": "query",
"description": "Fetch payouts using unique external id",
"schema": {
"type": "string"
},
"examples": {
"payout_success": {
"summary": "valid unique_external_id",
"value": "12323232"
}
}
}
],
"responses": {
"200": {
"description": "payouts response object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PayoutsDetails"
},
"examples": {
"payout_success": {
"value": {
"items": [
{
"unique_transfer_no": "d2ff79fcd3459831864824da8c9d7e5f",
"more_attributes": {
"city": "",
"state": "",
"country": "",
"bank_name": "YES",
"ifsc_code": "IFSCYES101",
"account_no": "9876541234",
"branch_name": "Mumbai",
"account_type": "current",
"account_holder": "Vikas Kumar"
},
"transfer_type": "bank",
"is_default": true,
"is_active": true,
"customers": {
"id": 2,
"name": "reliance retail",
"mobile": "1234567890",
"email": "reliance@gmail.com",
"unique_external_id": "company:1"
},
"payouts_aggregators": [
{
"payout_details_id": 888,
"aggregator_id": 3,
"aggregator_fund_id": null
}
]
},
{
"unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
"more_attributes": {
"city": "",
"state": "",
"country": "",
"bank_name": "SBI",
"ifsc_code": "SBIN0011513",
"account_no": "9876543210",
"branch_name": "Mumbai",
"account_type": "saving",
"account_holder": "Vikas Kumar"
},
"transfer_type": "bank",
"is_default": false,
"is_active": true,
"customers": {
"id": 2,
"name": "reliance retail",
"mobile": "1234567890",
"email": "reliance@gmail.com",
"unique_external_id": "company:1"
},
"payouts_aggregators": [
{
"payout_details_id": 891,
"aggregator_id": 3,
"aggregator_fund_id": null
}
]
}
],
"success": true
}
}
}
}
}
}
},
"x-groups": [
"Payout"
],
"security": [
{
"oauth2": [
"company/finance/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}",
"methodType": "get"
}
}

🔧 Operation: savePayouts​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.savePayouts
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Save Payout",
"description": "Save Payout",
"tags": [
"Payment"
],
"operationId": "savePayouts",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid company id",
"value": 1
},
"internal_server_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "unique_transfer_no",
"in": "path",
"description": "Unique transfer id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"payout_success": {
"summary": "valid unique_transfer_no",
"value": "1232323221"
},
"internal_server_fail": {
"summary": "valid unique_transfer_no",
"value": "1232323221"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PayoutCreation"
},
"examples": {
"payout_success": {
"value": {
"unique_external_id": "company:1",
"transfer_type": "bank",
"aggregator": "Razorpay",
"is_active": true,
"users": {
"unique_external_id": "company:1",
"name": "reliance retail",
"email": "reliance@gmail.com",
"mobile": "1234567890"
},
"bank_details": {
"country": "",
"state": "",
"city": "",
"account_no": "98765432101",
"bank_name": "SBI",
"branch_name": "Mumbai",
"account_holder": "Vikas Kumar",
"ifsc_code": "SBIN0011513",
"account_type": "saving"
}
}
},
"payout_fail": {
"value": {
"unique_external_id": "company:1",
"transfer_type": "bank",
"aggregator": "Razorpay",
"is_active": true,
"users": {
"unique_external_id": "company:1",
"name": "reliance retail",
"email": "reliance@gmail.com",
"mobile": "1234567890"
},
"bank_details": {
"country": "",
"state": "",
"city": "",
"account_no": "9876543210",
"bank_name": "SBI",
"branch_name": "Mumbai",
"account_holder": "Vikas Kumar",
"ifsc_code": "SBIN0011513",
"account_type": "saving"
}
}
},
"internal_server_fail": {
"value": {
"unique_external_id": "company:1",
"transfer_type": "bank",
"aggregator": "Razorpay",
"is_active": true,
"users": {
"unique_external_id": "company:1",
"name": "reliance retail",
"email": "reliance@gmail.com",
"mobile": "1234567890"
},
"bank_details": {
"country": "",
"state": "",
"city": "",
"account_no": "9876543210",
"bank_name": "SBI",
"branch_name": "Mumbai",
"account_holder": "Vikas Kumar",
"ifsc_code": "SBIN0011513",
"account_type": "saving"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "save payout response object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PayoutDetails"
},
"examples": {
"payout_success": {
"value": {
"success": true,
"is_active": true,
"bank_details": {
"account_type": "saving",
"account_holder": "Vikas Kumar",
"branch_name": "Mumbai",
"country": "",
"ifsc_code": "SBIN0011513",
"account_no": "9876543210",
"city": "",
"state": "",
"bank_name": "SBI"
},
"unique_transfer_no": "e388c1c5df4933fa01f6da9f92595589",
"users": {
"name": "reliance retail",
"unique_external_id": "company:1",
"mobile": "1234567890",
"email": "reliance@gmail.com"
},
"aggregator": "Razorpay",
"transfer_type": "bank",
"created": true,
"payouts": {
"aggregator_fund_id": null
},
"payment_status": "payout_initiated"
}
}
}
}
}
},
"400": {
"description": "Bad Request Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundErrorCodeAndMessage"
},
"examples": {
"payout_fail": {
"value": {
"success": false,
"error": {
"code": "BAD_REQUEST_ERROR",
"description": ""
}
}
}
}
}
}
}
},
"x-groups": [
"Payout"
],
"security": [
{
"oauth2": [
"company/finance/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/payouts/{unique_transfer_no}",
"methodType": "post"
}
}

🔧 Operation: getPaymentLinkId​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getPaymentLinkId
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get payment link",
"description": "get a payment link",
"tags": [
"Payment"
],
"operationId": "getPaymentLinkId",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payment_option_success": {
"summary": "valid company id",
"value": 1
},
"payment_option_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"payment_option_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"payment_option_fail": {
"summary": "valid app id",
"value": 1
}
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"description": "Unique payment link id"
},
"required": true,
"examples": {
"payment_option_success": {
"summary": "Unique payment link id",
"value": "b594184d9a060657566cef7e1ad61b77"
},
"payment_option_fail": {
"summary": "Unique payment link id",
"value": "b594184d9a060657566cef7e1ad61b77"
}
}
},
{
"in": "query",
"name": "payment_link_id",
"required": true,
"schema": {
"type": "string",
"description": "Unique payment link id"
},
"examples": {
"payment_option_success": {
"summary": "Unique payment link id",
"value": "b594184d9a060657566cef7e1ad61b77"
}
}
}
],
"responses": {
"200": {
"description": "Success. Check the example shown below",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPaymentLinkDetails"
},
"examples": {
"payment_option_success": {
"value": {
"success": true,
"message": "Payment link",
"status_code": 200,
"payment_link_current_status": "resent",
"payment_link_url": "https://api.fyndx0.de/service/application/payment/v1.0/payment/options/link/?id=4adb4451720a82ee69a3c1c4cc9ab442&refresh=false",
"external_order_id": "FY62614DF9D5CF31D3D0",
"amount": 21900,
"merchant_name": "Fynd",
"polling_timeout": 1800
}
}
}
}
}
}
},
"x-groups": [
"Payment link"
],
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/create-payment-link/{id}",
"methodType": "get"
}
}

🔧 Operation: getPaymentModeSequencing​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getPaymentModeSequencing
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get details for the active inactive payment modes for merchant",
"description": "get details for the given payment modes and its sequencingfor merchant",
"tags": [
"Payment"
],
"operationId": "getPaymentModeSequencing",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payment_mode_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"payment_mode_success": {
"summary": "valid Application id",
"value": "000000000000000000000001"
}
}
},
{
"name": "business_unit",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"payment_mode_success": {
"summary": "business unit",
"value": "storefront"
}
}
},
{
"name": "device",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"payment_mode_success": {
"summary": "device",
"value": "android"
}
}
}
],
"responses": {
"200": {
"description": "Success. Returns user cod limit , remaining limit and usage of user for COD. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentModeDetails"
},
"examples": {
"payment_mode_success": {
"value": {
"success": true,
"items": [
{
"name": "Card",
"id": 2,
"is_active": false,
"priority": 1,
"logos": {
"small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/payments/original/yniQOrWsoP-default_card.png",
"large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/payments/original/yniQOrWsoP-default_card.png"
}
}
]
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"x-groups": [
"Seller payment mode"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing",
"methodType": "get"
}
}

🔧 Operation: patchPaymentModeSequencing​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.patchPaymentModeSequencing
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update sequencing of payment modes for the merchant",
"description": "Update sequencing of payment modes for the merchant",
"tags": [
"Payment"
],
"operationId": "patchPaymentModeSequencing",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payment_mode_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"payment_mode_success": {
"summary": "valid Application id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "payment mode sequencing will get update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlatformPaymentMode"
},
"examples": {
"payment_mode_success": {
"value": {
"business_unit": "storefront",
"device": "desktop",
"items": [
{
"name": "Card",
"id": 2,
"is_active": false,
"priority": 1,
"logos": {
"small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/payments/original/yniQOrWsoP-default_card.png",
"large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/payments/original/yniQOrWsoP-default_card.png"
}
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success. Returns true or false for user cod option for payment. Check the example shown below or refer `GetUserCODLimitResponseSchema` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorConfigDetails"
},
"examples": {
"payment_mode_success": {
"value": {
"success": true,
"items": [
{
"name": "Card",
"id": 2,
"is_active": false,
"priority": 1,
"logos": {
"small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/payments/original/yniQOrWsoP-default_card.png",
"large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/x5/payments/original/yniQOrWsoP-default_card.png"
}
}
]
}
}
}
}
}
}
},
"x-groups": [
"Seller payment mode"
],
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing",
"methodType": "patch"
}
}

🔧 Operation: getPaymentMethodConfig​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getPaymentMethodConfig
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "List Payment Method Configs",
"description": "Get all active List Payment Method Configs",
"tags": [
"Payment"
],
"operationId": "getPaymentMethodConfig",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"payment_config_success": {
"summary": "valid company id",
"value": 1
}
}
}
],
"responses": {
"200": {
"description": "List Order Beneficiary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentMethodConfigDetails"
},
"examples": {
"payment_option_success": {
"value": {
"success": true,
"required_session_paths": [
{
"version": "v1.0",
"paths": [
{
"type": "payment_session",
"uri_path": "v1.0/payment_session",
"content_type": "json",
"methods": [
"GET",
"POST"
]
},
{
"type": "refund_session",
"uri_path": "v1.0/refund_session",
"content_type": "json",
"methods": [
"GET",
"POST",
"PUT"
]
},
{
"type": "payment_void_session",
"uri_path": "v1.0/payment_void_session",
"content_type": "json",
"methods": [
"GET",
"POST",
"PUT"
]
},
{
"type": "status_session",
"uri_path": "v1.0/status_session",
"content_type": "json",
"methods": [
"GET"
]
}
]
}
],
"payment_methods": [
{
"sub_payment_mode": [
{
"logo": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
"name": "ICICI Bank PayLater",
"code": "icic"
}
],
"name": "Pay Later",
"id": 1,
"logos": {
"large": "https://hdn-1.fynd.com/payment/netbanking.png",
"small": "https://hdn-1.fynd.com/payment/netbanking.png"
},
"slug": "PL"
},
{
"sub_payment_mode": [],
"name": "RUPIFIPG",
"id": 18,
"logos": {
"large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
"small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
},
"slug": "RUPIFIPG"
},
{
"sub_payment_mode": [],
"name": "CSAS",
"id": 20,
"logos": {
"large": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/U0YF3k1RS-card_store.png",
"small": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/U0YF3k1RS-card_store.png"
},
"slug": "CSAS"
},
{
"sub_payment_mode": [],
"name": "CCAVENUEPG",
"id": 21,
"logos": {
"large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
"small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
},
"slug": "CCAVENUEPG"
},
{
"sub_payment_mode": [],
"name": "CARDLESS_EMI",
"id": 22,
"logos": {
"large": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
"small": "https://hdn-1.fynd.com/payment/Pos+Logo.png"
},
"slug": "CARDLESS_EMI"
}
],
"checkout_type": [
{
"name": "Standard",
"slug": "standard"
},
{
"name": "Custom",
"slug": "custom"
}
],
"auto_capture": [
true,
false
],
"mode": [
{
"name": "Test",
"slug": "test"
},
{
"name": "Live",
"slug": "live"
}
],
"country": [
{
"name": "India",
"slug": "IND"
}
],
"currency": [
{
"name": "INR",
"slug": "INR"
}
]
}
}
}
}
}
}
},
"x-groups": [
"Seller payment mode"
],
"security": [
{
"oauth2": [
"company/finance/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/payment/methods/configs",
"methodType": "get"
}
}

🔧 Operation: getCodRefundAggregator​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getCodRefundAggregator
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Fetch COD Refund Aggregator configuration",
"description": "Retrieves COD refund aggregator configuration associated with the given application ID.",
"tags": [
"Payment"
],
"operationId": "getCodRefundAggregator",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"status_fetch_success": {
"summary": "valid company id",
"value": 1
},
"status_fetch_failed": {
"summary": "invalid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"status_fetch_success": {
"summary": "valid app id",
"value": "64bf81dcc07acacc135733ea"
}
}
}
],
"responses": {
"200": {
"description": "COD Refund aggregator details fetched successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CodRefundAggregatorResponseSchema"
},
"examples": {
"status_fetch_success": {
"summary": "COD Refund aggregator details found",
"value": {
"success": true,
"message": "COD Refund aggregator details fetched successfully",
"data": {
"bank": {
"beneficiary_limits": 5,
"aggregator_slug": "jioone_pay",
"pennydrop_validation": true
},
"upi": {
"beneficiary_limits": 2,
"aggregator_slug": "jioone_pay",
"masked_upi": false
},
"jmwallet": {}
}
}
}
}
}
}
}
},
"x-groups": [
"Payment"
],
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/cod/configuration",
"methodType": "get"
}
}

🔧 Operation: updateCodRefundAggregator​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.updateCodRefundAggregator
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Add/Update COD Refund Aggregator configuration",
"description": "Add/Update configuration for BANK/UPI/JMWALLET in COD refund aggregator for a specific application.",
"tags": [
"Payment"
],
"operationId": "updateCodRefundAggregator",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"examples": {
"status_update_success": {
"summary": "valid company id",
"value": 1
},
"status_update_failed": {
"summary": "invalid company id",
"value": 0
}
},
"required": true
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"examples": {
"status_update_success": {
"summary": "valid app id",
"value": "64bf81dcc07acacc135733ea"
}
},
"required": true
}
],
"requestBody": {
"description": "Payload to insert or update COD Refund Aggregator configuration.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCodRefundAggregatorRequestSchema"
},
"examples": {
"status_update_success": {
"summary": "Valid config for BANK and UPI",
"value": {
"bank": {
"beneficiary_limits": 5,
"aggregator_slug": "jioone_pay",
"pennydrop_validation": true
},
"upi": {
"beneficiary_limits": 2,
"aggregator_slug": "jioone_pay",
"masked_upi": false
},
"jmwallet": {}
}
},
"status_update_failed": {
"value": {
"bank": {
"beneficiary_limits": 5,
"aggregator_slug": "jioone_pay",
"penny_drop_validation": true
},
"upi": {
"beneficiary_limits": 2,
"aggregator_slug": "jioone_pay",
"masked_upi": false
},
"jmwallet": {}
}
}
}
}
}
},
"responses": {
"200": {
"description": "COD Refund aggregator inserted or updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CodRefundAggregatorResponseSchema"
},
"examples": {
"status_update_success": {
"summary": "COD Refund aggregator inserted Successfully",
"value": {
"success": true,
"message": "COD Refund aggregator inserted Successfully",
"data": {
"bank": {
"beneficiary_limits": 5,
"aggregator_slug": "jioone_pay",
"pennydrop_validation": true
},
"upi": {
"beneficiary_limits": 2,
"aggregator_slug": "jioone_pay",
"masked_upi": false
},
"jmwallet": {}
}
}
}
}
}
}
}
},
"x-groups": [
"Payment"
],
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/cod/configuration",
"methodType": "post"
}
}

🔧 Operation: getDevices​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getDevices
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get all business units and it's devices.",
"description": "Get all business units and it's devices.",
"tags": [
"Payment"
],
"operationId": "getDevices",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"aggregator_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"aggregator_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"responses": {
"200": {
"description": "Success Returns all business units and it's devices.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDevice"
},
"examples": {
"aggregator_success": {
"summary": "business unit like storefront , pos and devices like android, ios.",
"value": {
"success": true,
"message": "",
"items": {
"business_unit": [
{
"name": "POS",
"slug": "pos"
},
{
"name": "Storefront",
"slug": "storefront"
}
],
"device": [
{
"name": "Website",
"slug": "desktop"
},
{
"name": "iOS",
"slug": "ios"
},
{
"name": "Android",
"slug": "android"
},
{
"name": "Payment-link",
"slug": "payment_link"
}
]
}
}
}
}
}
}
}
},
"x-groups": [
"Seller payment mode"
],
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/all-devices",
"methodType": "get"
}
}

🔧 Operation: getAggregatorCredentialHistory​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getAggregatorCredentialHistory
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Get merchant refund priority",
"description": "Get merchant refund priority.",
"tags": [
"Payment"
],
"operationId": "getAggregatorCredentialHistory",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"credentials_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"credentials_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
},
{
"name": "aggregator",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The aggregator for which credentials are requested",
"examples": {
"credentials_success": {
"summary": "valid aggregator name",
"value": "razorpay"
}
}
},
{
"name": "config_type",
"in": "query",
"required": true,
"x-not-enum": true,
"schema": {
"type": "string",
"x-not-enum": true
},
"description": "The configuration type for which credentials are requested",
"examples": {
"credentials_success": {
"summary": "config type",
"value": "self"
}
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorHistoryDetails"
},
"examples": {
"credentials_success": {
"value": {
"success": true,
"items": [
{
"created_on": "2023-05-29T15:09:15.000Z",
"updated_on": "2023-06-01T12:38:21.000Z",
"reviewer": "",
"comments": "",
"review_status": "inactive",
"is_active": false,
"config_type": "partner",
"public_token": "**************************96T",
"razorpay_account_id": "***************6l7"
}
]
}
}
}
}
}
}
},
"x-groups": [
"Aggregator"
],
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential/history",
"methodType": "get"
}
}

🔧 Operation: getAggregatorCredential​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getAggregatorCredential
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "API to get merchant refund priority",
"description": "API to get merchant refund priority",
"tags": [
"Payment"
],
"operationId": "getAggregatorCredential",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"credentials_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"credentials_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
},
{
"name": "aggregator",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The aggregator for which credentials are requested",
"examples": {
"credentials_success": {
"summary": "valid aggregator",
"value": "razorpay"
}
}
},
{
"name": "config_type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"x-not-enum": true
},
"description": "The configuration type for which credentials are requested",
"examples": {
"credentials_success": {
"summary": "config type",
"value": "self"
}
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorCredentialRes"
},
"examples": {
"credentials_success": {
"value": {
"success": true,
"created": true,
"app_id": "6399ba6924ab1bacf0131493"
}
}
}
}
}
}
},
"x-groups": [
"Aggregator"
],
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential",
"methodType": "get"
}
}

🔧 Operation: updateAggregatorCredential​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.updateAggregatorCredential
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Update Aggregator Credentials",
"tags": [
"Payment"
],
"operationId": "updateAggregatorCredential",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"aggregator_credential_success": {
"summary": "valid company id",
"value": 1
},
"internal_server_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"aggregator_credential_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"internal_server_fail": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorCredentialReq"
},
"examples": {
"aggregator_credential_success": {
"summary": "aggregator details like logo, name, is_active.",
"value": {
"ccavenue": {
"key": "sdfdsf",
"secret": "fdsdsfdff",
"merchant_id": "sdfffsfsfsfsf",
"integration_type": "iframe_normal",
"is_active": true,
"config_type": "self"
},
"app_id": "000000000000000000000001",
"is_active": true
}
},
"internal_server_fail": {
"summary": "aggregator details like logo, name, is_active.",
"value": {
"ccavenue": {
"key": "sdfdsf",
"secret": "fdsdsfdff",
"merchant_id": "sdfffsfsfsfsf",
"integration_type": "iframe_normal",
"is_active": true,
"config_type": "self"
},
"app_id": "000000000000000000000001",
"is_active": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchAggregatorCredentialDetails"
},
"examples": {
"aggregator_credential_success": {
"value": {
"success": true,
"aggregators": [
"ccavenue"
]
}
}
}
}
}
}
},
"x-groups": [
"Aggregator"
],
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/configuration/aggregator/credential",
"methodType": "post"
}
}

🔧 Operation: copyConfigPaymentModes​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.copyConfigPaymentModes
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Copy payment mode config of onc device to another.",
"description": "Copy aggregator config like Wallet, NB, paylater from one device of an aggregator like razorpay to another device.",
"tags": [
"Payment"
],
"operationId": "copyConfigPaymentModes",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"copy_config_aggregator_success": {
"summary": "valid company id",
"value": 1
},
"brand_payment_gateway_fail": {
"summary": "valid company id",
"value": 1
},
"copy_config_internal_server_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"copy_config_aggregator_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"brand_payment_gateway_fail": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"copy_config_internal_server_fail": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "Pass device and business unit to copy data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlatformPaymentModeCopyConfigCreation"
},
"examples": {
"copy_config_aggregator_success": {
"summary": "from and to devices and its business_unit from where config is to be copyed.",
"value": {
"from_config": {
"business_unit": "storefront",
"device": "android"
},
"to_config": {
"business_unit": "storefront",
"device": [
"ios",
"desktop"
]
}
}
},
"brand_payment_gateway_fail": {
"summary": "from and to devices and its business_unit from where config is to be copyed.",
"value": {
"from_config": {
"business_unit": "storefront",
"device": "android"
},
"to_config": {
"business_unit": "pos",
"device": [
"ios"
]
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Enable/Disable the aggregator and return updated response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorConfigDetails"
},
"examples": {
"copy_config_aggregator_success": {
"summary": "from and to devices and its business_unit from where config is to be copyed.",
"value": {
"success": true,
"message": "requested change is being performed",
"items": []
}
}
}
}
}
},
"400": {
"description": "Bad Request Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorCodeAndMessage"
},
"examples": {
"brand_payment_gateway_fail": {
"summary": "get brand secret details failed.",
"value": {
"error": {
"code": "BAD_REQUEST_ERROR",
"description": ""
},
"success": false
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"x-groups": [
"Seller payment mode"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment_modes/sequencing/copy-config",
"methodType": "patch"
}
}

🔧 Operation: copyConfigAggPaymentModes​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.copyConfigAggPaymentModes
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Copy aggregator config of onc device to another.",
"description": "Copy aggregator config like Wallet, NB, paylater from one device of an aggregator like razorpay to another device.",
"tags": [
"Payment"
],
"operationId": "copyConfigAggPaymentModes",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"copy_config_aggregator_success": {
"summary": "valid company id",
"value": 1
},
"brand_payment_gateway_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"copy_config_aggregator_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"brand_payment_gateway_fail": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
},
{
"name": "aggregator_id",
"in": "path",
"description": "Aggregator Id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"copy_config_aggregator_success": {
"summary": "aggregator id",
"value": "2"
}
}
}
],
"requestBody": {
"description": "Pass device and business unit to copy data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlatformPaymentModeCopyConfigCreation"
},
"examples": {
"copy_config_aggregator_success": {
"summary": "from and to devices and its business_unit from where config is to be copyed.",
"value": {
"from_config": {
"business_unit": "storefront",
"device": "desktop"
},
"to_config": {
"business_unit": "storefront",
"device": [
"desktop"
]
}
}
},
"brand_payment_gateway_fail": {
"summary": "from and to devices and its business_unit from where config is to be copyed.",
"value": {
"from_config": {
"business_unit": "storefront",
"device": "android"
},
"to_config": {
"business_unit": "pos",
"device": [
"ios"
]
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Enable/Disable the aggregator and return updated response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AggregatorConfigDetails"
},
"examples": {
"copy_config_aggregator_success": {
"summary": "from and to devices and its business_unit from where config is to be copyed.",
"value": {
"success": true,
"message": "requested change is being performed",
"items": []
}
}
}
}
}
},
"400": {
"description": "Bad Request Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorCodeAndMessage"
},
"examples": {
"brand_payment_gateway_fail": {
"summary": "get brand secret details failed.",
"value": {
"error": {
"code": "BAD_REQUEST_ERROR",
"description": ""
},
"success": false
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"x-groups": [
"Aggregator"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/options/aggregators/{aggregator_id}/copy-config",
"methodType": "patch"
}
}

🔧 Operation: addRefundBankAccount​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.addRefundBankAccount
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Save bank details for cancelled/returned order",
"description": "save bank details for returned/cancelled order to refund amount in his account.",
"tags": [
"Payment"
],
"operationId": "addRefundBankAccount",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"add_refund_account_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"add_refund_account_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddBeneficiaryDetailsOTPCreation"
},
"examples": {
"add_refund_account_fail": {
"value": {
"details": {
"account_holder": "shashi bro",
"account_no": "000100289877623",
"address": "A-402, HARI SMRUTI BLDG, KHANDWALA LANE",
"bank_name": "Test",
"branch_name": "Test1",
"comment": "Test",
"email": "abc@example.com",
"ifsc_code": "SBIN0008752",
"mobile": "9999999999"
},
"order_id": "xyzxyzxyz",
"transfer_mode": "bank",
"shipment_id": "16100144824381402124",
"delights": false
}
},
"add_refund_account_success": {
"value": {
"details": {
"account_holder": "shashi bro",
"account_no": "000100289877623",
"address": "A-402, HARI SMRUTI BLDG, KHANDWALA LANE",
"bank_name": "Test",
"branch_name": "Test1",
"comment": "Test",
"email": "abc@example.com",
"ifsc_code": "SBIN0008752",
"mobile": "9999999999"
},
"order_id": "FY65C2797B2F00FCF07E",
"transfer_mode": "bank",
"shipment_id": "16100144824381402124",
"delights": false
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundAccountDetails"
},
"examples": {
"add_refund_account_success": {
"value": {
"success": true,
"message": "Account successfully created",
"data": {},
"is_verified_flag": true
}
}
}
}
}
},
"400": {
"description": "Bad Request Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundErrorCodeAndMessage"
},
"examples": {
"add_refund_account_fail": {
"value": {
"success": false,
"code": "BAD_REQUEST_ERROR",
"description": "Order not found!"
}
}
}
}
}
}
},
"x-groups": [
"Refund"
],
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account_create",
"methodType": "post"
}
}

🔧 Operation: deleteBeneficiaryDetails​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.deleteBeneficiaryDetails
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Delete saved beneficiary details of customers",
"description": "Delete the saved beneficiary details provided beneficiary Id.",
"tags": [
"Payment"
],
"operationId": "deleteBeneficiaryDetails",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"add_refund_account_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"add_refund_account_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "Pass the details in the request body as shown below.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteBeneficiary"
},
"examples": {
"ben_id_delete_success": {
"value": {
"beneficiary_id": "12344532qwq"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success. Shows whether the beneficiary details were saved to a returned/cancelled order or not.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteRefundAccountDetails"
},
"examples": {
"ben_id_delete_success": {
"value": {
"success": true,
"refund_options": "Account successfully deleted"
}
}
}
}
}
}
},
"x-groups": [
"Refund"
],
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/account_create",
"methodType": "patch"
}
}

🔧 Operation: setRefundOptionforShipment​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.setRefundOptionforShipment
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Save refund source against shipment and order",
"description": "Save refund source against shipment and order",
"tags": [
"Payment"
],
"operationId": "setRefundOptionforShipment",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid company id",
"value": 1
},
"merchant_payment_response_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"merchant_payment_response_fail": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "Check the example of a request body below or refer `ShipmentRefundDetails` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentRefundDetails"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"order_id": "FY65C2797B2F00FCF07E",
"beneficiary_id": "BHMF7MDOyDA3avPLlVkLxOxTnzeYpvOT8WXUkCKkxN0=",
"transfer_mode": "bank",
"shipment_ids": []
}
},
"merchant_payment_response_fail": {
"value": {
"beneficiary_id": "213123213123",
"transfer_mode": "bank"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success. Returns the status of saved refund source for shipment and order. Check the example shown below or refer `ShipmentRefundRes` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentRefundRes"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"success": true,
"data": {
"order_id": "FY653A517A0EF2BEE7A7",
"beneficiary_id": "213123213123",
"transfer_mode": "bank",
"shipment_ids": []
},
"message": "Saved transfer mode for shipment"
}
}
}
}
}
},
"400": {
"description": "Bad Request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundOptionErrorCodeAndMessage"
},
"examples": {
"merchant_payment_response_fail": {
"value": {
"message": "",
"success": false
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"x-groups": [
"Refund"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/refundoptions",
"methodType": "post"
}
}

🔧 Operation: getSelectedRefundOption​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getSelectedRefundOption
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "get the selected refund options for shipment id",
"description": "get the selected refund options for shipment id",
"tags": [
"Payment"
],
"operationId": "getSelectedRefundOption",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
},
{
"name": "shipment_id",
"in": "query",
"description": "shipment Id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"merchant_payment_response_success": {
"summary": "valid shipment id",
"value": "16100144824381402124"
}
}
},
{
"name": "order_id",
"in": "query",
"description": "Order Id",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"merchant_payment_response_success": {
"summary": "valid order id",
"value": "FY65C2797B2F00FCF07E"
}
}
}
],
"responses": {
"200": {
"description": "Success. Returns the selected refund option for shipment. Check the example shown below or refer `SelectedRefundOptionDetailsSchema` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelectedRefundOptionDetails"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"success": true,
"shipment_id": "1754345678232412312",
"transfer_mode": {
"mode": "bank",
"display_name": "Transfer to Bank"
},
"message": "Refund Source",
"beneficiary_details": {
"refund_to": "bank",
"refund_source": "Bank"
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"x-groups": [
"Refund"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/payment/selected_refund_options",
"methodType": "get"
}
}

🔧 Operation: getUserBeneficiariesDetailV2​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getUserBeneficiariesDetailV2
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Lists the beneficiary of a refund",
"description": "get the details of all active beneficiary added by a user for refund.",
"tags": [
"Payment"
],
"operationId": "getUserBeneficiariesDetailV2",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid company id",
"value": 1
},
"merchant_payment_response_fail": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
},
"merchant_payment_response_fail": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
},
{
"in": "query",
"description": "A unique number used for identifying and tracking your orders.",
"name": "order_id",
"schema": {
"type": "string"
},
"examples": {
"merchant_payment_response_success": {
"summary": "valid order_id",
"value": "FY65C2797B2F00FCF07E"
},
"merchant_payment_response_fail": {
"summary": "invalid order_id",
"value": "xyzxyzxyz"
}
}
},
{
"in": "query",
"description": "A unique number used for identifying and tracking your orders.",
"name": "shipment_id",
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "Mode of payment for which beneficiary data required",
"name": "mop",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success. Returns the details of the beneficiary getting a refund. Check the example shown below or refer `OrderBeneficiaryResponse` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderBeneficiaryResponseSchemaV2"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"data": {
"bank": [
{
"id": 221,
"beneficiary_id": "0f7e44a922df352c05c5f73cb40ba115",
"bank_name": "Example Bank",
"branch_name": "Example Bank",
"account_holder": "DUMMY NAME",
"account_no": "XXXX-XXXX-9999",
"ifsc_code": "EXAM0009999",
"mobile": "9999999999",
"email": "dummy@example.com",
"address": "204A",
"comment": "",
"is_active": true,
"created_on": "2020-06-29T12:38:39.000Z",
"modified_on": "2020-06-29T12:38:39.000Z",
"display_name": "BANK",
"transfer_mode": "bank",
"title": "Bank Account",
"subtitle": "1234567891",
"delights_user_name": "test",
"default_beneficiary": true
}
],
"upi": [
{
"id": 222,
"beneficiary_id": "0f7e44a922df352c05c5f73cb40ba115",
"vpa_address": "success@upi",
"vpa": "success@upi",
"mobile": "9999999999",
"email": "dummy@example.com",
"address": "204A",
"comment": "",
"display_name": "UPI",
"transfer_mode": "vpa",
"title": "UPI Payment",
"subtitle": "success@upi",
"delights_user_name": "test",
"default_beneficiary": true
}
],
"wallet": [
{
"id": 223,
"beneficiary_id": "234567823213123",
"wallet_address": "1234567891",
"wallet": "1234567891",
"mobile": "9999999999",
"email": "dummy@example.com",
"address": "204A",
"comment": "",
"display_name": "Wallet",
"transfer_mode": "wallet",
"title": "DummyWallet",
"subtitle": "1234567891",
"delights_user_name": "test",
"default_beneficiary": true
}
]
},
"show_beneficiary_details": true
}
}
}
}
}
},
"400": {
"description": "Internal Server Error. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundErrorCodeAndMessage"
},
"examples": {
"merchant_payment_response_fail": {
"value": {
"error": {
"description": "Internal Server Error"
},
"success": false
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"x-groups": [
"Beneficiary"
],
"path": "/service/platform/payment/v2.0/company/{company_id}/application/{application_id}/refund/user/beneficiary",
"methodType": "get"
}
}

🔧 Operation: validateBeneficiaryAddress​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.validateBeneficiaryAddress
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Validate UPI ID and IFSC code",
"description": "Validate UPI ID and IFSC code",
"tags": [
"Payment"
],
"operationId": "validateBeneficiaryAddress",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "Check the example of a request body below or refer `ValidateVPARequestSchema` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateValidateAddress"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"upi_vpa": "succes@okhdfcbank",
"aggregator": "juspay"
}
},
"merchant_payment_response_fail": {
"value": {
"xyz": "succes@razorpay"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success. Returns the IFSC/VPA validation. Check the example shown below or refer `ValidateValidateAddressDetails` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateValidateAddressDetails"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"success": true,
"ifsc": {
"branch_name": "MANPUR",
"bank_name": "GAYA",
"BRANCH": "MANPUR",
"CENTRE": "GAYA",
"DISTRICT": "GAYA",
"STATE": "BIHAR",
"ADDRESS": "POBUNIYADGANJBIHAR",
"CONTACT": "00",
"MICR": "816002103",
"UPI": true,
"RTGS": true,
"CITY": "GAYA",
"NEFT": true,
"IMPS": true,
"SWIFT": "",
"BANK": "State Bank of India",
"BANKCODE": "SBIN",
"IFSC": "SBIN0005611",
"success": true
},
"vpa": {
"upi_vpa": "success@razorpay",
"status": "VALID",
"is_valid": true,
"customer_name": "Verified"
}
}
}
}
}
}
},
"400": {
"description": "Bad Request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundErrorCodeAndMessage"
},
"examples": {
"merchant_payment_response_fail": {
"value": {
"success": false,
"data": {
"status": "failed"
},
"message": "error message"
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"x-groups": [
"Beneficiary"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/validate/beneficiary-address",
"methodType": "post"
}
}

🔧 Operation: updateDefaultBeneficiary​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.updateDefaultBeneficiary
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Set a default beneficiary for a refund",
"description": "set a default beneficiary for getting a refund.",
"tags": [
"Payment"
],
"operationId": "updateDefaultBeneficiary",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid company id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"required": true,
"examples": {
"merchant_payment_response_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
}
}
],
"requestBody": {
"description": "Pass the order ID and beneficiary ID in the request body as shown below.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultBeneficiary"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"order_id": "FY65C2797B2F00FCF07E",
"beneficiary_id": "BHMF7MDOyDA3avPLlVkLxOxTnzeYpvOT8WXUkCKkxN0=",
"merchant_shipment_id": "16100144824381402124"
}
},
"merchant_payment_response_fail": {
"value": {
"order_id": "FY5E85A08E01FA5075F0"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success. Check the example shown below or refer `SetDefaultBeneficiaryDetails` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultBeneficiaryDetails"
},
"examples": {
"merchant_payment_response_success": {
"value": {
"success": true,
"is_beneficiary_set": true
}
}
}
}
}
},
"400": {
"description": "Bad Request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultBeneficiaryDetails"
},
"examples": {
"merchant_payment_response_fail": {
"value": {
"success": false,
"is_beneficiary_set": false
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"x-groups": [
"Beneficiary"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refund/beneficiary/default",
"methodType": "post"
}
}

🔧 Operation: getPennyDropValidation​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getPennyDropValidation
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "pennydrop validation",
"description": "get pennydrop validation for bank account",
"tags": [
"Payment"
],
"operationId": "getPennyDropValidation",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"examples": {
"success_pennydrop": {
"summary": "valid company id",
"value": 1
}
},
"required": true
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"examples": {
"success_pennydrop": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
},
"required": true
}
],
"responses": {
"200": {
"description": "Success. Returns the status of pennydrop validation. Check the example shown below or refer `PennyDropValidationDetails` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PennyDropValidationDetails"
},
"examples": {
"success_pennydrop": {
"value": {
"success": true,
"allow_pennydrop_validation": true,
"message": "Penny drop validation updated"
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"x-groups": [
"Refund"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/pennydrop/validation",
"methodType": "get"
}
}

🔧 Operation: updatePennyDropValidation​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.updatePennyDropValidation
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "update penny drop validation for application ID",
"description": "update penny drop validation for application ID",
"tags": [
"Payment"
],
"operationId": "updatePennyDropValidation",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"examples": {
"pennydrop_success": {
"summary": "valid company id",
"value": 1
}
},
"required": true
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"examples": {
"pennydrop_success": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
},
"required": true
}
],
"requestBody": {
"description": "Check the example of a request body below or refer `UpdatePennyDropValidation` for more details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePennyDropValidation"
},
"examples": {
"pennydrop_success": {
"value": {
"allow_pennydrop_validation": false
}
},
"pennydrop_fail": {
"value": {
"allow_penny": false
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success. Returns the status for pennydrop validation flag. Check the example shown below or refer `PennyDropValidationDetails` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PennyDropValidationDetails"
},
"examples": {
"pennydrop_success": {
"value": {
"success": true,
"allow_pennydrop_validation": true,
"message": "Penny drop validation updated"
}
}
}
}
}
},
"400": {
"description": "Bad Request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundErrorCodeAndMessage"
},
"examples": {
"pennydrop_fail": {
"value": {
"success": false,
"message": "Bad request error message",
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "Bad request error message"
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/write"
]
}
],
"x-groups": [
"Refund"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/pennydrop/validation",
"methodType": "post"
}
}

🔧 Operation: getShipmentBeneficiary​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getShipmentBeneficiary
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "get beneficiary details",
"description": "get beneficiary details",
"tags": [
"Payment"
],
"operationId": "getShipmentBeneficiary",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company Id",
"schema": {
"type": "integer"
},
"examples": {
"success_beneficiary_details": {
"summary": "valid company id",
"value": 1
}
},
"required": true
},
{
"name": "application_id",
"in": "path",
"description": "Application id",
"schema": {
"type": "string"
},
"examples": {
"success_beneficiary_details": {
"summary": "valid app id",
"value": "000000000000000000000001"
}
},
"required": true
},
{
"name": "shipment_id",
"in": "path",
"description": "Shipment id",
"schema": {
"type": "string"
},
"examples": {
"beneficiary_details_success": {
"value": "16100144824381402124"
},
"beneficiary_details_fail": {
"value": "0111"
}
},
"required": true
}
],
"responses": {
"200": {
"description": "Success. Returns the Beneficiary details for the shipment. Check the example shown below or refer `ShipmentBeneficiaryDetailsRes` for more details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentBeneficiaryDetailsRes"
},
"examples": {
"beneficiary_details_success": {
"value": {
"success": true,
"shipment_id": 16100144824381403000,
"transfer_mode": {
"mode": "bank",
"display_name": "Bank"
},
"message": "Refund Option found.",
"beneficiary_details": "eyJpdiI6ICJUbDZhTU14Q1VZMnA5SGl6U0FlWEJRPT0iLCAiZ2F0ZXdheV9zZWNyZXQiOiAiaFpYNTMrOTVNbklVVHFUOGttNTBTbXU5NEljdW55d2JRbFN1SDVBQjJJdVV0dzd5TGlLNkErdnA2dk9qOXVPSmlEcW5KVkk4Y0t0ZG14OEozcjBpMWRucURSVXFEcFp5K0gyT25vdnJyZjhPanVrQi8zdUZDYnFCWWJTWFZ3cHJmR1cwTUJoalV4K1hjRW9ZSFVOYmI3UmJaM29EakMzakN2M2xDVG9ZY2JIN0VXUHg4cmo2dWVLMlorRnZhbWFoY0lQRXJGZ0JnU2lDbUlRVGxnN2lEYWJ5NHo3VnlwZnBCSUFha0YwV3JQejZRS3VQS2lvb1FLZ1ZhVXdaVEl1MU80eVJYK2IxSTkzYWljK1lrZVBManZQc2ttREttcGNsUGJjMW93S3Z4SFdzZGZGdG9TNWV2TkN4amkzOXdrU2tIL09vOXd2VmhJbGVxa05adm9XUm1KTDFrQ2xOZUkydkNVV21rQzRuV1djVmM4N0FOQ2wvVUZBdDF3WU5NZzd2aHRXYTF0cjQ2U2VKVGozZGp2RXZzbjQ2RzE3blpLWjNRR3E2cThHdmRMMlQxNlVKMUxRRjQ2NldWdUxvNmNRTXdMSzBiWDRkM2VEcmp1ckxCK3JCOHRSN1F3SXhDVGlRVFB6dzZpcTNtQUFHd0JiTWNuK0taVk5KTmIzRW9mUUt0NU5RdkN6VnBicWZiTEd1YlFHbEFaZ1VuSzA2TXRBOHYwMnVhbTVjcEtWeEVDbUdwdzN1cmV5Z3k5K1pFU1pMWTY0L3BmaUt6L09odXBHOG5SWXpVajNjSEpMK25aUzNsclIxTlpkU2tWRkFWbk9EWi9Da1ZEM2ZyNDFDOXZVViJ9"
}
}
}
}
}
},
"400": {
"description": "Bad Request. See the error object in the response body to know the exact reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundErrorCodeAndMessage"
},
"examples": {
"beneficiary_details_fail": {
"value": {
"success": false,
"message": "Bad request error message",
"error": {
"code": "BAD_REQUEST_ERROR",
"description": "Bad request error message"
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"x-groups": [
"Beneficiary"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/refunds/beneficiary-details/{shipment_id}",
"methodType": "get"
}
}

🔧 Operation: getTransactions​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_ADDED
  • Path: paths.getTransactions
  • New Schema:
{
"methodTypePlaceHolder": {
"summary": "Retrieve transaction history by user or order",
"description": "Fetches a list of transactions associated with a specific user ID or order ID. Allows filtering and pagination to retrieve specific transaction records.",
"tags": [
"Payment"
],
"operationId": "getTransactions",
"parameters": [
{
"name": "company_id",
"in": "path",
"description": "Company ID",
"required": true,
"schema": {
"type": "integer"
},
"examples": {
"successful_transactions_get_user_id": {
"summary": "Valid company ID for user id",
"value": 1
},
"successful_transactions_get_order_id": {
"summary": "Valid company ID for order id",
"value": 1
},
"successful_transactions_get_shipment_id": {
"summary": "Valid company ID for order id",
"value": 1
}
}
},
{
"name": "application_id",
"in": "path",
"description": "Application ID",
"required": true,
"schema": {
"type": "string"
},
"examples": {
"successful_transactions_get_user_id": {
"summary": "Valid application ID for user id",
"value": "000000000000000000000001"
},
"successful_transactions_get_order_id": {
"summary": "Valid application ID for order id",
"value": "000000000000000000000001"
},
"successful_transactions_get_shipment_id": {
"summary": "Valid application ID for order id",
"value": "000000000000000000000001"
}
}
},
{
"name": "user_id",
"in": "query",
"description": "User ID of the user",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"successful_transactions_get_user_id": {
"summary": "Valid user ID",
"value": "5c5c0b0a3fe3c6d1ae4ea1fc"
},
"failed_transactions_get_user_id": {
"summary": "Invalid user ID",
"value": "invalid_user_id"
},
"failed_transactions_get_null": {
"summary": "No user ID",
"value": null
}
}
},
{
"name": "page_size",
"in": "query",
"description": "Size of the page, default and max value is 10",
"required": false,
"schema": {
"type": "integer",
"default": 10
},
"examples": {
"successful_transactions_get_user_id": {
"summary": "Valid page size",
"value": 3
}
}
},
{
"name": "page_number",
"in": "query",
"description": "Page number, default is 1",
"required": false,
"schema": {
"type": "integer",
"default": 1
},
"examples": {
"successful_transactions_get_user_id": {
"summary": "Valid page number",
"value": 1
}
}
},
{
"name": "order_id",
"in": "query",
"description": "Order ID for which transaction data is needed",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"successful_transactions_get_order_id": {
"summary": "Valid order ID",
"value": "FY65C47E27CB249F999C"
},
"failed_transactions_get_order_id": {
"summary": "Invalid order ID",
"value": "invalid_order_id"
},
"failed_transactions_get_null": {
"summary": "No order ID",
"value": null
}
}
},
{
"name": "shipment_id",
"in": "query",
"description": "Shipment ID for which transaction data is needed",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"successful_transactions_get_shipment_id": {
"summary": "Valid shipment ID",
"value": "16260188949011882144"
},
"failed_transactions_get_shipment_id": {
"summary": "Invalid shipment ID",
"value": "invalid_shipment_id"
},
"failed_transactions_get_null": {
"summary": "No shipment ID",
"value": null
}
}
},
{
"name": "transaction_id",
"in": "query",
"description": "Transaction ID for which transaction data is needed",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"successful_transactions_get_transaction_id": {
"summary": "Valid transaction ID",
"value": "TR65C47E27CBFD964727"
},
"failed_transactions_get_transaction_id": {
"summary": "Invalid transaction ID",
"value": "invalid_transaction_id"
},
"failed_transactions_get_null": {
"summary": "No transaction ID",
"value": null
}
}
}
],
"responses": {
"200": {
"description": "Success. Returns the list of transaction and order data using order_id or the user_id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionsResponseSchema"
},
"examples": {
"successful_transactions_get_user_id": {
"summary": "Successful transaction retrieval via user id",
"value": {
"success": true,
"orders": {
"FY67C9417079482A571C": {
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "started",
"amount": 3785,
"paid_amount": 0,
"device": "android",
"transactions": [
{
"transaction_id": "TR67C94170792A6BB53B",
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "STARTED",
"aggregator_name": "Razorpay",
"transaction_type": "FORWARD",
"payment_mode": "UPI",
"amount": 3785,
"message": null,
"return_shipment_id": null
},
{
"transaction_id": "TR67C94170792A6BB53B",
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "REFUND_DONE",
"aggregator_name": "Razorpay",
"transaction_type": "REFUND",
"payment_mode": "UPI",
"amount": 3785,
"message": "",
"return_shipment_id": "FY67C9417079482A571C141"
}
]
},
"FY67C94170793883DB15": {
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "started",
"amount": 500,
"paid_amount": 0,
"device": "android",
"transactions": [
{
"transaction_id": "TR67C94170793F1FA759",
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "STARTED",
"aggregator_name": "JioOnePay",
"transaction_type": "FORWARD",
"payment_mode": "JIOPP",
"amount": 500,
"message": null,
"return_shipment_id": null
},
{
"transaction_id": "TR67C94170793F1FA759",
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "REFUND_DONE",
"aggregator_name": "JioOnePay",
"transaction_type": "REFUND",
"payment_mode": "JIOPP",
"amount": 500,
"message": "",
"return_shipment_id": "17092910928811366238"
}
]
},
"FY67C941707940E21EEF": {
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "started",
"amount": 3785,
"paid_amount": 0,
"device": "desktop",
"transactions": [
{
"transaction_id": "TR67C9417079E61F06C4",
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "STARTED",
"aggregator_name": "Checkout",
"transaction_type": "FORWARD",
"payment_mode": "PL",
"amount": 3785,
"message": null,
"return_shipment_id": null
},
{
"transaction_id": "TR67C9417079E61F06C4",
"created_on": "2025-03-06T12:02:16Z",
"modified_on": "2025-03-06T12:02:16Z",
"status": "REFUND_DONE",
"aggregator_name": "Checkout",
"transaction_type": "REFUND",
"payment_mode": "PL",
"amount": 3785,
"message": "",
"return_shipment_id": "17092910928811366238"
}
]
}
},
"page": {
"page_size": 3,
"current_page": 1
}
}
},
"successful_transactions_get_order_id": {
"summary": "Successful transaction retrieval via order id",
"value": {
"success": true,
"orders": {
"FY65C2797B2F00FCF07E": {
"created_on": "2023-06-22T15:40:18Z",
"modified_on": "2025-03-06T11:57:58Z",
"status": "pending",
"amount": 3785,
"paid_amount": 0,
"device": "desktop",
"transactions": [
{
"transaction_id": "TR65C2797B2FB1724BC1",
"created_on": "2024-02-06T23:54:59Z",
"modified_on": "2025-03-06T12:01:42Z",
"status": "PENDING",
"aggregator_name": "Razorpay",
"transaction_type": "FORWARD",
"payment_mode": "PAYMENTLINK",
"amount": 3785,
"message": "",
"return_shipment_id": null
},
{
"transaction_id": "TR65C2797B2FB1724BC1",
"created_on": "2025-03-06T11:57:37Z",
"modified_on": "2025-03-06T12:01:42Z",
"status": "REFUND_DONE",
"aggregator_name": "Razorpay",
"transaction_type": "REFUND",
"payment_mode": "PAYMENTLINK",
"amount": 3785,
"message": "",
"return_shipment_id": "FY65C2797B2F00FCF07E"
}
]
}
},
"page": {
"page_size": 1,
"current_page": 1
}
}
},
"successful_transactions_get_shipment_id": {
"summary": "Successful transaction retrieval via shipment id",
"value": {
"success": true,
"orders": {
"FY67C94015790894B04D": {
"created_on": "2025-03-06T11:56:29Z",
"modified_on": "2025-03-06T11:57:59Z",
"status": "started",
"amount": 2190,
"paid_amount": 0,
"device": "desktop",
"transactions": [
{
"transaction_id": "TR67C9401579F1921B96",
"created_on": "2025-03-06T11:56:29Z",
"modified_on": "2025-03-06T11:57:59Z",
"status": "STARTED",
"aggregator_name": "Ajiodhan",
"transaction_type": "FORWARD",
"payment_mode": "PL",
"amount": 2190,
"message": null,
"return_shipment_id": null
},
{
"transaction_id": "TR67C9401579F1921B96",
"created_on": "2025-03-06T11:57:59Z",
"modified_on": "2025-03-06T11:57:59Z",
"status": "REFUND_DONE",
"aggregator_name": "Jiopay",
"transaction_type": "REFUND",
"payment_mode": "PL",
"amount": 2190,
"message": "",
"return_shipment_id": "16260188949011882144"
}
]
}
},
"page": {
"page_size": 1,
"current_page": 1
}
}
},
"successful_transactions_get_transaction_id": {
"summary": "Successful transaction retrieval via transaction id",
"value": {
"success": true,
"orders": {
"FY65C47E27CB249F378C": {
"created_on": "2025-03-06T11:56:29Z",
"modified_on": "2025-03-06T11:57:59Z",
"status": "started",
"amount": 2190,
"paid_amount": 0,
"device": "desktop",
"transactions": [
{
"transaction_id": "TR65C47E27CBFD964727",
"created_on": "2025-03-06T11:56:29Z",
"modified_on": "2025-03-06T11:57:59Z",
"status": "STARTED",
"aggregator_name": "Ajiodhan",
"transaction_type": "FORWARD",
"payment_mode": "PL",
"amount": 2190,
"message": null,
"return_shipment_id": null
},
{
"transaction_id": "TR65C47E27CBFD964727",
"created_on": "2025-03-06T11:57:59Z",
"modified_on": "2025-03-06T11:57:59Z",
"status": "REFUND_DONE",
"aggregator_name": "Jiopay",
"transaction_type": "REFUND",
"payment_mode": "PL",
"amount": 2190,
"message": "",
"return_shipment_id": "16260188949011882144"
}
]
}
},
"page": {
"page_size": 1,
"current_page": 1
}
}
}
}
}
}
},
"400": {
"description": "Bad Request. See the error object in the response body for details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HttpErrorCodeAndMessage"
},
"examples": {
"failed_transactions_get_user_id": {
"summary": "Invalid User ID",
"value": {
"success": false,
"error": {
"code": "BAD_REQUEST",
"description": "User[invalid user id] not found in the system."
}
}
},
"failed_transactions_get_order_id": {
"summary": "Invalid Order ID",
"value": {
"success": false,
"error": {
"code": "BAD_REQUEST",
"description": "Order[invalid_order_id] not found in the system."
}
}
},
"failed_transactions_get_shipment_id": {
"summary": "Invalid Shipment ID",
"value": {
"success": false,
"error": {
"code": "BAD_REQUEST",
"description": "Shipment[invalid_shipment_id] not found in the system."
}
}
},
"failed_transactions_get_transaction_id": {
"summary": "Invalid Transaction ID",
"value": {
"success": false,
"error": {
"code": "BAD_REQUEST",
"description": "Transaction[invalid_transaction_id] not found in the system."
}
}
},
"failed_transactions_get_null": {
"summary": "Neither User ID nor Order ID passed",
"value": {
"success": false,
"error": {
"code": "BAD_REQUEST",
"description": "Please provide at least one of the following (user_id, order_id, transaction_id, or shipment_id)."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"application/payments/read"
]
}
],
"x-groups": [
"TransactionManagement"
],
"path": "/service/platform/payment/v1.0/company/{company_id}/application/{application_id}/transactions",
"methodType": "get"
}
}

Was this section helpful?