You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference-v2/openapi_spec.json
+12-81Lines changed: 12 additions & 81 deletions
Original file line number
Diff line number
Diff line change
@@ -20357,82 +20357,6 @@
20357
20357
}
20358
20358
}
20359
20359
},
20360
-
"RefundRequest": {
20361
-
"type": "object",
20362
-
"required": [
20363
-
"payment_id"
20364
-
],
20365
-
"properties": {
20366
-
"payment_id": {
20367
-
"type": "string",
20368
-
"description": "The payment id against which refund is to be initiated",
20369
-
"example": "pay_mbabizu24mvu3mela5njyhpit4",
20370
-
"maxLength": 30,
20371
-
"minLength": 30
20372
-
},
20373
-
"refund_id": {
20374
-
"type": "string",
20375
-
"description": "Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment. If this is not passed by the merchant, this field shall be auto generated and provided in the API response. It is recommended to generate uuid(v4) as the refund_id.",
20376
-
"example": "ref_mbabizu24mvu3mela5njyhpit4",
20377
-
"nullable": true,
20378
-
"maxLength": 30,
20379
-
"minLength": 30
20380
-
},
20381
-
"merchant_id": {
20382
-
"type": "string",
20383
-
"description": "The identifier for the Merchant Account",
20384
-
"example": "y3oqhf46pyzuxjbcn2giaqnb44",
20385
-
"nullable": true,
20386
-
"maxLength": 255
20387
-
},
20388
-
"amount": {
20389
-
"type": "integer",
20390
-
"format": "int64",
20391
-
"description": "Total amount for which the refund is to be initiated. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, this will default to the full payment amount",
20392
-
"example": 6540,
20393
-
"nullable": true,
20394
-
"minimum": 100
20395
-
},
20396
-
"reason": {
20397
-
"type": "string",
20398
-
"description": "Reason for the refund. Often useful for displaying to users and your customer support executive. In case the payment went through Stripe, this field needs to be passed with one of these enums: `duplicate`, `fraudulent`, or `requested_by_customer`",
20399
-
"example": "Customer returned the product",
20400
-
"nullable": true,
20401
-
"maxLength": 255
20402
-
},
20403
-
"refund_type": {
20404
-
"allOf": [
20405
-
{
20406
-
"$ref": "#/components/schemas/RefundType"
20407
-
}
20408
-
],
20409
-
"default": "Instant",
20410
-
"nullable": true
20411
-
},
20412
-
"metadata": {
20413
-
"type": "object",
20414
-
"description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
/// Total amount for which the refund is to be initiated. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, this will default to the amount_captured of the payment
87
92
#[schema(value_type = Option<i64> , minimum = 100, example = 6540)]
0 commit comments