Retrieve a refund - Equals Documentation

GET

roqqett

refunds

{refundId}

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/refunds/{refundId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/roqqett/refunds/{refundId}', 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.equalsmoney.com/v2/roqqett/refunds/{refundId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.equalsmoney.com/v2/roqqett/refunds/{refundId}"

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

	req.Header.Add("Authorization", "<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.equalsmoney.com/v2/roqqett/refunds/{refundId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "status": "AWAITING_AUTHORISATION",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "reason": "Item returned",
  "authorisationUrl": "https://pay.roqqett.com/ob/refund/4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45",
  "createdAt": "2019-08-24T14:15:22Z",
  "completedAt": "2026-10-02T12:10:00Z"
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

refundId

string<uuid>

required

The ID of a refund.

Maximum string length: 36

Example:

"4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Response

string<uuid>

required

The ID of a refund.

Maximum string length: 36

Example:

"4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"

paymentId

string<uuid>

required

The payment being refunded.

Maximum string length: 36

Example:

"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"

status

enum<string>

required

AWAITING_AUTHORISATION until the merchant authorises the refund at their bank via authorisationUrl.

Available options:

AWAITING_AUTHORISATION,

PENDING,

COMPLETED,

FAILED,

CANCELLED

Example:

"AWAITING_AUTHORISATION"

amount

object

required

A money value: a decimal amount as a string plus an ISO-4217 currency code.

Show child attributes

reason

string | null

required

Why the refund was made.

Maximum string length: 140

Example:

"Item returned"

authorisationUrl

string<uri> | null

required

Open in a new window for the merchant to authorise the refund at their bank, then poll the refund. null once authorised.

Maximum string length: 2048

Example:

"https://pay.roqqett.com/ob/refund/4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45"

createdAt

string<date-time>

required

The date the Resource was initially created. ISO 8601 format without milliseconds.

completedAt

string<date-time> | null

required

When the refund reached a terminal status.

Example:

"2026-10-02T12:10:00Z"

⌘I

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/refunds/{refundId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/roqqett/refunds/{refundId}', 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.equalsmoney.com/v2/roqqett/refunds/{refundId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.equalsmoney.com/v2/roqqett/refunds/{refundId}"

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

	req.Header.Add("Authorization", "<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.equalsmoney.com/v2/roqqett/refunds/{refundId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "status": "AWAITING_AUTHORISATION",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "reason": "Item returned",
  "authorisationUrl": "https://pay.roqqett.com/ob/refund/4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45",
  "createdAt": "2019-08-24T14:15:22Z",
  "completedAt": "2026-10-02T12:10:00Z"
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}