curl --request GET \
--url https://sandbox-api.axisfi.net/api/transactions/return/detail \
--header 'Api-Version: <api-version>' \
--header 'X-API-Key: <api-key>' \
--header 'X-API-Secret: <api-key>'import requests
url = "https://sandbox-api.axisfi.net/api/transactions/return/detail"
headers = {
"Api-Version": "<api-version>",
"X-API-Key": "<api-key>",
"X-API-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'Api-Version': '<api-version>',
'X-API-Key': '<api-key>',
'X-API-Secret': '<api-key>'
}
};
fetch('https://sandbox-api.axisfi.net/api/transactions/return/detail', 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://sandbox-api.axisfi.net/api/transactions/return/detail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-Version: <api-version>",
"X-API-Key: <api-key>",
"X-API-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://sandbox-api.axisfi.net/api/transactions/return/detail"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-API-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.axisfi.net/api/transactions/return/detail")
.header("Api-Version", "<api-version>")
.header("X-API-Key", "<api-key>")
.header("X-API-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.axisfi.net/api/transactions/return/detail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["X-API-Key"] = '<api-key>'
request["X-API-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "completed",
"currency": "USD",
"amount": 990,
"sender_account_name": "Example Beneficiary Ltd",
"sender_account_number": "1234567890",
"transaction_type": "return",
"transaction_id": "txn_6605854fbcf4423bb4d9c865fc10b10e",
"original_transaction_id": "txn_4963acdd765344c588c10cdd441a7399",
"refund_order_id": "R202609161531506979209",
"refund_reason": "Beneficiary bank return",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "Invalid organizationId",
"code": "ORG_ID_INVALID"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}Get Return Details
Get a payout return transaction by its transaction or refund order ID.
curl --request GET \
--url https://sandbox-api.axisfi.net/api/transactions/return/detail \
--header 'Api-Version: <api-version>' \
--header 'X-API-Key: <api-key>' \
--header 'X-API-Secret: <api-key>'import requests
url = "https://sandbox-api.axisfi.net/api/transactions/return/detail"
headers = {
"Api-Version": "<api-version>",
"X-API-Key": "<api-key>",
"X-API-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'Api-Version': '<api-version>',
'X-API-Key': '<api-key>',
'X-API-Secret': '<api-key>'
}
};
fetch('https://sandbox-api.axisfi.net/api/transactions/return/detail', 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://sandbox-api.axisfi.net/api/transactions/return/detail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-Version: <api-version>",
"X-API-Key: <api-key>",
"X-API-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://sandbox-api.axisfi.net/api/transactions/return/detail"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Version", "<api-version>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-API-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.axisfi.net/api/transactions/return/detail")
.header("Api-Version", "<api-version>")
.header("X-API-Key", "<api-key>")
.header("X-API-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.axisfi.net/api/transactions/return/detail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["X-API-Key"] = '<api-key>'
request["X-API-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "completed",
"currency": "USD",
"amount": 990,
"sender_account_name": "Example Beneficiary Ltd",
"sender_account_number": "1234567890",
"transaction_type": "return",
"transaction_id": "txn_6605854fbcf4423bb4d9c865fc10b10e",
"original_transaction_id": "txn_4963acdd765344c588c10cdd441a7399",
"refund_order_id": "R202609161531506979209",
"refund_reason": "Beneficiary bank return",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"detail": "Invalid organizationId",
"code": "ORG_ID_INVALID"
}
]
}{
"errors": [
{
"detail": "<string>",
"code": "<string>"
}
]
}Authorizations
Includes an API key in the HTTP headers to authenticate the client.
Includes an API secret in the HTTP headers to authenticate the client.
Headers
AxisFi API contract version
2024-12-01 Response
Operation Successful
Payout return transaction
Return transaction status
pending, completed, failed "completed"
Return currency code
"USD"
Return amount
990
Sender bank account name
"Example Beneficiary Ltd"
Sender bank account number
"1234567890"
Transaction Type
return "return"
AxisFI Return Transaction Id
"txn_6605854fbcf4423bb4d9c865fc10b10e"
Original Payout Transaction Id
"txn_4963acdd765344c588c10cdd441a7399"
Refund Order Id
"R202609161531506979209"
Reason for the payout return
"Beneficiary bank return"
Return transaction creation time
Return transaction completion time

