Refund - EnKash API Document

Request

Path Params

transactionId

string

required

The transaction id for which you want to initiate refund

Header Params

Authorization

string

required

merchantAccessKey

string

required

Body Params application/json

amount

number

required

The amount to be refunded.

remarks

string

optional

Additional remarks or comments regarding the refund.

requestId

string

required

The unique identifier for the refund request.

Example

{
    "amount": 0,
    "remarks": "string",
    "requestId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v0/payment//refund' \
--header 'Authorization;' \
--header 'merchantAccessKey;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 0,
    "remarks": "string",
    "requestId": "string"
}'

Responses

🟢200OK

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

object (RefundResponse)

optional

amount

number

optional

The amount associated with the transaction.

paymentMode

enum<string>

optional

The mode of payment used for the transaction.

Allowed values:

NET_BANKINGUPICREDIT_CARDDEBIT_CARDPREPAID_CARDPOINTSPAY_LATERWALLETCORPORATE_CARDUPI_CREDIT_CARDSEAMLESS_BANKINGENKASH_COIN

bankCode

string

optional

The code identifying the bank associated with the transaction.

bankName

string

optional

The name of the bank associated with the transaction.

currency

string

optional

The currency in which the transaction amount is specified.

status

enum<string>

optional

The current status of the transaction.

Allowed values:

CREATEDPENDING_WITH_BANKSUCCESSFAILEDCANCELLEDEXPIREDAUTHENTICATION_IN_PROCESSOTP_RENDEREDCHECKOUT_RENDEREDMPI_PROCESSEDINVALID_STATUSAUTHORIZEDPROCESSINGHOLD

transactionId

string

optional

The unique identifier for the transaction.

txnMsg

string

optional

Additional message or information related to the transaction.

txnDate

string

optional

The date when the transaction was initiated.

uniqueTransactionId

string

optional

The unique identifier for the transaction.

bankTransactionId

string

optional

The identifier provided by the bank for the transaction.

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"
    }
}