POST /refund

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
customer_note String No

Customer reason

transaction String Yes

Transaction reference or id

merchant_note String No

Merchant reason

amount Integer No

Amount ( in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR ) to be refunded to the customer. Amount cannot be more than the original transaction amount

currency String No

Three-letter ISO currency

Valid values:

  • "ZAR"
  • "GHS"
  • "USD"
  • "NGN"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.