Get Recipient Details
curl --request GET \
--url https://sandbox-api.axisfi.net/api/recipients/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/recipients/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/recipients/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/recipients/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/recipients/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/recipients/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/recipients/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{
"partner_recipient_id": "<string>",
"business_name": "<string>",
"business_type": "Business",
"country_code": "CN",
"recipient_id": "rcp_ff624a5b02d44c98af91698e0bc69118",
"status": "active",
"website": "https://www.example.com",
"created_at": "2023-11-07T05:31:56Z",
"address_info": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
},
"payment_details": {
"bank_name": "JPMorgan Chase",
"network": "SWIFT",
"account_name": "<string>",
"account_number": "<string>",
"swift_code": "<string>",
"account_currency": "USD",
"country_code": "CN",
"account_type": "<string>",
"payment_method": "INTERNATIONAL_WIRE",
"local_bank_code": "<string>"
},
"file_id_list": [
"<string>"
]
}{
"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>"
}
]
}Recipients
Get Recipient Details
Get a specific recipient by specifying the (Id).
GET
/
api
/
recipients
/
detail
Get Recipient Details
curl --request GET \
--url https://sandbox-api.axisfi.net/api/recipients/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/recipients/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/recipients/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/recipients/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/recipients/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/recipients/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/recipients/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{
"partner_recipient_id": "<string>",
"business_name": "<string>",
"business_type": "Business",
"country_code": "CN",
"recipient_id": "rcp_ff624a5b02d44c98af91698e0bc69118",
"status": "active",
"website": "https://www.example.com",
"created_at": "2023-11-07T05:31:56Z",
"address_info": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"state": "<string>",
"post_code": "<string>"
},
"payment_details": {
"bank_name": "JPMorgan Chase",
"network": "SWIFT",
"account_name": "<string>",
"account_number": "<string>",
"swift_code": "<string>",
"account_currency": "USD",
"country_code": "CN",
"account_type": "<string>",
"payment_method": "INTERNATIONAL_WIRE",
"local_bank_code": "<string>"
},
"file_id_list": [
"<string>"
]
}{
"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
Available options:
2024-12-01 Response
Operation Successful
Partner Assigned Recipient ID
Required string length:
20 - 64Business Name
Required string length:
2 - 128Business Type
Available options:
Business, Individual Pattern:
^(Business|Individual)$Country Code
Available options:
CN Pattern:
^(CN)$Example:
"CN"
Unique Recipient ID
Example:
"rcp_ff624a5b02d44c98af91698e0bc69118"
Status
Available options:
pending, active, rejected, suspended Example:
"active"
Website
Maximum string length:
225Example:
"https://www.example.com"
Address Information
Show child attributes
Show child attributes
Payment details
- Option 1
- Option 2
Show child attributes
Show child attributes
List of file IDs
Maximum array length:
10List of file IDs

