18636 lines
650 KiB
Plaintext
18636 lines
650 KiB
Plaintext
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title> Paynetics API documentation </title>
|
||
|
||
<link rel="icon" type="image/svg" href="/images/favicon.svg">
|
||
<link updateviacache="all" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-Zenh87qX5JnK2Jl0vWa8Ck2rdkQ2Bzep5IDxbcnCeuOxjzrPF/et3URy9Bv1WTRi" crossorigin="anonymous">
|
||
<link updateviacache="all" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.9.1/font/bootstrap-icons.css">
|
||
<link updateviacache="all" rel=stylesheet href=https://cdn.jsdelivr.net/npm/pretty-print-json@1.3/dist/pretty-print-json.dark-mode.css>
|
||
|
||
<link rel="stylesheet" href="/style/css/style-1.css">
|
||
|
||
|
||
|
||
<script src=https://cdn.jsdelivr.net/npm/pretty-print-json@1.3/dist/pretty-print-json.min.js></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-OERcA2EqjJCMA+/3y+gxIOqMEjwtxJY7qPCqsdltbNJuaOe923+mo//f6V8Qbsw3" crossorigin="anonymous"></script>
|
||
|
||
</head>
|
||
<body>
|
||
<aside>
|
||
<nav id="nav" class="d-flex flex-column justify-content-start align-items-start" style="height: 100vh; overflow-y: scroll;">
|
||
|
||
<div class="logo-container d-flex justify-content-between align-items-center w-100 mb-3 mb-lg-5">
|
||
<div>
|
||
<a href=""><img width="150" src="/images/logo.svg" alt="Paynetics"></a>
|
||
</div>
|
||
|
||
<button class="btn btn-outline-info btn-sm" id="changeTheme"><i class="bi bi-brightness-high"></i></button>
|
||
</div>
|
||
|
||
<button id="navButton" class="btn btn-primary d-lg-none">
|
||
<i class="bi bi-list"></i>
|
||
</button>
|
||
|
||
<ul id="navigationLinks" class="navMenu d-none d-lg-block">
|
||
<li><a href="#introduction" class="introductionNavItem navItem">Introduction</a></li>
|
||
<li><a href="#authentication" class="authenticationNavItem navItem">Authentication</a></li>
|
||
<li><a href="#errors" class="errorsNavItem navItem">Errors</a></li>
|
||
<li><a href="#pagination" class="paginationNavItem navItem">Pagination</a></li>
|
||
<li><a href="#request" class="requestNavItem navItem">Request IDs</a></li>
|
||
<li>
|
||
<a data-nav="hasSubNav" href="#onboarding" class="onboardingNavItem navItem">Onboarding</a>
|
||
<ul class="d-none">
|
||
<li><p>Merchants</p></li>
|
||
<li class="ml-10"><a href="#collectingData" class="collectingDataNavItem navItem">Collecting data</a></li>
|
||
<li class="ml-10"><a href="#onbApp" class="navItem">Submitting application</a></li>
|
||
<li class="ml-10"><a href="#onbDetails" class="navItem">Company details</a></li>
|
||
<li class="ml-10"><a href="#onbDetailsUp" class="navItem">Updating details</a></li>
|
||
<li class="ml-10"><a href="#onbAddDoc" class="navItem">Adding document</a></li>
|
||
<li class="ml-10"><a href="#onbAddMem" class="navItem">Adding member</a></li>
|
||
<li class="ml-10"><a href="#onbUpMem" class="navItem">Updating member</a></li>
|
||
<li><p>Users</p></li>
|
||
<li class="ml-10"><a href="#onbCNP" class="navItem">Create Natural Person</a></li>
|
||
<li class="ml-10"><a href="#onbUNP" class="navItem">Update Natural Person</a></li>
|
||
<li class="ml-10"><a href="#onbDNP" class="navItem">Details Natural Person</a></li>
|
||
<li class="ml-10"><a href="#onbRNP" class="navItem">Remove Natural Person</a></li>
|
||
<li class="ml-10"><a href="#onbRNPD" class="navItem">Add Natural Person Document</a></li>
|
||
<li><p>AML Check</p></li>
|
||
<li class="ml-10"><a href="#onbAML" class="navItem">AML Natural Persons</a></li>
|
||
<li><p>KYC</p></li>
|
||
<li class="ml-10"><a href="#kyc" class="navItem">Init</a></li>
|
||
<li class="ml-10"><a href="#kycID" class="navItem">Update</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a data-nav="hasSubNav" href="#transactions" class="transactionsNavItem navItem">Transactions</a>
|
||
<ul class="d-none">
|
||
<li><a href="#transactionsDetails">Structure details</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#programs" class="programsNavItem navItem">Programs</a></li>
|
||
<li>
|
||
<a data-nav="hasSubNav" href="#accounts" class="accountsNavItem navItem">Accounts</a>
|
||
<ul class="d-none">
|
||
<li><a href="#accCreation" class="navItem">Creation</a></li>
|
||
<li><a href="#accStatus" class="navItem">Status</a></li>
|
||
<li><a href="#accListDetail" class="navItem">List / Detail</a></li>
|
||
<li><a href="#accListDetailApi" class="navItem">List / Detail / API</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a data-nav="hasSubNav" href="#cards" class="cardsNavItem navItem">Cards</a>
|
||
<ul class="d-none">
|
||
<li><a href="#cardC" class="navItem">Creation</a></li>
|
||
<li><a href="#cardU" class="navItem">Details Update</a></li>
|
||
<li><a href="#cardConv" class="navItem">Conversion</a></li>
|
||
<li><a href="#cardA" class="navItem">Activation</a></li>
|
||
<li><a href="#cardST" class="navItem">Status and Termination</a></li>
|
||
<li><a href="#cardRewnew" class="navItem">Renew</a></li>
|
||
<li><a href="#cardLF" class="navItem">Limits and Fees</a></li>
|
||
<li><a href="#cardListDetail" class="navItem">List / detail</a></li>
|
||
<li><a href="#cardCVV" class="navItem">Number & CVV</a></li>
|
||
|
||
<li><a href="#cardPIN" class="navItem">PIN</a></li>
|
||
<li><a href="#card3ds" class="navItem">3DS Enrollment and process</a></li>
|
||
<li><a href="#cardP">Card Provisioning</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#transfers" data-nav="hasSubNav" class="transfersNavItem navItem">Transfers</a>
|
||
<ul class="d-none">
|
||
<li><a href="#queue" class="navItem">Queue</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#batch" class="transfersNavItem navItem">Batch</a></li>
|
||
<li>
|
||
<a data-nav="hasSubNav" href="#webHooks" class="webhookNavItem navItem">Webhooks</a>
|
||
<ul class="d-none">
|
||
<li><a href="#merchantC" class="navItem">Merchant created</a></li>
|
||
<li><a href="#merchantRisk" class="navItem">Merchant risk score</a></li>
|
||
<li><a href="#accountIban" class="navItem">Account IBAN</a></li>
|
||
<li><a href="#transactionNew" class="navItem">Transaction new</a></li>
|
||
<li><a href="#transactionUp" class="navItem">Transaction update</a></li>
|
||
<li><a href="#balanceUp" class="navItem">Balance update</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#postman" class="transfersNavItem navItem">Postman Collection</a></li>
|
||
</ul>
|
||
</nav>
|
||
</aside>
|
||
<main>
|
||
|
||
<div class="status">You are now <p class="m-0" id="status"></p>!</div>
|
||
|
||
<section class="introduction fh fh100" id="introduction">
|
||
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Introduction</h3>
|
||
<p>Welcome to Paynetics Developers Documentation hub. Happy to have you on board!</p>
|
||
|
||
<p>Paynetics services are built around a <a href="https://aws.amazon.com/what-is/restful-api/" target="_blank">RESTful API</a>. This architecture allows us to have a uniform and scalable solution for your payment services needs. </p>
|
||
|
||
<p>The API communication is based on JSON Encoded Requests and JSON Encoded Responses.</p>
|
||
|
||
<p>Paynetics also offers a sandbox environment for easy setup and testing before you are ready to go live.</p>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="code-card">
|
||
<div class="code-card-title code-card-title-psm d-flex justify-content-between align-items-center mb-0">
|
||
<p class="m-0">BASE URL Production</p>
|
||
|
||
<div class="d-flex align-items-center">
|
||
<div class="sm-border"></div>
|
||
<button type="button" class="copy-to-clipboard" onclick="copy('base')" title="Copy text"
|
||
data-bs-toggle="tooltip"
|
||
data-bs-placement="top"
|
||
data-bs-trigger="hover"
|
||
data-bs-custom-class="custom-tooltip"
|
||
data-bs-title="Click to copy."> <i class="bi bi-clipboard2-fill"></i></button>
|
||
</div>
|
||
</div>
|
||
<div class="code-card-content">
|
||
<div>
|
||
<code class="single-url"><input disabled type="text" value="https://api.paynetics.net" id="base"></code>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<div class="code-card-title code-card-title-psm d-flex justify-content-between align-items-center mb-0">
|
||
<p class="m-0">BASE URL Sandbox</p>
|
||
|
||
<div class="d-flex align-items-center">
|
||
<div class="sm-border"></div>
|
||
<button type="button" class="copy-to-clipboard" onclick="copy('baseSandBox')" title="Copy text"
|
||
data-bs-toggle="tooltip"
|
||
data-bs-placement="top"
|
||
data-bs-trigger="hover"
|
||
data-bs-custom-class="custom-tooltip"
|
||
data-bs-title="Click to copy."> <i class="bi bi-clipboard2-fill"></i></button>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card-content">
|
||
<div>
|
||
<code class="single-url"><input disabled type="text" value="https://api.paynetics.io" id="baseSandBox"></code>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
<section class="authentication ep" id="authentication">
|
||
<div class="main-content-area">
|
||
<div>
|
||
<h3 class="mb-3">Authentication</h3>
|
||
<p>Paynetics API uses <a href="https://en.wikipedia.org/wiki/HMAC" target="_blank">HMAC</a> authentication methodology.</p>
|
||
|
||
<p>To authenticate your API Request to Paynetics you need to provide the following elements in the <a
|
||
href="https://www.soapui.org/learn/api/understanding-rest-headers-and-parameters/" target="_blank">header</a> of your request:</p>
|
||
|
||
<p><code class="code-inside">x-api-key</code> : Key provided by Paynetics. </p>
|
||
|
||
<p><code class="code-inside">x-timestamp</code> : Current <a href="https://www.unixtimestamp.com" target="_blank">UNIX timestamp</a>.</p>
|
||
|
||
<p><code class="code-inside">x-hash</code> : HMAC sha256. Use secret key* for hash vector. Body of the hash is formed by concatenating:</p>
|
||
|
||
<p class="card-inside"><code class="code-inside">API Key</code> + <code class="code-inside">Timestamp</code> + <code class="code-inside">Operation</code> + <code class="code-inside">Content Body (Required: POST+PUT request)</code></p>
|
||
|
||
|
||
<p><strong>Important:</strong></p>
|
||
|
||
<ul>
|
||
<li><strong>Body content whitespaces will be omitted when comparing hashes!</strong></li>
|
||
</ul>
|
||
|
||
<p><code class="code-inside">{ " name ": " Paynetics " }</code> <i>will be</i> <code class="code-inside">{"name":"Paynetics"}</code></p>
|
||
|
||
<ul>
|
||
<li><strong>Request is valid for 15 seconds after hash generation!</strong></li>
|
||
</ul>
|
||
|
||
<p>For example if request timestamp is 1591096701 and current timestamp is 1591096720 request will not be authorized!</p>
|
||
|
||
<p><i>To exchange API key and secret Paynetics require public PGP key.</i></p>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="code-card">
|
||
<p class="code-card-title mb-0"> <i class="bi bi-key icons"></i> Secret key</p>
|
||
<div class="code-card-content">
|
||
<div>
|
||
<p><i>Provided by Paynetics. Keys should be kept secure to ensure your data stay safe. Never share them publicly.</i></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<h3>Hash Generation Examples:</h3>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title mb-0">Get Request</p>
|
||
<div class="code-card-content">
|
||
<div>
|
||
<p>HMAC_SHA256 with API Secret of <br> <code class="code-inside">07364675-5b2a-4d35-bd2c-b93e696aa53f1625399941cards_list</code></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title mb-0">Post Request</p>
|
||
<div class="code-card-content">
|
||
<div>
|
||
<p>Complete POST body which is sent HMAC_SHA256 with API Secret of <code class="code-inside">07364675-5b2a-4d35-bd2c-b93e696aa53f1625399941init_web{"openBankAccount":true,"issueCard":true}</code></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title mb-0">Put Request</p>
|
||
<div class="code-card-content">
|
||
<div>
|
||
<p>Complete PUT body which is sent HMAC_SHA256 with API Secret of <br> <code class="code-inside">07364675-5b2a-4d35-bd2c-b93e696aa53f1625399941init_web{"name":"Paynetics"}</code></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p><strong style="color: red;">NOTE: Attach example postman authentication.</strong></p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="errors ep" id="errors">
|
||
<div class="main-content-area">
|
||
<div>
|
||
<h3 class="mb-3">Errors</h3>
|
||
|
||
<p>Paynetics system incorporates the API result in the following format:</p>
|
||
|
||
<p>HTTP Response code - <strong>is always 200 - OK</strong>. This indicates that your request has successfully reached our servers.</p>
|
||
|
||
<p>Detailed error codes can be found in the JSON Response body:</p>
|
||
|
||
<p>Example <code class="code-inside">{"code": 0}</code> = <strong>SUCCESS</strong></p>
|
||
|
||
<h4>Attributes</h4>
|
||
|
||
|
||
<p><span style="color: red;">*</span> <i><strong>code</strong> string</i></p>
|
||
<p>All API responses come with a <code class="code-inside">code</code> attribute in the header. These indicate a variety of reasons why a request may be declined.</p>
|
||
|
||
<p><i><strong>message</strong> string</i></p>
|
||
<p>In addition to the code, Paynetics provides a description of the error that occurred. </p>
|
||
|
||
<p style="color: red;"><i>* mandatory</i></p>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">JSON GENERAL CODE SUMMARY</p>
|
||
<div class="code-card-content">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>400 - Bad Request</p></th>
|
||
<td><p>services.general.bad_request</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>401 - Unauthorized</p></th>
|
||
<td><p>services.general.http_unauthorized</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>404 - Not Found</p></th>
|
||
<td><p>services.general.http_not_found_exception</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>500 - Exception</p></th>
|
||
<td><p>services.general.http_exception</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>11000 - Error</p></th>
|
||
<td><p>services.general.error</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>11001 - Validation Error</p></th>
|
||
<td><p>services.general.validation_error</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>11002 - Entity not found</p></th>
|
||
<td><p>services.general.entity_not_found</p></td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th><p>11004 - Non Unique Value</p></th>
|
||
<td><p>services.general.non_unique_value</p></td>
|
||
</tr>
|
||
<tr>
|
||
<th><p>11008 - Service request exception</p></th>
|
||
<td><p>services.general.service_request_exception </p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="pagination ep" id="pagination" style="padding: 50px !important;">
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Pagination</h3>
|
||
<p>You can use Paynetics API for fetching data in bulk. Use the “list” API methodology to pull records like
|
||
applications, transactions etc. Use limit and page as parameters to define the scope of your query.</p>
|
||
<p>Each list API can have different filters passed as query parameters.</p>
|
||
|
||
<h4>Attributes</h4>
|
||
|
||
<p><span style="color: red;">*</span> <i><strong>page</strong> string</i></p>
|
||
<p>Starting from page 1</p>
|
||
|
||
<p><span style="color: red;">*</span> <i><strong>limit</strong> string</i></p>
|
||
<p>Maximum per page depending on the API</p>
|
||
|
||
<p style="color: red;"><i>* mandatory</i></p>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="code-card">
|
||
<p class="code-card-title ">RESPONSE SUCCESS</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="responseSuccess"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">RESPONSE VALIDATION ERROR</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="validationError"></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<section class="request fh fh70" id="request">
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Request IDs</h3>
|
||
<p>Request ID is a unique identifier for your API request. You can find it in the response headers, under
|
||
x-request-id. Use the request ID for any escalations to our support team. This will help them quickly
|
||
locate your request and resolve any issues that may have occured. </p>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Example</p>
|
||
|
||
<div class="code-card-content">
|
||
<p><code class="code-inside">X-Request-Id : 20be1835-85fb-4932-a986-a6b5fbe6b648</code></p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<section class="onboarding fh fh70" id="onboarding">
|
||
<div class="d-1160">
|
||
<div class="m-0">
|
||
<h3 class="mb-3">Onboarding</h3>
|
||
|
||
<p>Welcome to Paynetics' <strong>onboarding</strong> section. We are happy to have you and your
|
||
customers on board!</p>
|
||
|
||
<h4 class="mb-3">Through Paynetics, you can:</h4>
|
||
|
||
<ul class="custom-list">
|
||
<li>Open accounts</li>
|
||
<li>Make transfers</li>
|
||
<li>Issue cards and control them</li>
|
||
<li>Use our acquiring services</li>
|
||
<li>Onboard merchants</li>
|
||
<li>Use our white-label wallet solution for added value and convenience</li>
|
||
</ul>
|
||
|
||
<p>
|
||
We provide APIs for easy integration and usage of our capabilities
|
||
If your process is not ready for full API automation, we have the tools to enable your employees to
|
||
use it manually:
|
||
</p>
|
||
<ul class="custom-list">
|
||
<li>our onboarding portal</li>
|
||
<li>our card management portal</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="collecting fh fh70" id="collectingData">
|
||
<div class="d-1160">
|
||
<div class="mt-0">
|
||
<h4 class="mb-3">Collecting Data</h4>
|
||
|
||
<p>
|
||
Paynetics is a licensed EMI (Electronic Money Institution) institution, which means we need to maintain your
|
||
and our partner’s trust. Paynetics is legally obliged to collect data.
|
||
</p>
|
||
<p>
|
||
There are three factors which determine what type of data we need to collect:
|
||
</p>
|
||
<ul class="custom-list">
|
||
<li>What type of clients do you intend to onboard (Individuals/Legal Entities)?</li>
|
||
<li>Which of our products do you wish to access?</li>
|
||
<li>What is your current onboarding process?</li>
|
||
</ul>
|
||
<p>
|
||
Paynetics will provide a list of all mandatory fields and create a configuration for your profile based on
|
||
the
|
||
initial agreement. Once mandatory data fields are defined, you can test our offering and decide when to move
|
||
forward with live implementation.
|
||
</p>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="fh fh100">
|
||
<div class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Legal Entities Onboarding</h4>
|
||
|
||
<br>
|
||
|
||
<img class="img-fluid" src="/images/onbf.svg" alt="Onboarding Process Overview">
|
||
|
||
<br>
|
||
<br>
|
||
|
||
<p>Onboarding legal entities at Paynetics can be an automatic or semi-automatic process. </p>
|
||
|
||
<div class="alert alert-primary">
|
||
<p>
|
||
<strong>Automatic</strong> onboarding process utilizes a predefined ruleset of operations, which guide
|
||
the end decision
|
||
of every application.
|
||
</p>
|
||
<p>
|
||
<strong>Semi-automatic</strong> onboarding process offers assisted manual review by Paynetics'
|
||
underwriting specialists.
|
||
This is done after the <strong>automatic checks</strong>. This allows for a better understanding of the
|
||
legal entity’s
|
||
structure and background.
|
||
</p>
|
||
<p>
|
||
<i>Note - Depending on the initial agreement Paynetics may recommend one of the two solutions above.</i>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="onbApp">
|
||
|
||
<div class="">
|
||
<h3 class="mb-3">Submitting Application</h3>
|
||
|
||
<p>
|
||
By submitting a request with the predefined mandatory fields.
|
||
Refer to the example for the correct structure of the request.
|
||
Once the request is received, Paynetics system will check the submitted fields and validate the input.
|
||
Requests with invalid or missing fields will return an error prompting an update.
|
||
</p>
|
||
|
||
<h4>Automatic Checks</h4>
|
||
<p>
|
||
Once fields are validated, Paynetics system will perform a series of automatic checks, which can be:
|
||
</p>
|
||
<ul class="custom-list">
|
||
<li>Risk Calculation - Paynetics calculates the risk profile of each new application based on provided data.</li>
|
||
<li>
|
||
Automatic Verification - Paynetics uses a third-party provider to extract information from local trade
|
||
registration bureaus to verify company details.
|
||
</li>
|
||
<li>
|
||
Security Checks - Paynetics uses a third-party provider to screen every new entity for adverse media and
|
||
sanction lists presence.
|
||
</li>
|
||
</ul>
|
||
|
||
<h4>
|
||
Results
|
||
</h4>
|
||
|
||
<p>
|
||
Automation results are asynchronous and are received via webhook. Once automatic checks have concluded,
|
||
Paynetics system will be configured to perform different operations depending on your initial agreement.
|
||
</p>
|
||
|
||
|
||
<h4>Acquiring</h4>
|
||
<p>
|
||
Paynetics system will assign and provide a unique Merchant ID (MID) and Terminal ID (TID) via webhook. Once
|
||
received they are active and can be used via Paynetics API for operations and 3DS registration.
|
||
</p>
|
||
|
||
<h4>Account Opening and Issuing</h4>
|
||
<p>
|
||
Paynetics system will provide a unique merchant identifier(token), which allows an account to be created.
|
||
</p>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
<section>
|
||
|
||
|
||
<div>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v3/applications
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>application_create</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(32,36)</span>
|
||
</p>
|
||
|
||
<p>Master Merchant token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>products</strong>
|
||
<span class="att-type">array</span>
|
||
<span class="att-type">(1,5)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>pos , e-commerce , qr , account-opening , card-issuing</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>due_diligence</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>SDD , CDD</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Company Details</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#company1412539"
|
||
aria-expanded="false" aria-controls="company1412539">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="company1412539">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>trade_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Doing business as</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Legal name as appears in trade reigster</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>uic</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Business Registration Number</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>incorporation_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the company incorporation</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>website</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>URL of the website</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile phone of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(2,2)</span>
|
||
</p>
|
||
|
||
<p>Country of the company. Format: ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country region of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City where company is registerd</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Postal/ZIP Code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Additional details for the address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>contact_email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Correspondence email address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>correspondence_address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Correspondence phisical address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description_of_activity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Description of the business activity of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address_of_shop</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the phisical shop/office of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(4,4)</span>
|
||
</p>
|
||
|
||
<p>Filed is deprected and must be omitted</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_form</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Legal form of the company</p>
|
||
|
||
<strong>Available Options: </strong> <i>sole-trader , limited-company , limited-partnership , limited-liability-partnership , other , self-employed</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_form_description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Required when legal_form is specified as other</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>business_activity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomernclutres section</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country_of_incorporation</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>vat_registration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>VAT registration number of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_sie</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>In case the company appears in any sanctions list the field must be marked as true</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company_members</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#company_members1128849"
|
||
aria-expanded="false" aria-controls="company_members1128849">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="company_members1128849">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>First name of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Last name of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile phone of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Used when member is other legal entity</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>uic</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Business registration number.Used when member is other legal entity</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of birth or country of legal entity.ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country_of_residence</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Postal/Zip code of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Additional info for the address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Region of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ownership</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Only for UBO to specify the percentage of the ownership</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ownership_percentage</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Only for UBO to specify the percentage of the ownership</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">array</span>
|
||
<span class="att-type">(1,2)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>ubo , ceo , representative , proxy , legal-entity , officer</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>unique_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Unique number of persons on offical document.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Existing user in Paynetics system to get KYC details</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_form</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Legal form of the company</p>
|
||
|
||
<strong>Available Options: </strong> <i>sole-trader , limited-company , limited-partnership , limited-liability-partnership , other , self-employed</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>place_of_birth</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_declaration</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as PEP</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_related_declaration</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as PEP relative</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_sip</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as that appears in sanction lists</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>birthday</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of birth</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>nationality</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>contact_email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>documents</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#documents1407495"
|
||
aria-expanded="false" aria-controls="documents1407495">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="documents1407495">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>documents</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#documents192558"
|
||
aria-expanded="false" aria-controls="documents192558">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="documents192558">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>acquiring</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Details for e-commerce/pos products</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#acquiring1748619"
|
||
aria-expanded="false" aria-controls="acquiring1748619">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="acquiring1748619">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pos</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Details for pos product</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#pos1856574"
|
||
aria-expanded="false" aria-controls="pos1856574">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="pos1856574">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fee_group</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Predifined fee group provided by Paynetics in advance</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>projected_monthly_value</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>In EUR</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>descriptor</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Card Acceptor Name</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ecommerce</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Details for e-commerce product</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#ecommerce252872"
|
||
aria-expanded="false" aria-controls="ecommerce252872">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="ecommerce252872">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>register3ds</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>supported_authorization_types</strong>
|
||
<span class="att-type">array</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>moto , recurring , pay-by-link , oct</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fee_group</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>projected_monthly_value</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>descriptor</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>payout_details</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#payout_details977102"
|
||
aria-expanded="false" aria-controls="payout_details977102">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="payout_details977102">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Minimum amount for payout</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 4217 alpha 3</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Valid IBAN to which the funds will be send</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(6,6)</span>
|
||
</p>
|
||
|
||
<p>Valid UK sort code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(8,8)</span>
|
||
</p>
|
||
|
||
<p>UK Account number</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>period</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>When the payout must be done</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>delay</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Payout delay in days</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>questionnaire</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Futher questions for the company</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#questionnaire1392465"
|
||
aria-expanded="false" aria-controls="questionnaire1392465">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="questionnaire1392465">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_online</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer is doing business online</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>has_offshore_clients</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer has client from off shore zone</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>make_business_with_san</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer is doing business with legal entities/natural persions in sanction lists</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>has_kyc_procedure</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer has KYC procedure for their customers</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>has_kyc_procedure_description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>The KYC procedure must be specified.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>require_additional_licenses</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer must provide addtional license</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>maintains_accounts_on_behalf_of_clients</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer maiting other legal entities or naturual persons bank accounts</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>perform_transactions_on_behalf_of_clients</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer is performing transaction onbehalf of other egal entities or naturual persons </p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_off_shore</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Must be mark as true when customer is from offshore zone</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>purpose_of_usage</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Must specify how the requested product will be used</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>source_of_funds</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Source of funds of the company</p>
|
||
|
||
<strong>Available Options: </strong> <i>dividends , donation , funds_from_other_auxiliary_sources , inheritance , loan_from_financial_institutions , loan_from_third_parties , ordinary_business_activity , origin_of_funds_unknown , other , rent , sale_of_company_shares_or_business , sale_of_movable_assets , sale_of_real_estate</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>months_of_doing_business</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>For how long the company is oprerational</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>projected_monthly_volume</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Projected volume in EUR the company will make each month</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ip_address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>IP Address of customer submitted application</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fingerprint</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Device fingerprint of the customer submitted application</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications-request"></pre>
|
||
<script>document.getElementById('post_/v3/applications-request').innerHTML = prettyPrintJson.toHtml({"merchant":"faf5ee1a-298e-45c7-beb6-b8e410493da3","products":[{"type":"string","enum":["pos","e-commerce","qr","account-opening","card-issuing"]}],"due_diligence":"string","company":{"trade_name":"Paynetics","legal_name":"Paynetics AD","uic":"123567","incorporation_date":"2022-01-01","website":"https:\/\/paynetics.digital","phone":"+35900000000","mobile_phone":"+35900000000","country":"BG","county":"Sofia Grad","city":"Sofia","zip":"1407","address1":"James Bouchier 76A","address2":"Floor 2","contact_email":"john.doe@paynetics.digital","correspondence_address":"James Bouchier 76A","description_of_activity":"Acquiring, Issuing etc.","address_of_shop":"James Bouchier 76A","mcc":"5999","legal_form":"sole-trader","legal_form_description":"The sutrcte of the company is ... ","business_activity":"second-hand-store","country_of_incorporation":"BG","vat_registration":"12345678BG","is_sie":false,"company_members":[{"first_name":"John","last_name":"Doe","mobile_phone":"+359000000000","phone":"+359000000000","legal_name":"Paynetics AD","uic":"123456","country":"BG","country_of_residence":"BG","zip":"1407","city":"Sofia","address1":"James Bouchier 76A","address2":"Floor 2","county":"Sofia Grad","ownership":true,"ownership_percentage":10,"type":[{"type":"string","enum":["ubo","ceo","representative","proxy","legal-entity","officer"]}],"unique_identifier":"123456","user":"","legal_form":"sole-trader","place_of_birth":"BG","pep_declaration":true,"pep_related_declaration":true,"is_sip":true,"birthday":"1992-03-28","nationality":"BG","contact_email":"John Doe","documents":[{"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}]}],"documents":[{"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}]},"acquiring":{"pos":{"fee_group":"default","projected_monthly_value":"100","descriptor":"John Doe"},"ecommerce":{"register3ds":"boolean","supported_authorization_types":[{"type":"string","enum":["moto","recurring","pay-by-link","oct"]}],"fee_group":"string","projected_monthly_value":"number","descriptor":"string"}},"payout_details":[{"amount":"1","currency":"BGN","iban":"BG18RZBB91550123456789","sort_code":"123456","account_number":"12345678","period":"daily","delay":"2"}],"questionnaire":{"is_online":false,"has_offshore_clients":false,"make_business_with_san":false,"has_kyc_procedure":false,"has_kyc_procedure_description":false,"require_additional_licenses":false,"maintains_accounts_on_behalf_of_clients":false,"perform_transactions_on_behalf_of_clients":false,"is_off_shore":false,"purpose_of_usage":false,"source_of_funds":"dividends","months_of_doing_business":12,"projected_monthly_volume":10000},"ip_address":"127.0.0.1","fingerprint":"any string"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1730245"
|
||
aria-expanded="false" aria-controls="data1730245">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1730245">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>UUID of the application</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#company1828634"
|
||
aria-expanded="false" aria-controls="company1828634">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="company1828634">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>UUID of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company_members</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#company_members1638747"
|
||
aria-expanded="false" aria-controls="company_members1638747">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="company_members1638747">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>UUID of company member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of company member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of company member</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications-response"></pre>
|
||
<script>document.getElementById('post_/v3/applications-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"e3dcc1ee-26d4-40bb-ac24-c961a1c4f77c","company":{"token":"16880d2c-6616-4e16-947a-f5e1726604d7","company_members":[{"token":"7de3abb0-73e1-4d6a-bf72-1a2040685ff3","first_name":"John","last_name":"Doe"}]}}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11008</p></th>
|
||
<td><p>Validator configuration not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section class="fh fh70" id="onbDetails">
|
||
<div class="d-600">
|
||
<div>
|
||
<h3>Company Details</h3>
|
||
<p> You can add or change company details via Paynetics' API. Supported operations:</p>
|
||
<ul class="custom-list">
|
||
<li>Add documents</li>
|
||
<li>Change contact details</li>
|
||
<li>Add/Suspend company members</li>
|
||
<li>Add documents related to company members</li>
|
||
</ul>
|
||
|
||
<p>Please refer to the example for how to change company details.</p>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="d-1160 ep" id="onbDetailsUp">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Updating Company Details</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v3/applications/{application}/companies
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>company_update</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ application ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>trade_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Doing business as</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Legal name as appears in trade reigster</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>website</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>URL of the website</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile phone of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(2,2)</span>
|
||
</p>
|
||
|
||
<p>Country of the company. Format: ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country region of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City where company is registerd</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Postal/ZIP Code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Additional details for the address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>contact_email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Correspondence email address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>correspondence_address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Correspondence phisical address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description_of_activity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Description of the business activity of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address_of_shop</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the phisical shop/office of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>business_activity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomernclutres section</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_sie</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>In case the company appears in any sanctions list the field must be marked as true</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v3/applications/{application}/companies-request"></pre>
|
||
<script>document.getElementById('put_/v3/applications/{application}/companies-request').innerHTML = prettyPrintJson.toHtml({"trade_name":"Paynetics","legal_name":"Paynetics AD","website":"https:\/\/paynetics.digital","phone":"+35900000000","mobile_phone":"+35900000000","country":"BG","county":"Sofia Grad","city":"Sofia","zip":"1407","address1":"James Bouchier 76A","address2":"Floor 2","contact_email":"john.doe@paynetics.digital","correspondence_address":"James Bouchier 76A","description_of_activity":"Acquiring, Issuing etc.","address_of_shop":"James Bouchier 76A","business_activity":"second-hand-store","is_sie":false}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v3/applications/{application}/companies-response"></pre>
|
||
<script>document.getElementById('put_/v3/applications/{application}/companies-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>Application not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="onbAddDoc">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Adding Company Document</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v3/applications/{application}/companies/documents
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>company_add_document</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ application ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications/{application}/companies/documents-request"></pre>
|
||
<script>document.getElementById('post_/v3/applications/{application}/companies/documents-request').innerHTML = prettyPrintJson.toHtml({"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications/{application}/companies/documents-response"></pre>
|
||
<script>document.getElementById('post_/v3/applications/{application}/companies/documents-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>Application not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
<section class="d-1160 ep" id="onbAddMem">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Adding Company member</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v3/applications/{application}/companies/members
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>company_add_member</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ application ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>First name of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Last name of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile phone of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Used when member is other legal entity</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>uic</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Business registration number.Used when member is other legal entity</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of birth or country of legal entity.ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country_of_residence</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Postal/Zip code of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Additional info for the address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Region of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ownership</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Only for UBO to specify the percentage of the ownership</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ownership_percentage</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Only for UBO to specify the percentage of the ownership</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">array</span>
|
||
<span class="att-type">(1,2)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>ubo , ceo , representative , proxy , legal-entity , officer</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>unique_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Unique number of persons on offical document.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Existing user in Paynetics system to get KYC details</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_form</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Legal form of the company</p>
|
||
|
||
<strong>Available Options: </strong> <i>sole-trader , limited-company , limited-partnership , limited-liability-partnership , other , self-employed</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>place_of_birth</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_declaration</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as PEP</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_related_declaration</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as PEP relative</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_sip</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as that appears in sanction lists</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>birthday</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of birth</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>nationality</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>contact_email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>documents</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#documents1382259"
|
||
aria-expanded="false" aria-controls="documents1382259">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="documents1382259">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications/{application}/companies/members-request"></pre>
|
||
<script>document.getElementById('post_/v3/applications/{application}/companies/members-request').innerHTML = prettyPrintJson.toHtml({"first_name":"John","last_name":"Doe","mobile_phone":"+359000000000","phone":"+359000000000","legal_name":"Paynetics AD","uic":"123456","country":"BG","country_of_residence":"BG","zip":"1407","city":"Sofia","address1":"James Bouchier 76A","address2":"Floor 2","county":"Sofia Grad","ownership":true,"ownership_percentage":10,"type":[{"type":"string","enum":["ubo","ceo","representative","proxy","legal-entity","officer"]}],"unique_identifier":"123456","user":"","legal_form":"sole-trader","place_of_birth":"BG","pep_declaration":true,"pep_related_declaration":true,"is_sip":true,"birthday":"1992-03-28","nationality":"BG","contact_email":"John Doe","documents":[{"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}]}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1202320"
|
||
aria-expanded="false" aria-controls="data1202320">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1202320">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>UUID of the application</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#company254128"
|
||
aria-expanded="false" aria-controls="company254128">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="company254128">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>UUID of the company</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company_members</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#company_members1821469"
|
||
aria-expanded="false" aria-controls="company_members1821469">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="company_members1821469">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>UUID of company member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of company member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of company member</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications/{application}/companies/members-response"></pre>
|
||
<script>document.getElementById('post_/v3/applications/{application}/companies/members-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"e3dcc1ee-26d4-40bb-ac24-c961a1c4f77c","company":{"token":"16880d2c-6616-4e16-947a-f5e1726604d7","company_members":[{"token":"7de3abb0-73e1-4d6a-bf72-1a2040685ff3","first_name":"John","last_name":"Doe"}]}}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>Application not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
<section class="d-1160" id="onbUpMem" xmlns="http://www.w3.org/1999/html">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Updating Company member</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v3/applications/{application}/companies/members/{token}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>company_member_update</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ application ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
<p class="text-uppercase">[ token ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>First name of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Last name of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile phone of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Used when member is other legal entity</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of birth or country of legal entity.ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country_of_residence</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ISO 3166-1 alpha-2</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Postal/Zip code of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the member.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Additional info for the address</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Region of the member</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ownership</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Only for UBO to specify the percentage of the ownership</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ownership_percentage</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Only for UBO to specify the percentage of the ownership</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>legal_form</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Legal form of the company</p>
|
||
|
||
<strong>Available Options: </strong> <i>sole-trader , limited-company , limited-partnership , limited-liability-partnership , other , self-employed</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_declaration</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as PEP</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_related_declaration</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as PEP relative</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_sip</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Mark as that appears in sanction lists</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>contact_email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>active , inactive</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v3/applications/{application}/companies/members/{token}-request"></pre>
|
||
<script>document.getElementById('put_/v3/applications/{application}/companies/members/{token}-request').innerHTML = prettyPrintJson.toHtml({"first_name":"John","last_name":"Doe","mobile_phone":"+359000000000","phone":"+359000000000","legal_name":"Paynetics AD","country":"BG","country_of_residence":"BG","zip":"1407","city":"Sofia","address1":"James Bouchier 76A","address2":"Floor 2","county":"Sofia Grad","ownership":true,"ownership_percentage":10,"legal_form":"sole-trader","pep_declaration":true,"pep_related_declaration":true,"is_sip":true,"contact_email":"John Doe","status":"active"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v3/applications/{application}/companies/members/{token}-response"></pre>
|
||
<script>document.getElementById('put_/v3/applications/{application}/companies/members/{token}-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>Company member not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
<section class="d-1160" id="kyc">
|
||
<div>
|
||
<h3 class="mb-3">KYC Init</h3>
|
||
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v1/kyc
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>kyc_init</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Token of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v1/kyc-request"></pre>
|
||
<script>document.getElementById('post_/v1/kyc-request').innerHTML = prettyPrintJson.toHtml({"user":"9944b942-d297-4bee-bfba-0990ce9b6788"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1358591"
|
||
aria-expanded="false" aria-controls="data1358591">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1358591">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>identification</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>short_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v1/kyc-response"></pre>
|
||
<script>document.getElementById('post_/v1/kyc-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"identification":"87f084cc-d323-4c04-86b8-0e8c5f0b9f58","short_code":"f06df88c884f"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>payoo.users.not_found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160" id="kycID">
|
||
<div>
|
||
<h3 class="mb-3">KYC Update</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong> </strong>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong></strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="d-1160 ep" id="onbAddMemDoc">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Add Company member document</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v3/applications/{application}/companies/members/{token}/documents
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>company_member_add_document</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ application ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
<p class="text-uppercase">[ token ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications/{application}/companies/members/{token}/documents-request"></pre>
|
||
<script>document.getElementById('post_/v3/applications/{application}/companies/members/{token}/documents-request').innerHTML = prettyPrintJson.toHtml({"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v3/applications/{application}/companies/members/{token}/documents-response"></pre>
|
||
<script>document.getElementById('post_/v3/applications/{application}/companies/members/{token}/documents-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>Company member not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
<section class="d-1160 ep" id="onbCNP">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Create Natural Person</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/users
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>user_create</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Email address of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>First name of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Last name of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of resident of the user (Alpha-2)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ZIP/Postal Code of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile Phone of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>language</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>nationality</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Nationality of the user (Alpha-2)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>birthday</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of birth of the user (YYYY-MM-DD)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>aml</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>place_of_birth</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(32,36)</span>
|
||
</p>
|
||
|
||
<p>Master Merchant token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>occupation</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>education</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>info</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>money_declaration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>source_of_funds</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>registration_ip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_san</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>peps_declaration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_relative</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>unique_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>id_passport_validity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>id_passport_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>card-usage , default</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>documents</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#documents1747549"
|
||
aria-expanded="false" aria-controls="documents1747549">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="documents1747549">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>company</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/users-request"></pre>
|
||
<script>document.getElementById('post_/v2/users-request').innerHTML = prettyPrintJson.toHtml({"email":"john.doe@example.com","first_name":"John","last_name":"Doe","address1":"James Bouchier 76a","address2":"string","country":"BG","city":"Sofia","zip":"1407","phone":"+3590000000","mobile_phone":"+3590000000","language":"string","nationality":"BG","birthday":"BG","aml":"string","place_of_birth":"string","merchant":"faf5ee1a-298e-45c7-beb6-b8e410493da3","occupation":"string","education":"string","info":"string","money_declaration":"string","source_of_funds":"string","external_reference":"string","registration_ip":"string","is_san":"string","peps_declaration":"string","pep":"string","pep_relative":"string","unique_identifier":"string","id_passport_validity":"string","id_passport_number":"string","type":"string","documents":[{"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}],"company":"string"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep" id="onbUNP">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Update Natural Person</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/users/{user}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>user_update</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ user ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from user creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>First name of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Last name of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of resident of the user (Alpha-2)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ZIP/Postal Code of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile Phone of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>language</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>nationality</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Nationality of the user (Alpha-2)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>birthday</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of birth of the user (YYYY-MM-DD)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>place_of_birth</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(32,36)</span>
|
||
</p>
|
||
|
||
<p>Master Merchant token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>occupation</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>education</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>info</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>money_declaration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>source_of_funds</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_san</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>peps_declaration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_relative</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>unique_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>id_passport_validity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>id_passport_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/users/{user}-request"></pre>
|
||
<script>document.getElementById('put_/v2/users/{user}-request').innerHTML = prettyPrintJson.toHtml({"first_name":"John","last_name":"Doe","address1":"James Bouchier 76a","address2":"string","country":"BG","city":"Sofia","zip":"1407","phone":"+3590000000","mobile_phone":"+3590000000","language":"string","nationality":"BG","birthday":"BG","place_of_birth":"string","merchant":"faf5ee1a-298e-45c7-beb6-b8e410493da3","occupation":"string","education":"string","info":"string","money_declaration":"string","source_of_funds":"string","external_reference":"string","is_san":"string","peps_declaration":"string","pep":"string","pep_relative":"string","unique_identifier":"string","id_passport_validity":"string","id_passport_number":"string"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/users/{user}-response"></pre>
|
||
<script>document.getElementById('put_/v2/users/{user}-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep" id="onbDNP">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Get Details of Natural Person</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/users/{user}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>user_details</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ user ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from user creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Email address of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>First name of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Last name of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of resident of the user (Alpha-2)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>City of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>ZIP/Postal Code of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Phone of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Mobile Phone of the user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>language</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>nationality</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Nationality of the user (Alpha-2)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>birthday</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of birth of the user (YYYY-MM-DD)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>aml</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>place_of_birth</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(32,36)</span>
|
||
</p>
|
||
|
||
<p>Master Merchant token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>occupation</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>education</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>info</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>money_declaration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>source_of_funds</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>registration_ip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_san</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>peps_declaration</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pep_relative</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>unique_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>id_passport_validity</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>id_passport_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>card-usage , default</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/users/{user}-response"></pre>
|
||
<script>document.getElementById('get_/v2/users/{user}-response').innerHTML = prettyPrintJson.toHtml({"email":"john.doe@example.com","first_name":"John","last_name":"Doe","address1":"James Bouchier 76a","address2":"string","country":"BG","city":"Sofia","zip":"1407","phone":"+3590000000","mobile_phone":"+3590000000","language":"string","nationality":"BG","birthday":"BG","aml":"string","place_of_birth":"string","merchant":"faf5ee1a-298e-45c7-beb6-b8e410493da3","occupation":"string","education":"string","info":"string","money_declaration":"string","source_of_funds":"string","external_reference":"string","registration_ip":"string","is_san":"string","peps_declaration":"string","pep":"string","pep_relative":"string","unique_identifier":"string","id_passport_validity":"string","id_passport_number":"string","type":"string"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep" id="onbRNP">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Remove Natural Person</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>DELETE </strong>
|
||
/v2/users/{user}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>user_remove</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ user ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from user creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/users/{user}-response"></pre>
|
||
<script>document.getElementById('delete_/v2/users/{user}-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep" id="onbRNPD">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Add Natural Person Document</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/users/{user}/documents
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>user_add_document</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ user ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Base64 encoded file</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>file_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Type of the file</p>
|
||
|
||
<strong>Available Options: </strong> <i>pdf , docx , xlxs , jpg , jpeg , png , mov , mp4</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>document_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>More details in nomenclatures section</p>
|
||
|
||
<strong>Available Options: </strong> <i>idcard , bankstmt , bill , other , idcard-front , idcard-back , idcard-selfie , passport-back , passport-selfie , passport , driving-license-selfie , selfie , driving-license-front , driving-license-back , sharebook-excerpt , management-contract , moms-of-the-board , activity-license , bank-account , bulstat-registration , vat-registration , patent-law , power-of-attorney , ubo-declaration , frame-contract , sample-of-signatures , face-compare , proof , recent-excerpt , incorporation-documents , share_holders_list , other_corporate , signature , id_card_passport_photo , biometric-residence-permit-front , biometric-residence-permit-back , kyc-vendor-report</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/users/{user}/documents-request"></pre>
|
||
<script>document.getElementById('post_/v2/users/{user}/documents-request').innerHTML = prettyPrintJson.toHtml({"file":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3\/HwADvgI9\/iYBsgAAAABJRU5ErkJggg==","file_type":"pdf","document_type":"passport"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1215434"
|
||
aria-expanded="false" aria-controls="data1215434">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1215434">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Token from operation</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/users/{user}/documents-response"></pre>
|
||
<script>document.getElementById('post_/v2/users/{user}/documents-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"0ba5e81d-c43b-4008-b2d6-0d390f6f8c08"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>Validation error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11002</p></th>
|
||
<td><p>Application not found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<div class="main-content-area ep" id="onbAML">
|
||
|
||
<div>
|
||
<h3>AML Natural Persons</h3>
|
||
<p> You can check AML and sanctions presence:</p>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<hr>
|
||
|
||
<div class="d-1160 ep" id="onbDetailsUp">
|
||
|
||
<div>
|
||
<h3 class="mb-3">AML Check</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v1/aml
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>aml_check</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>nationality</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>birthday</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v1/aml-request"></pre>
|
||
<script>document.getElementById('post_/v1/aml-request').innerHTML = prettyPrintJson.toHtml({"first_name":"John","last_name":"Doe","nationality":"BG","birthday":"2022-12-21"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data831990"
|
||
aria-expanded="false" aria-controls="data831990">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data831990">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Token from operation</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v1/aml-response"></pre>
|
||
<script>document.getElementById('post_/v1/aml-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"0ba5e81d-c43b-4008-b2d6-0d390f6f8c08"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>18000</p></th>
|
||
<td><p>services.general.invalid_processor</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>18001</p></th>
|
||
<td><p>service.aml.match.found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<hr>
|
||
|
||
<section class="transactions fh fh100" id="transactions">
|
||
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Transactions</h3>
|
||
<p>Welcome to Paynetics' <strong>transactions</strong> section. Let’s go over the basics.</p>
|
||
|
||
<h4>What is a transaction in Paynetics?</h4>
|
||
|
||
<p>Transaction in paynetics system is a <strong>record</strong> that represents an operation that affect the ballance of the end customer. This can be a blockage or a movement of funds internally in the system or externally to other banks.</p>
|
||
|
||
<div class="info-box">
|
||
<p><i class="bi bi-box-arrow-in-down"></i> Examples for <strong>Internal</strong> movements:</p>
|
||
<ul>
|
||
<li>Funds are transferred between two Paynetics accounts by preforming P2P using identifiers (tokens)</li>
|
||
<li>IBAN transfers to PATC accounts</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="info-box secondary mt-5">
|
||
<div class="d-flex justify-content-start align-items-center">
|
||
<i class="bi bi-box-arrow-in-up"></i>
|
||
<p>Examples for <strong>External</strong> movements:</p>
|
||
</div>
|
||
<ul>
|
||
<li>Card issued by Paynetics is charged/funded</li>
|
||
<li>Wire transfer is performed from/to Paynetics issued IBAN</li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<div>
|
||
<h4>Types of Transactions</h4>
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th scope="col">Code</th>
|
||
<th scope="col">Mapping</th>
|
||
<th scope="col">Impacts Balance</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>internal-transfer</td>
|
||
<td>Financial</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>load</td>
|
||
<td>Financial</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>wire-transfer</td>
|
||
<td>Financial</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>authorization</td>
|
||
<td>Authorization</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>refund</td>
|
||
<td>Authorisation</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>reversal</td>
|
||
<td>Authorisation</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>fee</td>
|
||
<td>Financial</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>oct</td>
|
||
<td>Financial</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
<tr>
|
||
<td>presentment</td>
|
||
<td>Financial</td>
|
||
<td>Yes</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<p>Depending on the type, the transaction may have a different structure.</p>
|
||
|
||
<ul>
|
||
<li><code class="code-inside">counterpart</code> is a mandatory field for all internal transfers. It contains the details of debtor/creditor.</li>
|
||
<li><code class="code-inside">wires</code> is a mandatory field for cases of internal transfers done using IBAN</li>
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="transactionsDetails">
|
||
<div>
|
||
<h3>Transactions List</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/transactions/{page}/{limit}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>transactions_list</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ page ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Starting from page 1</p>
|
||
<p class="text-uppercase">[ limit ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Maximum per page 1000</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Filters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p>
|
||
start_date - (For this date onwards)
|
||
</p>
|
||
<p>
|
||
end_date - (Up to this date)
|
||
</p>
|
||
<p>
|
||
type - (Type of the transaction. For more info check)
|
||
</p>
|
||
<p>
|
||
code - (Code of the transaction. For more info check)
|
||
</p>
|
||
<p>
|
||
channel - ()
|
||
</p>
|
||
<p>
|
||
status - (Status of the transaction. For more info)
|
||
</p>
|
||
<p>
|
||
merchant - (Identifier of merchant|company in Paynetics system)
|
||
</p>
|
||
<p>
|
||
user - (Identifier of user in Paynetics system)
|
||
</p>
|
||
<p>
|
||
reference - (Reference of the transaction)
|
||
</p>
|
||
<p>
|
||
show_hidden - (Force show hidden transactions)
|
||
</p>
|
||
<p>
|
||
account - (Identifier of the account in Paynetics system)
|
||
</p>
|
||
<p>
|
||
balance - (Identifier of the balance in Paynetics system)
|
||
</p>
|
||
<p>
|
||
card - (Identifier of the card in Paynetics system)
|
||
</p>
|
||
<p>
|
||
debit_credit - (Direction of transction debit or credit)
|
||
</p>
|
||
<p>
|
||
load_after - (Load transaction from specified identifier onwards)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1102276"
|
||
aria-expanded="false" aria-controls="data1102276">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1102276">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>items</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#items1523509"
|
||
aria-expanded="false" aria-controls="items1523509">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="items1523509">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Unique identifier of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the account</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the balance</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Identifier in external processor if available</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>channel</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Type of the transaction</p>
|
||
|
||
<strong>Available Options: </strong> <i>internal-transfer , load , wire-transfer , authorization , pre-authorization , capture , purchase , refund , reversal , credit , fee , oct , presentment</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Amount in balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Account balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>original_amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Original amount of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>original_currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Original currency of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Email of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_before</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer before transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_after</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer after transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>debit_credit</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Direction of funds. Debit -> outgoing, Credit -> incoming</p>
|
||
|
||
<strong>Available Options: </strong> <i>debit , credit</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>linked_transaction</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Link of different type of transactions. Authorizaions - Presentments. Authorizations - Reveresal etc</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Identifier in external system</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_link</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Link of different card authorization and presentments. Can be any type of length.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>General fee for the opreration in account currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Status of the transaction. 1 - Processed, 0 - Pending, -1 - Failed, -2 - Cancelled</p>
|
||
|
||
<strong>Available Options: </strong> <i>1 , 0 , -1 , -2</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source or set by customer for transfers</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source or set by customer for transfers</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Description of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_recurring</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Applicable for transactions which are marked to be recurring event</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_initial_recurring</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorizations</strong>
|
||
<span class="att-type">array</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>created_at</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the transaction creation</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>updated_on</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the transaction last update</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>execution_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the transaction processing</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>acquiring</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#acquiring1153843"
|
||
aria-expanded="false" aria-controls="acquiring1153843">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="acquiring1153843">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_pan_obfuscated</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ccti_id</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>transaction_stamp</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pos_terminal_id</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>processing_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>point_of_service_entry_mode</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>acquiring_institution_identification_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_identification_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>system_trace_audit_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_captured</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorization_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>retrieval_reference_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is3d</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_moto</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc_description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx_fixed_fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx_fee_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>domestic_fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>domestic_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>non_domestic_fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>non_domestic_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token_unique_reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>approval_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorization_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorization_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>note</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>wires</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Details of wire transfer. Required when type is wire-transfer. Conditional for type internal-transfer</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#wires126070"
|
||
aria-expanded="false" aria-controls="wires126070">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="wires126070">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Sender of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender bank name</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender bank country</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender bank code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Sender IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender Sort code (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender Account (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Receiver of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank name</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Receiver IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver Sort code (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver Account (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank name</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank country</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>charges</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Who pays for charges</p>
|
||
|
||
<strong>Available Options: </strong> <i>sha , our , ben</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>value_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Value date of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>settlement_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Settlement date of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>network_original_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>network</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_instant</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>counterpart</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Required when type is internal-transfer. Represents the other particiapnt in the transcation.</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#counterpart1176473"
|
||
aria-expanded="false" aria-controls="counterpart1176473">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="counterpart1176473">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>instance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the account</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the balance</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Identifier in external processor if available</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Amount in balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Account balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>debit_credit</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Direction of funds. Debit -> outgoing, Credit -> incoming</p>
|
||
|
||
<strong>Available Options: </strong> <i>debit , credit</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Email of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_before</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer before transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_after</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer after transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>FX conversion rate.</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>total_items</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/transactions/{page}/{limit}-response"></pre>
|
||
<script>document.getElementById('get_/v2/transactions/{page}/{limit}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"items":[{"token":"cae2cdcb-e0db-4159-b522-44c0629179d9","merchant":"cae2cdcb-e0db-4159-b522-44c0629179d9","user":"cae2cdcb-e0db-4159-b522-44c0629179d9","account":"cae2cdcb-e0db-4159-b522-44c0629179d9","balance":"cae2cdcb-e0db-4159-b522-44c0629179d9","external_balance":"123456789","channel":"string","type":"authorization","amount":1.23,"currency":"GBP","original_amount":1.23,"original_currency":"EUR","name":"John Doe","phone":"+35900000000","email":"john.doe@paynetics.digital","balance_before":1,"balance_after":1,"debit_credit":"debit","linked_transaction":"12345678","external_identifier":"12345678","external_link":"12345678","fee":1.23,"status":"1","reference":"Additional info 1","reference2":"Additional info 2","reference3":"Additional info 3","reference4":"Additional info 4","description":"Transfer for fun :)","is_recurring":false,"is_initial_recurring":false,"authorizations":[{"type":"string","example":"e7ebef39-0d74-4f1c-872b-3b7c9d1f771b"}],"created_at":"2022-12-12 00:00:00","updated_on":"2022-12-12 00:00:00","execution_date":"2022-12-12 00:00:00","acquiring":{"card":"cae2cdcb-e0db-4159-b522-44c0629179d9","card_pan_obfuscated":"411111XXXXXX1111","card_type":"visa","ccti_id":"string","transaction_stamp":"string","pos_terminal_id":"16P00000","processing_code":"000000","point_of_service_entry_mode":"string","acquiring_institution_identification_code":"16000000","card_acceptor_identification_code":"16000000","card_acceptor_name":"Paynetics","card_acceptor_city":"Sofia","card_acceptor_country":"BG","system_trace_audit_number":"123456","is_captured":"boolean","authorization_code":"123456","retrieval_reference_number":"string","is3d":true,"is_moto":false,"mcc":"6012","mcc_description":"Financial Institution","fx_fixed_fee":1.2345,"fx_fee_rate":1.2345,"fx_rate":1.2345,"domestic_fee":1.2345,"domestic_rate":1.2345,"non_domestic_fee":1.2345,"non_domestic_rate":1.2345,"token_unique_reference":"string","approval_code":"string","authorization_date":"string","authorization_type":"string","note":"string","description":"string"},"wires":{"sender_name":"John Doe","sender_bank_name":"Paynetics AD","sender_bank_country":"BG","sender_bank_code":"PATCBGXXX","sender_iban":"BG91PATC40021921028091","sender_sort_code":"040738","sender_account_number":"12345676","receiver_name":"John Doe","receiver_bank":"Paynetics AD","receiver_iban":"BG91PATC40021921028091","receiver_sort_code":"040738","receiver_account_number":"12345676","receiver_bank_name":"Paynetics AD","receiver_bank_country":"BG","receiver_bank_code":"PATCBGXXX","charges":"sha","value_date":"2023-01-25","settlement_date":"2023-01-25","status":"string","network_original_code":"string","network":"string","is_instant":false},"counterpart":{"instance":"8cf9963a-2042-41b3-906c-48c2aea16458","merchant":"cae2cdcb-e0db-4159-b522-44c0629179d9","user":"cae2cdcb-e0db-4159-b522-44c0629179d9","account":"cae2cdcb-e0db-4159-b522-44c0629179d9","balance":"cae2cdcb-e0db-4159-b522-44c0629179d9","external_balance":"123456789","amount":1.23,"currency":"GBP","debit_credit":"debit","phone":"+35900000000","email":"john.doe@paynetics.digital","name":"John Doe","balance_before":1,"balance_after":1,"fx":1}}],"total_items":1}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="d-1160" id="transactionsDetails">
|
||
<div>
|
||
<h3>Transaction Details</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/transactions/{transaction}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>transaction_details</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ transaction ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1115625"
|
||
aria-expanded="false" aria-controls="data1115625">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1115625">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Unique identifier of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the account</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the balance</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Identifier in external processor if available</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>channel</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Type of the transaction</p>
|
||
|
||
<strong>Available Options: </strong> <i>internal-transfer , load , wire-transfer , authorization , pre-authorization , capture , purchase , refund , reversal , credit , fee , oct , presentment</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Amount in balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Account balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>original_amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Original amount of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>original_currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Original currency of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Email of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_before</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer before transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_after</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer after transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>debit_credit</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Direction of funds. Debit -> outgoing, Credit -> incoming</p>
|
||
|
||
<strong>Available Options: </strong> <i>debit , credit</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>linked_transaction</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Link of different type of transactions. Authorizaions - Presentments. Authorizations - Reveresal etc</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Identifier in external system</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_link</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Link of different card authorization and presentments. Can be any type of length.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>General fee for the opreration in account currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Status of the transaction. 1 - Processed, 0 - Pending, -1 - Failed, -2 - Cancelled</p>
|
||
|
||
<strong>Available Options: </strong> <i>1 , 0 , -1 , -2</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source or set by customer for transfers</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source or set by customer for transfers</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Reference coming from external source</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Description of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_recurring</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Applicable for transactions which are marked to be recurring event</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_initial_recurring</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorizations</strong>
|
||
<span class="att-type">array</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>created_at</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the transaction creation</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>updated_on</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the transaction last update</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>execution_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Date of the transaction processing</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>acquiring</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#acquiring296401"
|
||
aria-expanded="false" aria-controls="acquiring296401">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="acquiring296401">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_pan_obfuscated</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ccti_id</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>transaction_stamp</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pos_terminal_id</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>processing_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>point_of_service_entry_mode</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>acquiring_institution_identification_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_identification_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_acceptor_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>system_trace_audit_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_captured</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorization_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>retrieval_reference_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is3d</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_moto</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc_description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx_fixed_fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx_fee_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>domestic_fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>domestic_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>non_domestic_fee</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>non_domestic_rate</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token_unique_reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>approval_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorization_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>authorization_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>note</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>wires</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Details of wire transfer. Required when type is wire-transfer. Conditional for type internal-transfer</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#wires1673804"
|
||
aria-expanded="false" aria-controls="wires1673804">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="wires1673804">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Sender of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender bank name</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender bank country</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender bank code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Sender IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender Sort code (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Sender Account (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Receiver of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank name</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Receiver IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver Sort code (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver Account (GBP transfers)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank name</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank country</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Receiver bank code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>charges</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Who pays for charges</p>
|
||
|
||
<strong>Available Options: </strong> <i>sha , our , ben</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>value_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Value date of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>settlement_date</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Settlement date of the transfer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>network_original_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>network</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_instant</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>counterpart</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Required when type is internal-transfer. Represents the other particiapnt in the transcation.</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#counterpart1988174"
|
||
aria-expanded="false" aria-controls="counterpart1988174">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="counterpart1988174">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>instance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional in case account is opened to user</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the account</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Token of the balance</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Identifier in external processor if available</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Amount in balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Account balance currency</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>debit_credit</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
<span class="mandatory">*</span>
|
||
</p>
|
||
|
||
<p>Direction of funds. Debit -> outgoing, Credit -> incoming</p>
|
||
|
||
<strong>Available Options: </strong> <i>debit , credit</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Email of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of the customer.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_before</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer before transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance_after</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance of the customer after transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fx</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>FX conversion rate.</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/transactions/{transaction}-response"></pre>
|
||
<script>document.getElementById('get_/v2/transactions/{transaction}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"cae2cdcb-e0db-4159-b522-44c0629179d9","merchant":"cae2cdcb-e0db-4159-b522-44c0629179d9","user":"cae2cdcb-e0db-4159-b522-44c0629179d9","account":"cae2cdcb-e0db-4159-b522-44c0629179d9","balance":"cae2cdcb-e0db-4159-b522-44c0629179d9","external_balance":"123456789","channel":"string","type":"authorization","amount":1.23,"currency":"GBP","original_amount":1.23,"original_currency":"EUR","name":"John Doe","phone":"+35900000000","email":"john.doe@paynetics.digital","balance_before":1,"balance_after":1,"debit_credit":"debit","linked_transaction":"12345678","external_identifier":"12345678","external_link":"12345678","fee":1.23,"status":"1","reference":"Additional info 1","reference2":"Additional info 2","reference3":"Additional info 3","reference4":"Additional info 4","description":"Transfer for fun :)","is_recurring":false,"is_initial_recurring":false,"authorizations":[{"type":"string","example":"e7ebef39-0d74-4f1c-872b-3b7c9d1f771b"}],"created_at":"2022-12-12 00:00:00","updated_on":"2022-12-12 00:00:00","execution_date":"2022-12-12 00:00:00","acquiring":{"card":"cae2cdcb-e0db-4159-b522-44c0629179d9","card_pan_obfuscated":"411111XXXXXX1111","card_type":"visa","ccti_id":"string","transaction_stamp":"string","pos_terminal_id":"16P00000","processing_code":"000000","point_of_service_entry_mode":"string","acquiring_institution_identification_code":"16000000","card_acceptor_identification_code":"16000000","card_acceptor_name":"Paynetics","card_acceptor_city":"Sofia","card_acceptor_country":"BG","system_trace_audit_number":"123456","is_captured":"boolean","authorization_code":"123456","retrieval_reference_number":"string","is3d":true,"is_moto":false,"mcc":"6012","mcc_description":"Financial Institution","fx_fixed_fee":1.2345,"fx_fee_rate":1.2345,"fx_rate":1.2345,"domestic_fee":1.2345,"domestic_rate":1.2345,"non_domestic_fee":1.2345,"non_domestic_rate":1.2345,"token_unique_reference":"string","approval_code":"string","authorization_date":"string","authorization_type":"string","note":"string","description":"string"},"wires":{"sender_name":"John Doe","sender_bank_name":"Paynetics AD","sender_bank_country":"BG","sender_bank_code":"PATCBGXXX","sender_iban":"BG91PATC40021921028091","sender_sort_code":"040738","sender_account_number":"12345676","receiver_name":"John Doe","receiver_bank":"Paynetics AD","receiver_iban":"BG91PATC40021921028091","receiver_sort_code":"040738","receiver_account_number":"12345676","receiver_bank_name":"Paynetics AD","receiver_bank_country":"BG","receiver_bank_code":"PATCBGXXX","charges":"sha","value_date":"2023-01-25","settlement_date":"2023-01-25","status":"string","network_original_code":"string","network":"string","is_instant":false},"counterpart":{"instance":"8cf9963a-2042-41b3-906c-48c2aea16458","merchant":"cae2cdcb-e0db-4159-b522-44c0629179d9","user":"cae2cdcb-e0db-4159-b522-44c0629179d9","account":"cae2cdcb-e0db-4159-b522-44c0629179d9","balance":"cae2cdcb-e0db-4159-b522-44c0629179d9","external_balance":"123456789","amount":1.23,"currency":"GBP","debit_credit":"debit","phone":"+35900000000","email":"john.doe@paynetics.digital","name":"John Doe","balance_before":1,"balance_after":1,"fx":1}}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="programs ep" id="programs">
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Programs</h3>
|
||
<h4>What is a program in Paynetics?</h4>
|
||
<p>Your initial agreement with Payntics includes a definition of how you intend to use Paynetics' services.
|
||
This includes types of products, limits etc. Program is configured by Paynetics and is used as a term
|
||
that refers to a set of rules used for account and card creation as well as management. </p>
|
||
</div>
|
||
|
||
<div>
|
||
<div>
|
||
<p class="code-card-title ">The program configuration allows for a wide range of settings:</p>
|
||
|
||
<div class="info-box" >
|
||
<p class="info-box-title"><i class="bi bi-gear-wide-connected"></i> <span style="margin-left: 5px; font-size: 16px;">Balances settings</span></p>
|
||
|
||
<div style="padding-left: 40px;">
|
||
<p>All accounts have one primary (main) balance that can be set in one of Paynetics' supported currencies.</p>
|
||
|
||
<p>Paynetics supports multiple secondary balances that can be set in the preferred supported currency.</p>
|
||
|
||
<p>Based on the settings, accounts can have one IBAN linked to the primary (main) balance or multiple IBANs for each secondary balance.</p>
|
||
|
||
<p class="info-box-title">KYC requirements</p>
|
||
|
||
<p>Each program comes with configurable KYC onboarding requirements settings. Some programs may require KYC verification for natural persons. This is set up depending on the initial agreement.</p>
|
||
|
||
<p class="info-box-title">Card settings</p>
|
||
|
||
<p>Paynetics offers plastic and virtual card issuing, which can be enabled via the available configurations in the program.</p>
|
||
|
||
<p>Cards can be configured to have enabled/disabled card push provisioning for <a href="https://support.apple.com/en-gb/guide/security/sec0f005981a/web" target="_blank">Apple pay</a> and
|
||
<a href="https://developers.google.com/pay/issuers/apis/push-provisioning/android" target="_blank">Google pay</a> wallets.</p>
|
||
|
||
<p>The program specifies the processor and the default limit and fee groups for it. Other configurations include direct issuing and the max lenght of the name on cards.</p>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<section class="accounts" id="accounts">
|
||
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Accounts</h3>
|
||
|
||
<h4>What is an account in Paynetics?</h4>
|
||
<p>Accounts are entities created against a merchant or user with the respective program. They can have one
|
||
or multiple balances depending on your program. </p>
|
||
|
||
<h4>Paynetics Account Core Functionalities</h4>
|
||
|
||
<p>Accounts at Paynetics can perform a large number of operations.</p>
|
||
|
||
<p><span class="feature-title"><img src="/images/accounts.svg" alt="">IBAN</span> - Accounts can have one or multiple IBANs depending on the program. </p>
|
||
|
||
<p><i>Supported currencies: EUR, BGN, GBP (Account number + Sort Code)</i></p>
|
||
|
||
<p><span class="feature-title"><img src="/images/viban.svg" alt="">Virtual Accounts</span> - Virtual accounts are linked to one main account and do not hold a balance. Instead, they are using the primary (main) account balance.</p>
|
||
|
||
<p><span class="feature-title"><img src="/images/issuing.svg" alt="">Card</span> - A single card can be issued to an account. Cards can be plastic and/or virtual. </p>
|
||
|
||
<p><span class="feature-title"><img src="/images/transfers.svg" alt="">Money transfers</span> - Account holders can send and receive money internally to/from another Paynetics account or externally to/from any IBAN. </p>
|
||
|
||
<p><span class="feature-title"><img src="/images/acquiring.svg" alt="">Spend money by card</span> - Cards can be used to pay in any physical location, online or withdraw money from ATMs.</p>
|
||
|
||
<p><span class="feature-title"><img src="/images/pound.svg" alt="">Load</span> - There are multiple ways accounts can be loaded:</p>
|
||
|
||
<ul>
|
||
<li>via wire transfer from an external bank by IBAN</li>
|
||
<li>via external bank card</li>
|
||
<li>via internal bank transfer (P2P)</li>
|
||
</ul>
|
||
|
||
|
||
<h4>Type of accounts</h4>
|
||
|
||
<p>There are several types of accounts that can be created:</p>
|
||
|
||
<div class="accounts-box d-flex justify-content-left align-items-center">
|
||
<div>
|
||
<p>Default</p>
|
||
<p>Funding</p>
|
||
</div>
|
||
<div>
|
||
<p>Virtual</p>
|
||
<p>Breakage</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div>
|
||
<div class="info-box">
|
||
<strong>Glossary</strong>
|
||
<ul>
|
||
<li><strong>merchant</strong> - all legal entity clients of Paynetics</li>
|
||
<li><strong>user</strong> - all natural parsons clients of Paynetics</li>
|
||
<li><strong>balance</strong> - a record of available funds that is always linked with an IBAN or balance token.</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
<section id="accCreation">
|
||
|
||
<div class="d-1160">
|
||
<div>
|
||
<h4 class="mb-3">Account Creation</h4>
|
||
<h4 class="mb-3">How to Create an Account?</h4>
|
||
|
||
<p>Accounts are created via an API request. Each request should include the program and the merchant/user
|
||
associated with it.</p>
|
||
|
||
<p>For cases where IBAN/Account Number creation is allowed by the program, but should be omitted for a specific
|
||
account, a property in the API request can be used to skip that step.</p>
|
||
|
||
<p>For cases where a virtual account must be created, please include the primary (main) account identifier in
|
||
the API request. It is mandatory that the primary (main) account is opened to the same merchant/user as in
|
||
the request.</p>
|
||
|
||
<p>If the request is successful, the API response will return an account identifier and an array of balances
|
||
with identifiers to each one. It is recommended these identifiers are stored by external parties for later
|
||
usage.</p>
|
||
|
||
|
||
<div class="info-box d-flex align-items-start">
|
||
<div class="m-0">
|
||
<i class="bi bi-info-circle-fill"></i>
|
||
</div>
|
||
<div style="margin-left: 10px;">
|
||
<p>
|
||
<strong>For merchant virtual</strong>
|
||
accounts, Paynetics system checks if the primary (main) account exists and has valid KYB
|
||
verification.
|
||
</p>
|
||
<p>
|
||
<strong>For user virtual</strong>
|
||
accounts, Paynetics system checks if the primary (main) account is not blocked/terminated and has
|
||
valid
|
||
KYC verification.
|
||
</p>
|
||
<p>Each merchant/user can have multiple primary (main) and virtual accounts.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="d-1160">
|
||
<div>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/accounts
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>account_create</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>main</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>skip_iban_generation</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>alias</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/accounts-request"></pre>
|
||
<script>document.getElementById('post_/v2/accounts-request').innerHTML = prettyPrintJson.toHtml({"program":"account_eur","merchant":"242d993a-be0e-461d-b9e4-7c84b8bfff4f","user":"3e42849a-f1ef-4a65-b0ad-193a5e87a626","main":"5a836b53-5a3f-47ab-9a76-13a7eb7d7865","skip_iban_generation":false,"alias":"alias of account"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data562119"
|
||
aria-expanded="false" aria-controls="data562119">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data562119">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>link_key</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>multicurrency</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balances</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#balances243305"
|
||
aria-expanded="false" aria-controls="balances243305">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="balances243305">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>available</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>blocked</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/accounts-response"></pre>
|
||
<script>document.getElementById('post_/v2/accounts-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"program":"account_eur","token":"202f828a-c594-436d-b753-87c47556ef11","merchant":"68f63588-2859-4997-8a23-29c59223e6ba","user":"5eef34b5-69d8-4596-a9d3-b3aad500e825","type":"default","number":"0123456789","link_key":"1234","is_main":true,"status":"active","multicurrency":false,"balances":[{"available":1.23,"blocked":1.23,"currency":"EUR","token":"338e7368-4800-40ad-a4db-2e3df401087b","iban":"BG31PATC4002115468108680","sort_code":"123456","account_number":"12345678","number":"0123456789","is_main":true}]}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</section>
|
||
|
||
|
||
<section id="accStatus" class="d-1160 account-status-section">
|
||
|
||
<div class="account-status">
|
||
<h4>Account Status</h4>
|
||
|
||
<p>There are 3 statuses that an account can have:</p>
|
||
|
||
<div class="alert alert-success" role="alert">
|
||
<p><strong><i class="bi bi-check-circle-fill"></i>Active</strong></p>
|
||
<p>By default, accounts are created in active status. This means that the account can be loaded using an
|
||
external bank card, wire transfer, or internal transfer. Wire/internal transfers can also be initiated
|
||
by the account owner.</p>
|
||
<p>Active accounts can have plastic and/or virtual cards that can be used to spend available funds.</p>
|
||
</div>
|
||
|
||
<div class="alert alert-secondary" role="alert">
|
||
<p><strong><i class="bi bi-lock-fill"></i>Inactive</strong></p>
|
||
<p>Inactive status restricts the account holder to spend or receive any funds. Cards cannot be issued. This
|
||
status is reversible to active. If any cards are issued to the account, they are frozen as well as any
|
||
Apple/Google tokens</p>
|
||
</div>
|
||
|
||
<div class="alert alert-danger" role="alert">
|
||
<p><strong><i class="bi bi-x-octagon-fill"></i>Closed</strong></p>
|
||
<p>Closed have same properties as inactive but it also destroys all cards issued, remove all apple/google
|
||
tokens. Account closure is an irreversible operation.</p>
|
||
</div>
|
||
|
||
<p>There are two different APIs for account status change. One is for changing between active/inactive status
|
||
and a separate one is used for account termination since it is an irreversible process.</p>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</section>
|
||
|
||
<section class="d-1160 account-status-section">
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/accounts/{account}/status
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>account_status</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ account ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from account creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>active , blocked</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/accounts/{account}/status-request"></pre>
|
||
<script>document.getElementById('put_/v2/accounts/{account}/status-request').innerHTML = prettyPrintJson.toHtml({"status":"active"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/accounts/{account}/status-response"></pre>
|
||
<script>document.getElementById('put_/v2/accounts/{account}/status-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160 account-status-section">
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>DELETE </strong>
|
||
/v2/accounts/{account}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>account_terminate</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ account ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from account creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/accounts/{account}-response"></pre>
|
||
<script>document.getElementById('delete_/v2/accounts/{account}-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
<section class="ep" id="accListDetail">
|
||
|
||
<div class="d-1160">
|
||
<div>
|
||
<h3 class="mb-3">Account List/Details</h3>
|
||
<p>Account list/details can be extracted using API.</p>
|
||
|
||
<p><strong class="color-paynetics">List API</strong> is used to extract basic information for all accounts associated with an instance.
|
||
There are several filters that can be used to refine your query.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/accounts/{page}/{limit}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>accounts_list</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ page ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Starting from page 1</p>
|
||
<p class="text-uppercase">[ limit ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Maximum per page 10</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Filters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p>
|
||
merchant - (Token of merchant)
|
||
</p>
|
||
<p>
|
||
user - (Token of user)
|
||
</p>
|
||
<p>
|
||
program - (Code of program)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data269267"
|
||
aria-expanded="false" aria-controls="data269267">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data269267">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>items</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#items1329490"
|
||
aria-expanded="false" aria-controls="items1329490">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="items1329490">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>link_key</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>multicurrency</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balances</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#balances1097495"
|
||
aria-expanded="false" aria-controls="balances1097495">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="balances1097495">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>available</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>blocked</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>total_items</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/accounts/{page}/{limit}-response"></pre>
|
||
<script>document.getElementById('get_/v2/accounts/{page}/{limit}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"items":[{"program":"account_eur","token":"202f828a-c594-436d-b753-87c47556ef11","merchant":"68f63588-2859-4997-8a23-29c59223e6ba","user":"5eef34b5-69d8-4596-a9d3-b3aad500e825","type":"default","number":"0123456789","link_key":"1234","is_main":true,"status":"active","multicurrency":false,"balances":[{"available":1.23,"blocked":1.23,"currency":"EUR","token":"338e7368-4800-40ad-a4db-2e3df401087b","iban":"BG31PATC4002115468108680","sort_code":"123456","account_number":"12345678","number":"0123456789","is_main":true}]}],"total_items":"1"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
|
||
|
||
<section class="ep" id="accListDetailApi">
|
||
<div class="d-1160">
|
||
<div>
|
||
<h3 class="mb-3">Account List/Details</h3>
|
||
|
||
<p><strong class="color-paynetics">Details API</strong> is used to return full information for the account and associated balances.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/accounts/{account}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>account_details</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ account ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from account creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data386730"
|
||
aria-expanded="false" aria-controls="data386730">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data386730">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>link_key</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>multicurrency</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balances</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#balances1723776"
|
||
aria-expanded="false" aria-controls="balances1723776">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="balances1723776">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>available</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>blocked</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/accounts/{account}-response"></pre>
|
||
<script>document.getElementById('get_/v2/accounts/{account}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"program":"account_eur","token":"202f828a-c594-436d-b753-87c47556ef11","merchant":"68f63588-2859-4997-8a23-29c59223e6ba","user":"5eef34b5-69d8-4596-a9d3-b3aad500e825","type":"default","number":"0123456789","link_key":"1234","is_main":true,"status":"active","multicurrency":false,"balances":[{"available":1.23,"blocked":1.23,"currency":"EUR","token":"338e7368-4800-40ad-a4db-2e3df401087b","iban":"BG31PATC4002115468108680","sort_code":"123456","account_number":"12345678","number":"0123456789","is_main":true}]}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="cards" id="cards">
|
||
|
||
<div class="fh fh100">
|
||
<div class="d-1160">
|
||
<div class="m-0">
|
||
<h3 class="mb-3">Cards</h3>
|
||
|
||
<p>Cards can be issued to an account or can be non-personalized depending on program configuration. Each account
|
||
can have a <u class="color-paynetics">single</u> active card. Card can be either virtual or plastic depending on the program. Cards
|
||
can be
|
||
used to pay in any physical location, online or withdraw money from ATMs.
|
||
All virtual cards are activated upon issuing and can be used immediately.
|
||
All plastic cards are not activated upon issuing and must be activated by the customer once received. </p>
|
||
|
||
<p><strong class="color-paynetics">All virtual cards</strong> are activated upon issuing and can be used immediately. </p>
|
||
|
||
<p><strong class="color-paynetics">All plastic cards</strong> are not activated upon issuing and must be activated by the customer once
|
||
received. </p>
|
||
|
||
<p>Cards can be converted from virtual to plastic at a later stage. The PIN can be set on card creation or changed
|
||
at a later stage on ATM.</p>
|
||
|
||
<p>Apple Pay/Google Pay push provision is supported depending on the program.</p>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
|
||
<section class="ep" id="cardC">
|
||
<div class="d-1160">
|
||
<div>
|
||
<h4 class="mb-3">Card Creation</h4>
|
||
|
||
<p>Card creation can require different fields depending on type (virtual, plastic) and affiliation (customer, non-personalized).</p>
|
||
<p><strong class="color-paynetics">Virtual Cards</strong> - to create a virtual card associated with a customer account, please include the account identifier and type of card (virtual). In case the name of the merchant/user is not present in the customer profile, please specify them in the emboss name, emboss name line 4, first and last name (for natural persons) fields of the API request.</p>
|
||
<p><strong class="color-paynetics">Plastic Cards</strong> - the requirements for plastic card issuing for an account associated with a customer are similar to those for virtual cards. The only addition is to include the delivery details of the cardholder.</p>
|
||
<p>The program associated with the account will be used when the card is created. Virtual accounts use the balance of the primary (main) account.</p>
|
||
|
||
<p><strong class="color-paynetics">Non-personalized virtual cards</strong> - the required fields are program code and type of the card (virtual).</p>
|
||
<p><strong class="color-paynetics">Non-personalized plastic cards</strong> - the requirements for non-personalized plastic card issuing are similar to those for non-personalized virtual cards. The only addition is to include the card delivery details.</p>
|
||
|
||
<p>For all cases above there are additional fields which can be provided like PIN, fulfil and thermal line data. Card 3DS details can also be provided in order for the card to be enrolled immediately after creation.</p>
|
||
<p>Please be advised that fulfil and thermal line data usage and placement on the card may vary depending on the personalization bureau. Contact your account manager before usage.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/cards
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_create</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Required only for non pesonalized card in case must be assigned to merchant immediately.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Required only for non pesonalized card in case must be assigned to user immediately.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>aml</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Token of AML check. Conditinal: depending on program configuration</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name_line4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fulfil1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fulfil2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>thermal_line1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>thermal_line2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>active</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pin</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>plastic , virtual</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>alias</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>delivery_details</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Required for plastic cards</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#delivery_details1510843"
|
||
aria-expanded="false" aria-controls="delivery_details1510843">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="delivery_details1510843">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>method</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>three_domain_enrolment</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#three_domain_enrolment581895"
|
||
aria-expanded="false" aria-controls="three_domain_enrolment581895">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="three_domain_enrolment581895">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>otp_sms</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>biometric</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards-request"></pre>
|
||
<script>document.getElementById('post_/v2/cards-request').innerHTML = prettyPrintJson.toHtml({"program":"card_eur","account":"a451c34e-56d7-4e7f-8b6c-3322791ea792","merchant":"b204ac3f-a23e-442b-a909-898238197070","user":"b204ac3f-a23e-442b-a909-898238197070","aml":"b204ac3f-a23e-442b-a909-898238197070","emboss_name":"John Doe","emboss_name_line4":"JohnDoe Ltd","fulfil1":"123456","fulfil2":"789123","thermal_line1":"123456","thermal_line2":"789123","active":false,"pin":"1234","type":"virtual","first_name":"John","last_name":"Doe","alias":"Shopping Card","delivery_details":{"city":"Sofia","country":"BG","county":"Sofia Grad","zip":"1407","address1":"James Bouchier 76A","address2":"Paynetics Office","address3":"Floor 2","method":"string","code":"string","mobile_phone":"+3590000000"},"three_domain_enrolment":{"otp_sms":"+3590000000","biometric":true}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1413150"
|
||
aria-expanded="false" aria-controls="data1413150">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1413150">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>link_key</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>multicurrency</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balances</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#balances841068"
|
||
aria-expanded="false" aria-controls="balances841068">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="balances841068">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>available</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>blocked</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_main</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards-response"></pre>
|
||
<script>document.getElementById('post_/v2/cards-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"program":"account_eur","token":"202f828a-c594-436d-b753-87c47556ef11","merchant":"68f63588-2859-4997-8a23-29c59223e6ba","user":"5eef34b5-69d8-4596-a9d3-b3aad500e825","type":"default","number":"0123456789","link_key":"1234","is_main":true,"status":"active","multicurrency":false,"balances":[{"available":1.23,"blocked":1.23,"currency":"EUR","token":"338e7368-4800-40ad-a4db-2e3df401087b","iban":"BG31PATC4002115468108680","sort_code":"123456","account_number":"12345678","number":"0123456789","is_main":true}]}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="ep" id="cardU">
|
||
<div class="d-1160">
|
||
<div>
|
||
<h4 class="mb-3">Card Details Update</h4>
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_update</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Required only for non pesonalized card in case must be assigned to merchant immediately.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Required only for non pesonalized card in case must be assigned to user immediately.</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>branch_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>expiration_month</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>expiration_year</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}-request"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}-request').innerHTML = prettyPrintJson.toHtml({"merchant":"b204ac3f-a23e-442b-a909-898238197070","user":"b204ac3f-a23e-442b-a909-898238197070","emboss_name":"John Doe","mobile_phone":"string","first_name":"John","last_name":"Doe","branch_code":"string","expiration_month":"05","expiration_year":"2026"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
<section class="d-1160" id="cardConv">
|
||
<div>
|
||
<h4 class="mb-3">Card Conversion</h4>
|
||
<p>Virtual cards can be converted to plastic. The requirement for conversion is card delivery details to be
|
||
present when the virtual card was created or added when making a request to the conversion API endpoint.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}/convert
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_convert</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/convert-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/convert-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="cardA">
|
||
<div>
|
||
<h4 class="mb-3">Card Activation</h4>
|
||
<p>Plastic cards are always created not activated, meaning no transactions can be executed with the card before activation. Activation is a one-time process and must be done once the card is received by the cardholder for security reasons.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}/activate
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_activate</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>aml</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Conditional: For some cases for non personalized cards.</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/activate-request"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/activate-request').innerHTML = prettyPrintJson.toHtml({"aml":"f37377c0-50c0-4324-a330-902f92db23a4"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/activate-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/activate-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 card-status-termination-section" id="cardST">
|
||
<div>
|
||
<h4 class="mb-3">Card Status and Termination</h4>
|
||
<p>There are 3 statuses that a card can have:</p>
|
||
|
||
<div class="alert alert-success" role="alert">
|
||
<p><span><strong><i class="bi bi-check-circle-fill"></i>Active</strong></span></p>
|
||
<p>By default, cards are created in active status. This means that card transactions can be executed with
|
||
the card on POS, ATM, E-commerce, etc. </p>
|
||
<p><strong>Please be advised</strong>, active status is different than card activation. While activation is
|
||
a one-time process, card statuses can be changed between active/inactive at any time.</p>
|
||
</div>
|
||
|
||
<div class="alert alert-secondary" role="alert">
|
||
<p><span><strong><i class="bi bi-lock-fill"></i>Inactive</strong></span></p>
|
||
<p>Inactive status restricts all transactions with the card. The status is reversable to active.</p>
|
||
</div>
|
||
|
||
<div class="alert alert-danger" role="alert">
|
||
<p><span><strong><i class="bi bi-x-octagon-fill"></i>Closed</strong></span></p>
|
||
<p>Void status destroys the card. No transactions can be done.</p>
|
||
<p><strong>The status is not reversable!</strong></p>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}/status
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_status</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>active , inactive</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/status-request"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/status-request').innerHTML = prettyPrintJson.toHtml({"status":"string"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/status-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/status-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>DELETE </strong>
|
||
/v2/cards/{card}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_terminate</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/cards/{card}-response"></pre>
|
||
<script>document.getElementById('delete_/v2/cards/{card}-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<div id="cardST" class="d-1160 card-status-termination-section">
|
||
|
||
</div>
|
||
<section class="d-1160" id="cardConv">
|
||
<div>
|
||
<h4 class="mb-3">Card Renew</h4>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}/renew
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_renew</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mode</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/renew-request"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/renew-request').innerHTML = prettyPrintJson.toHtml({"mode":"integer"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/renew-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/renew-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="cardLF">
|
||
<div>
|
||
<h4 class="mb-3">Card Limits and Fees</h4>
|
||
<p>By default, limit and fee groups are set upon card creation depending on program configuration. Each limit/fee group can be changed or removed at any time.</p>
|
||
|
||
<p>The group codes will be provided by Paynetics and must be associated with the program, or the change will not be executed.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{card}/groups
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_groups</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data953028"
|
||
aria-expanded="false" aria-controls="data953028">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data953028">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>usage</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fees</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>schedule_fees</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>web_service_fees</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>limits</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>linkage</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{card}/groups-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{card}/groups-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"usage":"usage_group_1","fees":"fee_group_1","schedule_fees":"schedule_fee_group_1","web_service_fees":"web_services_fee_group_1","limits":"limits_group_1","linkage":"linkage_group_1","mcc":"mcc_black_group_1"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}/groups
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_groups</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>usage</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fees</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>schedule_fees</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>web_service_fees</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>limits</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>linkage</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mcc</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/groups-request"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/groups-request').innerHTML = prettyPrintJson.toHtml({"usage":"usage_group_1","fees":"fee_group_1","schedule_fees":"schedule_fee_group_1","web_service_fees":"web_services_fee_group_1","limits":"limits_group_1","linkage":"linkage_group_1","mcc":"mcc_black_group_1"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/groups-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/groups-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="cardListDetail" >
|
||
<div>
|
||
<h4 class="mb-3">List / detail</h4>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{page}/{limit}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>cards_list</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ page ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
<p class="text-uppercase">[ limit ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Filters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p>
|
||
merchant - (Token of merchant)
|
||
</p>
|
||
<p>
|
||
user - (Token of user)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1169257"
|
||
aria-expanded="false" aria-controls="data1169257">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1169257">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>items</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#items450340"
|
||
aria-expanded="false" aria-controls="items450340">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="items450340">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_digitalized</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_activated</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_otp_sms_enabled</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_bio_enabled</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>branch_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>delivery_details</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#delivery_details1756035"
|
||
aria-expanded="false" aria-controls="delivery_details1756035">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="delivery_details1756035">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_issued</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name_line4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>total_items</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{page}/{limit}-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{page}/{limit}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"items":[{"token":"string","type":"string","is_digitalized":"boolean","is_activated":"boolean","is_otp_sms_enabled":"boolean","is_bio_enabled":"boolean","external_identifier":"string","status":"string","branch_code":"string","delivery_details":{"country":"string","county":"string","city":"string","zip":"string","address1":"string","address2":"string","address3":"string","mobile_phone":"string","first_name":"string","last_name":"string"},"is_issued":"boolean","user":"string","merchant":"string","first_name":"string","last_name":"string","emboss_name":"string","emboss_name_line4":"string"}],"total_items":"1"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{card}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_details</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1280879"
|
||
aria-expanded="false" aria-controls="data1280879">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1280879">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_digitalized</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_activated</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_otp_sms_enabled</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_bio_enabled</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>branch_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>delivery_details</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#delivery_details583390"
|
||
aria-expanded="false" aria-controls="delivery_details583390">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="delivery_details583390">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_issued</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name_line4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{card}-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{card}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"string","type":"string","is_digitalized":"boolean","is_activated":"boolean","is_otp_sms_enabled":"boolean","is_bio_enabled":"boolean","external_identifier":"string","status":"string","branch_code":"string","delivery_details":{"country":"string","county":"string","city":"string","zip":"string","address1":"string","address2":"string","address3":"string","mobile_phone":"string","first_name":"string","last_name":"string"},"is_issued":"boolean","user":"string","merchant":"string","first_name":"string","last_name":"string","emboss_name":"string","emboss_name_line4":"string"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
<section class="d-1160" id="cardCVV" >
|
||
<div>
|
||
<h4 class="mb-3">Number & CVV</h4>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{card}/first-half
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_number</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data168014"
|
||
aria-expanded="false" aria-controls="data168014">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data168014">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pan</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>expiration_month</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>expiration_year</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{card}/first-half-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{card}/first-half-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"pan":"5355XXXXXXXX0316","expiration_month":"04","expiration_year":"26"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{card}/second-half
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_number</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data899982"
|
||
aria-expanded="false" aria-controls="data899982">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data899982">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pan</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>cvv</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{card}/second-half-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{card}/second-half-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"pan":"XXXX94203030XXXX","cvv":"671"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<section class="d-1160" id="cardPIN" >
|
||
<div>
|
||
<h4 class="mb-3">Card PIN Management</h4>
|
||
<p>Card PIN can be retrieved using API at any time.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{card}/pin
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_retrieve_pin</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1891478"
|
||
aria-expanded="false" aria-controls="data1891478">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1891478">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pin</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>PIN of the card</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{card}/pin-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{card}/pin-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"pin":"0123"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
|
||
|
||
<section class="d-1160">
|
||
<div>
|
||
<h4 class="mb-3">Card PIN</h4>
|
||
<p> It can be sent to the cardholder via SMS depending on the program configuration. The mobile phone
|
||
number added upon card creation will be used. In case the phone number must be changed please use the
|
||
cardholder details update API.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/cards/{card}/pin/send
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_send_pin</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/pin/send-response"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/pin/send-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
|
||
<section class="d-1160">
|
||
<div>
|
||
<h3 class="d-1160">Card PIN & CVV</h3>
|
||
<p> Error counter can be reset using API. This is needed in case the cardholder has entered an
|
||
incorrect PIN/CVV several times on POS, ATM or online.
|
||
</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>DELETE </strong>
|
||
/v2/cards/{card}/pin/reset
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_reset_pin</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/cards/{card}/pin/reset-response"></pre>
|
||
<script>document.getElementById('delete_/v2/cards/{card}/pin/reset-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
<section class="d-1160" id="card3ds">
|
||
<div>
|
||
<h4 class="mb-3">Card 3DS Enrollment</h4>
|
||
<p>Card can be enrolled for 3DS for both OTP SMS authentication and/or biometric authentication. For OTP SMS
|
||
authentication the mobile phone number of the account holder is required.</p>
|
||
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/cards/{card}/3ds
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_3ds_enrol</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>otp_sms</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>biometric</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/3ds-request"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/3ds-request').innerHTML = prettyPrintJson.toHtml({"otp_sms":"+3590000000","biometric":true}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/3ds-response"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/3ds-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
<section class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Enrolment mobile phone</h4>
|
||
<p> * number can be amended at a later stage.</p>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>PUT </strong>
|
||
/v2/cards/{card}/3ds
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_3ds_update</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>otp_sms</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/3ds-request"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/3ds-request').innerHTML = prettyPrintJson.toHtml({"otp_sms":"+3590000000"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="put_/v2/cards/{card}/3ds-response"></pre>
|
||
<script>document.getElementById('put_/v2/cards/{card}/3ds-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Enrolment for both types</h4>
|
||
<p> * can be disabled at any time but is not recommended.</p>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>DELETE </strong>
|
||
/v2/cards/{card}/3ds
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_3ds_remove</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/cards/{card}/3ds-request"></pre>
|
||
<script>document.getElementById('delete_/v2/cards/{card}/3ds-request').innerHTML = prettyPrintJson.toHtml({"type":"string"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/cards/{card}/3ds-response"></pre>
|
||
<script>document.getElementById('delete_/v2/cards/{card}/3ds-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Process biometric 3ds</h4>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/cards/{card}/3ds/process
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_3ds_process</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase"></p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>request</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>SUCCESS , FAILURE</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/3ds/process-request"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/3ds/process-request').innerHTML = prettyPrintJson.toHtml({"request":"3aa1caa4-7ddc-41e4-bac9-63efa99676d5","status":"SUCCESS"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/3ds/process-response"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/3ds/process-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
<section class="d-1160 fh fh70" id="cardP" >
|
||
<div class="flex-column align-items-start">
|
||
<h4 class="mb-3">Card Provisioning</h4>
|
||
<p>Apple/Google wallet push provisioning is supported depending on the program. Push provisioning is used for automatic In-App provisioning for both platforms.</p>
|
||
<p>API request will return an encrypted payload required for the card to be added to Apple/Google wallet using platform SDK/API.</p>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Process Apple Encryption</h4>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/cards/{card}/apple/encrypt
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>enc_card</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1604443"
|
||
aria-expanded="false" aria-controls="data1604443">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1604443">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>encryption_pass_data</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>activation_data</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>ephemeral_public_key</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/apple/encrypt-response"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/apple/encrypt-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"encryption_pass_data":"string","activation_data":"string","ephemeral_public_key":"string"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Process Google Encryption</h4>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/cards/{card}/google/encrypt
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>enc_card</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data987014"
|
||
aria-expanded="false" aria-controls="data987014">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data987014">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>opc</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#address292884"
|
||
aria-expanded="false" aria-controls="address292884">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="address292884">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>real_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/cards/{card}/google/encrypt-response"></pre>
|
||
<script>document.getElementById('post_/v2/cards/{card}/google/encrypt-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"opc":0,"address":{"card_type":"string","real_name":"string"}}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep">
|
||
<div>
|
||
<h4 class="mb-3">Card Tokens</h4>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/cards/{card}/tokens/{deviceId}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>card_tokens</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ card ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token from card creation</p>
|
||
<p class="text-uppercase">[ deviceId ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Device ID</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1894192"
|
||
aria-expanded="false" aria-controls="data1894192">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1894192">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_tokens</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/cards/{card}/tokens/{deviceId}-response"></pre>
|
||
<script>document.getElementById('get_/v2/cards/{card}/tokens/{deviceId}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"card_tokens":"string"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="transfers fh fh100" id="transfers">
|
||
|
||
<div class="main-content-area">
|
||
|
||
<div>
|
||
<h3 class="mb-3">Transfers</h3>
|
||
|
||
<p>To move funds between accounts within the system or to external banks customers must have an account/card
|
||
opened in advance. Transfers API may have different requirements depending on the type of transfer
|
||
(internal/wire). Amount, currency, debtor, and creditor are required for all requests. </p>
|
||
</div>
|
||
|
||
<div>
|
||
<p><strong>Debtor</strong> is the customer from which the funds will be deducted.</p>
|
||
<p><strong>Creditor</strong> is the customer/external account that will receive the funds.</p>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160">
|
||
<div class="d-1160">
|
||
<div>
|
||
<h4 class="mb-3">Internal Transfers</h4>
|
||
<p>Internal transfers can be initiated between accounts/cards in the system using several identifiers like balance identifier, IBAN, Sort Code and Account Number.</p>
|
||
<p>As a response from the API call, a transaction identifier will be received when transfer is successful. The transfer is a real-time operation, meaning that in case a transaction identifier is received the transfer has been completed.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="d-1160">
|
||
<div>
|
||
<h4 class="mb-3">Wire Transfers</h4>
|
||
<p>For wire transfer account must have IBAN or account number generated for a specific payment network. The
|
||
network is routed depending on the currency and/or program configurations.</p>
|
||
<p>For most wire transfers there are additional requirements for creditor name, address, and country (depending
|
||
on the network).</p>
|
||
<p>Debtor name, address, and country will also be required in case they are missing in the customer profile.</p>
|
||
<p>A response from the API call, a transaction identifier will be received when the transfer is successfully
|
||
initiated. Wire transfers are not processed in real-time the way internal transfers are. There might be a
|
||
delay between several seconds to several days depending on the payment network. When the transfer has been
|
||
processed a webhook (link to webhook) with the status of the transfer will be sent.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160">
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/transfers
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>transfer</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Amount to be deducted from customer account</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>EUR , BGN , GBP</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>link</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Link to another transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>origin_of_funds</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i></i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_instant</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Only for SEPA transfers (EUR)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>debtor</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Sender of the funds</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#debtor1301570"
|
||
aria-expanded="false" aria-controls="debtor1301570">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="debtor1301570">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance token of the customer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>GPS Public token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Valid IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(6,6)</span>
|
||
</p>
|
||
|
||
<p>Valid sort code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(8,8)</span>
|
||
</p>
|
||
|
||
<p>Valid account number</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>creditor</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Receiver of the funds</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#creditor1772795"
|
||
aria-expanded="false" aria-controls="creditor1772795">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="creditor1772795">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance token of the customer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>GPS Public token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Valid IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(6,6)</span>
|
||
</p>
|
||
|
||
<p>Valid sort code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(8,8)</span>
|
||
</p>
|
||
|
||
<p>Valid account number</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/transfers-request"></pre>
|
||
<script>document.getElementById('post_/v2/transfers-request').innerHTML = prettyPrintJson.toHtml({"amount":1.23,"currency":"EUR","code":"string","link":"520bec3b-8051-4a2b-928c-81d32b6bfa41","reference":"Payment for goods","reference2":"Items 1,2,3","reference3":"Additional Info","reference4":"Additional Info","origin_of_funds":"string","description":"Merchant 123","is_instant":false,"debtor":{"balance":"444f4f2c-6a05-43bb-93ab-7ab76ce5658c","external_identifier":"123456789","iban":"BG85PATC40021918158842","sort_code":"123456","account_number":"12345678","address":"BG, Sofia, James Bouchier 76 A","name":"John Doe","country":"BG"},"creditor":{"balance":"444f4f2c-6a05-43bb-93ab-7ab76ce5658c","external_identifier":"123456789","iban":"BG85PATC40021918158842","sort_code":"123456","account_number":"12345678","address":"BG, Sofia, James Bouchier 76 A","name":"John Doe","country":"BG"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data912155"
|
||
aria-expanded="false" aria-controls="data912155">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data912155">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>transaction</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Token of the transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/transfers-response"></pre>
|
||
<script>document.getElementById('post_/v2/transfers-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"transaction":"8b06d551-5453-48e5-842c-c1e2d969da84"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Errors</p>
|
||
|
||
<div class="code-card-content c-t">
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11000</p></th>
|
||
<td><p>services.general.error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>11001</p></th>
|
||
<td><p>services.general.validation_error</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16013</p></th>
|
||
<td><p>services.balances.balance_not_updated</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16014</p></th>
|
||
<td><p>services.balances.insufficient_funds</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16015</p></th>
|
||
<td><p>services.balances.debtor_balance_not_found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16016</p></th>
|
||
<td><p>services.balances.creditor_balance_not_found</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16017</p></th>
|
||
<td><p>services.balances.conversion_rate_not_available</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16018</p></th>
|
||
<td><p>services.balances.blocked_amount</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16019</p></th>
|
||
<td><p>services.balances.transfer_to_same_balance</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>16020</p></th>
|
||
<td><p>services.balances.transfer_to_same_main_account</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="w-100">
|
||
<tbody>
|
||
<tr>
|
||
<th><p>20001</p></th>
|
||
<td><p>services.balances.sepa_instant_not_supported_by_creditor_bank</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="" id="queue">
|
||
|
||
<h1>Queue</h1>
|
||
<p>
|
||
Based on instance level configuration the IWT will be placed in queue where external system can make decision what must have done with the transfer.
|
||
<br>
|
||
System will automatically return the transfer in case the account is not found, closed, or blocked.
|
||
<br>
|
||
Once the transfer has been added into the queue webhook will be sent to external system with token (identifier) of the queue record.
|
||
<br>
|
||
In case the webhook has not been received from the first time the system will try to resend it 3 more times.
|
||
<br>
|
||
Example of the webhook can be found <a href="#transactionSuspended">webhooks</a> section <b>TRANSACTION.SUSPENDED</b>
|
||
</p>
|
||
|
||
</section>
|
||
<section class="d-1160">
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/queue/{page}/{limit}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>queue_list</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ page ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Starting from page 1</p>
|
||
<p class="text-uppercase">[ limit ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Maximum per page 1000</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Filters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p>
|
||
merchant - (Identifier of merchant in Paynetics system)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1762030"
|
||
aria-expanded="false" aria-controls="data1762030">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1762030">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>items</strong>
|
||
<span class="att-type">array[object]</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#items740912"
|
||
aria-expanded="false" aria-controls="items740912">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="items740912">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_instant</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>wires</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#wires1396731"
|
||
aria-expanded="false" aria-controls="wires1396731">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="wires1396731">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>network</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>total_items</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/queue/{page}/{limit}-response"></pre>
|
||
<script>document.getElementById('get_/v2/queue/{page}/{limit}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"items":[{"amount":1.23,"currency":"EUR","token":"d39ed40b-078c-494f-86de-1a86d4ab5f26","reference":"Transfer","merchant":"d39ed40b-078c-494f-86de-1a86d4ab5f26","user":"d39ed40b-078c-494f-86de-1a86d4ab5f26","account":"d39ed40b-078c-494f-86de-1a86d4ab5f26","balance":"d39ed40b-078c-494f-86de-1a86d4ab5f26","is_instant":false,"wires":{"sender_name":"Company 123","sender_iban":"AT483200000012345864","sender_bank_name":"Bank 123","sender_bank_country":"AT","sender_bank_code":"RLNWATWWXXX","sender_sort_code":"123456","sender_account_number":"1234578","receiver_iban":"BG75PATC40022171680259","receiver_name":"John Doe","receiver_bank_name":"Paynetics AD","receiver_bank_country":"BG","receiver_bank_code":"PATCBGSFXXX","receiver_sort_code":"123456","receiver_account_number":"1234578","network":"string"}}],"total_items":"integer"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160">
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>GET </strong>
|
||
/v2/queue/{token}
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>queue_details</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ token ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token of the queue entry</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1404971"
|
||
aria-expanded="false" aria-controls="data1404971">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1404971">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_instant</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>wires</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#wires577606"
|
||
aria-expanded="false" aria-controls="wires577606">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="wires577606">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sender_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_bank_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>receiver_account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>network</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="get_/v2/queue/{token}-response"></pre>
|
||
<script>document.getElementById('get_/v2/queue/{token}-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"amount":1.23,"currency":"EUR","token":"d39ed40b-078c-494f-86de-1a86d4ab5f26","reference":"Transfer","merchant":"d39ed40b-078c-494f-86de-1a86d4ab5f26","user":"d39ed40b-078c-494f-86de-1a86d4ab5f26","account":"d39ed40b-078c-494f-86de-1a86d4ab5f26","balance":"d39ed40b-078c-494f-86de-1a86d4ab5f26","is_instant":false,"wires":{"sender_name":"Company 123","sender_iban":"AT483200000012345864","sender_bank_name":"Bank 123","sender_bank_country":"AT","sender_bank_code":"RLNWATWWXXX","sender_sort_code":"123456","sender_account_number":"1234578","receiver_iban":"BG75PATC40022171680259","receiver_name":"John Doe","receiver_bank_name":"Paynetics AD","receiver_bank_country":"BG","receiver_bank_code":"PATCBGSFXXX","receiver_sort_code":"123456","receiver_account_number":"1234578","network":"string"}}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160">
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/queue/{token}/process
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>queue_process</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ token ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token of the queue entry</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/queue/{token}/process-response"></pre>
|
||
<script>document.getElementById('post_/v2/queue/{token}/process-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="d-1160">
|
||
<div>
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>DELETE </strong>
|
||
/v2/queue/{token}/return
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>queue_return</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Parameters</p>
|
||
|
||
<div class="code-card-content">
|
||
<p class="text-uppercase">[ token ]</p>
|
||
|
||
<p class="text-uppercase"></p>
|
||
|
||
<p class="text-camelcase">Token of the queue entry</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>return_reason</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>incorrect-account-number , closed-account-number , blocked-account , beneficiary-deceased , account-cannot-be-identified , beneficiary-account-name-does-not-match-beneficiary-account-number , return-requested-by-sender-of-original-payment , account-is-not-in-currency-quoted , beneficiary-not-expecting-funds-or-instructed-return , terms-and-conditions-of-account-do-not-permit-crediting-of-funds , sending-fps-institution-action-required , account-transferred , payment-cannot-be-applied-because-of-beneficiary-sensitivities , other , transaction-forbidden , invalid-bank-operation-code , duplication , missing-creditor-address , creditor-bank-is-not-registered , eri-option-not-supported , end-customer-deceased , not-specified-reason-customer-generated , not-specified-reason-agent-generated , bank-identifier-incorrect , missing-debtor-account-or-identification , missing-debtor-name-or-address , missing-creditor-name-or-address , regulatory-reason , following-cancellation-request</i>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/queue/{token}/return-request"></pre>
|
||
<script>document.getElementById('delete_/v2/queue/{token}/return-request').innerHTML = prettyPrintJson.toHtml({"return_reason":"beneficiary-account-closed"}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="delete_/v2/queue/{token}/return-response"></pre>
|
||
<script>document.getElementById('delete_/v2/queue/{token}/return-response').innerHTML = prettyPrintJson.toHtml({"code":0}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="d-1160 ep" id="batch">
|
||
|
||
<div>
|
||
|
||
<h3 class="mb-3">Batch</h3>
|
||
|
||
<div class="swagger">
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Endpoint</p>
|
||
<p class="code-card-content">
|
||
<strong>POST </strong>
|
||
/v2/batch
|
||
</p>
|
||
</div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title">Operation</p>
|
||
<p class="code-card-content">
|
||
<strong>batch_create</strong>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="main-content-area mt-0">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Request
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user_create</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#user_create303636"
|
||
aria-expanded="false" aria-controls="user_create303636">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="user_create303636">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>email</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>first_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>last_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>dob</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_create</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#account_create348773"
|
||
aria-expanded="false" aria-controls="account_create348773">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="account_create348773">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_create</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#card_create1939860"
|
||
aria-expanded="false" aria-controls="card_create1939860">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="card_create1939860">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>instance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>program</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>emboss_name_line4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>delivery_details</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#delivery_details1985050"
|
||
aria-expanded="false" aria-controls="delivery_details1985050">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="delivery_details1985050">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>city</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>zip</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>county</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>method</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mobile_phone</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>pin</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fulfil1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>fulfil2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>thermal_line1</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>thermal_line2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_activate</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#card_activate782999"
|
||
aria-expanded="false" aria-controls="card_activate782999">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="card_activate782999">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_status</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#card_status1925460"
|
||
aria-expanded="false" aria-controls="card_status1925460">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="card_status1925460">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>status</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_renew</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#card_renew1719111"
|
||
aria-expanded="false" aria-controls="card_renew1719111">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="card_renew1719111">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>mode</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_group_update</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#card_group_update496161"
|
||
aria-expanded="false" aria-controls="card_group_update496161">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="card_group_update496161">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>group</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>group_type</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card_assign</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#card_assign528023"
|
||
aria-expanded="false" aria-controls="card_assign528023">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="card_assign528023">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>card</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>merchant</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>user</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>branch_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>transfer</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#transfer1353520"
|
||
aria-expanded="false" aria-controls="transfer1353520">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="transfer1353520">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>amount</strong>
|
||
<span class="att-type">number</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Amount to be deducted from customer account</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>currency</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i>EUR , BGN , GBP</i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>instance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>link</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Link to another transaction</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference2</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference3</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>reference4</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>origin_of_funds</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
<strong>Available Options: </strong> <i></i>
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>description</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>is_instant</strong>
|
||
<span class="att-type">boolean</span>
|
||
</p>
|
||
|
||
<p>Only for SEPA transfers (EUR)</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>debtor</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Sender of the funds</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#debtor1988133"
|
||
aria-expanded="false" aria-controls="debtor1988133">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="debtor1988133">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance token of the customer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>GPS Public token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Valid IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(6,6)</span>
|
||
</p>
|
||
|
||
<p>Valid sort code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(8,8)</span>
|
||
</p>
|
||
|
||
<p>Valid account number</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>creditor</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p>Receiver of the funds</p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#creditor1184197"
|
||
aria-expanded="false" aria-controls="creditor1184197">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="creditor1184197">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>balance</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Balance token of the customer</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>external_identifier</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>GPS Public token</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>iban</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Valid IBAN</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>sort_code</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(6,6)</span>
|
||
</p>
|
||
|
||
<p>Valid sort code</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>account_number</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(8,8)</span>
|
||
</p>
|
||
|
||
<p>Valid account number</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>address</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Address of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>name</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Name of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>country</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Country of legal entity or natural person. Required of absent in customer profile on registration!</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Request</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/batch-request"></pre>
|
||
<script>document.getElementById('post_/v2/batch-request').innerHTML = prettyPrintJson.toHtml([{"user_create":{"email":"string","first_name":"string","last_name":"string","dob":"string","phone":"string"},"account_create":{"program":"string","merchant":"string","user":"string"},"card_create":{"instance":"string","account":"string","program":"string","merchant":"string","user":"string","emboss_name":"string","emboss_name_line4":"string","delivery_details":{"city":"string","country":"string","zip":"string","county":"string","code":"string","method":"string","address1":"string","address2":"string","address3":"string","mobile_phone":"string"},"pin":"string","fulfil1":"string","fulfil2":"string","thermal_line1":"string","thermal_line2":"string","type":"string"},"card_activate":{"card":"string"},"card_status":{"card":"string","status":"string"},"card_renew":{"card":"string","mode":"string"},"card_group_update":{"card":"string","group":"string","group_type":"string"},"card_assign":{"card":"string","merchant":"string","user":"string","branch_code":"string"},"transfer":{"amount":1.23,"currency":"EUR","instance":"string","code":"string","link":"520bec3b-8051-4a2b-928c-81d32b6bfa41","reference":"Payment for goods","reference2":"Items 1,2,3","reference3":"Additional Info","reference4":"Additional Info","origin_of_funds":"string","description":"Merchant 123","is_instant":false,"debtor":{"balance":"444f4f2c-6a05-43bb-93ab-7ab76ce5658c","external_identifier":"123456789","iban":"BG85PATC40021918158842","sort_code":"123456","account_number":"12345678","address":"BG, Sofia, James Bouchier 76 A","name":"John Doe","country":"BG"},"creditor":{"balance":"444f4f2c-6a05-43bb-93ab-7ab76ce5658c","external_identifier":"123456789","iban":"BG85PATC40021918158842","sort_code":"123456","account_number":"12345678","address":"BG, Sofia, James Bouchier 76 A","name":"John Doe","country":"BG"}}}], {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area mt-5">
|
||
<div>
|
||
|
||
<div class="mt-4">
|
||
|
||
<h3>
|
||
Response
|
||
Structure
|
||
</h3>
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>code</strong>
|
||
<span class="att-type">integer</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>data</strong>
|
||
<span class="att-type">object</span>
|
||
</p>
|
||
|
||
<p></p>
|
||
|
||
|
||
|
||
<button class="btn btn-paynetics" type="button" data-bs-toggle="collapse"
|
||
data-bs-target="#data1898768"
|
||
aria-expanded="false" aria-controls="data1898768">
|
||
<i class="bi bi-braces-asterisk"></i> Show
|
||
</button>
|
||
<div class="collapse mt-3" style="margin-left: 14px" id="data1898768">
|
||
<div class="card">
|
||
<div class="card-body">
|
||
|
||
<div class="mt-4">
|
||
|
||
|
||
<div class="main-attributes">
|
||
<p>
|
||
<strong>token</strong>
|
||
<span class="att-type">string</span>
|
||
<span class="att-type">(0,any)</span>
|
||
</p>
|
||
|
||
<p>Token from operation</p>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="code-card">
|
||
<p class="code-card-title">Response</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="post_/v2/batch-response"></pre>
|
||
<script>document.getElementById('post_/v2/batch-response').innerHTML = prettyPrintJson.toHtml({"code":0,"data":{"token":"0ba5e81d-c43b-4008-b2d6-0d390f6f8c08"}}, {quoteKeys: true})</script>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
|
||
<section class="webhooks " id="webHooks">
|
||
|
||
<div class="m-0">
|
||
<h3 class="mb-3">Web hooks</h3>
|
||
|
||
|
||
<div class="main-content-area" id="merchantC">
|
||
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Merchant created</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="mCreated"></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<div class="main-content-area" id="merchantRisk">
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Merchant risk score</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="mRScore"></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area" id="accountIban">
|
||
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Account iban</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="aIban"></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="main-content-area" id="transactionNew">
|
||
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Transaction new</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="tNew"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="main-content-area" id="transactionUp">
|
||
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Transaction update</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="tUpdate"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="main-content-area" id="balanceUp">
|
||
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Balance update</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="bUpdate"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="main-content-area" id="transactionSuspended">
|
||
|
||
<div></div>
|
||
|
||
<div class="code-card">
|
||
<p class="code-card-title ">Transaction Suspended</p>
|
||
|
||
<div class="code-card-content">
|
||
<pre id="transactionSuspendedJson"></pre>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="ep" id="postman">
|
||
<div class="d-1160">
|
||
<div>
|
||
<h3 class="mb-3">Postman Collection</h3>
|
||
|
||
<p>
|
||
To understand better how our API works and speed up your integration process, you can download our Postman collection.
|
||
|
||
In order to use it, the following will be provided to you by your account/project manager: <br>
|
||
<br>
|
||
1.API Key + Secret. <br>
|
||
2.Requirements for onboarding of legal entities or natural persons. <br>
|
||
3.Program code needed for account/card creation. <br>
|
||
4.Others - depending on your business case. <br>
|
||
</p>
|
||
|
||
<h4 class="mb-5 mt-5">Instructions</h4>
|
||
|
||
<h5>1. Download Postman</h5>
|
||
|
||
<p>
|
||
You can download and install Postman on all operating systems from <a
|
||
href="https://www.postman.com/downloads/" target="_blank">https://www.postman.com/downloads/</a>
|
||
</p>
|
||
|
||
<h5 class="mt-5">2. Download Paynetics API Postman Collection</h5>
|
||
|
||
<p>
|
||
Click <a href="/download/postman">here</a>
|
||
</p>
|
||
|
||
<h5 class="mt-5">3. Import Postman Collection</h5>
|
||
|
||
<p>
|
||
First things first. You need to import the collection into your Postman App.
|
||
<br>
|
||
In top left corner there is import button which will open modal where you can add the file downloaded in
|
||
step 2.
|
||
<br>
|
||
<br>
|
||
<img src="/images/postman/Import.png" alt="import" width="90%">
|
||
<br>
|
||
<br>
|
||
<img src="/images/postman/select.png" alt="import" width="90%">
|
||
</p>
|
||
|
||
<h5 class="mt-5">3. Configuration</h5>
|
||
|
||
<p>
|
||
After successfully importing the collection you need to make simple configuration. <br>
|
||
Click on the collection variable section where you will find API_KEY and API_SECRET variables. <br>
|
||
Please enter the credentials provided to you by your account/project manager. <BR>
|
||
<small style="font-size: 10px; color: indianred">BE AWARE THAT BOTH INITIAL AND CURRENT VALUE FIELDS
|
||
MUST BE FILED</small>
|
||
|
||
<br>
|
||
<br>
|
||
<img src="/images/postman/configuration.png" alt="import" width="90%">
|
||
</p>
|
||
|
||
<h5 class="mt-5">3. Usage and Guidelines</h5>
|
||
|
||
<p>
|
||
You can now start using the collection and explore the API. <br>
|
||
Just few additional tips and todos. <br>
|
||
Each body of each request is located in Pre Request section. <br>
|
||
The pre request script execute a function which will calculate the authentication value and add need
|
||
headers for authentication. <br>
|
||
The operation and body of the request (if any) are passed as arguments to the function which
|
||
authenticates the request. <br>
|
||
You can use this function for additional request in order to authenticate. <br>
|
||
|
||
<br>
|
||
<img src="/images/postman/body.png" alt="import" width="90%">
|
||
|
||
<br>
|
||
<br>
|
||
|
||
There will some parts of the json body which must be added by you. <br>
|
||
You will find the as {{ todo sections }} with explanation what must be done.
|
||
<br>
|
||
<br>
|
||
<img src="/images/postman/todo.png" alt="import" width="90%">
|
||
|
||
</p>
|
||
|
||
|
||
<ul>
|
||
<li>For legal entities onboarding after successful request
|
||
tokens of the application and company members will added as variables for subsequent requests.
|
||
</li>
|
||
<li>
|
||
For natural persons onboarding after successful request
|
||
user token will be added as variable which can be used for sub requests.
|
||
</li>
|
||
<li>
|
||
For account creation you can add program as variable in collection or replace it on each request.
|
||
After successful account creation account token will be added as variable and can be used for sub requests.
|
||
</li>
|
||
<li>
|
||
For non personalized card creation you can add program as variable in collection or replace it on each request.
|
||
After successful card creation account card will be added as variable and can be used for sub requests.
|
||
</li>
|
||
<li>
|
||
For transfers you will need either debtor/creditor identifiers of the balances or for external transfers valid creditor IBAN/AccountNumber and Sort Code.
|
||
</li>
|
||
<li>
|
||
For all API which return list of entities like transactions list, accounts list etc, you can find all available filters in Params section of the request.
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<script src="/js/theme-1.js"></script>
|
||
<script src="/js/onlineStatus-1.js"></script>
|
||
<script defer src="/js/script-1.js"></script>
|
||
<script defer src="/js/toastEnable-1.js"></script>
|
||
<script defer src="/js/enableTooltips-1.js"></script>
|
||
<script defer src="/js/prettyJson-1.js"></script>
|
||
<script defer src="/js/scrollTop-1.js"></script>
|
||
<script defer src="/js/copyToClipboard-1.js"></script>
|
||
</main>
|
||
|
||
<div class="toast-container position-fixed top-0 end-0 p-3">
|
||
<div id="liveToast" class="toast" role="alert" aria-live="assertive" aria-atomic="true" data-bs-delay="3000">
|
||
<div class="toast-header">
|
||
<i class="bi bi-circle"></i>
|
||
<strong class="me-auto" style="margin-left: 10px;">Paynetics</strong>
|
||
<small>Just now</small>
|
||
</div>
|
||
<div class="toast-body">
|
||
Copied !
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<button onclick="topScrollButton()" class="top-button" id="topButton" title="Scroll to top">Top</button>
|
||
</body>
|
||
</html>
|