Create Refund Transaction

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

RESPONSE MESSAGE DESCRIPTION

ParameterDescription
idThe refund ID in the DB.
refundReferenceThe reference of the newly created refund
parentPaymentIdThe database ID
refundTypePARTIAL or FULL, determined by the refund amount.
refundAmountThe amount requested. The amount is in minor e.g 100 naira would be 10000
createdDateUNIX timestamp of when the request was created.
refundStatusThe 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
createdByDetails of the user who requested the refundUNIX timestamp of when the request was created.
reasonForRefundDetails of the refund reason.
merchantCodeThe initiating merchant's code.
Body Params
string
Defaults to kjsd313sjdsyegdie9322ssaud0004
string
string
Defaults to 3207368
string
Defaults to PARTIAL
string
Defaults to 10
string
string
Headers
string
required
Defaults to Bearer eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOlsiaXN3LWNvbGxlY3Rpb25zIiwiaXN3LXBheW1lbnRnYXRld2F5IiwicGFzc3BvcnQiLCJwcm9qZWN0LXgtbWVyY2hhbnQiLCJ2YXVsdCJdLCJtZXJjaGFudF9jb2RlIjoiTVg2MDcyIiwicmVxdWVzdG9yX2lkIjoiMTIzODA4NTk1MDMiLCJzY29wZSI6WyJwcm9maWxlIl0sImp0aSI6IjVkOTczM2Y5LWMzNDEtNGFjZC04ZjE3LWViYzUyYWE0NjM2MiIsInBheWFibGVfaWQiOiIzMzU5NyIsImNsaWVudF9pZCI6IklLSUFCMjNBNEUyNzU2NjA1QzFBQkMzM0NFM0MyODdFMjcyNjdGNjYwRDYxIn0.ElgBX2KoF9LuUUpeBGzzp8CDAllTHWfgM6pJRgTtPYGJpoZufKlJrmE4QTvZV6MIVaNtK21majTgR4qXJr7CEkPK_4zCIHyN2b8a445vqhLYcbffQvK4EeUn_RzsWTmub2bruG5s4bRS1il5itPR0QQ-trEsbELU7TAHvC4p786RiAQd-K_I0bwtLzIXQN65jlw3eJxxK-BGfca-OMTUo9HGvraebfLB-7h4-vNbPred58gfLBSwK31jaLP19cMRc5Jea28jrlmGNUhHGzjnP7ZanqgC9uuvoepQsa39_DNBonR6xirxKw4aNlNLcKOTn026wyOTHIHUGlDQ3s3AOQ
string
required
Defaults to application/json
Responses

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