List Refunds

curl --request GET \
  --url https://api-staging.eximpe.com/pg/refunds \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

import requests

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

headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Client-ID': '<api-key>', 'X-Client-Secret': '<api-key>'}
};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'

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

{
  "count": 4,
  "page": 1,
  "page_size": 250,
  "next": null,
  "previous": null,
  "results": [
    {
      "refund_id": "RF8380989720",
      "refund_amount": 11,
      "refund_status": "INITIATED",
      "refunded_at": null,
      "message": "Refund Request Queued",
      "payment_id": "PR8867819681"
    },
    {
      "refund_id": "RF8370660295",
      "refund_amount": 12,
      "refund_status": "INITIATED",
      "refunded_at": null,
      "message": "No action status found",
      "payment_id": "PR3828502708"
    }
  ]
}

GET

refunds

List Refunds

curl --request GET \
  --url https://api-staging.eximpe.com/pg/refunds \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

import requests

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

headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Client-ID': '<api-key>', 'X-Client-Secret': '<api-key>'}
};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'

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

{
  "count": 4,
  "page": 1,
  "page_size": 250,
  "next": null,
  "previous": null,
  "results": [
    {
      "refund_id": "RF8380989720",
      "refund_amount": 11,
      "refund_status": "INITIATED",
      "refunded_at": null,
      "message": "Refund Request Queued",
      "payment_id": "PR8867819681"
    },
    {
      "refund_id": "RF8370660295",
      "refund_amount": 12,
      "refund_status": "INITIATED",
      "refunded_at": null,
      "message": "No action status found",
      "payment_id": "PR3828502708"
    }
  ]
}

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.

Query Parameters

payment_id

string

Filter by payment ID.

reference_id

string

Filter by order reference ID.

from_date

string<date>

Filter refunds created from this date. Format: YYYY-MM-DD.

to_date

string<date>

Filter refunds created up to this date. Format: YYYY-MM-DD.

merchant_id

string

Filter refunds by merchant ID.

Response

200 - application/json

A paginated list of refunds.

count

integer

required

Total number of refunds

page

integer

required

Current page number

page_size

integer

required

Number of refunds per page

string | null

required

URL for the next page of results

string | null

required

URL for the previous page of results

results

object[]

required

Show child attributes

Order

Payment

Merchant

Settlement

Refund

Webhooks

List Refunds

Authorizations

Query Parameters

Response