Create Refund Transaction

post

https://qa.interswitchng.com/paymentgateway/api/v1/refunds

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

RESPONSE MESSAGE DESCRIPTION

Parameter	Description
id	The refund ID in the DB.
refundReference	The reference of the newly created refund
parentPaymentId	The database ID
refundType	PARTIAL or FULL, determined by the refund amount.
refundAmount	The amount requested. The amount is in minor e.g 100 naira would be 10000
createdDate	UNIX timestamp of when the request was created.
refundStatus	The processing state of the refund request, this could be either: SUCCESS, PENDING, PROCESSING, FAILED,COMPLETE, COMPLETE_MANUAL. You can view the full refund statuses and their meanings here Refund Guide
createdBy	Details of the user who requested the refundUNIX timestamp of when the request was created.
reasonForRefund	Details of the refund reason.
merchantCode	The initiating merchant's code.

Body Params

refundReference

string

Defaults to kjsd313sjdsyegdie9322ssaud0004

This is a unique identifier sent by the merchant to identify his refund. I propose they should be guided to append their merchant code as a prefix so as not to clash with some other merchant's ID. If this field is not provided, a randomly reference is generated. Max length is 100

parentTransactionReference

string

The transaction reference of the initial payment.Please Note: This field is Optional if parentPaymentId supplied. It is required if parentPaymentId is supplied. Max length is 100

parentPaymentId

string

Defaults to 3207368

The payemnt Id of the initial payment. This field is Optional if parentTransactionReference is supplied. Required if parentTransactionReference is supplied. Max length is 100

refundType

string

Defaults to PARTIAL

It should be either PARTIAL or FULL. If PARTIAL, the refundAmount should be passed. If FULL, the refundAmount does not need to be passed. The full transaction amount will be refunded.

refundAmount

string

Defaults to 10

The amount is in minor. If the refundType is PARTIAL, this field is mandatory. If the refundType is FULL, this field is not mandatory.

createdBy

string

The details of the user that initiated the refund.

reasonsForRefund

string

Details of why a refund was requested.

Headers

Authorization

string

required

Defaults to Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiaXN3LWNvbGxlY3Rpb25zIiwiaXN3LXBheW1lbnRnYXRld2F5IiwicGFzc3BvcnQiLCJwcm9qZWN0LXgtbWVyY2hhbnQiLCJ2YXVsdCJdLCJtZXJjaGFudF9jb2RlIjoiTVg2MDcyIiwicmVxdWVzdG9yX2lkIjoiMTIzODA4NTk1MDMiLCJzY29wZSI6WyJwcm9maWxlIl0sImp0aSI6IjVkOTczM2Y5LWMzNDEtNGFjZC04ZjE3LWViYzUyYWE0NjM2MiIsInBheWFibGVfaWQiOiIzMzU5NyIsImNsaWVudF9pZCI6IklLSUFCMjNBNEUyNzU2NjA1QzFBQkMzM0NFM0MyODdFMjcyNjdGNjYwRDYxIn0.ElgBX2KoF9LuUUpeBGzzp8CDAllTHWfgM6pJRgTtPYGJpoZufKlJrmE4QTvZV6MIVaNtK21majTgR4qXJr7CEkPK_4zCIHyN2b8a445vqhLYcbffQvK4EeUn_RzsWTmub2bruG5s4bRS1il5itPR0QQ-trEsbELU7TAHvC4p786RiAQd-K_I0bwtLzIXQN65jlw3eJxxK-BGfca-OMTUo9HGvraebfLB-7h4-vNbPred58gfLBSwK31jaLP19cMRc5Jea28jrlmGNUhHGzjnP7ZanqgC9uuvoepQsa39_DNBonR6xirxKw4aNlNLcKOTn026wyOTHIHUGlDQ3s3AOQ

Responses

RESPONSE MESSAGE DESCRIPTION

200200

400400