{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img","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":"add-an-integration","__idx":0},"children":["Add an integration"]},{"$$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 for the client account — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/setup/obtain-credentials"},"children":["Obtain API credentials"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Processor credentials provided by the host processor (for example, TSYS merchant ID or Vericheck business details)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-integrations-work","__idx":2},"children":["How integrations work"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An integration links a client account to a third-party processor. Once created, the client can route transactions through that processor."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"https://files.modern-mermaid.live/images/1776276491078-mermaid-diagram-1776276491199.png","alt":"How integrations work","framed":false,"withLightbox":true,"className":"how-integrations-work","width":"auto","height":"auto"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-processors","__idx":3},"children":["Supported processors"]},{"$$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":"Processor"},"children":["Processor"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Object type"},"children":["Object type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Payment types"},"children":["Payment types"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TSYS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["processor_account"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Credit/debit card transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vericheck"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vericheck"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["ACH payments and payouts"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"option-a-add-a-tsys-integration","__idx":4},"children":["Option A: Add a TSYS integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/integrations"]}," with the TSYS-specific fields."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-fields","__idx":5},"children":["Key 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":"Required"},"children":["Required"]},{"$$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":["general_details.is_active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether the integration is active (default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["general_details.mid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["TSYS merchant ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["general_details.card_brand"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Primary card brand (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visa"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mastercard"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["american_express"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["discover"]},", etc.)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["general_details.industry_type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Industry type for the merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["general_details.bin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["BIN number assigned by the processor"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["general_details.url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["TSYS host URL for transaction processing"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["general_details.settlement_time"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Time at which daily settlement occurs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["agent_details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Agent/ISO details if applicable"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Up to 50 key-value pairs for custom data"]}]}]}]}]},{"$$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 -X POST \\\n  https://api.dev.paradisegateway.net/v1/integrations \\\n  -H \"Content-Type: application/json\" \\\n  -H \"APIKEY: CLIENT-API-KEY\" \\\n  -d '{\n    \"general_details\": {\n      \"is_active\": true,\n      \"mid\": \"999000000011\",\n      \"card_brand\": \"visa\",\n      \"industry_type\": \"retail\",\n      \"bin\": \"999995\",\n      \"url\": \"https://example.tsyshost.com\",\n      \"settlement_time\": \"2026-01-01T22:00:00Z\"\n    },\n    \"metadata\": {\n      \"internal_ref\": \"tsys-primary\"\n    }\n  }'\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.post(\n    \"https://api.dev.paradisegateway.net/v1/integrations\",\n    headers={\"Content-Type\": \"application/json\", \"APIKEY\": \"CLIENT-API-KEY\"},\n    json={\n        \"general_details\": {\n            \"is_active\": True,\n            \"mid\": \"999000000011\",\n            \"card_brand\": \"visa\",\n            \"industry_type\": \"retail\",\n            \"bin\": \"999995\",\n            \"url\": \"https://example.tsyshost.com\",\n            \"settlement_time\": \"2026-01-01T22:00:00Z\",\n        },\n        \"metadata\": {\"internal_ref\": \"tsys-primary\"},\n    },\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 resp = await fetch(\n  \"https://api.dev.paradisegateway.net/v1/integrations\",\n  {\n    method: \"POST\",\n    headers: {\n      \"Content-Type\": \"application/json\",\n      \"APIKEY\": \"CLIENT-API-KEY\",\n    },\n    body: JSON.stringify({\n      general_details: {\n        is_active: true,\n        mid: \"999000000011\",\n        card_brand: \"visa\",\n        industry_type: \"retail\",\n        bin: \"999995\",\n        url: \"https://example.tsyshost.com\",\n        settlement_time: \"2026-01-01T22:00:00Z\",\n      },\n      metadata: { internal_ref: \"tsys-primary\" },\n    }),\n  }\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":"using var client = new HttpClient();\nclient.DefaultRequestHeaders.Add(\"APIKEY\", \"CLIENT-API-KEY\");\n\nvar payload = new\n{\n    general_details = new\n    {\n        is_active = true, mid = \"999000000011\",\n        card_brand = \"visa\", industry_type = \"retail\",\n        bin = \"999995\", url = \"https://example.tsyshost.com\",\n        settlement_time = \"2026-01-01T22:00:00Z\",\n    },\n    metadata = new { internal_ref = \"tsys-primary\" }\n};\nvar resp = await client.PostAsJsonAsync(\n    \"https://api.dev.paradisegateway.net/v1/integrations\", payload);\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();\nString body = \"\"\"\n    {\n      \"general_details\": {\n        \"is_active\": true,\n        \"mid\": \"999000000011\",\n        \"card_brand\": \"visa\",\n        \"industry_type\": \"retail\",\n        \"bin\": \"999995\",\n        \"url\": \"https://example.tsyshost.com\",\n        \"settlement_time\": \"2026-01-01T22:00:00Z\"\n      },\n      \"metadata\": { \"internal_ref\": \"tsys-primary\" }\n    }\n    \"\"\";\nHttpRequest request = HttpRequest.newBuilder()\n    .uri(URI.create(\"https://api.dev.paradisegateway.net/v1/integrations\"))\n    .header(\"Content-Type\", \"application/json\")\n    .header(\"APIKEY\", \"CLIENT-API-KEY\")\n    .POST(HttpRequest.BodyPublishers.ofString(body)).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":"payload := strings.NewReader(`{\n  \"general_details\": {\n    \"is_active\": true,\n    \"mid\": \"999000000011\",\n    \"card_brand\": \"visa\",\n    \"industry_type\": \"retail\",\n    \"bin\": \"999995\",\n    \"url\": \"https://example.tsyshost.com\",\n    \"settlement_time\": \"2026-01-01T22:00:00Z\"\n  },\n  \"metadata\": { \"internal_ref\": \"tsys-primary\" }\n}`)\nreq, _ := http.NewRequest(\"POST\",\n    \"https://api.dev.paradisegateway.net/v1/integrations\", payload)\nreq.Header.Set(\"Content-Type\", \"application/json\")\nreq.Header.Set(\"APIKEY\", \"CLIENT-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/integrations\");\ncurl_setopt_array($ch, [\n    CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true,\n    CURLOPT_HTTPHEADER => [\"Content-Type: application/json\", \"APIKEY: CLIENT-API-KEY\"],\n    CURLOPT_POSTFIELDS => json_encode([\n        \"general_details\" => [\n            \"is_active\" => true, \"mid\" => \"999000000011\",\n            \"card_brand\" => \"visa\", \"industry_type\" => \"retail\",\n            \"bin\" => \"999995\", \"url\" => \"https://example.tsyshost.com\",\n            \"settlement_time\" => \"2026-01-01T22:00:00Z\",\n        ],\n        \"metadata\" => [\"internal_ref\" => \"tsys-primary\"],\n    ]),\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\"; require \"json\"\nuri = URI(\"https://api.dev.paradisegateway.net/v1/integrations\")\nreq = Net::HTTP::Post.new(uri, {\n  \"Content-Type\" => \"application/json\", \"APIKEY\" => \"CLIENT-API-KEY\",\n})\nreq.body = {\n  general_details: {\n    is_active: true, mid: \"999000000011\", card_brand: \"visa\",\n    industry_type: \"retail\", bin: \"999995\",\n    url: \"https://example.tsyshost.com\",\n    settlement_time: \"2026-01-01T22:00:00Z\",\n  },\n  metadata: { internal_ref: \"tsys-primary\" },\n}.to_json\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":6},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," response returns the new integration with its system-assigned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"proc_3MtwBwLkdIwHu7ix28a3tqPa\",\n  \"object\": \"processor_account\",\n  \"general_details\": {\n    \"is_active\": true,\n    \"mid\": \"999000000011\",\n    \"card_brand\": \"visa\",\n    \"industry_type\": \"retail\",\n    \"bin\": \"999995\",\n    \"url\": \"https://example.tsyshost.com\",\n    \"settlement_time\": \"2026-01-01T22:00:00Z\"\n  },\n  \"metadata\": {\n    \"internal_ref\": \"tsys-primary\"\n  },\n  \"correlation_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," — you need it to update or deactivate the integration later."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"option-b-add-a-vericheck-integration","__idx":7},"children":["Option B: Add a Vericheck integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/integrations"]}," with the Vericheck-specific fields."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-fields-in-vericheck-integration","__idx":8},"children":["Key fields in Vericheck integration"]},{"$$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":"Required"},"children":["Required"]},{"$$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":["business_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Legal name of the business"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["doing_business_as"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["DBA / trade name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["website_url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Business website URL"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Business address details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses.address_line_1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Street address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses.city"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["City"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses.state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["State"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses.zip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["ZIP code"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  https://api.dev.paradisegateway.net/v1/integrations \\\n  -H \"Content-Type: application/json\" \\\n  -H \"APIKEY: CLIENT-API-KEY\" \\\n  -d '{\n    \"business_name\": \"Starfleet Exchange\",\n    \"doing_business_as\": \"Starfleet Exchange\",\n    \"website_url\": \"https://www.starfleet.ufp.gov\",\n    \"addresses\": {\n      \"nickname\": \"HQ\",\n      \"address_line_1\": \"1701 Enterprise Blvd\",\n      \"city\": \"San Francisco\",\n      \"state\": \"CA\",\n      \"zip\": \"94102\"\n    }\n  }'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-in-vericheck-integration","__idx":9},"children":["Response in Vericheck integration"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"INTEGRATION-01KFDKXMQ637EKEAY410MSQSXB\",\n  \"object\": \"vericheck\",\n  \"business_name\": \"Starfleet Exchange\",\n  \"doing_business_as\": \"Starfleet Exchange\",\n  \"website_url\": \"https://www.starfleet.ufp.gov\",\n  \"addresses\": {\n    \"nickname\": \"HQ\",\n    \"address_line_1\": \"1701 Enterprise Blvd\",\n    \"city\": \"San Francisco\",\n    \"state\": \"CA\",\n    \"zip\": \"94102\"\n  },\n  \"correlation_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verify-the-integration","__idx":10},"children":["Verify the integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all integrations to confirm:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl https://api.dev.paradisegateway.net/v1/integrations \\\n  -H \"APIKEY: CLIENT-API-KEY\"\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":11},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/integrations/update-integration"},"children":["Update processor credentials"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/get-started/supported-processors"},"children":["About supported processors"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/process-payments/process-credit-card"},"children":["Process a credit card sale"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/how-tos/process-payments/process-ach-payment"},"children":["Process an ACH payment"]}]}]}]},"headings":[{"value":"Add an integration","id":"add-an-integration","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"How integrations work","id":"how-integrations-work","depth":2},{"value":"Supported processors","id":"supported-processors","depth":2},{"value":"Option A: Add a TSYS integration","id":"option-a-add-a-tsys-integration","depth":2},{"value":"Key fields","id":"key-fields","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Option B: Add a Vericheck integration","id":"option-b-add-a-vericheck-integration","depth":2},{"value":"Key fields in Vericheck integration","id":"key-fields-in-vericheck-integration","depth":3},{"value":"Response in Vericheck integration","id":"response-in-vericheck-integration","depth":3},{"value":"Verify the integration","id":"verify-the-integration","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Add an integration","shortTitle":"Add integration","intro":"Connect a client account to a host processor such as TSYS (card processing) or Vericheck (ACH processing) by creating an integration through the Integrations API.","type":"how-to","seo":{"title":""}},"lastModified":"2026-06-05T02:46:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/how-tos/integrations/add-integration","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}