Create Refund

A refund can be initiated for a transaction using the Create Refund API.

Multiple refund requests can be initiated against the same transactionid such that the sum of the refund amounts do not exceed the transaction amount.

Body Params
string
required
^[A-Za-z0-9]{14,35}$

Unique transactionid created by BillDesk

string
required
^[-/~A-Za-z0-9\_ \:.,#@!\\*\\+]{1,120}$

Unique ID generated by the merchant for each request

string
required
^[A-Za-z0-9]{1,10}$

Unique identifier as defined by BillDesk for each merchant

date-time
required

BillDesk transaction date and time in YYYY-MM-DDThh:mm:ssTZD format

string
required
^([1-9]{1}[0-9]{0,7}(\.[0-9]{1,2})?)$

Original transaction amount in two decimals

string
required
^([1-9]{1}[0-9]{0,7}(\.[0-9]{1,2})?)$

Refund amount in two decimals

string
required

ISO currency code of the transaction amount, for INR this value will be 356

string
required
^[A-Za-z0-9\_\:\-]{1,100}$

Unique reference number created by the merchant for the refund request

split_payment
object
Headers
string
required

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

string
required

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json