Skip to main content

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
Loading...
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
Loading...

Was this section helpful?