Create a new refund session/transaction

POST

/api/v1/payment_session/{gid}/refund

Fynd platform uses this api to initiate/create refund session/transaction. This API will be called from gringotts to extension url to initiate a refund. Extension will need to validate `checksum_auth` in headers before proceeding with the request.

Request Parameters

gid

string

Global identifier for the transaction. This is generated by Fynd payments platform and is unique for each transaction

Request body

amount

integer

Transaction value in the smallest unit of the currency (paise/cents)

app_id

string

Application id of sales channel

currency

string

Currency of the payment

gid

string

Global identifier of the transaction against which payment_session was initiated. This is generated by Fynd payments platform and is unique for each transaction

journey_type

string

Enum

meta

object

Optional

Additional metadata associated with the payment session

mode

string

Enum

request_id

string

Refund request id, unique id for each refund request generated by Fynd platform

status

string

Constant value of 'initiate'

Example request

{
  "gid": "TR661CED900E91E14001",
  "object": "refund",
  "request_id": "17066802422601819004",
  "amount": "79",
  "currency": "INR",
  "status": "initiate",
  "meta": {
    "payment_mode": "CARD"
  }
}

Response schema

200

400

Success

RefundPaymentSessionResponse

aggregator_payment_refund_details

object (AggregatorPaymentRefundDetails)

AggregatorPaymentRefundDetails

gid

string

Global identifier of the transaction against which payment_session was initiated. This is generated by Fynd payments platform and is unique for each transaction

Example Response

{
  "aggregator_payment_refund_details": {
    "amount": 10000,
    "currency": "INR",
    "request_id": "17066802422601819004",
    "status": "started"
  },
  "gid": "TR661CED900E91E14001"
}