Retrieve a refund
curl --request GET \
--url https://api.vori.com/v1/refunds/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vori.com/v1/refunds/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vori.com/v1/refunds/{id}', 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.vori.com/v1/refunds/{id}",
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: Bearer <token>"
],
]);
$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.vori.com/v1/refunds/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vori.com/v1/refunds/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/refunds/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amount": "199.99",
"created_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"metadata": {
"order_source": "shopify",
"fulfillment_id": "88213"
},
"mode": "live",
"payment_id": "<string>",
"processor": "datacap",
"status": "authorized",
"store_id": "<string>",
"type": "return",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error_code": "insufficient_permissions",
"error_details": {
"action": "*",
"resource": "*"
}
}Refunds
Retrieve a refund
Reads a refund back, including the status of the money going back and whether the payment was cancelled or returned.
GET
/
v1
/
refunds
/
{id}
Retrieve a refund
curl --request GET \
--url https://api.vori.com/v1/refunds/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vori.com/v1/refunds/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vori.com/v1/refunds/{id}', 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.vori.com/v1/refunds/{id}",
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: Bearer <token>"
],
]);
$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.vori.com/v1/refunds/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vori.com/v1/refunds/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vori.com/v1/refunds/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"amount": "199.99",
"created_at": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"metadata": {
"order_source": "shopify",
"fulfillment_id": "88213"
},
"mode": "live",
"payment_id": "<string>",
"processor": "datacap",
"status": "authorized",
"store_id": "<string>",
"type": "return",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error_code": "insufficient_permissions",
"error_details": {
"action": "*",
"resource": "*"
}
}Payments and refunds are in beta. Contact Vori Support to enable them for your account. Until they are enabled, these endpoints answer
403 Forbidden.Authorizations
Response
A refund of a card payment taken through the Vori API. One refund is one attempt to give money back, and a refund is never edited once the processor has answered.
Where the refund stands: captured once the money was given back, and failed when the processor refused it. A refund is never authorized. A refund the processor has not answered for yet is not served at all, and goes on holding that part of the payment until its outcome is known.
Available options:
authorized, captured, failed Was this page helpful?