curl --request GET \
--url https://api.augustus.com/v1/returns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.augustus.com/v1/returns/{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.augustus.com/v1/returns/{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.augustus.com/v1/returns/{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.augustus.com/v1/returns/{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.augustus.com/v1/returns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/returns/{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": "550e8400-e29b-41d4-a716-446655440005",
"type": "return",
"status": "sent",
"deposit_id": "550e8400-e29b-41d4-a716-446655440004",
"amount": "100.50",
"currency": "USD",
"failure": null,
"initiated_at": "2026-01-15T10:30:00Z",
"sent_at": "2026-01-15T10:35:00Z",
"tx_hash": null,
"rail": "ach",
"metadata": {
"invoice_id": "INV-2026-0042"
}
}Retrieve return
Retrieves a return by ID.
curl --request GET \
--url https://api.augustus.com/v1/returns/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.augustus.com/v1/returns/{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.augustus.com/v1/returns/{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.augustus.com/v1/returns/{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.augustus.com/v1/returns/{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.augustus.com/v1/returns/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/returns/{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": "550e8400-e29b-41d4-a716-446655440005",
"type": "return",
"status": "sent",
"deposit_id": "550e8400-e29b-41d4-a716-446655440004",
"amount": "100.50",
"currency": "USD",
"failure": null,
"initiated_at": "2026-01-15T10:30:00Z",
"sent_at": "2026-01-15T10:35:00Z",
"tx_hash": null,
"rail": "ach",
"metadata": {
"invoice_id": "INV-2026-0042"
}
}Authorizations
Bearer token for authentication with Augustus Banking API
Path Parameters
Unique identifier of the return.
"550e8400-e29b-41d4-a716-446655440005"
Response
The return resource
Unique identifier of the return.
"550e8400-e29b-41d4-a716-446655440005"
Resource type discriminator.
return Current status of the return.
initiated, submitted, sent, failed, returned "sent"
ID of the parent deposit.
"550e8400-e29b-41d4-a716-446655440004"
Amount as a string decimal (e.g. "100.50").
"100.50"
Currency code (ISO 4217 or crypto).
EUR, GBP, USD, USDC "USD"
Failure details when status is failed, otherwise null.
Show child attributes
Show child attributes
null
ISO 8601 UTC timestamp when the return was initiated.
"2026-01-15T10:30:00Z"
ISO 8601 UTC timestamp when the return was sent.
"2026-01-15T10:35:00Z"
Transaction hash for crypto returns, or null when not known. Only blockchain rails support this field.
null
Payment scheme or blockchain used for the return, or null when unknown.
sepa, sepa_instant, faster_payments, swift, internal, target, ach, fedwire, bitcoin, bitcoin_testnet4, ethereum, ethereum_sepolia, solana, solana_devnet, polygon, polygon_amoy, null "ach"
Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.
Show child attributes
Show child attributes
{ "invoice_id": "INV-2026-0042" }
Was this page helpful?