Create Refund

curl --request POST \
  --url https://api-staging.eximpe.com/pg/refunds \
  --header 'Content-Type: application/json' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "payment_id": "PR8867819681",
  "refund_amount": "11"
}
'

import requests

url = "https://api-staging.eximpe.com/pg/refunds"

payload = {
    "payment_id": "PR8867819681",
    "refund_amount": "11"
}
headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({payment_id: 'PR8867819681', refund_amount: '11'})
};

fetch('https://api-staging.eximpe.com/pg/refunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.eximpe.com/pg/refunds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_id' => 'PR8867819681',
    'refund_amount' => '11'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.eximpe.com/pg/refunds"

	payload := strings.NewReader("{\n  \"payment_id\": \"PR8867819681\",\n  \"refund_amount\": \"11\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.eximpe.com/pg/refunds")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_id\": \"PR8867819681\",\n  \"refund_amount\": \"11\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.eximpe.com/pg/refunds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_id\": \"PR8867819681\",\n  \"refund_amount\": \"11\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Refund request processed successfully",
  "data": {
    "refund_id": "RF8380989720",
    "payment_id": "PR8867819681",
    "refund_status": "INITIATED",
    "message": "Refund Request Queued",
    "transaction_id": "138287318",
    "bank_ref_num": null,
    "refund_amount": "11"
  }
}

{
  "success": true,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

POST

refunds

Create Refund

curl --request POST \
  --url https://api-staging.eximpe.com/pg/refunds \
  --header 'Content-Type: application/json' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "payment_id": "PR8867819681",
  "refund_amount": "11"
}
'

import requests

url = "https://api-staging.eximpe.com/pg/refunds"

payload = {
    "payment_id": "PR8867819681",
    "refund_amount": "11"
}
headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({payment_id: 'PR8867819681', refund_amount: '11'})
};

fetch('https://api-staging.eximpe.com/pg/refunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.eximpe.com/pg/refunds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_id' => 'PR8867819681',
    'refund_amount' => '11'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.eximpe.com/pg/refunds"

	payload := strings.NewReader("{\n  \"payment_id\": \"PR8867819681\",\n  \"refund_amount\": \"11\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.eximpe.com/pg/refunds")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_id\": \"PR8867819681\",\n  \"refund_amount\": \"11\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.eximpe.com/pg/refunds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_id\": \"PR8867819681\",\n  \"refund_amount\": \"11\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Refund request processed successfully",
  "data": {
    "refund_id": "RF8380989720",
    "payment_id": "PR8867819681",
    "refund_status": "INITIATED",
    "message": "Refund Request Queued",
    "transaction_id": "138287318",
    "bank_ref_num": null,
    "refund_amount": "11"
  }
}

{
  "success": true,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

X-Client-ID

string

header

required

Client app ID. You can find your app id in the merchant dashboard.

X-Client-Secret

string

header

required

Client secret key. You can find your secret in the merchant dashboard.

Body

application/json

Refund creation request

payment_id

string

required

The ID of the payment to refund.

refund_amount

string

required

The amount to be refunded. Can be a partial amount.

Response

Refund created successfully

success

boolean

required

Indicates if the request was successful

message

string

required

Response message

data

object

required

Show child attributes

Order

Payment

Merchant

Settlement

Refund

Webhooks

Create Refund

Authorizations

Body

Response