- Payment Gateway Overview
- Payment Gateway Sign Up
- Payment Methods
- Supported Integrations
- Payment Gateway APIs
- Web Integration
- Server to Server Integration
- Test Card Details
- Authorization
- Orders
- Payments
- Refunds
- Settlements
- Split Settlements
- E-Commerce Plugins
- Payment Links
- Payment Button
- Qr Code
- UPI Mandate
Refund
POST
/api/v0/payment/{transactionId}/refund
order-controller
Request
Path Params
transactionId
string
required
Header Params
Authorization
string
required
merchantAccessKey
string
required
Body Params application/json
amount
number
required
remarks
string
optional
requestId
string
required
Example
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v0/payment//refund' \
--header 'Authorization;' \
--header 'merchantAccessKey;' \
--header 'Content-Type: application/json' \
--data-raw ''
Responses
🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
string
optional
payload
object (RefundResponse)
optional
amount
number
optional
paymentMode
enum<string>
optional
Allowed values:
NET_BANKINGUPICREDIT_CARDDEBIT_CARDPREPAID_CARDPOINTSPAY_LATERWALLETCORPORATE_CARDUPI_CREDIT_CARDSEAMLESS_BANKINGENKASH_COIN
bankCode
string
optional
bankName
string
optional
currency
string
optional
status
enum<string>
optional
Allowed values:
CREATEDPENDING_WITH_BANKSUCCESSFAILEDCANCELLEDEXPIREDAUTHENTICATION_IN_PROCESSOTP_RENDEREDCHECKOUT_RENDEREDMPI_PROCESSEDINVALID_STATUSAUTHORIZEDPROCESSINGHOLD
transactionId
string
optional
txnMsg
string
optional
txnDate
string
optional
uniqueTransactionId
string
optional
bankTransactionId
string
optional
Example
{
"response_code": 0,
"response_message": "string",
"payload": {
"amount": 0,
"paymentMode": "NET_BANKING",
"bankCode": "string",
"bankName": "string",
"currency": "string",
"status": "CREATED",
"transactionId": "string",
"txnMsg": "string",
"txnDate": "string",
"uniqueTransactionId": "string",
"bankTransactionId": "string"
}
}
Modified at 2024-10-10 08:31:41