{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"Reefpay Docs","description":"Reefpay is the groundbreaking payment gateway that lets you integrate with the future of payments.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"generate-a-client-report","__idx":0},"children":["Generate a client report"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A valid API key — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/setup/obtain-credentials"},"children":["Obtain API credentials"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"client-reporting-endpoints","__idx":2},"children":["Client reporting endpoints"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/clients"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["List all client accounts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/clients/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retrieve details for a specific client"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"option-a-list-all-clients","__idx":3},"children":["Option A: List all clients"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/clients"]}," to retrieve all client accounts visible to the authenticated account."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl https://api.dev.paradisegateway.net/v1/clients \\\n  -H \"APIKEY: YOUR-API-KEY\"\n","lang":"shell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\n\nresp = requests.get(\n    \"https://api.dev.paradisegateway.net/v1/clients\",\n    headers={\"APIKEY\": \"YOUR-API-KEY\"},\n)\nclients = resp.json()\nfor c in clients:\n    print(f\"{c['id']} — {c['dba']} ({c['type']})\")\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const resp = await fetch(\n  \"https://api.dev.paradisegateway.net/v1/clients\",\n  { headers: { \"APIKEY\": \"YOUR-API-KEY\" } }\n);\nconst clients = await resp.json();\nclients.forEach((c) => console.log(`${c.id} — ${c.dba} (${c.type})`));\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"csharp","header":{"controls":{"copy":{}}},"source":"using var client = new HttpClient();\nclient.DefaultRequestHeaders.Add(\"APIKEY\", \"YOUR-API-KEY\");\nvar resp = await client.GetAsync(\n    \"https://api.dev.paradisegateway.net/v1/clients\");\nConsole.WriteLine(await resp.Content.ReadAsStringAsync());\n","lang":"csharp"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Java","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"java","header":{"controls":{"copy":{}}},"source":"HttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n    .uri(URI.create(\"https://api.dev.paradisegateway.net/v1/clients\"))\n    .header(\"APIKEY\", \"YOUR-API-KEY\")\n    .GET().build();\nHttpResponse<String> resp = client.send(request,\n    HttpResponse.BodyHandlers.ofString());\nSystem.out.println(resp.body());\n","lang":"java"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Go","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"go","header":{"controls":{"copy":{}}},"source":"req, _ := http.NewRequest(\"GET\",\n    \"https://api.dev.paradisegateway.net/v1/clients\", nil)\nreq.Header.Set(\"APIKEY\", \"YOUR-API-KEY\")\nresp, _ := http.DefaultClient.Do(req)\ndefer resp.Body.Close()\nbody, _ := io.ReadAll(resp.Body)\nfmt.Println(string(body))\n","lang":"go"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PHP","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"$ch = curl_init(\"https://api.dev.paradisegateway.net/v1/clients\");\ncurl_setopt_array($ch, [\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_HTTPHEADER => [\"APIKEY: YOUR-API-KEY\"],\n]);\necho curl_exec($ch); curl_close($ch);\n","lang":"php"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Ruby","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ruby","header":{"controls":{"copy":{}}},"source":"require \"net/http\"\nuri = URI(\"https://api.dev.paradisegateway.net/v1/clients\")\nreq = Net::HTTP::Get.new(uri, { \"APIKEY\" => \"YOUR-API-KEY\" })\nresp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }\nputs resp.body\n","lang":"ruby"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is an array of client objects."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"id\": \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\",\n    \"object\": \"client\",\n    \"dba\": \"Acme Jewelry\",\n    \"parent_id\": \"CLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y\",\n    \"type\": \"merchant\",\n    \"admin_contact_details\": {\n      \"first_name\": \"John\",\n      \"last_name\": \"Doe\",\n      \"email\": \"john.doe@example.com\",\n      \"phone\": \"+15551234567\",\n      \"time_zone\": \"America/New_York\"\n    },\n    \"correlation_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"option-b-retrieve-a-specific-client","__idx":5},"children":["Option B: Retrieve a specific client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/clients/{id}"]}," to get the full details of a single client account."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"curl","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl https://api.dev.paradisegateway.net/v1/clients/CLIENT-3MtwBwLkdIwHu7ix28a3tqPa \\\n  -H \"APIKEY: YOUR-API-KEY\"\n","lang":"shell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"client_id = \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\"\nresp = requests.get(\n    f\"https://api.dev.paradisegateway.net/v1/clients/{client_id}\",\n    headers={\"APIKEY\": \"YOUR-API-KEY\"},\n)\nprint(resp.json())\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"JavaScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const clientId = \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\";\nconst resp = await fetch(\n  `https://api.dev.paradisegateway.net/v1/clients/${clientId}`,\n  { headers: { \"APIKEY\": \"YOUR-API-KEY\" } }\n);\nconsole.log(await resp.json());\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"csharp","header":{"controls":{"copy":{}}},"source":"var clientId = \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\";\nvar resp = await client.GetAsync(\n    $\"https://api.dev.paradisegateway.net/v1/clients/{clientId}\");\nConsole.WriteLine(await resp.Content.ReadAsStringAsync());\n","lang":"csharp"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Java","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"java","header":{"controls":{"copy":{}}},"source":"String clientId = \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\";\nHttpRequest request = HttpRequest.newBuilder()\n    .uri(URI.create(\n        \"https://api.dev.paradisegateway.net/v1/clients/\" + clientId))\n    .header(\"APIKEY\", \"YOUR-API-KEY\")\n    .GET().build();\nHttpResponse<String> resp = client.send(request,\n    HttpResponse.BodyHandlers.ofString());\nSystem.out.println(resp.body());\n","lang":"java"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Go","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"go","header":{"controls":{"copy":{}}},"source":"clientId := \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\"\nreq, _ := http.NewRequest(\"GET\",\n    \"https://api.dev.paradisegateway.net/v1/clients/\"+clientId, nil)\nreq.Header.Set(\"APIKEY\", \"YOUR-API-KEY\")\nresp, _ := http.DefaultClient.Do(req)\ndefer resp.Body.Close()\nbody, _ := io.ReadAll(resp.Body)\nfmt.Println(string(body))\n","lang":"go"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PHP","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"$clientId = \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\";\n$ch = curl_init(\"https://api.dev.paradisegateway.net/v1/clients/$clientId\");\ncurl_setopt_array($ch, [\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_HTTPHEADER => [\"APIKEY: YOUR-API-KEY\"],\n]);\necho curl_exec($ch); curl_close($ch);\n","lang":"php"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Ruby","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ruby","header":{"controls":{"copy":{}}},"source":"client_id = \"CLIENT-3MtwBwLkdIwHu7ix28a3tqPa\"\nuri = URI(\"https://api.dev.paradisegateway.net/v1/clients/#{client_id}\")\nreq = Net::HTTP::Get.new(uri, { \"APIKEY\" => \"YOUR-API-KEY\" })\nresp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }\nputs resp.body\n","lang":"ruby"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-client-fields","__idx":6},"children":["Key client fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unique client identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dba"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Doing-business-as name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchant"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reseller"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["parent_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Parent account in the hierarchy"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["admin_contact_details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Primary admin contact information"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"visibility-rules","__idx":7},"children":["Visibility rules"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list of clients you see depends on your API key's position in the account hierarchy:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Your account type"},"children":["Your account type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Clients visible"},"children":["Clients visible"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Top-level reseller"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["All merchants and sub-resellers in your hierarchy"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sub-reseller"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Only merchants under your account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Merchant"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Only your own client record"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":8},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/clients-users/onboard-client"},"children":["Onboard a new client"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/account-hierarchy/clients-and-resellers"},"children":["About clients and resellers"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/reports/user-reports"},"children":["Generate a user report"]}]}]}]},"headings":[{"value":"Generate a client report","id":"generate-a-client-report","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Client reporting endpoints","id":"client-reporting-endpoints","depth":2},{"value":"Option A: List all clients","id":"option-a-list-all-clients","depth":2},{"value":"Response","id":"response","depth":3},{"value":"Option B: Retrieve a specific client","id":"option-b-retrieve-a-specific-client","depth":2},{"value":"Key client fields","id":"key-client-fields","depth":3},{"value":"Visibility rules","id":"visibility-rules","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Generate a client report","shortTitle":"Client reports","intro":"Retrieve a summary list of all client accounts or the full details of a specific client using the Clients API.","type":"how-to","seo":{"title":""}},"lastModified":"2026-06-05T02:46:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/how-tos/reports/client-reports","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}