Skip to content

Instantly share code, notes, and snippets.

@NdagiStanley
Last active April 2, 2024 18:31
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save NdagiStanley/a26876d6fd75e41c5edc2a04cb500dde to your computer and use it in GitHub Desktop.
Save NdagiStanley/a26876d6fd75e41c5edc2a04cb500dde to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
{
"swagger" : "2.0",
"info" : {
"description" : "<p>The Paymentology web services allow clients to perform all of the normal card and account activities such as :</p> \n\t\t\t<ul>\n <li>account creation</li>\n <li> card creation (Physical, virtual card)</li>\n <li>Load amount/balance</li>\n <li>Set/get card account status</li>\n <li>pin services</li>\n <li>groups/rules/action creations etc</li>\n\t\t\t</ul>\n\n<h2>OverView</h2>\n<p>The Paymentology API interface allows users to perform end-to-end management of their card programs, including but not limited to the following:</p>\n <ul>\n <li class=\\docBullet\\>Create cards - Virtual or Physical in singles or in bulk, including customisable delivery to client or end consumer</li>\n <li class=\\docBullet\\>Create accounts- An account hierarchy allows operation of card wallets (fx, expense or other wallets)</li>\n <li class=\\docBullet\\>Load/Transfer funds- Load/unload amounts onto cards or transfer between cards.</li>\n <li class=\\docBullet\\>pin services- pin resets, pin status, pin change, pin set and so on.</li> \n <li class=\\docBullet\\>rules Engine- create and edit advanced rules which can apply at card level or across entire products.</li>\n <li class=\\docBullet\\>Actions engine- user triggered rules to drive a variety of actions: Sms, email, web service call, apply fees, block cards etc.</li>\n </ul>\n<h2>Account Structure</h2>\n <p><br />The platform is currently running Version 2.0 of out API, known as API 2.0. Version 3.0 is being developed and will be released for beta testing in due course.<br />To browse through the current API, please select API 2.0 from the tree structure on the left and expand into the various API sections. Please note that each API is usable, which means you can use the &lsquo;Try me&rsquo; button directly on the page to submit a web service call and get a response.</p>\n\n\n<p>The following section provides a simple summary of the account and card structure and mechanism within the&nbsp;<strong>Banking.Live&nbsp;</strong>platform.</p> \n <p><strong>Definitions&nbsp;</strong></p> \n <p><strong>ACCOUNT :&nbsp;</strong>is the record of transactions over a financial period and the resulting balance.&nbsp;</p> \n <p><strong>PARENT ACCOUNT :&nbsp;</strong>is an account, that can have one or more accounts below it. It allows users to set up a hierarchical relationship.&nbsp;</p> \n <p><strong>CARD :&nbsp;</strong>is the financial instrument enabling to access the funds or automated teller machine and make payments. The card could be physical or virtual and is usually associated with an account.&nbsp;</p> \n <p><strong>Features&nbsp;</strong></p> \n <p>The&nbsp;<strong>Banking.Live&nbsp;&nbsp;</strong>main features are :</p> \n <ul> \n <li>account Cards Creation</li> \n <li>account Hierarchy&nbsp;</li> \n </ul> \n <p><strong>account card Creation</strong></p> \n <p>account and Cards are generated through webservices calls to the platform. As can be seen in the table, two different approaches are available.</p> \n <table> \n <thead> \n <tr> \n <th>\\Create account\\ then \\Create card\\. (two steps)</th> \n <th>\\Create card\\ automatically \\Create account\\</th> \n </tr> \n </thead> \n <thead></thead> \n <tbody> \n <tr> \n <td> \n <p>In this approach, the <em>account</em> is created first through the pws_create_account.</p> \n <p>The webservice request (JSON), includes&nbsp;<strong>\\ac_parent_id\\</strong>&nbsp;field populated by the ID of the already existing parent account. On the webservice response (JSON), it could be possible to find the&nbsp;<strong>\\ac_id\\</strong>, of the new account.</p> \n <p>The <em>card</em> is created through the pws_create_card .</p> \n <p>The webservice request (JSON), will include only the<strong>\\ac_id\\</strong>of the previously created <em>account</em>.</p> \n <p>In the response (JSON), the<strong>\\ac_id\\ </strong>match.</p> \n </td> \n <td> \n <p>In this approach, the <em>card</em> is created through the pws_create_card.</p> \n <p>The webservice request (JSON), includes the <strong>\\ac_parent_id\\ </strong>field populated by the ID of the existing parent account.</p> \n <p><em>Then</em></p> \n <p>An <em>account</em> is created automatically, becoming a sub-account of the existing parent.</p> \n <p>The webservice response (JSON), includes the new created account ID, <strong>\\ac_id\\</strong>.</p> \n </td> \n </tr> \n </tbody> \n </table> \n <p><strong>account Hierarchy</strong></p> \n <p>The platform offers a flexible structure, giving to the users ability to create personalized levels of hierarchical relationship.</p> \n <ul> \n <li><u><em>card account Mapping</em></u>: we can have multiple account assigned to card. . However, an account does not need to have a card associated with it.<br /><br /></li> \n <li><u><em>Parent Accounts</em></u>: an account can have a parent account, this allows for managing a group of accounts and cards under a specific master \\parent account\\(i.e. account generation for a corporate group).<br /><br /></li> \n <li><u><em>Multi-level structure</em></u>: multiple tiers of accounts and parent accounts can be created for different purposes.</li> \n </ul>\n\n<h2>Security and Authentication</h2>\n<h4 id=\\SecurityandAuthentication-HTTPSsecureconnections\\><strong>HTTPS&nbsp; secure connections</strong></h4>\n <p>Banking.Live API is protected and authenticated by SSL PKI (<a class=\\external-link\\ href=\\https://en.wikipedia.org/wiki/Public_key_certificate\\ >https://en.wikipedia.org/wiki/Public_key_certificate</a>&nbsp;) where Banking.Live verifies API calls against client certificates.</p>\n <p><span class=\\confluence-embedded-file-wrapper confluence-embedded-manual-size\\><img src=\"http://help.fortinet.com/fweb/554/Content/FortiWeb/fortiweb-admin/Images/pkiAuthentication_clientCertificateVerification1.png\" alt=\"Image result for api pki ssl p12\" width=\"397\" height=\"231\" data-image-src=\"http://help.fortinet.com/fweb/554/Content/FortiWeb/fortiweb-admin/Images/pkiAuthentication_clientCertificateVerification1.png\" /></span></p>\n\n\n\n<h2>Required Fields</h2>\n<p>For every web services request, there are two main fields, \\api_unique_identifier\\ and \\client_id\\. The API specification illustrates the requirements of the fields as follows:</p>\n <table \n <thead>\n <tr >\n <th>Field</th>\n <th> Description</th>\n </tr>\n </thead>\n <tbody >\n <tr>\n <td ><strong>api_unique_identifier</strong></td>\n <td >This is a unique random number that must be passed during a web service request. For each request, it must be different. The api will check if this field is already present in database, if so then return back error as&nbsp;<strong><em>api_unique_identifier is already used.</em></strong></td>\n </tr>\n <tr >\n <td ><strong>client_id</strong></td>\n <td >The unique identifier for the client, which Paymentology provides at the project initiation. During client creation a client processing key is emailed to the client. This key is used for different encryption processes and security purposes throughout Paymentology actions.</td>\n </tr>\n </tbody>\n </table>\n\n<h2>Error handling/Codes</h2>\n \n<p>In this section the <strong>Banking.live</strong><strong>&nbsp;</strong>web services request&nbsp;<strong>ERROR IDs</strong>&nbsp;are described. Starting from the successful \\error_id\\: 0, the full list of request failures is given as follows:</p>\n <p>API's ERROR Codes</p>\n <table>\n <thead>\n <tr >\n <th >Error Code</th>\n <th >Error Description\n </th>\n </tr>\n </thead>\n <tbody >\n <tr>\n <th >0</th>\n <td >Success</td>\n </tr>\n <tr >\n <th >900</th>\n <td >Internal Server Error. Contact Paymentology Support</td>\n </tr>\n <tr >\n <th >987</th>\n <td >Failure connecting database. Try again or contact Paymentology</td>\n </tr>\n <tr >\n <th >988</th>\n <td >Timeout executing database query. Try again or contact Paymentology</td>\n </tr>\n <tr >\n <th >989</th>\n <td >Failure executing database query. Try again or contact Paymentology&nbsp;</td>\n </tr>\n <tr >\n <th >990</th>\n <td >The client_id is invalid</td>\n </tr>\n <tr >\n <th >990</th>\n <td >The sub_client_id is invalid</td>\n </tr>\n <tr >\n <th >991</th>\n <td >The parent account number is invalid</td>\n </tr>\n <tr >\n <th >992</th>\n <td >The account id is invalid</td>\n </tr>\n <tr >\n <th >993</th>\n <td >api_call_unique_identifier already been used</td>\n </tr>\n <tr >\n <th >994</th>\n <td >The token is invalid</td>\n </tr>\n <tr >\n <th >995</th>\n <td >Validation failed ! on input request.</td>\n </tr>\n <tr >\n <th >996</th>\n <td >Permission denied ! The client does not have access to this web service. Contact Paymentology</td>\n </tr>\n <tr >\n <th >997</th>\n <td >No data found</td>\n </tr>\n <tr >\n <th >998</th>\n <td >The currency code is not valid</td>\n </tr>\n <tr >\n <th >998</th>\n <td >Currency failure. The amt_ccy is invalid</td>\n </tr>\n <tr >\n <th >998</th>\n <td >Currency failure. The load_ccy is invalid</td>\n </tr>\n <tr >\n <th >999</th>\n <td >The client_id is not authorized to perform action with the token provided!</td>\n </tr>\n <tr >\n <th >1000</th>\n <td >The client_id is not authorized to perform action with the account id provided</td>\n </tr>\n <tr >\n <th >1001</th>\n <td >The client_id is not authorized to perform action with the product id provided</td>\n </tr>\n <tr >\n <th >1012</th>\n <td >The manufacturer id is not available in repository</td>\n </tr>\n <tr >\n <th >1013</th>\n <td >The manufacturer id is not associated with the client id</td>\n </tr>\n <tr >\n <th >1014</th>\n <td >The product id is invalid</td>\n </tr>\n <tr >\n <th >1015</th>\n <td >card renewal failed. Check status_network. Set the card to lost,expired or stolen or damaged.</td>\n </tr>\n <tr >\n <th >1016</th>\n <td >card stack is not empty</td>\n </tr>\n <tr >\n <th >1017</th>\n <td >card image template is not configured. Contact Paymentology</td>\n </tr>\n <tr >\n <th >1018</th>\n <td >account Already assigned to card. Please create new account for create card</td>\n </tr>\n <tr >\n <th >1019</th>\n <td >The card has been deactivated already</td>\n </tr>\n <tr >\n <th >1020</th>\n <td >Please Provide valid Parent account or \\account id\\</td>\n </tr>\n <tr >\n <th >1021</th>\n <td >The card has already been sent for renewal</td>\n </tr>\n <tr >\n <th >1022</th>\n <td >Inserting purchaser details failed during physical card creation</td>\n </tr>\n <tr >\n <th >1025</th>\n <td >The card is physical. Use virtual card for card conversion</td>\n </tr>\n <tr >\n <th >1026</th>\n <td >Error generating card files. No cards found associated with batch_id</td>\n </tr>\n <tr >\n <th >1027</th>\n <td >Failed to unload balance. The balance is insufficient</td>\n </tr>\n <tr >\n <th >1031</th>\n <td >No pin set for this token (pvv not generated). set pin via pws_set_pin</td>\n </tr>\n <tr >\n <th >1032</th>\n <td >Ecno Failure from database. Try again or please contact the Paymentology</td>\n </tr>\n <tr >\n <th >1033</th>\n <td >Failed to create virtual card. Try again or contact the Paymentology</td>\n </tr>\n <tr >\n <th >1034</th>\n <td >Failed to create&nbsp;physical card. Try again or contact the Paymentology</td>\n </tr>\n <tr >\n <th >1035</th>\n <td >Failed to create card image. Try again or contact the Paymentology</td>\n </tr>\n <tr >\n <th >1036</th>\n <td >Failed to encrypt card file</td>\n </tr>\n <tr >\n <th >1037</th>\n <td >Failed to edit the card status</td>\n </tr>\n <tr >\n <th >1038</th>\n <td >Failed to upload into Sftp folder</td>\n </tr>\n <tr >\n <th >1039</th>\n <td >The card and account is already linked</td>\n </tr>\n <tr >\n <th >1040</th>\n <td >The card and account is not linked</td>\n </tr>\n <tr >\n <th >1041</th>\n <td >The currency code is invalid for above account</td>\n </tr>\n <tr >\n <th >1042</th>\n <td >The default currency is already active</td>\n </tr>\n <tr >\n <th >1043</th>\n <td >The account new donot belong to client id</td>\n </tr>\n <tr >\n <th >1044</th>\n <td >card is still awaiting to send to manufacturer. Cannot change status</td>\n </tr>\n <tr >\n <th >1080</th>\n <td >rules Id not found</td>\n </tr>\n <tr >\n <th >1081</th>\n <td >Failed to add action please contact the Paymentology support</td>\n </tr>\n <tr >\n <th >1082</th>\n <td >Failed to delete action please contact the Paymentology support</td>\n </tr>\n <tr >\n <th >1083</th>\n <td >Invalid action Id</td>\n </tr>\n <tr >\n <th >1084</th>\n <td >Failed to update action please contact the Paymentology support</td>\n </tr>\n <tr >\n <th >1085</th>\n <td >Failed to add rules. Contact Paymentology</td>\n </tr>\n <tr >\n <th >1086</th>\n <td >Failed to Update rules. Contact Paymentology</td>\n </tr>\n <tr >\n <th >1087</th>\n <td >Failed to Delete rules. Contact Paymentology</td>\n </tr>\n <tr >\n <th >1088</th>\n <td >Failed to get the Auth Unblock</td>\n </tr>\n <tr >\n <th >1089</th>\n <td >The card is a void card. No actions allowed ! | The card is a Blocked card. No actions allowed ! | The card has been blocked due to pin verification failed for successive 4 times</td>\n </tr>\n <tr >\n <th >1200</th>\n <td >Invalid Request</td>\n </tr>\n <tr >\n <th >1201</th>\n <td >card Already Enrolled</td>\n </tr>\n <tr >\n <th >1202</th>\n <td >No such card Range</td>\n </tr>\n <tr >\n <th >1203</th>\n <td >Got Internal Error From Touch Touch</td>\n </tr>\n <tr >\n <th >1301</th>\n <td >Weak pin</td>\n </tr>\n <tr >\n <th >1302</th>\n <td >Failed to Decrypt pin</td>\n </tr>\n <tr >\n <th >1302</th>\n <td >Failed to Set pin</td>\n </tr>\n <tr >\n <th >1303</th>\n <td >Failed to Encrypt with Provided Key</td>\n </tr>\n <tr >\n <th >1304</th>\n <td >Failed to Get Pan Number</td>\n </tr>\n <tr >\n <th >1305</th>\n <td >Failed to Get pin</td>\n </tr>\n <tr >\n <th >1306</th>\n <td >cvv2 doesnot matched</td>\n </tr>\n <tr >\n <th >1307</th>\n <td >Failed to decrypt cvv2</td>\n </tr>\n <tr >\n <th >1308</th>\n <td >Failed to Get cvv2</td>\n </tr>\n <tr >\n <th >1309</th>\n <td >RSA Key Not Found for client</td>\n </tr>\n <tr >\n <th >1310</th>\n <td >Session key already used</td>\n </tr>\n </tbody>\n </table>\n\n<h2>Curl Request Sample</h2>\n<p>The description below allows to make Banking.Live web service requests using CURL method.</p> \n <p><strong>Here are the steps through which web service request is achieved using the curl method:</strong></p> \n <p>For web service requests we need to get the client ssl certificate which will be provided by the Banking.Live technical team. The certificates will be in format i.e.&nbsp; &nbsp; *****.crt , *****.p12 , ******.key.</p> \n <p>In some cases the curl command may expect&nbsp;<strong>.pem</strong>&nbsp;format for ssl verification.&nbsp;<br />So you need to export the certificate as .pem format using OpenSSL as below</p> \n <pre>OpenSSL&gt; pkcs12 -in D:\\\\*****.p12 -out D:\\\\****.pem \n Enter Import Password: \n Enter PEM pass phrase: \n Verifying - Enter PEM pass phrase: \n OpenSSL&gt; \n </pre> \n <p>Now the command for request is as below with samples.</p> \n <p>curl -vk --cert ./***<strong>.pem:passphrase</strong>&nbsp;-X POST -H \\\"Content-Type:application/json\\\"&nbsp;<strong>base_url</strong><a class=\\\"external-link\\\" href=\\\"https://uat.banking.live:45443/api/pws/pws_ping_api\\\" >/api/pws/pws_ping_api</a>&nbsp;-d ' { \\\"api_call_unique_identifier\\\":\\\"1212009001\\\" , \\\"client_id\\\" : \\\"123456\\\" }'</p> \n <p>curl -vk --cert ./***<strong>.pem:passphrase</strong>&nbsp;-X POST -H \\\"Content-Type:application/json\\\"&nbsp;<a class=\\\"external-link\\\" href=\\\"https://uat.banking.live:45443/api/pws/pws_ping_api\\\" ><strong>base_url</strong>/api/pws/pws_ping_api</a>&nbsp;-d ' { \\\"api_call_unique_identifier\\\":1212009001, \\\"client_id\\\" : 123456 }'</p> \n <p>$ curl -vk --cert ./****<strong>.pem:passphrase</strong>&nbsp;-X POST -H \\\"Content-Type:application/json\\\"&nbsp;&nbsp;<strong>base_url</strong><a class=\\\"external-link\\\" href=\\\"https://uat.banking.live:45443/api/pws/pws_ping_api\\\" rel=\\\"nofollow\\\">/api/pws/pws_ping_api</a>&nbsp;-d @D:/ping.txt</p>\n <p>&nbsp;</p> \n <p><strong>For cases where curl supports the .crt certificate directly, make the API request as per below:</strong><br /><br />curl -vk -E ./*****.crt --key ./*****.key -H \\\"Content-Type: application/json\\\" -X POST&nbsp;<strong>base_url</strong><a class=\\\"external-link\\\" href=\\\"https://uat.banking.live:45443/api/pws/pws_ping_api\\\" >/api/pws/pws_ping_api</a>&nbsp;-d ' { \\\"api_call_unique_identifier\\\":\\\"1212009001\\\" , \\\"client_id\\\" : \\\"123456\\\" }'</p>",
"version" : "2.0",
"title" : "PayApi Docs"
},
"host" : "dev-app01.pay:45009",
"basePath" : "/api",
"tags" : [ {
"name" : "Paycontrol WS (PCJS)"
}, {
"name" : "ChargeCard"
}, {
"name" : "Card"
}, {
"name" : "Transaction"
}, {
"name" : "ChargeBack-Beta"
}, {
"name" : "Tokenization (Beta)"
}, {
"name" : "VCAS"
}, {
"name" : "Fees"
}, {
"name" : "Reward"
}, {
"name" : "API 2.0",
"description" : "Currently Running Api Version"
}, {
"name" : "Account",
"description" : ""
}, {
"name" : "Group",
"description" : "group"
}, {
"name" : "Card PaySecure WS",
"description" : "<p>PaySecure card Web services are used to provide end to end encryption for sharing sensitive information.</p>\n<ul>\n<li class=\"docBullet\">Information related to pan/cvv2/pin are sensitive and should not be available to any unauthenticated person.<br />For this service we will use RSA and AES algorithm.</li>\n<li class=\"docBullet\">RSA is asymmetric key crytography concept while Advanced Encryption Standard(AES) is symmetrical key cryptography concept.</li>\n<li class=\"docBullet\">For AES same private key is used for both encryption and decryption.While for RSA ,we will use the public key to encrypt and private key for decryption.</li>\n<li class=\"docBullet\">RSA public key is provided to client through email if client wants to use Paysecure card services while associating with Paymentology and can be regenerated upon request.</li>\n<li class=\"docBullet\">AES-256 is used for this service. AES key must be in base64 format.Padding used is AES/CBC/PKCS5PADDING .Initially , AES-256 key bit is used as message for RSA and this message will be encrypted using RSA public key .</li>\n<li class=\"docBullet\">The encryped message will be set as session-id for the Api.Api will then decrypt the session-id to get AES key .Then using the AES key we will encrypt the sensitive information like cvv,pan,pin.Finally ,Api will return the encrypted pan ,pin ,cvv to the end user .</li>\n<li class=\"docBullet\">The end user can decrypt the message using same AES key and 16 bits initialization vector (IV) returned from api. Hence,the sensitive information are transfer to end user from the Api using RSA and AES algorithm .</li>\n</ul>\n<h3>End to end Flow</h3>\n<p>When a Paymentology client is created, an associated RSA key is generated and shared with Paymentology client.&nbsp;<br />client can then safely pass this public key to the cardholders ( applications) so they can communicate securely with Paymentology systems without the client in the middle be able to decrypt that information.</p>\n<p>&nbsp;</p>\n<p><img src=\"../paycontrol/images/SC-Card_1.png\" /></p>\n<p><img src=\"../paycontrol/images/SC-Card_2.png\" /></p>\n<h3>Encryption and PIN Format</h3>\n<ul>\n<li>RSA Encryption will be used for asymmetric Encryption&nbsp;between Cardholder and Paymentology. This will prevent any intercept attacks and loss of sensitive data.(<a class=\"external-link\" href=\"https://simple.wikipedia.org/wiki/RSA_algorithm\">https://simple.wikipedia.org/wiki/RSA_alogrithm)</a></li>\n<li>AES 256 Encryption (AES/CBC/PKCS5PADDING) will be used for Encryption of the Sensitive data e.g. PIN,PAN, CVV2. this will be a random key generated for each call and shared under the RSA Key Pair, stronger than conventional Tripple DES algorithm.(<a class=\"external-link\" href=\"https://simple.wikipedia.org/wiki/Advanced_Encryption_Standard)\">https://simple.wikipedia.org/wiki/Advanced_Encryption_Standard)</a></li>\n<li>\n<p>PIN BLOCK Format iso format 2 will be used to communicate the encrypted PIN block to and from the cardholder to Paymentology.</p>\n</li>\n</ul>\n<p>&nbsp;</p>\n<p>&nbsp;</p>\n<h3>Session-Id Generation Java Example</h3>\n<ul>\n<li>Create a 32 character length random string :&nbsp;<strong>SESSION_KEY</strong></li>\n<li>Encrypt SESSION_KEY with RSA_PUBLIC Key :&nbsp;<strong>SESSION-ID</strong></li>\n</ul>\n<p><span style=\"text-decoration: underline;\"><strong>Sample source code</strong></span></p>\n<pre>\n<code>\nString RSA_PUBLIC = \"RSA_PUBLIC KEY\";\nString SESSION_KEY = \"RANDOM STRING\"; // GENERATE RANDOM 32 LENGTH CHARACTER SESSION KEY\nAsymmetricCryptography ac = new AsymmetricCryptography();\nPublicKey publicKey = ac.getPublickey(RSA_PUBLIC);\nString SESSION_ID = ac.encrypt(SESSION_KEY, publicKey); // This is the session-id that needs to be passed into header on api request\n\npublic class AsymmetricCryptography {\n private Cipher cipher;\n\n public AsymmetricCryptography() throws NoSuchAlgorithmException, NoSuchPaddingException {\n this.cipher = Cipher.getInstance(\"RSA\"); \n }\n\n public PublicKey getPublickey(String base64) throws exception {\n byte[] keyBytes = java.util.Base64.getDecoder().decode(base64);\n X509EncodedKeySpec spec = new X509EncodedKeySpec(keyBytes);\n KeyFactory kf = KeyFactory.getInstance(\"RSA\");\n return kf.generatePublic(spec);\n }\n\n\n public String encrypt(String msg, PublicKey key) throws NoSuchAlgorithmException, NoSuchPaddingException, UnsupportedEncodingException, IllegalBlockSizeException, BadPaddingException, InvalidKeyException {\n this.cipher.init(Cipher.ENCRYPT_MODE, key);\n return Base64.encodeBase64String(cipher.doFinal(msg.getBytes(\"UTF-8\")));\n }\n\n public PrivateKey getPrivatekey(String base64) throws exception {\n byte[] keyBytes = java.util.Base64.getDecoder().decode(base64);\n PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(keyBytes);\n KeyFactory kf = KeyFactory.getInstance(\"RSA\");\n return kf.generatePrivate(spec);\n }\n\npublic String decrypt(String msg, PrivateKey key) throws InvalidKeyException, UnsupportedEncodingException, IllegalBlockSizeException, BadPaddingException {\n this.cipher.init(Cipher.DECRYPT_MODE, key);\n return new String(cipher.doFinal(Base64.decodeBase64(msg)), \"UTF-8\");\n}\n}\n</code>\n</pre> \n<p><span style=\"text-decoration: underline;\"><strong>Decryption Example</strong></span></p>\n<pre><code>\nString secret = \"+AyrdXnhXhc=\"; // encrypted cvv2 in response\nString iv = \"Xb6qbV2L6d1F92YU\"; // IV value generated in payapi while decrypting cvv\n\nCipher Aesdcipher = Cipher.getInstance(\"AES/CBC/PKCS5PADDING\");\nIvParameterSpec iv_spec = new IvParameterSpec(iv .getBytes(\"UTF-8\"));\nbyte[] decodedKey = Base64.getDecoder().decode(SESSION_KEY); // SESSION-KEY is the key generated at client side i.e. 32 character random string\nSecretKey Aeskey = new SecretKeySpec(decodedKey, 0, decodedKey.length, \"AES\");\n\n// initialize the ciphers with the given key\nAesdcipher.init(Cipher.DECRYPT_MODE, Aeskey, iv_spec);\nbyte[] dec = BASE64DecoderStream.decode(secret.getBytes());\n\nbyte[] utf8 = Aesdcipher.doFinal(dec);\n\nString decrypted_cvv2 = new String(utf8, \"UTF8\"); // Final decrypted cvv2\n</code></pre>\n<p><strong><span style=\"text-decoration: underline;\">IV-vector key Generation</span></strong></p>\n<ul>\n<li>Create a 16 character length random string : IV_KEY.</li>\n<li>Generate IV spec for the IV_KEY as below.</li>\n</ul>\n<pre><code>\nString IV_KEY = \"Xb6qbV2L6d1F92YU\"; // pass as iv in request to api\nIvParameterSpec IV = new IvParameterSpec(IV_KEY.getBytes(\"UTF-8\"));\n</code></pre>\n<p><strong><span style=\"text-decoration: underline;\">Encryption Example</span></strong></p>\n<pre>\n<code>\n byte[] decodedKey = Base64.getDecoder().decode(SESSION_KEY); // use 32 characters session key generated at first step\n SecretKey Aeskey = new SecretKeySpec(decodedKey, 0, decodedKey.length, \"AES\");\n\n String CVV2= \"024\"; \n Cipher Aesecipher = Cipher.getInstance(\"AES/CBC/PKCS5PADDING\");\n Aesecipher.init(Cipher.ENCRYPT_MODE, Aeskey, IV);\n byte[] utf8 = CVV2.getBytes(\"UTF8\");\n byte[] enc = Aesecipher.doFinal(utf8);\n String CVV2_enc = Base64.getEncoder().encodeToString(enc); // pass encrypted cvv2 in request\n\n</code>\n</pre>"
}, {
"name" : "Rules action"
}, {
"name" : "Rules",
"description" : "rules"
}, {
"name" : "wallet",
"description" : ""
}, {
"name" : "Credit Interest"
}, {
"name" : "API 3.0",
"description" : "API 3.0 is currently in alpha phase and not yet visible to customers. As we move to Beta, web services will be available for users to review and try the degree of backward compatibility will be clearly conveyed within the description of each individual web service"
}, {
"name" : "Overview",
"description" : "<p>The Paymentology API interface allows users to perform end-to-end management of their card programs, including but not limited to the following:</p>\n<ul>\n<li class=\"docBullet\">Create cards - Virtual or Physical in singles or in bulk, including customisable delivery to client or end consumer</li>\n<li class=\"docBullet\">Create accounts- An account hierarchy allows operation of card wallets (fx, expense or other wallets)</li>\n<li class=\"docBullet\">Load/Transfer funds- Load/unload amounts onto cards or transfer between cards.</li>\n<li class=\"docBullet\">pin services- pin resets, pin status, pin change, pin set and so on.</li>\n<li class=\"docBullet\">rules Engine- create and edit advanced rules which can apply at card level or across entire products.</li>\n<li class=\"docBullet\">Actions engine- user triggered rules to drive a variety of actions: Sms, email, web service call, apply fees, block cards etc.</li>\n</ul>\n<p><br />The platform is currently running Version 2.0 of our API, known as API 2.0. Version 3.0 is being developed and will be released for beta testing in due course.<br />To browse through the current API, please select API 2.0 from the tree structure on the left and expand into the various API sections. Please note that each API is usable, which means you can use the &lsquo;Try me&rsquo; button directly on the page to submit a web service call and get a response.</p>"
}, {
"name" : "Account Structure",
"description" : "<p>The following section provides a simple summary of the account and card structure and mechanism within the&nbsp;<strong>Banking.Live&nbsp;</strong>platform.</p>\n<p><strong>Definitions&nbsp;</strong></p>\n<p><strong>ACCOUNT :&nbsp;</strong>is the record of transactions over a financial period and the resulting balance.&nbsp;</p>\n<p><strong>PARENT ACCOUNT :&nbsp;</strong>is an account, that can have one or more accounts below it. It allows users to set up a hierarchical relationship.&nbsp;</p>\n<p><strong>CARD :&nbsp;</strong>is the financial instrument enabling to access the funds or automated teller machine and make payments. The card could be physical or virtual and is usually associated with an account.&nbsp;</p>\n<p><strong>Features&nbsp;</strong></p>\n<p>The&nbsp;<strong>Banking.Live&nbsp;&nbsp;</strong>main features are :</p>\n<ul>\n<li>account Cards Creation</li>\n<li>account Hierarchy&nbsp;</li>\n</ul>\n<p><strong>account card Creation</strong></p>\n<p>account and Cards are generated through webservices calls to the platform. As can be seen in the table, two different approaches are available.</p>\n<table>\n<thead>\n<tr>\n<th>\"Create account\" then \"Create card\". (two steps)</th>\n<th>\"Create card\" automatically \"Create account\"</th>\n</tr>\n</thead>\n<thead></thead>\n<tbody>\n<tr>\n<td>\n<p>In this approach, the <em>account</em> is created first through the pws_create_account.</p>\n<p>The webservice request (JSON), includes&nbsp;<strong>\"ac_parent_id\"</strong>&nbsp;field populated by the ID of the already existing parent account. On the webservice response (JSON), it could be possible to find the&nbsp;<strong>\"ac_id\"</strong>, of the new account.</p>\n<p>The <em>card</em> is created through the pws_create_card .</p>\n<p>The webservice request (JSON), will include only the<strong>\"ac_id\"</strong>of the previously created <em>account</em>.</p>\n<p>In the response (JSON), the<strong>\"ac_id\" </strong>match.</p>\n</td>\n<td>\n<p>In this approach, the <em>card</em> is created through the pws_create_card.</p>\n<p>The webservice request (JSON), includes the <strong>\"ac_parent_id\" </strong>field populated by the ID of the existing parent account.</p>\n<p><em>Then</em></p>\n<p>An <em>account</em> is created automatically, becoming a sub-account of the existing parent.</p>\n<p>The webservice response (JSON), includes the new created account ID, <strong>\"ac_id\"</strong>.</p>\n</td>\n</tr>\n</tbody>\n</table>\n<p><strong>account Hierarchy</strong></p>\n<p>The platform offers a flexible structure, giving to the users ability to create personalized levels of hierarchical relationship.</p>\n<ul>\n<li><u><em>card account Mapping</em></u>: we can have multiple account assigned to card. However, an account does not need to have a card associated with it.<br /><br /></li>\n<li><u><em>Parent Accounts</em></u>: an account can have a parent account, this allows for managing a group of accounts and cards under a specific master \"parent account\"(i.e. account generation for a corporate group).<br /><br /></li>\n<li><u><em>Multi-level structure</em></u>: multiple tiers of accounts and parent accounts can be created for different purposes.</li>\n</ul>"
}, {
"name" : "Security and Authentication",
"description" : "<h4 id=\"SecurityandAuthentication-HTTPSsecureconnections\"><strong>HTTPS&nbsp; secure connections</strong></h4>\n<p>Banking.Live API is protected and authenticated by SSL PKI (<a class=\"external-link\" href=\"https://en.wikipedia.org/wiki/Public_key_certificate\" >https://en.wikipedia.org/wiki/Public_key_certificate</a>&nbsp;) where Banking.Live verifies API calls against client certificates.</p>\n<p><span class=\"confluence-embedded-file-wrapper confluence-embedded-manual-size\"><img src=\"http://help.fortinet.com/fweb/554/Content/FortiWeb/fortiweb-admin/Images/pkiAuthentication_clientCertificateVerification1.png\" alt=\"Image result for api pki ssl p12\" width=\"397\" height=\"231\" data-image-src=\"http://help.fortinet.com/fweb/554/Content/FortiWeb/fortiweb-admin/Images/pkiAuthentication_clientCertificateVerification1.png\" /></span></p>"
}, {
"name" : "Required Fields",
"description" : "<p>For every web services request, there are two main fields, \"api_unique_identifier\" and \"client_id\". The API specification illustrates the requirements of the fields as follows:</p>\n<table \n<thead>\n<tr >\n<th>Field</th>\n<th> Description</th>\n</tr>\n</thead>\n<tbody >\n<tr>\n<td ><strong>api_unique_identifier</strong></td>\n<td >This is a unique random number that must be passed during a web service request. For each request, it must be different. The api will check if this field is already present in database, if so then return back error as&nbsp;<strong><em>api_unique_identifier is already used.</em></strong></td>\n</tr>\n<tr >\n<td ><strong>client_id</strong></td>\n<td >The unique identifier for the client, which Paymentology provides at the project initiation. During client creation a client processing key is emailed to the client. This key is used for different encryption processes and security purposes throughout Paymentology actions.</td>\n</tr>\n</tbody>\n</table>"
}, {
"name" : "Error handling/Codes",
"description" : "<p>In this section the <strong>Banking.live</strong><strong>&nbsp;</strong>web services request&nbsp;<strong>ERROR IDs</strong>&nbsp;are described. Starting from the successful \"error_id\": 0, the full list of request failures is given as follows:</p>\n<p>API's ERROR Codes</p>\n<table>\n<thead>\n<tr >\n<th >Error Code</th>\n<th >Error Description\n</th>\n</tr>\n</thead>\n<tbody >\n<tr>\n<th >0</th>\n<td >Success</td>\n</tr>\n<tr >\n<th >900</th>\n<td >Internal Server Error. Contact Paymentology Support</td>\n</tr>\n<tr >\n<th >987</th>\n<td >Failure connecting database. Try again or contact Paymentology</td>\n</tr>\n<tr >\n<th >988</th>\n<td >Timeout executing database query. Try again or contact Paymentology</td>\n</tr>\n<tr >\n<th >989</th>\n<td >Failure executing database query. Try again or contact Paymentology&nbsp;</td>\n</tr>\n<tr >\n<th >990</th>\n<td >The client_id is invalid</td>\n</tr>\n<tr >\n<th >990</th>\n<td >The sub_client_id is invalid</td>\n</tr>\n<tr >\n<th >991</th>\n<td >The parent account number is invalid</td>\n</tr>\n<tr >\n<th >992</th>\n<td >The account id is invalid</td>\n</tr>\n<tr >\n<th >993</th>\n<td >api_call_unique_identifier already been used</td>\n</tr>\n<tr >\n<th >994</th>\n<td >The token is invalid</td>\n</tr>\n<tr >\n<th >995</th>\n<td >Validation failed ! on input request.</td>\n</tr>\n<tr >\n<th >996</th>\n<td >Permission denied ! The client does not have access to this web service. Contact Paymentology</td>\n</tr>\n<tr >\n<th >997</th>\n<td >No data found</td>\n</tr>\n<tr >\n<th >998</th>\n<td >The currency code is not valid</td>\n</tr>\n<tr >\n<th >998</th>\n<td >Currency failure. The amt_ccy is invalid</td>\n</tr>\n<tr >\n<th >998</th>\n<td >Currency failure. The load_ccy is invalid</td>\n</tr>\n<tr >\n<th >999</th>\n<td >The client_id is not authorized to perform action with the token provided!</td>\n</tr>\n<tr >\n<th >1000</th>\n<td >The client_id is not authorized to perform action with the account id provided</td>\n</tr>\n<tr >\n<th >1001</th>\n<td >The client_id is not authorized to perform action with the product id provided</td>\n</tr>\n<tr >\n<th >1012</th>\n<td >The manufacturer id is not available in repository</td>\n</tr>\n<tr >\n<th >1013</th>\n<td >The manufacturer id is not associated with the client id</td>\n</tr>\n<tr >\n<th >1014</th>\n<td >The product id is invalid</td>\n</tr>\n<tr >\n<th >1015</th>\n<td >card renewal failed. Check status_network. Set the card to lost,expired or stolen or damaged.</td>\n</tr>\n<tr >\n<th >1016</th>\n<td >card stack is not empty</td>\n</tr>\n<tr >\n<th >1017</th>\n<td >card image template is not configured. Contact Paymentology</td>\n</tr>\n<tr >\n<th >1018</th>\n<td >account Already assigned to card. Please create new account for create card</td>\n</tr>\n<tr >\n<th >1019</th>\n<td >The card has been deactivated already</td>\n</tr>\n<tr >\n<th >1020</th>\n<td >Please Provide valid Parent account or \"account id\"</td>\n</tr>\n<tr >\n<th >1021</th>\n<td >The card has already been sent for renewal</td>\n</tr>\n<tr >\n<th >1022</th>\n<td >Inserting purchaser details failed during physical card creation</td>\n</tr>\n<tr >\n<th >1025</th>\n<td >The card is physical. Use virtual card for card conversion</td>\n</tr>\n<tr >\n<th >1026</th>\n<td >Error generating card files. No cards found associated with batch_id</td>\n</tr>\n<tr >\n<th >1027</th>\n<td >Failed to unload balance. The balance is insufficient</td>\n</tr>\n<tr >\n<th >1031</th>\n<td >No pin set for this token (pvv not generated). set pin via pws_set_pin</td>\n</tr>\n<tr >\n<th >1032</th>\n<td >Ecno Failure from database. Try again or please contact the Paymentology</td>\n</tr>\n<tr >\n<th >1033</th>\n<td >Failed to create virtual card. Try again or contact the Paymentology</td>\n</tr>\n<tr >\n<th >1034</th>\n<td >Failed to create&nbsp;physical card. Try again or contact the Paymentology</td>\n</tr>\n<tr >\n<th >1035</th>\n<td >Failed to create card image. Try again or contact the Paymentology</td>\n</tr>\n<tr >\n<th >1036</th>\n<td >Failed to encrypt card file</td>\n</tr>\n<tr >\n<th >1037</th>\n<td >Failed to edit the card status</td>\n</tr>\n<tr >\n<th >1038</th>\n<td >Failed to upload into Sftp folder</td>\n</tr>\n<tr >\n<th >1039</th>\n<td >The card and account is already linked</td>\n</tr>\n<tr >\n<th >1040</th>\n<td >The card and account is not linked</td>\n</tr>\n<tr >\n<th >1041</th>\n<td >The currency code is invalid for above account</td>\n</tr>\n<tr >\n<th >1042</th>\n<td >The default currency is already active</td>\n</tr>\n<tr >\n<th >1043</th>\n<td >The account new donot belong to client id</td>\n</tr>\n<tr >\n<th >1044</th>\n<td >card is still awaiting to send to manufacturer. Cannot change status</td>\n</tr>\n<tr >\n<th >1080</th>\n<td >rules Id not found</td>\n</tr>\n<tr >\n<th >1081</th>\n<td >Failed to add action please contact the Paymentology support</td>\n</tr>\n<tr >\n<th >1082</th>\n<td >Failed to delete action please contact the Paymentology support</td>\n</tr>\n<tr >\n<th >1083</th>\n<td >Invalid action Id</td>\n</tr>\n<tr >\n<th >1084</th>\n<td >Failed to update action please contact the Paymentology support</td>\n</tr>\n<tr >\n<th >1085</th>\n<td >Failed to add rules. Contact Paymentology</td>\n</tr>\n<tr >\n<th >1086</th>\n<td >Failed to Update rules. Contact Paymentology</td>\n</tr>\n<tr >\n<th >1087</th>\n<td >Failed to Delete rules. Contact Paymentology</td>\n</tr>\n<tr >\n<th >1088</th>\n<td >Failed to get the Auth Unblock</td>\n</tr>\n<tr >\n<th >1089</th>\n<td >The card is a void card. No actions allowed ! | The card is a Blocked card. No actions allowed ! | The card has been blocked due to pin verification failed for successive 4 times</td>\n</tr>\n<tr >\n<th >1200</th>\n<td >Invalid Request</td>\n</tr>\n<tr >\n<th >1201</th>\n<td >card Already Enrolled</td>\n</tr>\n<tr >\n<th >1202</th>\n<td >No such card Range</td>\n</tr>\n<tr >\n<th >1203</th>\n<td >Got Internal Error From Touch Touch</td>\n</tr>\n<tr >\n<th >1301</th>\n<td >Weak pin</td>\n</tr>\n<tr >\n<th >1302</th>\n<td >Failed to Decrypt pin</td>\n</tr>\n<tr >\n<th >1302</th>\n<td >Failed to Set pin</td>\n</tr>\n<tr >\n<th >1303</th>\n<td >Failed to Encrypt with Provided Key</td>\n</tr>\n<tr >\n<th >1304</th>\n<td >Failed to Get Pan Number</td>\n</tr>\n<tr >\n<th >1305</th>\n<td >Failed to Get pin</td>\n</tr>\n<tr >\n<th >1306</th>\n<td >cvv2 doesnot matched</td>\n</tr>\n<tr >\n<th >1307</th>\n<td >Failed to decrypt cvv2</td>\n</tr>\n<tr >\n<th >1308</th>\n<td >Failed to Get cvv2</td>\n</tr>\n<tr >\n<th >1309</th>\n<td >RSA Key Not Found for client</td>\n</tr>\n<tr >\n<th >1310</th>\n<td >Session key already used</td>\n</tr>\n</tbody>\n</table>"
}, {
"name" : "Curl Request Sample",
"description" : "<p>The description below allows to make Banking.Live web service requests using CURL method.</p>\n<p><strong>Here are the steps through which web service request is achieved using the curl method:</strong></p>\n<p>For web service requests we need to get the client ssl certificate which will be provided by the Banking.Live technical team. The certificates will be in format i.e.&nbsp; &nbsp; *****.crt , *****.p12 , ******.key.</p>\n<p>In some cases the curl command may expect&nbsp;<strong>.pem</strong>&nbsp;format for ssl verification.&nbsp;<br />So you need to export the certificate as .pem format using OpenSSL as below</p>\n<pre>OpenSSL&gt; pkcs12 -in D:\\*****.p12 -out D:\\****.pem\nEnter Import Password:\nEnter PEM pass phrase:\nVerifying - Enter PEM pass phrase:\nOpenSSL&gt;\n</pre>\n<p>Now the command for request is as below with samples.</p>\n<p>curl -vk --cert ./***<strong>.pem:passphrase</strong>&nbsp;-X POST -H \"Content-Type:application/json\"&nbsp;<strong>base_url</strong><a class=\"external-link\" href=\"https://uat.banking.live:45443/api/pws/pws_ping_api\" >/api/pws/pws_ping_api</a>&nbsp;-d ' { \"api_call_unique_identifier\":\"1212009001\" , \"client_id\" : \"123456\" }'</p>\n<p>curl -vk --cert ./***<strong>.pem:passphrase</strong>&nbsp;-X POST -H \"Content-Type:application/json\"&nbsp;<a class=\"external-link\" href=\"https://uat.banking.live:45443/api/pws/pws_ping_api\" ><strong>base_url</strong>/api/pws/pws_ping_api</a>&nbsp;-d ' { \"api_call_unique_identifier\":1212009001, \"client_id\" : 123456 }'</p>\n<p>$ curl -vk --cert ./****<strong>.pem:passphrase</strong>&nbsp;-X POST -H \"Content-Type:application/json\"&nbsp;&nbsp;<strong>base_url</strong><a class=\"external-link\" href=\"https://uat.banking.live:45443/api/pws/pws_ping_api\" rel=\"nofollow\">/api/pws/pws_ping_api</a>&nbsp;-d @D:/ping.txt</p>\n <p>&nbsp;</p>\n<p><strong>For cases where curl supports the .crt certificate directly, make the API request as per below:</strong><br /><br />curl -vk -E ./*****.crt --key ./*****.key -H \"Content-Type: application/json\" -X POST&nbsp;<strong>base_url</strong><a class=\"external-link\" href=\"https://uat.banking.live:45443/api/pws/pws_ping_api\" >/api/pws/pws_ping_api</a>&nbsp;-d ' { \"api_call_unique_identifier\":\"1212009001\" , \"client_id\" : \"123456\" }'</p>"
}, {
"name" : "API 1.0",
"description" : "API 1.0 was retired in December 2019 and is therefore no longer available"
}, {
"name" : "Pin",
"description" : "pin"
}, {
"name" : "Ping",
"description" : "Ping - This web service is used to monitor the Paymentology web services and ensure they are functional."
}, {
"name" : "Customer"
}, {
"name" : "Contract"
}, {
"name" : "Credit Limits"
}, {
"name" : "Credit Grace Periods"
}, {
"name" : "Credit Account Status"
}, {
"name" : "MCC"
}, {
"name" : "Credit Billing Cycle"
} ],
"schemes" : [ "https" ],
"paths" : {
"/pws/pws_ch_get_client_billing_cycle/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Client Billing Cycle - This web service gets the billing cycle created for the given client",
"operationId" : "pws_ch_get_client_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetClientBillingCycle"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ClientBillingCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_client_billing_cycle"
}
},
"/pws/pws_ch_set_account_credit_limit/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Set Account Credit Limit - This web service set credit limit for the given account",
"operationId" : "pws_ch_set_account_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountCreditLimit"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetAccountCreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_set_account_credit_limit"
}
},
"/pws/pws_ch_update_account_credit_limit/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Update Account Credit Limit - This web service update credit limit applied to the given account",
"operationId" : "pws_ch_update_account_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountCreditLimit"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateCreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_update_account_credit_limit"
}
},
"/pws/pws_ch_get_account_credit_limit/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Account Credit Limit - This web service gets the credit limit applied to the given account",
"operationId" : "pws_ch_get_account_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountCreditLimit"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountCreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_account_credit_limit"
}
},
"/pws/pws_ch_get_account_credit_limit_history/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Account Credit Limit History- This web service gets history of credit limit applied to the given account",
"operationId" : "pws_ch_get_account_credit_limit_history",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountCreditLimit"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountCreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_account_credit_limit_history"
}
},
"/pws/pws_ch_set_account_billing_cycle_config/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Set Account Billing Cycle Config - This web service set billing cycle config for the given account and start the statement cycle",
"operationId" : "pws_ch_set_account_billing_cycle_config",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsSetAccountBillingCycle"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetAccountBillingCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_set_account_billing_cycle_config"
}
},
"/pws/pws_ch_get_account_billing_cycle_config/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Account Billing Cycle Config - This web service gets billing cycle config that are applied to the given account",
"operationId" : "pws_ch_get_account_billing_cycle_config",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountBillingCycle"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountBillingCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_account_billing_cycle_config"
}
},
"/pws/pws_ch_get_account_interest_details/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Account Interest Details - This web service gets interest details applied to the given account",
"operationId" : "pws_ch_get_account_interest_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountInterestDetails"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountInterestDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_account_interest_details"
}
},
"/pws/pws_ch_get_account_billing_cycle_details/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Account Billing Cycle Details - This web service gets billing cycle details applied to the given account",
"operationId" : "pws_ch_get_account_billing_cycle_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountBillingCycleDetails"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountBillingCycleDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_account_billing_cycle_details"
}
},
"/pws/pws_ch_get_payment_details/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Payment Details - This web service gets payment details for the given account",
"operationId" : "pws_ch_get_payment_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountPaymentDetails"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetPaymentResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_payment_details"
}
},
"/pws/pws_ch_get_statement/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get ChargeCard Statement - This web service gets statement for the given account",
"operationId" : "pws_ch_get_statement",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetChargeCardStatement"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_statement"
}
},
"/pws/pws_ch_offer_installment/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Offer Installment Quote - This web service offer installment quote for the given account.",
"operationId" : "pws_ch_offer_installment",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/OfferInstallment"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/OfferInstallmentResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_offer_installment"
}
},
"/pws/pws_ch_confirm_installment/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Confirm Installment - This web service confirm installment for the given account.",
"operationId" : "pws_ch_confirm_installment",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsConfirmInstallment"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ConfirmInstallmentResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_confirm_installment"
}
},
"/pws/pws_ch_get_installment_details/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Installment Details - This web service gets installment details for the given account",
"operationId" : "pws_ch_get_installment_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetChargeCardInstallment"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetInstallmentDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_installment_details"
}
},
"/pws/pws_ch_get_installment_config/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Installment Config - This web service gets installment config that are set at product level.",
"operationId" : "pws_ch_get_installment_config",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetInstallmentConfig"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetInstallmentConfigResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_installment_config"
}
},
"/pws/pws_ch_set_installment_fee/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Set Installment Fee - This web services allows to update the fixed fee of the installment on program level.",
"operationId" : "pws_ch_set_installment_fee",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SetInstallmentFee"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetInstallmentFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_set_installment_fee"
}
},
"/pws/pws_ch_get_claim/" : {
"post" : {
"tags" : [ "ChargeCard" ],
"summary" : "Get Claim Details- This web services retrieves all claim information for a specific account.",
"operationId" : "pws_ch_get_claim",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetClaimModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetClaimResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ch_get_claim"
}
},
"/pws/pws_acs_authentication/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "ACS Authentication FSS - This API is used for Transaction Authentication from ACS to MB Server",
"operationId" : "pws_acs_authentication",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AcsAuthenticationModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AcsAuthenticationResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_acs_authentication"
}
},
"/pws/pws_auth_unblock/" : {
"post" : {
"tags" : [ "Transaction" ],
"summary" : "Unblock Authorisation - This web service unblocks an authorisation.",
"operationId" : "pws_auth_unblock",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AuthUnblockModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AuthUnblockResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_auth_unblock"
}
},
"/pws/pws_mc_health_check/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Health Check - This resource will check status of mastercard api suite",
"operationId" : "pws_mc_health_check",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/MasterComTxnSearchResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_health_check"
}
},
"/pws/pws_mc_txn_search/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Transaction Search - This resource is used to query for transaction data\n\nAn issuer uses this endpoint to search for information about an original transaction. An issuer may use this information to take an action on the original transaction, such as creating a claim",
"operationId" : "pws_mc_txn_search",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/MasterComTxnSearchModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/MasterComTxnSearchResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_txn_search"
}
},
"/pws/pws_mc_create_claim/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Create Claim - This resource creates a new claim\n\nIssuers use this endpoint to create a new claim, which is required before creating a retrieval request or a first chargeback. If an issuer attempts to create a duplicate claim on an original transaction, the issuer receives a error message with the claim ID of the existing claim. Acquirers are not able to create claims. They receive claims from disputes that issuers initiate.\n\nNote: issuers must have a first presentment in order to create a claim.\n\nNote: issuers cannot create claims on first presentments that acquirers have reversed.",
"operationId" : "pws_mc_create_claim",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/McClaimModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/McClaimResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_create_claim"
}
},
"/pws/pws_mc_get_claim/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Claim Detail - Retrieve Claim Details\n\nIssuers and acquirers use this endpoint to retrieve details for an existing claim, including any cases with which the claim is associated.",
"operationId" : "pws_mc_get_claim",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/McClaimGetModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/McClaimResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_get_claim"
}
},
"/pws/pws_mc_datafor_cb/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Load Data for CB - This resource retrieves a structure containing possible values used to create a chargeback",
"operationId" : "pws_mc_datafor_cb",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/McCbDataModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/McClaimResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_datafor_cb"
}
},
"/pws/pws_mc_cb_request/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Request Chargeback - This resource creates a new chargeback\n\nIssuers and acquirers use this endpoint to create chargeback and second presentments and optionally to upload supporting documents. Issuers and acquirers may use the parameters in the request to automatically generate the Expedited Billing Dispute Form (EBDF) and attach it to the claim.",
"operationId" : "pws_mc_cb_request",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/McCbRequestModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/McCbRequestModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_cb_request"
}
},
"/pws/pws_mc_cb_status/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "CB image status - This resource retrieves the processing status of a chargeback image\n\n",
"operationId" : "pws_mc_cb_status",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/McCbStatusModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/McCbRequestModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_cb_status"
}
},
"/pws/pws_mc_cb_cancel/" : {
"post" : {
"tags" : [ "ChargeBack-Beta" ],
"summary" : "Cancel Chargeback - This resource creates a chargeback reversal\n\nIssuers and acquirers use this endpoint to reverse an existing chargeback when they create a chargeback in error.\n\n",
"operationId" : "pws_mc_cb_cancel",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/McCbStatusModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/McCbRequestModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mc_cb_cancel"
}
},
"/pws/predigitization/v1/authorizeService/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Authorize Service - Authorize Service requests an Issuer to authorize a Primary Account Number for a Mastercard service or set of services. Information about the service request will be provided to assist with authorization of the account. If additional authentication is required the Issuer may return a list of Activation Methods. The Activation Methods will be presented to the Cardholder so they may select their preferred delivery channel to receive an Activation Code. If there are no methods to return the field may be omitted. This call is made as part of the service activation flow and may be subject to strict time constraints based on the service.",
"operationId" : "pws_mea_authorize_service",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AuthorizeService"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AuthorizeServiceResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_authorize_service"
}
},
"/pws/predigitization/v1/authorizeBinding/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Authorize Binding - This API (Device Token Binding Request) is invoked to bind an ECOM/COF token to a device.",
"operationId" : "pws_mea_authorize_binding",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AuthorizeBinding"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AuthorizeBindingResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_authorize_binding"
}
},
"/pws/predigitization/v1/requestActivationMethods/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Request Activation Methods - RequestActivationMethods advises an Issuer that a service activation has been requested and that an Issuer should provide Activation Methods for the Cardholder.",
"operationId" : "pws_mea_request_activation_methods",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RequestActivationMethods"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/RequestActivationMethodsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_request_activation_methods"
}
},
"/pws/predigitization/v1/deliverActivationCode/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Deliver Activation Code - DeliverActivationCode is used to request an Activation Code be sent to authenticate the Cardholder.",
"operationId" : "pws_mea_deliver_activation_code",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DeliverActivationCode"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/DeliverActivationCodeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_deliver_activation_code"
}
},
"/pws/stepup/" : {
"post" : {
"tags" : [ "VCAS" ],
"summary" : "Stepup - Stepup request is communicate by the VCAS platform to the partner, and the partner responds with parameters necessary for VCAS to perform the step-up challenge.",
"operationId" : "pws_vcas_stepup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StepupRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/StepupResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_vcas_stepup"
}
},
"/pws/initiateaction/" : {
"post" : {
"tags" : [ "VCAS" ],
"summary" : "Initiate Action - Initiate Action request is used to signal to the partner to take action on an item.",
"operationId" : "pws_vcas_initiate_action",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/InitiateActionRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/InitiateActionResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_vcas_initiate_action"
}
},
"/pws/validate/" : {
"post" : {
"tags" : [ "VCAS" ],
"summary" : "Stepup Validate - Stepup Validate request is communicate by the VCAS platform to the partner, and the partner responds with a success,failure or retry logic.",
"operationId" : "pws_vcas_validate",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ValidateRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ValidateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_vcas_validate"
}
},
"/pws/pws_create_fee/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Create Fee - This web service creates a new credit fee. The fee will still need to be applied to a context using Activate Fee",
"operationId" : "pws_create_fee",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreateFeeTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_fee"
}
},
"/pws/pws_update_fee/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Update Fee - This web service updates a given fee",
"operationId" : "pws_update_fee",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/UpdateFeeTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_update_fee"
}
},
"/pws/pws_get_current_fees/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Current Fees - This web service gets the details of a fee that was applied and is still active",
"operationId" : "pws_get_current_fees",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetFeeTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCurrentFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_current_fees"
}
},
"/pws/pws_get_fee_historic/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Fee History- This web service gets the details of a historic fee that was applied but is no longer active",
"operationId" : "pws_get_fee_historic",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetFeeTemplaetHistoricModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetFeeHistoricResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_fee_historic"
}
},
"/pws/pws_fee_current_product_create/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Activate Product Fee - This web service applies fees to product",
"operationId" : "pws_fee_current_product_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProductFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateProductFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_product_create"
}
},
"/pws/pws_fee_current_product_update/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Update Product Fee - This web service update fees for product",
"operationId" : "pws_fee_current_product_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProductFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateProductFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_product_update"
}
},
"/pws/pws_fee_current_product_get/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Product Fees - This web service gets the fees applied to the given product",
"operationId" : "pws_fee_current_product_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsProductIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_product_get"
}
},
"/pws/pws_fee_history_product_get/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Product Fee History - This web service gets the fees applied to the given product history",
"operationId" : "pws_fee_history_product_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetProductFeeHistoricModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductFeeHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_history_product_get"
}
},
"/pws/pws_fee_current_account_create/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Activate Account Fee - This web service applies fees to account",
"operationId" : "pws_fee_current_account_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AccountFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateAccountFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_account_create"
}
},
"/pws/pws_fee_current_account_update/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Update Account Fee - This web service update fees for account",
"operationId" : "pws_fee_current_account_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AccountFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateAccountFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_account_update"
}
},
"/pws/pws_fee_current_account_get/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Account Fees - This web service gets the fees applied to the given product",
"operationId" : "pws_fee_current_account_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_account_get"
}
},
"/pws/pws_fee_history_account_get/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Account Fee History - This web service gets the fees applied to the given account history",
"operationId" : "pws_fee_history_account_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountFeeHistoryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountFeeHistroryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_history_account_get"
}
},
"/pws/pws_fee_current_group_create/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Activate Group Fee - This web service applies fees to group",
"operationId" : "pws_fee_current_group_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GroupFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateGroupFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_group_create"
}
},
"/pws/pws_fee_current_group_update/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Update Group Fee - This web service update fees for group",
"operationId" : "pws_fee_current_group_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GroupFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateGroupFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_group_update"
}
},
"/pws/pws_fee_current_group_get/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Group Fees - This web service gets the fees applied to the given group",
"operationId" : "pws_fee_current_group_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGroupIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_current_group_get"
}
},
"/pws/pws_fee_history_group_get/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Group Fee History - This web service gets the history of fees applied to the given group",
"operationId" : "pws_fee_history_group_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetGroupFeeHistoryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupFeeHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fee_history_group_get"
}
},
"/pws/pws_get_manual_fee_applied/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Manual Fee- This web service gets the details of a manual fee that was applied and is still active",
"operationId" : "pws_get_manual_fee_applied",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetManualFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetManualFeeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_manual_fee_applied"
}
},
"/pws/pws_apply_rebate_fees/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Apply Rebate Fee -This web service apply rebate fee for the given account/groups",
"operationId" : "pws_apply_rebate_fees",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApplyRebateFeeModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyRebateFeeResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_apply_rebate_fees"
}
},
"/pws/pws_get_account_fee_details/" : {
"post" : {
"tags" : [ "Fees" ],
"summary" : "Get Account Fee Details -This web service allows to get fee subjected to the given account",
"operationId" : "pws_get_account_fee_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountFeeDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_fee_details"
}
},
"/pws/pws_create_reward_template/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Create Reward Template- This web service allows to create reward template",
"operationId" : "pws_create_reward_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreateRewardTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateRewardResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_reward_template"
}
},
"/pws/pws_edit_reward_template/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Update Reward Template- This web service is used to update reward template",
"operationId" : "pws_edit_reward_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsUpdateRewardTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_edit_reward_template"
}
},
"/pws/pws_get_current_reward_template/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Reward Template- This web service is used to get reward template",
"operationId" : "pws_get_current_reward_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetRewardTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetRewardTemplateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_current_reward_template"
}
},
"/pws/pws_reward_current_product_create/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Activate Product Reward - This web service allow us to apply reward at product level",
"operationId" : "pws_reward_current_product_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyProductRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyProductRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_product_create"
}
},
"/pws/pws_reward_current_product_edit/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Update Product Reward - This web service allow us to edit existing reward configuration at product level",
"operationId" : "pws_reward_current_product_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyProductRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateProductRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_product_edit"
}
},
"/pws/pws_reward_current_product_get/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Product Reward-This web service allows to get reward applied to the given product",
"operationId" : "pws_reward_current_product_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetProductRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_product_get"
}
},
"/pws/pws_reward_historic_product_get/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Product Reward Historic - This web service allows to get history of reward applied to product",
"operationId" : "pws_reward_historic_product_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetProdutRewardHistoryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductRewardHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_historic_product_get"
}
},
"/pws/pws_reward_current_group_create/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Activate Group Reward - This web service allow us to apply reward at group level",
"operationId" : "pws_reward_current_group_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyGroupRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyGroupRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_group_create"
}
},
"/pws/pws_reward_current_group_edit/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Update Group Reward - This web service allows to update existing reward applied to group ",
"operationId" : "pws_reward_current_group_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyGroupRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateGroupRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_group_edit"
}
},
"/pws/pws_reward_current_group_get/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Group Reward- This web service allows to get reward applied to group",
"operationId" : "pws_reward_current_group_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetGroupRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_group_get"
}
},
"/pws/pws_reward_historic_group_get/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Group Reward Historic - This web service allows to get history of reward applied to group",
"operationId" : "pws_reward_historic_group_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetGroupRewardHistoryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupRewardHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_historic_group_get"
}
},
"/pws/pws_reward_current_account_create/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Activate Account Reward - This web service allows us to apply reward at account level",
"operationId" : "pws_reward_current_account_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyAccountRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyAccountRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_account_create"
}
},
"/pws/pws_reward_current_account_edit/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "Update Account Reward - This web service allows to update reward configuration applied at account level",
"operationId" : "pws_reward_current_account_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyAccountRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateAccountRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_account_edit"
}
},
"/pws/pws_reward_current_account_get/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Account Reward-This web service allows to get reward applied at account level",
"operationId" : "pws_reward_current_account_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountRewardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountRewardResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_current_account_get"
}
},
"/pws/pws_reward_historic_account_get/" : {
"post" : {
"tags" : [ "Reward" ],
"summary" : "View Account Reward Historic-This web service allows to get history of reward applied at account level",
"operationId" : "pws_reward_historic_account_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountRewardHistoryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountRewardHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_reward_historic_account_get"
}
},
"/pws/pws_create_account/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Create account -<ul>\n<li class=\"docBullet\">Allows to create&nbsp;an account in the Paymentology ledger.</li>\n<li class=\"docBullet\">The user can, optionally, create an external reference for this account should they require.</li>\n<li class=\"docBullet\">All accounts must sit within an account hierarchy in the ledger. This means that a parent account must be provided by the user.</li>\n<li class=\"docBullet\">The new account is then a child of the parent account.</li>\n<li class=\"docBullet\">This hierarchy is beneficial to the user as it allows accounts to be related as wallets and allows for reporting at multiple hierarchy levels.</li>\n</ul>",
"operationId" : "pws_create_account",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CreateAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateAccountResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_account"
}
},
"/pws/pws_account_edit/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Edit account - <ul><li class=\"docBullet\">Allows the user to edit critical elements of the account.</li><li class=\"docBullet\">Due to historic computation associated with account currencies and relationships to parent accounts, the only editable elements are ac_ext_ref,account_name and ac_desc</li>\n</ul>\n<p>&nbsp;</p>",
"operationId" : "pws_account_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/EditAccountResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_account_edit"
}
},
"/pws/pws_get_account/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Get account Details- <ul>\n<li class=\"docBullet\">Allows for retrieval of account details by passing in account id</li>\n<li class=\"docBullet\">All fields relating to the account are returned</li></ul>",
"operationId" : "pws_get_account",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountDetailResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account"
}
},
"/pws/pws_account_list/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Get account list - <ul>\n<li class=\"docBullet\">Allows for retrieval of a list of all child accounts of an account or list all account of provided customer id.</li>\n<li class=\"docBullet\">A simple list of all child account id&rsquo;s and their names, descriptions and billing currencies are returned.</li>\n<li class=\"docBullet\">\"ac_id\" or \"cu_id\" any one of the parameter needs to be provided. If both fields are provided than \"ac_id\" will have precedence and response will return the details of account mentioned in \"ac_id\" and all accounts where \"ac_id\" is a parent account</li>\n</ul>",
"operationId" : "pws_account_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AccountListModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AccountListResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_account_list"
}
},
"/pws/pws_get_acc_status/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Get account Status - \n<ul>\n<li class=\"docBullet\">Allows to retrieve account status</li>\n<li class=\"docBullet\">Pass account id and get account status in response</li></ul>",
"operationId" : "pws_get_acc_status",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountStatusResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_acc_status"
}
},
"/pws/pws_get_balance/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Get Balance - <p>Token or account number can be passed in. In the case where token is passed, the balance of the account to which the token is related to by default, is returned.<br />Provision is made for four balances to be returned :</p>\n<ol>\n<li class=\"docBullet\">Total blocked amount (bal_blk_amt)</li>\n<li class=\"docBullet\">Total Settled amount (bal_act_amt)</li>\n<li class=\"docBullet\">Total pending amount (bal_pnd_amt)</li>\n<li class=\"docBullet\">Total Available amount (bal_avail_amt)</li>\n</ol>\n<p>Note: Pending amounts are amounts that may be &lsquo;in progress&rsquo; to the account but not cleared for use (eg a chaps transfer, or chargeback refund).</p>",
"operationId" : "pws_get_balance",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetBalanceModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetBalanceResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_balance"
}
},
"/pws/pws_get_statement/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Get statement - Allows for retrieval of statement based on input of token/account and a time range. ",
"operationId" : "pws_get_statement",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StatementModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetStatementResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_statement"
}
},
"/pws/pws_load_balance/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Load Balance - Allows user to load or unload an amount onto an account. Token or account id can be passed in. In the event that token is passed, then the account to which the token is linked by default is credited. Note: it is normal to load/unload in the billing currency of the account. However, this web service offers scope for FX conversion during the load/unload process. Conversion rates are live within the platform and controllable by the user on various bases. A load/unload fee can also be accommodated. It is important to note that the user has control over how this fee impacts account/card balance. See description in load_fee_type field for further details",
"operationId" : "pws_load_balance",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LoadBalanceModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/LoadBalanceResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_load_balance"
}
},
"/pws/pws_set_acc_status/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Set account Status - user passes in account id and a new status to supersede current status. Status descriptions are provided in ac_status field below.\nNote: account status is different to card/token status.\n",
"operationId" : "pws_set_acc_status",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SetAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetAccountStatusResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_acc_status"
}
},
"/pws/pws_set_default_card_account/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Set Default card account - This API allows a card to have a new default account assigned. Fields should be self-explanatory below.",
"operationId" : "pws_set_default_card_account",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DefaultCardAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetDefaultCardAccountResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_default_card_account"
}
},
"/pws/pws_update_balance/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Update account Balance - Allows user to update individual account’s balances. Token or account id can be passed in. In the event that token is passed, then the account to which the token is linked by default is updated. This API is useful mainly for clients whose products are enabled for Stand In Processing (STIP).",
"operationId" : "pws_update_balance",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/UpdateBalanceModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateBalanceResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_update_balance"
}
},
"/pws/pws_fund_transfer/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Transfer fund - This API allows to transfer fund between two cards or accounts",
"operationId" : "pws_fund_transfer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FundTransferModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetDefaultCardAccountResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_fund_transfer"
}
},
"/pws/pws_block_load/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Load Block Unblock - Allows user to either block load or unblock load functionality",
"operationId" : "pws_block_load",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/BlockLoadModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/BlockLoadModelResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_block_load"
}
},
"/pws/pws_credit_financial_adjustment/" : {
"post" : {
"tags" : [ "Account" ],
"summary" : "Financial Adjustment - Allows user to post a debit or a credit on the account. Token or account id can be passed in. In the event that token is passed, then the account to which the token is linked by default is credited.\nFor the Post Debit we can perform:<ul><li>Debit Balance Adjustment</li><li>Balance Transfer</li><li>Third Party Bill Payment</li></ul>\nSimilarly, for the Post Credit we can perform:<ul><li>Credit Card Payment</li><li>Credit Balance Adjustment</li> </ul>",
"operationId" : "pws_credit_financial_adjustment",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PostTransactionModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreditFinancialAdjustmentResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_credit_financial_adjustment"
}
},
"/pws/pws_card_holder_edit/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Edit Card Holder Details - This API provides the ability to edit cardholder details and delivery details for a card by passing the client id and token details",
"operationId" : "pws_card_holder_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/UpdateCardDetailsModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateCardDetailsResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_card_holder_edit"
}
},
"/pws/pws_tok_flag_edit/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Edit card's Tok Flags - This web service allows for the editing of the flags set against a token that determines how the card will behave once created, activated, and used.The flags are checked prior to processing a transaction and before processing any rule.",
"operationId" : "pws_tok_flag_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/TokFlagEditModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/TokFlagEditResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_tok_flag_edit"
}
},
"/pws/pws_enroll_3ds/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Enroll Card To 3DS - <ul><li class=\"docBullet\">This web service enables the enrolment of a card for 3D-Secure service as configured for the specific product.</li><li class=\"docBullet\">Currently supported ACS Provider are :<ul><li>TouchTech(Stripe)</li><li>FSS</li></ul></li><li class=\"docBullet\">This Api is also used to update card Holder details at FSS side.</li><li class=\"docBullet\">To update email and mobile number with FSS:<ol><li>Call <a href=\"#operation/pws_card_holder_edit\">Edit Card Holder Details API </a></li><li>Call Enroll card To 3DS API to update card holder email &amp; mobile number with FSS</li></ol></li><li class=\"docBullet\">To update card holder detail with TouchTech(Stripe) client has to call Stripe API directly</li></ul>",
"operationId" : "pws_enroll_3ds",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Enroll3DSModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Enroll3DSResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_enroll_3ds"
}
},
"/pws/pws_generate_card_file/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Generate Card File - <ul><li class=\"docBullet\">The webservice allows for the regeneration of a card Personalization file that was previously generated as a batch and sent to the respective card Manafucturer.</li><li class=\"docBullet\">The file is recreated and placed in the SFTP directory as specified for the batch job.</li><li class=\"docBullet\">You must grant additional permission to use this API - please discuss it with your Implementation Manager.</li></ul>",
"operationId" : "pws_generate_card_file",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GenerateFileModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_generate_card_file"
}
},
"/pws/pws_get_card_detail/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Card Details - This web service retrieves card holder details, token flag details and descriptions. Pass a public token and client ID, to retrieve card details.",
"operationId" : "pws_get_card_detail",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CardDetailsModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCardDetailsResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_card_detail"
}
},
"/pws/pws_card_history/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Card History - This web service gets the full audit history of a card (load card, get balance, set/get status) over a specified time period ",
"operationId" : "pws_card_history",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CardHistoryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CardHistoryResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_card_history"
}
},
"/pws/pws_get_card_image/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Card Image - This web service provides the card image based on public token provided and the card details specified in the call viz. PAN, CVV, expiry or image details. <br /> Note : Encrypted Pan/image returned will be AES encrypted by client Processing key (CP-Key)",
"operationId" : "pws_get_card_image",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CardImageModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCardImageResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_card_image"
}
},
"/pws/pws_card_list/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Card list - This web service retrieves a list of all cards linked to an account or parent account",
"operationId" : "pws_card_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CardListModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CardListResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_card_list"
}
},
"/pws/pws_get_card_status/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Card Status - This web service retrieves the current card status",
"operationId" : "pws_get_card_status",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetCardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCardStatusResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_card_status"
}
},
"/pws/pws_get_pan_number/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Pan Number - <p>This web service retrieves the PAN number for a specified token.<br /> The PAN number is retrieved based on the following options:</p>\n<ul>\n<li class=\"docBullet\">2 = first six digits</li>\n<li class=\"docBullet\">3 = last four digits</li>\n<li class=\"docBullet\">4 = first 6 + last 4 digits</li>\n</ul>",
"operationId" : "pws_get_pan_number",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetPanModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetPanNumberResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_pan_number"
}
},
"/pws/pws_perso_data/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Get Perso Data Of Card - This web service retrieves Personalization Data for a specific card (token) as was included in the original personalization file sent to the card manufacturer. Personalization Data will be AES encrypted by client processing key(CP Key).",
"operationId" : "pws_perso_data",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PersoDataModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PersoDataResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_perso_data"
}
},
"/pws/pws_link_card_acc/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Link Card And account - This web service allows to link card and accounts.",
"operationId" : "pws_link_card_account",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LinkAccountCardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/LinkAccountCardResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_link_card_account"
}
},
"/pws/pws_linked_acc_card_list/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "List Accounts Linked To Card - This web service allows to get list of accounts linked with card token.",
"operationId" : "pws_linked_acc_card_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ListCardLinkedAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CardListResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_linked_acc_card_list"
}
},
"/pws/pws_card_renewal/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Renew Card - <p>This web service creates a new card and maintains a reference to the old one when one of the following actions is required :</p>\n<ol>\n<li class=\"docBullet\">Replacement (new pan + new token + new expiry generated).</li>\n<li class=\"docBullet\">Renew (old pan + old token + new expiry generated)</li>\n</ol>\n<p>A reason for the replacement is also required and recorded against the renewal action.</p>",
"operationId" : "pws_card_renewal",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CardRenewModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CardRenewResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_card_renewal"
}
},
"/pws/pws_card_renewal_v3/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Renew Card V3 - <p>This web service creates a new card and maintains a reference to the old one when one of the following actions is required :</p>\n<ol>\n<li class=\"docBullet\">Replacement (new pan + new token + new expiry generated).</li>\n<li class=\"docBullet\">Renew (old pan + old token + new expiry generated)</li>\n</ol>\n<p>A reason for the replacement is also required and recorded against the renewal action.</p>",
"operationId" : "pws_card_renewal_v3",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CardRenewModelV3"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CardRenewResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_card_renewal_v3"
}
},
"/pws/pws_set_card_status/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Set Card Status - This web service sets the status for a token(card) and verifies the system and network status of a card. This can be used in changing the status of a card while card is still in use or alternatively when the card is renewed.",
"operationId" : "pws_set_card_status",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SetCardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetCardStatusResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_card_status"
}
},
"/pws/pws_set_default_ccy/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Set Default ccy - This webservice allows for the setting of the default currency for the card ",
"operationId" : "pws_set_default_ccy",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SetDefaultCcyModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/LinkAccountCardResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_default_ccy"
}
},
"/pws/pws_virtual_to_physical/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Virtual Card To Physical Card Conversion - The webservice allows for the conversion of a virtual card to a physical card and creates the file for the card manufacturer which is placed in the SFTP directory as specified for the specific product.",
"operationId" : "pws_virtual_to_physical",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/VirtualToPhysicalModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_virtual_to_physical"
}
},
"/pws/pws_group_create/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Create group - This web service allows to create group.",
"operationId" : "pws_group_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CreateGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateGroupResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_group_create"
}
},
"/pws/pws_create_product_group_template/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Create product group Template - This API allows to set default group template for product.New created card/account of product will inherit the group from this template created.",
"operationId" : "pws_create_product_group_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CreateProductGroupTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_product_group_template"
}
},
"/pws/pws_group_edit/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Edit group - This web service allows to edit group.",
"operationId" : "pws_group_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_group_edit"
}
},
"/pws/pws_edit_product_group_template/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Edit product group Template - This web service allows to edit default group template for product.",
"operationId" : "pws_edit_product_group_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditProductGroupTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_edit_product_group_template"
}
},
"/pws/pws_group_list/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "View group - This web service allows to list group.",
"operationId" : "pws_group_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ListGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GroupListResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_group_list"
}
},
"/pws/customerservice/v3/search/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Search V3- Provides the ability to search for tokens based on Account PAN, Token Unique Reference, Token, Payment App Instance Id or Comment Id.",
"operationId" : "pws_mea_cs_search",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SearchInternal"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_cs_search"
}
},
"/pws/customerservice/v3/token/activate/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Token Activate- Used to activate a token for a digitization that has been approved and provisioned, but requires additional cardholder authentication prior to activation. ",
"operationId" : "pws_mea_cs_token_activate",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SearchInternal"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_cs_token_activate"
}
},
"/pws/customerservice/v3/token/update/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Token Update- Used to update Account PAN Mapping Information or Issuer Product Configuration ID associated to an already provisioned token.",
"operationId" : "pws_mea_cs_token_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SearchInternal"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_cs_token_update"
}
},
"/pws/customerservice/v3/token/suspend/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Token Suspend - Used to suspend an active token so that it may not initiate any new transactions. All authorizations for a suspended token will be declined.",
"operationId" : "pws_mea_cs_token_suspend",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SearchInternal"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_cs_token_suspend"
}
},
"/pws/customerservice/v3/token/unsuspend/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Token Unsuspend - Used to unsuspend or resume a suspended token and return it to the active state where it may initiate new transactions.",
"operationId" : "pws_mea_cs_token_unsuspend",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SearchInternal"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_cs_token_unsuspend"
}
},
"/pws/customerservice/v3/token/delete/" : {
"post" : {
"tags" : [ "Tokenization (Beta)" ],
"summary" : "Token Delete - Used to delete a token so that it may not initiate any new transactions. All authorizations for a deleted token will be declined. A deleted token may not be returned to an active state.",
"operationId" : "pws_mea_cs_token_delete",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SearchInternal"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_mea_cs_token_delete"
}
},
"/sc/sc_get_cvv2/" : {
"post" : {
"tags" : [ "Card PaySecure WS" ],
"summary" : "Get Cvv2 - <ul>\n<li class=\"docBullet\">This web service allows to get CVV2 for a card/token.</li>\n<li class=\"docBullet\">Pass the public token and the API will retrieve back AES encrypted CVV2.</li>\n</ul>",
"operationId" : "api-sc_get_cvv2",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Session-Id",
"in" : "header",
"description" : "Session Id for Current Request - 32 byte AES key encrypted by RSA Public Key passed in Header in every PaySecure API call.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PSGetCvv2Model"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCVV2Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "sc_get_cvv2"
}
},
"/sc/sc_get_pan/" : {
"post" : {
"tags" : [ "Card PaySecure WS" ],
"summary" : "Get Pan - <ul>\n<li class=\"docBullet\">This web service allows to get the PAN for a card/token.</li>\n<li class=\"docBullet\">Pass the public token and the API will retrieve back the AES encrypted PAN.</li>\n</ul>",
"operationId" : "api-sc_get_pan",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Session-Id",
"in" : "header",
"description" : "Session Id for Current Request - 32 byte AES key encrypted by RSA Public Key passed in Header in every PaySecure API call.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PSGetPanModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetPanResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "sc_get_pan"
}
},
"/sc/sc_get_pin/" : {
"post" : {
"tags" : [ "Card PaySecure WS" ],
"summary" : "Get pin - <ul>\n<li class=\"docBullet\">This web service allows to get the PIN for a card/token.</li>\n<li class=\"docBullet\">Pass the public token and the API will retrieve back the AES encrypted pin.</li>\n<li class=\"docBullet\">Also pass the AES encrypted CVV2 for security purposes.</li>\n</ul>",
"operationId" : "api-sc_get_pin",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Session-Id",
"in" : "header",
"description" : "Session Id for Current Request - 32 byte AES key encrypted by RSA Public Key passed in Header in every PaySecure API call.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PSGetPinModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PaySecureGetPinResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "sc_get_pin"
}
},
"/sc/sc_set_pin/" : {
"post" : {
"tags" : [ "Card PaySecure WS" ],
"summary" : "Set pin - <ul>\n<li class=\"docBullet\">This web service allows set pin for a card/token.</li>\n<li class=\"docBullet\">&nbsp;client should pass AES encrypted pin&nbsp; to api.</li>\n<li class=\"docBullet\">Weak&nbsp;PINs would not be accepted/ \"Weak PIN\" means with repeated integers (xxxxx, yyyy, zzzzz) and also the serial integers (1234, 4289); more info. contact Paymentology</li>\n</ul>",
"operationId" : "api-sc_set_pin",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Session-Id",
"in" : "header",
"description" : "Session Id for Current Request - 32 byte AES key encrypted by RSA Public Key passed in Header in every PaySecure API call.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PSSetPinModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PaySecureSetPinResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "sc_set_pin"
}
},
"/sc/sc_pin_verify/" : {
"post" : {
"tags" : [ "Card PaySecure WS" ],
"summary" : "Verify pin - <ul>\n<li class=\"docBullet\">This web service allows to verify the PIN for the provided PAN.</li>\n<li class=\"docBullet\">Pass the AES encrypted PIN&nbsp; &amp; PAN to the API.</li>\n</ul>",
"operationId" : "api-sc_pin_verify",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Session-Id",
"in" : "header",
"description" : "Session Id for Current Request - 32 byte AES key encrypted by RSA Public Key passed in Header in every PaySecure API call.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PSVerifyPinModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PaySecurePinVerifyResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "sc_pin_verify"
}
},
"/sc/sc_pan_to_token/" : {
"post" : {
"tags" : [ "Card PaySecure WS" ],
"summary" : "Pan To Token - <ul>\n<li class=\"docBullet\">This web service allows to get token for the provided PAN.</li>\n<li class=\"docBullet\">Pass the AES encrypted PAN,EXPIRY &amp; CVV2 to the API.</li>\n<li class=\"docBullet\">Expiry must be in YYMM format before encryption.</li></ul>",
"operationId" : "api-sc_pan_to_token",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Session-Id",
"in" : "header",
"description" : "Session Id for Current Request - 32 byte AES key encrypted by RSA Public Key passed in Header in every PaySecure API call.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PsPanToToken"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PaySecurePanToTokenResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "sc_pan_to_token"
}
},
"/pws/pws_load_unload_alert_edit/" : {
"post" : {
"tags" : [ "Rules action" ],
"summary" : "Edit Load Alert action - This web service is used to edit load alert action",
"operationId" : "pws_load_unload_alert_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LoadAlertEditModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_load_unload_alert_edit"
}
},
"/pws/pws_rule_create_basic/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Create Basic Velocity Rule - <p>This web service allows to set limits for restricting ATM and ECOM transactions like :</p>\n<ul>\n<li class=\"docBullet\">Daily ATM Cash Limit</li>\n<li class=\"docBullet\">Weekly ATM Cash Limit</li>\n<li class=\"docBullet\">Monthly ATM Cash Limit</li>\n<li class=\"docBullet\">Yearly ATM Cash Limit</li>\n<li class=\"docBullet\">Daily ECOM Limit</li>\n<li class=\"docBullet\">Weekly ECOM Limit</li>\n<li class=\"docBullet\">Monthly ECOM Limit</li>\n<li class=\"docBullet\">Yearly ECOM Limit</li>\n<li class=\"docBullet\">Daily ATM Txn Count</li>\n<li class=\"docBullet\">Daily POS Txn Count</li>\n<li class=\"docBullet\">Daily ECOM Txn Count</li>\n<li class=\"docBullet\">Daily MOTO Txn Count</li>\n</ul>",
"operationId" : "pws_rule_create_basic",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CreateBasicRuleModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateRuleResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_rule_create_basic"
}
},
"/pws/pws_financial_rules/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Create Financial Rules - <p>This web service allows to set&nbsp;Limits for restricting ATM and ECOM transactions like :</p>\n<ul>\n<li class=\"docBullet\">Daily ATM Cash Limit</li>\n<li class=\"docBullet\">Weekly ATM Cash Limit</li>\n<li class=\"docBullet\">Monthly ATM Cash Limit</li>\n<li class=\"docBullet\">Yearly ATM Cash Limit</li>\n<li class=\"docBullet\">Daily ECOM Limit</li>\n<li class=\"docBullet\">Weekly ECOM Limit</li>\n<li class=\"docBullet\">Monthly ECOM Limit</li>\n<li class=\"docBullet\">Yearly ECOM Limit</li>\n<li class=\"docBullet\">Daily ATM Txn Count</li>\n<li class=\"docBullet\">Daily POS Txn Count</li>\n<li class=\"docBullet\">Daily ECOM Txn Count</li>\n<li class=\"docBullet\">Daily MOTO Txn Count</li>\n</ul>",
"operationId" : "pws_financial_rules",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FinancialRuleModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateRuleResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_financial_rules"
}
},
"/pws/pws_other_rules/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Create Rules Advanced - This web service allows to create different types of advanced rules.",
"operationId" : "pws_other_rules",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CreateRulesModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateRuleResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_other_rules"
}
},
"/pws/pws_enable_disable_rules/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Enable/Disable Rule Check for card - This API allows to Enable/Disable rule check.",
"operationId" : "pws_enable_disable_rules",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EnableDisableRulesModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_enable_disable_rules"
}
},
"/pws/pws_edit_rules/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Edit Rules Advanced - This web service allows to edit rules details.",
"operationId" : "pws_rules_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditRulesModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_rules_edit"
}
},
"/pws/pws_manage_rulegroup/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Manage Rule Group - This web service allows to Link/unlink/view groups to a card.",
"operationId" : "pws_manage_rulegroup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ManageRuleGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ManageRuleGroupResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_manage_rulegroup"
}
},
"/pws/pws_list_rules/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "List Rules - This web service allows to list different rules at different levels i.e card, account, group and rule id.",
"operationId" : "pws_rules_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ListRulesModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ListRulesResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_rules_list"
}
},
"/pws/pws_account_limit/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Set Account Limit - <ul><li class=\"docBullet\">This API allows to set account Limit.</li><li class=\"docBullet\">account limits are set up to limit the amount and frequency of transactions for a particular account.</li><li class=\"docBullet\">account Limits are set by the bank but they can be adjusted by the cardholder to lower the amount and the frequency of transactions allowed. For example, if the weekly limit for domestic ATM withdrawal is set to 5,000 USD and 3 transactions per week, the cardholder can further restrict it by decreasing the amount, for example, to 3,000 USD, and the number of transactions to 2 per week. The cardholder however cannot increase the amount or transaction frequency.</li><li class=\"docBullet\">Fields with&nbsp; suffix _bn_lim or just _bn are Limits to set by the Bank .</li><li class=\"docBullet\">Fields with suffix _ch_lim or just _ch are Limits to set by the card holder.</li></ul>",
"operationId" : "pws_account_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AccountLimitModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_account_limit"
}
},
"/pws/pws_advanced_rules/" : {
"post" : {
"tags" : [ "Rules" ],
"summary" : "Create Basic Rule- This web service allows to create different types of advanced rules.",
"operationId" : "pws_advanced_rules",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AdvancedRules"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateRuleResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_advanced_rules"
}
},
"/pws/pws_wallet_account/" : {
"post" : {
"tags" : [ "wallet" ],
"summary" : "Create wallet account-<ul>\n<li class=\"docBullet\">Allows to create&nbsp;an account in the Paymentology ledger.</li><li class=\"docBullet\">The user can, optionally, create an external reference for this account should they require.</li>\n<li class=\"docBullet\">All accounts must sit within an account hierarchy in the ledger. This means that a parent account must be provided by the user.</li>\n<li class=\"docBullet\">The new account is then a child of the parent account.</li>\n<li class=\"docBullet\">This hierarchy is beneficial to the user as it allows accounts to be related as wallets and allows for reporting at multiple hierarchy levels.</li>\n</ul>",
"operationId" : "pws_wallet_account",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WalletAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateWalletAccountResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_wallet_account"
}
},
"/pws/pws_wallet_card/" : {
"post" : {
"tags" : [ "wallet" ],
"summary" : "Create wallet card - <p>This web service is used to create a card. To create a card an account needs to be created first as a card has a one to one relationship with an account.</p>\n<ul>\n<li class=\"docBullet\" >Cards can be created as either physical or virtual cards with a variety of images that have been predefined and loaded per client. When calling the create card the option to return pan, cvv, expiry, public token, card image can be used to allow for the display of the card image with all details post card creation.</li>\n<li class=\"docBullet\" >It is essential that the correct product ID is provided. </span></li>\n<li class=\"docBullet\" >At the time of card creation, you can select the status of the card, typically set to Decline All Txns DE39=05 until the card holder activates the card. card holder details are provided at the time of card creation to populate the card holder details and to provide these as part of the card personalization process (physical card only).</li>\n<li class=\"docBullet\" >At creation the card can be loaded with funds in accordance with the specific product settings. </span></li>\n<li class=\"docBullet\" >These inputs are used for creating cards for sub clients/customers under a generic client. Sub clients/customers do not have products or bins of their own and will inherit from parent client, post card creation. </li>\n<li class=\"docBullet\" >The characteristics (tok_flag) of the card can be set at the card create stage and this determines how the card will behave once created, activated, and used.</span></li>\n</ul>",
"operationId" : "pws_wallet_card",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WalletCardModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/WalletCardResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_wallet_card"
}
},
"/pws/pws_cr_create_interest_template/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Create Interest - This web service creates a new credit interest. The interest will still need to be applied to a context using Activate interest",
"operationId" : "pws_cr_create_interest_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreateInterestTemplate"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_create_interest_template"
}
},
"/pws/pws_cr_update_interest_template/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Update Interest Template - This web service updates a given interest",
"operationId" : "pws_cr_update_interest_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsUpdateInterestTemplate"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_update_interest_template"
}
},
"/pws/pws_cr_get_current_interest_template/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Current Interests - This web service gets the details of a interest that was applied and is still active",
"operationId" : "pws_cr_get_current_interest_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetCurrentInterestTemplate"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetInterestTemplateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_get_current_interest_template"
}
},
"/pws/pws_cr_get_interest_historic/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Interest History- This web service gets the history of an interest that was applied but is no longer active",
"operationId" : "pws_cr_get_interest_historic",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetInterestTemplateHistory"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetInterestTemplateHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_get_interest_historic"
}
},
"/pws/pws_cr_interest_current_product_create/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Activate Product Interest - This web service applies interests to product",
"operationId" : "pws_cr_interest_current_product_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyInterestOnProduct"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyInterestatProductResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_product_create"
}
},
"/pws/pws_cr_interest_current_product_update/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Update Product Interest - This web service update interests for product",
"operationId" : "pws_cr_interest_current_product_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyInterestOnProduct"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateProductInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_product_update"
}
},
"/pws/pws_cr_interest_current_product_get/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Product Interests - This web service gets the interests applied to the given product",
"operationId" : "pws_cr_interest_current_product_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetCurrentProductInterest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_product_get"
}
},
"/pws/pws_cr_interest_history_product_get/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Product Interest History - This web service gets history of interests applied to the given product",
"operationId" : "pws_cr_interest_history_product_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetProductInterestHistory"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductInterestHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_history_product_get"
}
},
"/pws/pws_cr_interest_current_account_create/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Activate Account Interest - This web service applies interests to account",
"operationId" : "pws_cr_interest_current_account_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyInterestOnAccount"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyAccountInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_account_create"
}
},
"/pws/pws_cr_interest_current_account_update/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Update Account Interest - This web service update interests for account",
"operationId" : "pws_cr_interest_current_account_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyInterestOnAccount"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateAccountInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_account_update"
}
},
"/pws/pws_cr_interest_current_account_get/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Account Interests - This web service gets the interests applied to the given product",
"operationId" : "pws_cr_interest_current_account_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountInterest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_account_get"
}
},
"/pws/pws_cr_interest_history_account_get/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Account Interest History - This web service gets the interests applied to the given account history",
"operationId" : "pws_cr_interest_history_account_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountInterestHistory"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountInterestHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_history_account_get"
}
},
"/pws/pws_cr_interest_current_group_create/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Activate Group Interest - This web service applies interests to group",
"operationId" : "pws_cr_interest_current_group_create",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyInterestOnGroup"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyGroupInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_group_create"
}
},
"/pws/pws_cr_interest_current_group_update/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Update Group Interest - This web service update interests for group",
"operationId" : "pws_cr_interest_current_group_update",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyInterestOnGroup"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateGroupInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_group_update"
}
},
"/pws/pws_cr_interest_current_group_get/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Group Interests - This web service gets the interests applied to the given group",
"operationId" : "pws_cr_interest_current_group_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetGroupInterest"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupInterestResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_current_group_get"
}
},
"/pws/pws_cr_interest_history_group_get/" : {
"post" : {
"tags" : [ "Credit Interest" ],
"summary" : "Get Group Interest History - This web service gets the history of interests applied to the given group",
"operationId" : "pws_cr_interest_history_group_get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetGroupInterestHistory"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupInterestHistoryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_cr_interest_history_group_get"
}
},
"/pws/pws_action_alert/" : {
"post" : {
"tags" : [ "Rules action" ],
"summary" : "Create Alert action- This API is used to create alert action that can be applied to different rule.",
"operationId" : "pws_action_alert",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AlertActionModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateActionResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_action_alert"
}
},
"/pws/pws_action_decline/" : {
"post" : {
"tags" : [ "Rules action" ],
"summary" : "Create Decline action - This web service is used to create decline action",
"operationId" : "pws_action_decline",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DeclineActionModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateActionResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_action_decline"
}
},
"/pws/pws_action_list/" : {
"post" : {
"tags" : [ "Rules action" ],
"summary" : "list action - This API is used to list the action that are applied to group or rule",
"operationId" : "pws_action_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ListActionModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ListActionResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_action_list"
}
},
"/pws/pws_action_alert_edit/" : {
"post" : {
"tags" : [ "Rules action" ],
"summary" : "Edit Alert action - This web service is used to edit alert action",
"operationId" : "pws_action_alert_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditAlertActionModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_action_alert_edit"
}
},
"/pws/pws_action_decline_edit/" : {
"post" : {
"tags" : [ "Rules action" ],
"summary" : "Edit Decline action - This web service is used to edit decline action",
"operationId" : "pws_action_decline_edit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditDeclineActionModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_action_decline_edit"
}
},
"/pws/pws_get_pin/" : {
"post" : {
"tags" : [ "Pin" ],
"summary" : "Get pin - This web service provides the ability to retrieve a PIN for a card/token. The encrypted pin is returned, or the PIN is sent via SMS to the cardholder.Note: The sending of the PIN via SMS requires that a valid mobile number be included during the card create process ",
"operationId" : "pws_get_pin",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PinModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetPinResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_pin"
}
},
"/pws/pws_set_pin/" : {
"post" : {
"tags" : [ "Pin" ],
"summary" : "Set pin - <p>This web service provides the ability to set the PIN for a card/token. An encrypted PIN (encrypted with client processing key (CP Key)) is required and needs to meet PIN criteria of strength i.e.</p>\n<ul><li class=\"docBullet\">No simple number sequences like 1234, 0000</li>\n<li class=\"docBullet\">No repeated number like 1111,22222</li>\n<li class=\"docBullet\">Minimum length of 4 digit only</li>\n<li class=\"docBullet\">Maximum length of 12 digit only</li>\n</ul> <h3>Epin Generation Java Example</h3>\n<pre><code>\nString cpkey=\"34df95e9ef7cd3f79c118022a7ef379c\"; //CPkey is sent in email during client create\nString pin=\"5296\";\nSecretKey secretKey = new SecretKeySpec(hexStringToByteArray(cpkey), \"AES\");\nCipher cipher = Cipher.getInstance(\"AES/ECB/ZeroBytePadding\",new BouncyCastleProvider());\ncipher.init(Cipher.ENCRYPT_MODE, secretKey);\nbyte[] bytedata=cipher.doFinal(pin.getBytes());\nString epin=byteArrayToHexString(bytedata);\n\n//Function To Convert Hex String to Byte Array \npublic static byte[] hexStringToByteArray(String Hex) { \nint len = Hex.length(); \nbyte[] data = new byte[len / 2]; \nfor(int i = 0; i &lt; len; i += 2) { \ndata[i / 2] = (byte)((Character.digit(Hex.charAt(i), 16) &lt;&lt; 4) + Character.digit(Hex.charAt(i + 1), 16)); \n} \nreturn data; \n}\n\n//Function To Convert Byte Array to Hex String \npublic static String byteArrayToHexString(byte[] bytes) { \nchar[] hexChars = new char[bytes.length * 2]; \nfor(int j = 0; j &lt; bytes.length; ++j) { \nint v = bytes[j] &amp; 255; \nhexChars[j * 2] = hexArray[v &gt;&gt;&gt; 4]; \nhexChars[j * 2 + 1] = hexArray[v &amp; 15]; \n} \nreturn new String(hexChars); \n}</code></pre>",
"operationId" : "pws_set_pin",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SetPinModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetPinResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_pin"
}
},
"/pws/pws_pin_unblock/" : {
"post" : {
"tags" : [ "Pin" ],
"summary" : "Unblock pin - This web service provides the ability to unblock a PIN for a token(card). PIN is blocked after 3 failed attempts ",
"operationId" : "pws_pin_unblock",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PinUnblockModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PinUnblockResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_pin_unblock"
}
},
"/pws/pws_ping_api/" : {
"post" : {
"tags" : [ "Ping" ],
"summary" : "Ping Api",
"operationId" : "api-ApiPing",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/PingResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_ping_api"
}
},
"/pws/pws_transaction_list/" : {
"post" : {
"tags" : [ "Transaction" ],
"summary" : "List Transaction-This web service retrieves back transaction list based on various filter applied. Filters : token, transaction type, transaction spend type, date etc",
"operationId" : "pws_transaction_list",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/TransactionListModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/TransactionListResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_transaction_list"
}
},
"/pws/pws_get_settlement/" : {
"post" : {
"tags" : [ "Transaction" ],
"summary" : "Get Settlement Data - This web service retrives back settlement data.",
"operationId" : "pws_get_settlement",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/GetSettlementModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetSettlementResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_settlement"
}
},
"/pws/pws_request_chargeback/" : {
"post" : {
"tags" : [ "Transaction" ],
"summary" : "Request chargeback - This web service allows to perform chargeback reqeust.",
"operationId" : "pws_request_chargeback",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RequestChargebackModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/RequestChargebackResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_request_chargeback"
}
},
"/pws/pws_create_customer" : {
"post" : {
"tags" : [ "Customer" ],
"summary" : "Create Customer -This web service creates a new customer/cardholder",
"operationId" : "pws_create_customer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCustomerModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CustomerCreateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_customer"
}
},
"/pws/pws_update_customer" : {
"post" : {
"tags" : [ "Customer" ],
"summary" : "Update Customer -This web service updates a customer's details",
"operationId" : "pws_update_customer",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EditCustomerModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CustomerCreateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_update_customer"
}
},
"/pws/pws_get_customer_details" : {
"post" : {
"tags" : [ "Customer" ],
"summary" : "Get Customer Details-This web service gets the customers details for the given search criteria",
"operationId" : "pws_get_customer_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetCustomerDetails"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCustomerDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_customer_details"
}
},
"/pws/pws_edit_contract_event" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Edit Contract Event-This web service allows to edit event for the given contract",
"operationId" : "pws_edit_contract_event",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsContractEventModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateContractEventResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_edit_contract_event"
}
},
"/pws/pws_get_contract_event" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Event-This web service allows to get contract event",
"operationId" : "pws_get_contract_event",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractEventResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_event"
}
},
"/pws/pws_create_contract_entry" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Create Contract Entry- This web service allows to create contract entry",
"operationId" : "pws_create_contract_entry",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsContractEntryModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateContractEntryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_contract_entry"
}
},
"/pws/pws_get_contract_entry" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Entry- This web service allows to get contract entry",
"operationId" : "pws_get_contract_entry",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractEntryResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_entry"
}
},
"/pws/pws_create_contract_template" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Create Contract Template- This web service allows to create contract template",
"operationId" : "pws_create_contract_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsContractTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateContractTemplateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_contract_template"
}
},
"/pws/pws_get_contract_template" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Template- This web service allows to get contract template",
"operationId" : "pws_get_contract_template",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetContractTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractTemplateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_template"
}
},
"/pws/pws_create_participant_roles" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Create Participant Roles- This web service allows to create participant roles for a contract",
"operationId" : "pws_create_participant_roles",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsParticipantRoleModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateParticipantRoleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_participant_roles"
}
},
"/pws/pws_get_participant_roles" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Participant Role- This web service allows to get contract participants role",
"operationId" : "pws_get_participant_roles",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ContractTemplateIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetParticipantRoleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_participant_roles"
}
},
"/pws/pws_set_contract_eligibility_criteria" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Set Contract Eligibility Criteria- This web service allows to set contract eligibility criteria",
"operationId" : "pws_set_contract_eligibility_criteria",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsSetContractEligibility"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetContractEligibilityResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_contract_eligibility_criteria"
}
},
"/pws/pws_get_contract_eligibility_criteria" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Eligibility Criteria- This web service allows to get contract eligibility criteria",
"operationId" : "pws_get_contract_eligibility_criteria",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ContractTemplateIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractEligibilityResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_eligibility_criteria"
}
},
"/pws/pws_set_contract_reference_objects" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Set Contract Reference Object- This web service allows to set contract reference object",
"operationId" : "pws_set_contract_reference_objects",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsSetReferenceObject"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetReferenceObjectResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_contract_reference_objects"
}
},
"/pws/pws_get_contract_reference_objects" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Reference Objects- This web service allows to get contract refrence objects",
"operationId" : "pws_get_contract_reference_objects",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ContractTemplateIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetRefrenceObjectResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_reference_objects"
}
},
"/pws/pws_set_contract_execution_entry" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Set Contract Execution Entry- This web service allows to set contract execution entry",
"operationId" : "pws_set_contract_execution_entry",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsContractExecutionEntry"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetContractExecutionResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_contract_execution_entry"
}
},
"/pws/pws_get_contract_execution_entry" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Execution Entry- This web service allows to get contract execution entry",
"operationId" : "pws_get_contract_execution_entry",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ContractTemplateIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractExecutionResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_execution_entry"
}
},
"/pws/pws_set_contract_stages" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Set Contract Stages- This web service allows to create contract stages",
"operationId" : "pws_set_contract_stages",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsSetContractStages"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/SetContractStagesResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_set_contract_stages"
}
},
"/pws/pws_get_contract_stages" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Stages-This web service allows to get contract stages",
"operationId" : "pws_get_contract_stages",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ContractTemplateIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractStageResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_stages"
}
},
"/pws/pws_get_contract_states" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract State- This web service allows to get contract states",
"operationId" : "pws_get_contract_states",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractStateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_states"
}
},
"/pws/pws_get_contract_status" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Status- This web service allows to get contract status",
"operationId" : "pws_get_contract_status",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetContractStatusResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contract_status"
}
},
"/pws/pws_apply_contract" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Apply Contract - This web service allows to apply contract for a given transaction",
"operationId" : "pws_apply_contract",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsApplyContractModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ApplyContractResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_apply_contract"
}
},
"/pws/pws_get_contracts" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract - This web service allows to get contract for given client",
"operationId" : "pws_get_contracts",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetContractsModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetClientContractResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_contracts"
}
},
"/pws/pws_get_client_contract" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Get Contract Details - This web service allows to get client contract details",
"operationId" : "pws_get_client_contract",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsContractIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/EnableProductContractResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_client_contract"
}
},
"/pws/pws_link_product_contract" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "Link Product Contract-This web service allows to link contract template and product",
"operationId" : "pws_link_product_contract",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsEnableProductContractModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/EnableProductContractResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_link_product_contract"
}
},
"/pws/pws_get_product_contract" : {
"post" : {
"tags" : [ "Contract" ],
"summary" : "View Product Contract-This web service allows to get contract template linked with the product",
"operationId" : "pws_get_product_contract",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetProductContractModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductContractResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_product_contract"
}
},
"/pws/pws_create_card/" : {
"post" : {
"tags" : [ "Card" ],
"summary" : "Create Card - <p>This web service is used to create a card(prepaid,debit,credit). To create a card an account needs to be created first as a card has a one to one relationship with an account.</p>\n<ul>\n<li class=\"docBullet\" >Cards can be created as either physical or virtual cards with a variety of images that have been predefined and loaded per client. When calling the create card the option to return pan, cvv, expiry, public token, card image can be used to allow for the display of the card image with all details post card creation.</li>\n<li class=\"docBullet\" >It is essential that the correct product ID is provided. </span></li>\n<li class=\"docBullet\" >At the time of card creation, you can select the status of the card, typically set to Decline All Txns DE39=05 until the card holder activates the card. card holder details are provided at the time of card creation to populate the card holder details and to provide these as part of the card personalization process (physical card only).</li>\n<li class=\"docBullet\" >At creation the card can be loaded with funds in accordance with the specific product settings. </span></li>\n<li class=\"docBullet\" >These inputs are used for creating cards for sub clients/customers under a generic client. Sub clients/customers do not have products or bins of their own and will inherit from parent client, post card creation. </li>\n<li class=\"docBullet\" >The characteristics (tok_flag) of the card can be set at the card create stage and this determines how the card will behave once created, activated, and used.</span></li>\n</ul><p>Note For Clients using FSS(3DS provider) adhere to FSS requirements.&nbsp;</p>\n<ul>\n<li class=\"docBullet\">\n<p>Cardholder name (ch_fname and ch_sname) - String minimum 2 and maximum 45 characters combined first and last name - only letters are acceptable&nbsp;</p>\n</li>\n<li class=\"docBullet\">\n<p>Mobile phone number(ch_mobilel) - only numbers without space (symbols are not acceptable) - must contain between 5 and 15 characters</p>\n</li>\n</ul>",
"operationId" : "pws_create_card",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CreditCardCreateModifiedModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateCardResponseModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_card"
}
},
"/pws/pws_create_account_credit_limit/" : {
"post" : {
"tags" : [ "Credit Limits" ],
"summary" : "Create Account Credit Limit - This web service creates a credit limit and optional overdraft for a card account. Optionally scope the limit and overdraft to a specific Merchant Category.",
"operationId" : "pws_create_account_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreditLimitAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AccountLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_account_credit_limit"
}
},
"/pws/pws_update_account_credit_limit/" : {
"post" : {
"tags" : [ "Credit Limits" ],
"summary" : "Update Account Credit Limit - This web service update a credit limit and optional overdraft for a card account. Optionally scope the limit and overdraft to a specific Merchant Category.",
"operationId" : "pws_update_account_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreditLimitAccountModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateAccountLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_update_account_credit_limit"
}
},
"/pws/pws_product_credit_limit/" : {
"post" : {
"tags" : [ "Credit Limits" ],
"summary" : "Create Product Credit Limit - This web service creates a credit limit and optional overdraft for a product. Optionally scope the limit and overdraft to a specific Merchant Category.",
"operationId" : "pws_product_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsProductCreditLimitModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_product_credit_limit"
}
},
"/pws/pws_update_product_credit_limit/" : {
"post" : {
"tags" : [ "Credit Limits" ],
"summary" : "Update Product Credit Limit - This web service update a credit limit and optional overdraft for a product. Optionally scope the limit and overdraft to a specific Merchant Category.",
"operationId" : "pws_update_product_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsProductCreditLimitModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UpdateProductCreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_update_product_credit_limit"
}
},
"/pws/pws_get_product_credit_limit/" : {
"post" : {
"tags" : [ "Credit Limits" ],
"summary" : "Get Product Credit Limit - This web service gets the credit limit and overdraft information for a given product",
"operationId" : "pws_get_product_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetProductLimitModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/ProductCreditResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_product_credit_limit"
}
},
"/pws/pws_get_account_credit_limit/" : {
"post" : {
"tags" : [ "Credit Limits" ],
"summary" : "Get Account Credit Limit - This web service gets the credit limit and overdraft information for a given account",
"operationId" : "pws_get_account_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountCreditModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountCreditLimitsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_credit_limit"
}
},
"/pws/pws_apply_account_grace_period/" : {
"post" : {
"tags" : [ "Credit Grace Periods" ],
"summary" : "Apply Account Grace Period - This web service applies a grace period to a given account interest rate or fee",
"operationId" : "pws_apply_account_grace_period",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountGraceperiodModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AddAccountGracePeriodResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_apply_account_grace_period"
}
},
"/pws/pws_get_account_grace_period/" : {
"post" : {
"tags" : [ "Credit Grace Periods" ],
"summary" : "Get Account Grace Period - This web service gets the grace period for the given account",
"operationId" : "pws_get_account_grace_period",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccountGrace"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AccountGracePeriodResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_grace_period"
}
},
"/pws/pws_get_account_balance_details/" : {
"post" : {
"tags" : [ "Credit Account Status" ],
"summary" : "Get Account Credit Balance Details - This web service gets the current credit balance details for the credit account",
"operationId" : "pws_get_account_balance_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreditAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountBalanceDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_balance_details"
}
},
"/pws/pws_get_credit_transaction_statement/" : {
"post" : {
"tags" : [ "Credit Account Status" ],
"summary" : "Get Credit Txn statement - This web service gets the credit transaction statement for the given account",
"operationId" : "pws_get_credit_transaction_statement",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetCreditBalanceDetailsModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_credit_transaction_statement"
}
},
"/pws/pws_get_account_credit_balance/" : {
"post" : {
"tags" : [ "Credit Account Status" ],
"summary" : "Get Account Credit Balance - This web service gets the current credit balance summary for the credit account",
"operationId" : "pws_get_account_credit_balance",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetCreditCurrentBalanceModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCurrentBalanceResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_credit_balance"
}
},
"/pws/pws_get_acc_groups/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "View Linked Account Groups -This web service is used to view account/groups that are linked for the given client",
"operationId" : "pws_get_acc_groups",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetAccGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetGroupListResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_acc_groups"
}
},
"/pws/pws_apply_group_credit_limit/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Create Group Limit - Create a Credit Limit for group",
"operationId" : "pws_apply_group_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGroupCreditLimitTemplateModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreditLimitResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_apply_group_credit_limit"
}
},
"/pws/pws_get_group_credit_limit/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Get Group Limit - View Credit limit of a group",
"operationId" : "pws_get_group_credit_limit",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGroupIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GroupCreditTemplateResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_group_credit_limit"
}
},
"/pws/pws_link_account_group/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "Link Account Group - Link account to a group(s), based on specific customer characteristics.",
"operationId" : "pws_link_account_group",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsLinkAccountGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/LinkAccountGroupResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_link_account_group"
}
},
"/pws/pws_unlink_account_group/" : {
"post" : {
"tags" : [ "Group" ],
"summary" : "UnLink Account Group - UnLink group(s) from account, based on specific customer characteristics.",
"operationId" : "pws_unlink_account_group",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsUnLinkAccountGroupModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/UnlinkAccountGroupResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_unlink_account_group"
}
},
"/pws/pws_get_merchant_type_categories/" : {
"post" : {
"tags" : [ "MCC" ],
"summary" : "Get Merchant Categories",
"operationId" : "pws_get_merchant_type_categories",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/MerchantListResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_merchant_type_categories"
}
},
"/pws/pws_get_mcc_groups/" : {
"post" : {
"tags" : [ "MCC" ],
"summary" : "Get MCC Groups",
"operationId" : "pws_get_mcc_groups",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetMCCGroupResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_mcc_groups"
}
},
"/pws/pws_get_mcc_code/" : {
"post" : {
"tags" : [ "MCC" ],
"summary" : "Get MCC Codes - list Merchant Category Code",
"operationId" : "pws_get_mcc_code",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApiBasic"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetMCCCodeResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_mcc_code"
}
},
"/pws/pws_get_credit_statement/" : {
"post" : {
"tags" : [ "Credit Account Status" ],
"summary" : "Get Credit Statement-This web service gets the credit statement details for the given account",
"operationId" : "pws_get_credit_statement",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsGetCreditStatementModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountStatementResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_credit_statement"
}
},
"/pws/pws_create_client_billing_cycle/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Create Client Billing Cycle -This web service creates a billing cycle for a credit client",
"operationId" : "pws_create_client_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsInsertClientCycleModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/InsertClientCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_client_billing_cycle"
}
},
"/pws/pws_get_client_billing_cycle/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Get Billing Cycle By Client-This web service gets credit cycle details for the given client",
"operationId" : "pws_get_client_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsClientIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetClientCycleConfigResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_client_billing_cycle"
}
},
"/pws/pws_create_product_billing_cycle/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Create Product Billing Cycle -This web service creates a billing cycle for a credit product",
"operationId" : "pws_create_product_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsProductCycleConfigModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/InsertClientCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_product_billing_cycle"
}
},
"/pws/pws_get_product_billing_cycle/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Get Billing Cycle by Product -This web service gets credit cycle details for the given product",
"operationId" : "pws_get_product_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsProductIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetProductCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_product_billing_cycle"
}
},
"/pws/pws_create_billing_cycle/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Create Billing Cycle- This web service creates a billing cycle for a credit account/card",
"operationId" : "pws_create_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsCreditCycleModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/CreateCreditCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_create_billing_cycle"
}
},
"/pws/pws_get_account_billing_cycle/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Get Billing Cycle List by Account-This web service gets credit cycle details for the given account",
"operationId" : "pws_get_account_billing_cycle",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetCreditCycleListResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_billing_cycle"
}
},
"/pws/pws_get_account_billing_cycle_config/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Get Billing Cycle Config by Account-This web service gets credit cycle config applied for the given account",
"operationId" : "pws_get_account_billing_cycle_config",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/GetAccountBillingCycleConfigModel"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_billing_cycle_config"
}
},
"/pws/pws_start_account_billing_cycles/" : {
"post" : {
"tags" : [ "Credit Billing Cycle" ],
"summary" : "Start Account Billing Cycles -This web service starts all billing cycles for an account id",
"operationId" : "pws_start_account_billing_cycles",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/StartBillingCycleResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_start_account_billing_cycles"
}
},
"/pws/pws_get_account_billing_cycle_details/" : {
"post" : {
"tags" : [ "Credit Account Status" ],
"summary" : "Get Account Billing Cycle Details-This web service gets the current billing cycle details for the given account",
"operationId" : "pws_get_account_billing_cycle_details",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/AccountInterestDetailsResponse"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_account_billing_cycle_details"
}
},
"/pws/pws_get_transaction_history/" : {
"post" : {
"tags" : [ "Credit Account Status" ],
"summary" : "Get Transaction History-This web service gets the transaction history for the given account",
"operationId" : "pws_get_transaction_history",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PwsAccountIdModel"
}
} ],
"responses" : {
"200" : {
"description" : "Successful Response",
"schema" : {
"$ref" : "#/definitions/Response"
}
},
"404" : {
"description" : "Webservices does not exist"
},
"500" : {
"description" : "Internal Server error"
}
},
"x-camelContextId" : "payapi",
"x-routeId" : "pws_get_transaction_history"
}
}
},
"definitions" : {
"GetClientBillingCycle" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.GetClientBillingCycle"
}
},
"Response" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/Header"
},
"body" : {
"type" : "object"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.Response"
}
},
"Header" : {
"type" : "object",
"required" : [ "error_desc", "error_id" ],
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Error_id "
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "Error_description "
}
}
},
"GetBillingCycleBody" : {
"type" : "object",
"required" : [ "cycle_template_id" ],
"properties" : {
"cycle_template_id" : {
"type" : "integer",
"format" : "int32",
"example" : 14,
"description" : "config id that is applied for given client"
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 123456,
"description" : "client id"
},
"cycle_unit" : {
"type" : "string",
"example" : "M",
"description" : "Cycle Unit which is either M or D",
"minLength" : 1,
"maxLength" : 1
},
"start_day" : {
"type" : "integer",
"format" : "int32",
"example" : 18,
"description" : "start day"
},
"end_day" : {
"type" : "integer",
"format" : "int32",
"example" : 25,
"description" : "end day"
},
"pay_day" : {
"type" : "integer",
"format" : "int32",
"example" : 26,
"description" : "pay day"
}
}
},
"ClientBillingCycleResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetBillingCycleHeader"
},
"body" : {
"$ref" : "#/definitions/GetBillingCycleBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.ClientBillingCycleResponse"
}
},
"GetBillingCycleHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsAccountCreditLimit" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "credit_limit_amount", "effective_date" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041,
"description" : "account Id",
"minimum" : 1
},
"credit_limit_amount" : {
"type" : "number",
"example" : 1000.0,
"description" : "credit limit for the given account",
"minimum" : 1
},
"effective_date" : {
"type" : "string",
"example" : "2021-07-31",
"description" : "effective date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsAccountCreditLimit"
}
},
"SetAccountCreditLimitResponseBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Account Limit Set Successfully"
}
}
},
"SetAccountCreditLimitResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/SetAccountCreditLimitResponseHeader"
},
"body" : {
"$ref" : "#/definitions/SetAccountCreditLimitResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.SetAccountCreditLimitResponse"
}
},
"SetAccountCreditLimitResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateCreditLimitResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateCreditLimitResponseHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateCreditLimitResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.UpdateCreditLimitResponse"
}
},
"UpdateCreditLimitResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateCreditLimitResponseBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Account Credit Limit Updated Successfully"
}
}
},
"GetAccountCreditLimit" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041,
"description" : "Account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.GetAccountCreditLimit"
}
},
"GetAccountCreditLimitHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountCreditLimitBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 510257088,
"description" : "account Id"
},
"effective_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-07-08",
"description" : "Effective Date"
},
"cycle_id" : {
"type" : "integer",
"format" : "int32",
"example" : 14,
"description" : "Client Billing Cycle Id"
},
"credit_limit_amount" : {
"type" : "number",
"example" : 100.0,
"description" : "Credit Limit Amount"
},
"credit_limit_used" : {
"type" : "number",
"example" : 50.0,
"description" : "Credit Limit Amount"
},
"credit_limit_available" : {
"type" : "number",
"example" : 50.0,
"description" : "Credit Limit Amount"
},
"ccy" : {
"type" : "string",
"example" : "354",
"description" : "Billing Currency"
},
"cre_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-07-20 11:22:33.564",
"description" : "credit limit created date"
},
"arrears_counter" : {
"type" : "integer",
"format" : "int32",
"example" : 354,
"description" : "Billing Currency"
}
}
},
"GetAccountCreditLimitResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountCreditLimitHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountCreditLimitBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetAccountCreditLimitResponse"
}
},
"PwsSetAccountBillingCycle" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "cycle_template_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041,
"description" : "account Id",
"minimum" : 1
},
"cycle_template_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Cycle Template Id",
"minimum" : 1
},
"active_date" : {
"type" : "string",
"example" : "2021-07-31",
"description" : "active date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsSetAccountBillingCycle"
}
},
"SetAccountBillingCycleResponseBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Statement Cycle-Id 1 started"
}
}
},
"SetAccountBillingCycleResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"SetAccountBillingCycleResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/SetAccountBillingCycleResponseHeader"
},
"body" : {
"$ref" : "#/definitions/SetAccountBillingCycleResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.SetAccountBillingCycleResponse"
}
},
"GetAccountBillingCycle" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041,
"description" : "Account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.GetAccountBillingCycle"
}
},
"GetAccountBillingCycleResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountBillingCycleHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountBillingCycleBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetAccountBillingCycleResponse"
}
},
"GetAccountBillingCycleHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountBillingCycleBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 548798862,
"description" : "account Id"
},
"cycle_unit" : {
"type" : "string",
"example" : "M",
"description" : "Cycle Unit which is either M or D",
"minLength" : 1,
"maxLength" : 1
},
"start_day" : {
"type" : "integer",
"format" : "int32",
"example" : 18,
"description" : "start day"
},
"end_day" : {
"type" : "integer",
"format" : "int32",
"example" : 25,
"description" : "end day"
},
"pay_day" : {
"type" : "integer",
"format" : "int32",
"example" : 26,
"description" : "pay day adjusted for holiday"
},
"cycle_template_id" : {
"type" : "integer",
"format" : "int32",
"example" : 16,
"description" : "Billing Cycle Template assigned to Account"
},
"cycle_sequence_id" : {
"type" : "integer",
"format" : "int32",
"example" : 13,
"description" : "The current billing cycle the account is in"
},
"active_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-07-21",
"description" : "Biling Cycle Start Date"
}
}
},
"PwsGetAccountInterestDetails" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"cycle_id" : {
"type" : "integer",
"format" : "int32",
"description" : "Account Cycle Id"
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041,
"description" : "Account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsGetAccountInterestDetails"
}
},
"GetAccountInterestDetailsResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountInterestDetailsHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountInterestDetailsBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetAccountInterestDetailsResponse"
}
},
"InterestDetails" : {
"type" : "object",
"properties" : {
"ch_interest_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 261
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041
},
"cycle_sequence_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1
},
"ccy" : {
"type" : "string",
"example" : "352"
},
"actual_interest_amount" : {
"type" : "number",
"example" : 10.54
},
"interest_bearing_amount" : {
"type" : "number",
"example" : 10.54
},
"interest_rate" : {
"type" : "number",
"format" : "double",
"example" : 10.54
},
"pend_interest" : {
"type" : "number",
"example" : 10.54
},
"pend_interest_bearing_amount" : {
"type" : "number",
"example" : 10.54
},
"excess_payment" : {
"type" : "number",
"example" : 10.54
},
"cre_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-07-31 11:12:15"
},
"operational_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-07-30"
},
"interest_check" : {
"type" : "boolean",
"example" : false
}
}
},
"GetAccountInterestDetailsBody" : {
"type" : "object",
"properties" : {
"interestDetails" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/InterestDetails"
}
}
}
},
"GetAccountInterestDetailsHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountBillingCycleDetails" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 303047041,
"description" : "Account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.GetAccountBillingCycleDetails"
}
},
"GetAccountBillingCycleDetailsResponseBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 548798862,
"description" : "account Id"
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 268,
"description" : "Product Id"
},
"cycle_sequence_id" : {
"type" : "integer",
"format" : "int32",
"example" : 13,
"description" : "The current billing cycle the account is in"
},
"cycle_status" : {
"type" : "string",
"example" : "C",
"description" : "Billing Cycle Staus"
},
"start_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-08-18",
"description" : "Cycle Start Date"
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-08-25",
"description" : "Cycle End Date"
},
"pay_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-08-24",
"description" : "Pay Date"
},
"ccy" : {
"type" : "string",
"example" : "826",
"description" : "Billing CCY"
},
"opening_balance" : {
"type" : "number",
"example" : 0.0,
"description" : "Opening Balance"
},
"spending_total" : {
"type" : "number",
"example" : 0.0,
"description" : "Spending Total"
},
"fees_total" : {
"type" : "number",
"example" : 0.0,
"description" : "Total Fees"
},
"interest_total" : {
"type" : "number",
"example" : 0.0,
"description" : "Interest Accured Total"
},
"payment_total" : {
"type" : "number",
"example" : 0.0,
"description" : "Total Payment"
},
"closing_balance" : {
"type" : "number",
"example" : 0.0,
"description" : "Closing Balance"
},
"excess_payment" : {
"type" : "number",
"example" : 0.0,
"description" : "Excess Payment"
},
"interest_sum" : {
"type" : "number",
"example" : 0.0,
"description" : "Interest Sum"
},
"installment" : {
"type" : "number",
"example" : 0.0,
"description" : "Installment"
},
"claim_status" : {
"type" : "integer",
"format" : "int32",
"example" : "0.000",
"description" : "Claim Status"
}
}
},
"GetAccountBillingCycleDetailsResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountBillingCycleDetailsResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountBillingCycleDetailsResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountBillingCycleDetailsResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetAccountBillingCycleDetailsResponse"
}
},
"GetAccountPaymentDetails" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 588260025,
"description" : "acc_id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.GetAccountPaymentDetails"
}
},
"GetPaymentResponseBody" : {
"type" : "object",
"properties" : {
"payment_id" : {
"type" : "integer",
"format" : "int32",
"description" : "Payment Id"
},
"tc_id" : {
"type" : "integer",
"format" : "int32"
},
"txn_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Transaction Id"
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 548798862,
"description" : "account Id"
},
"date_processed" : {
"type" : "string",
"format" : "date-time",
"description" : "Payment Date Processed"
},
"pay_source" : {
"type" : "string",
"description" : "Payment Source"
},
"txn_type" : {
"type" : "string",
"description" : "Transaction Type"
},
"bank_branch_no" : {
"type" : "integer",
"format" : "int32",
"description" : "Bank Branch No"
},
"bank_acc_cat" : {
"type" : "integer",
"format" : "int32"
},
"bank_acc_no" : {
"type" : "integer",
"format" : "int64",
"description" : "Bank Account No"
},
"txn_key" : {
"type" : "integer",
"format" : "int32",
"description" : "Transaction Key"
},
"ssn" : {
"type" : "string",
"description" : "SSN No"
},
"slip_no" : {
"type" : "integer",
"format" : "int32",
"description" : "Slip No"
},
"date_of_interest" : {
"type" : "string",
"format" : "date-time",
"description" : "Interest Calculation Date"
},
"date_of_transaction" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction Date"
},
"payment_amt" : {
"type" : "number",
"description" : "Payment Amount"
},
"description" : {
"type" : "string",
"description" : "Payment Description"
},
"redemption_bank" : {
"type" : "integer",
"format" : "int32",
"description" : "Redemption Bank"
},
"batch_no" : {
"type" : "string",
"description" : "Batch No"
},
"ref_no" : {
"type" : "string",
"description" : "Reference No"
},
"priority" : {
"type" : "integer",
"format" : "int32",
"description" : "Payment Priority"
},
"input_type" : {
"type" : "string",
"description" : "Input Type"
},
"txn_no" : {
"type" : "string",
"description" : "Transaction Number"
},
"date_of_txn_receive" : {
"type" : "string",
"format" : "date-time",
"description" : "Transaction Received Date"
},
"status" : {
"type" : "string",
"description" : "Payment Status"
},
"error_no" : {
"type" : "integer",
"format" : "int32",
"description" : "Error Number"
},
"pb_tok" : {
"type" : "integer",
"format" : "int64",
"description" : "Public Token"
},
"slip_no_2" : {
"type" : "integer",
"format" : "int32",
"description" : "Slip No 2"
},
"due_date_of_claim" : {
"type" : "string",
"format" : "date-time",
"description" : "Due Claim Date"
},
"cat_code" : {
"type" : "string"
}
}
},
"GetPaymentResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetPaymentResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetPaymentResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetPaymentResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetPaymentResponse"
}
},
"PwsGetChargeCardStatement" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 588260025,
"description" : "acc_id",
"minimum" : 1
},
"start_date" : {
"type" : "string",
"example" : "2021-08-10",
"description" : "Start Date.Optional when billing_cycle_end_date is provided",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"end_date" : {
"type" : "string",
"example" : "2021-11-12",
"description" : "End Date.Optional when billing_cycle_end_date is provided",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"billing_cycle_end_date" : {
"type" : "string",
"example" : "2021-11-12",
"description" : "statement billing cycle end date.Optional when Start Date and End Date filter are provided",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsGetChargeCardStatement"
}
},
"OfferInstallment" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "ins_amt", "ins_periods" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 508836241,
"description" : "Account Id",
"minimum" : 1
},
"ins_amt" : {
"type" : "number",
"example" : 2400.0,
"description" : "Installment Amount",
"minimum" : 1
},
"ins_periods" : {
"type" : "integer",
"format" : "int32",
"example" : 6,
"description" : "Installment Periond",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.OfferInstallment"
}
},
"Periods" : {
"type" : "object",
"properties" : {
"ins_period" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Installment Period"
},
"ins_status" : {
"type" : "string",
"example" : "Q",
"description" : "Installment Status.Q->Quote,A->Active,E->Expired,P->Posted",
"enum" : [ "Q", "A", "E", "P" ]
},
"effective_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-12",
"description" : "Installment Effective Date"
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-21",
"description" : "Installment End Date"
},
"due_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-23",
"description" : "Installment Due Date"
},
"no_of_days" : {
"type" : "integer",
"format" : "int32",
"example" : 9,
"description" : "Installment Days"
},
"principal_sum" : {
"type" : "number",
"example" : 2400.0,
"description" : "Total Amount that is to be installed"
},
"principal_unit" : {
"type" : "number",
"example" : 1200.0,
"description" : "Total Amount that is to be installed at each periods"
},
"ins_interest_amt" : {
"type" : "number",
"example" : 35.0,
"description" : "Interest Amount at that periods"
},
"ins_fee" : {
"type" : "integer",
"format" : "int32",
"example" : 25,
"description" : "Installment Fee for that period"
}
}
},
"OfferInstallmentResponseBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 508836241,
"description" : "Account Id"
},
"contract_nr" : {
"type" : "integer",
"format" : "int64",
"example" : 98,
"description" : "Contract Number"
},
"contract_status" : {
"type" : "string",
"example" : "00",
"description" : "Contract Status."
},
"valid_to" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-10-13",
"description" : "Contract Validated date."
},
"ins_interest" : {
"type" : "number",
"example" : 8.5,
"description" : "Installment Interest Rate Perc."
},
"ins_apr" : {
"type" : "number",
"format" : "double",
"example" : 12.0,
"description" : "Installment APR."
},
"principal_sum" : {
"type" : "number",
"example" : 2400.0,
"description" : "Installment Amount."
},
"ins_interest_sum" : {
"type" : "number",
"example" : 65.0,
"description" : "Total Installment Interest"
},
"ins_fee_sum" : {
"type" : "integer",
"format" : "int32",
"example" : 50,
"description" : "Total Installment Fee"
},
"ins_periods" : {
"type" : "array",
"description" : "Installment Periods Details",
"items" : {
"$ref" : "#/definitions/Periods"
}
}
}
},
"OfferInstallmentResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/OfferInstallmentResponseHeader"
},
"body" : {
"$ref" : "#/definitions/OfferInstallmentResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.OfferInstallmentResponse"
}
},
"OfferInstallmentResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsConfirmInstallment" : {
"type" : "object",
"required" : [ "acc_id", "activate_installment", "api_call_unique_identifier", "client_id", "contract_nr" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 508836241,
"description" : "Account Id",
"minimum" : 1
},
"contract_nr" : {
"type" : "integer",
"format" : "int64",
"example" : 98,
"description" : "Contract Number obtained when offer installment api is called",
"minimum" : 1
},
"activate_installment" : {
"type" : "boolean",
"example" : false,
"description" : "Confirm Installment Offer to active or expire"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsConfirmInstallment"
}
},
"ConfirmInstallmentResponseBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 508836241,
"description" : "Account Id"
},
"contract_nr" : {
"type" : "integer",
"format" : "int64",
"example" : 98,
"description" : "Contract Number"
},
"contract_status" : {
"type" : "string",
"example" : "00",
"description" : "Contract Status."
},
"valid_to" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-10-13",
"description" : "Contract Validated date."
},
"ins_interest" : {
"type" : "number",
"example" : 8.5,
"description" : "Installment Interest Rate Perc."
},
"ins_apr" : {
"type" : "number",
"format" : "double",
"example" : 12.0,
"description" : "Installment APR."
},
"principal_sum" : {
"type" : "number",
"example" : 2400.0,
"description" : "Installment Amount."
},
"ins_interest_sum" : {
"type" : "number",
"example" : 65.0,
"description" : "Total Installment Interest"
},
"ins_fee_sum" : {
"type" : "integer",
"format" : "int32",
"example" : 50,
"description" : "Total Installment Fee"
},
"ins_periods" : {
"type" : "array",
"description" : "Installment Periods Details",
"items" : {
"$ref" : "#/definitions/ConfirmPeriods"
}
}
}
},
"ConfirmInstallmentResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"ConfirmInstallmentResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ConfirmInstallmentResponseHeader"
},
"body" : {
"$ref" : "#/definitions/ConfirmInstallmentResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.ConfirmInstallmentResponse"
}
},
"ConfirmPeriods" : {
"type" : "object",
"properties" : {
"ins_period" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Installment Period"
},
"ins_status" : {
"type" : "string",
"example" : "Q",
"description" : "Installment Status.Q->Quote,A->Active,E->Expired,P->Posted",
"enum" : [ "Q", "A", "E", "P" ]
},
"effective_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-12",
"description" : "Installment Effective Date"
},
"end_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-21",
"description" : "Installment End Date"
},
"due_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-23",
"description" : "Installment Due Date"
},
"no_of_days" : {
"type" : "integer",
"format" : "int32",
"example" : 9,
"description" : "Installment Days"
},
"principal_sum" : {
"type" : "number",
"example" : 2400.0,
"description" : "Total Amount that is to be installed"
},
"principal_unit" : {
"type" : "number",
"example" : 1200.0,
"description" : "Total Amount that is to be installed at each periods"
},
"ins_interest_amt" : {
"type" : "number",
"example" : 35.0,
"description" : "Interest Amount at that periods"
},
"ins_fee" : {
"type" : "integer",
"format" : "int32",
"example" : 25,
"description" : "Installment Fee for that period"
}
}
},
"PwsGetChargeCardInstallment" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 508836241,
"description" : "Account Id",
"minimum" : 1
},
"contract_nr" : {
"type" : "integer",
"format" : "int64",
"example" : 98,
"description" : "Contract Number obtained when offer installment api is called"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsGetChargeCardInstallment"
}
},
"GetInstallmentDetailsResponseBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 508836241,
"description" : "Account Id"
},
"contract_nr" : {
"type" : "integer",
"format" : "int64",
"example" : 98,
"description" : "Contract Number"
},
"contract_status" : {
"type" : "string",
"example" : "00",
"description" : "Contract Status."
},
"valid_to" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-10-13",
"description" : "Contract Validated date."
},
"ins_interest" : {
"type" : "number",
"example" : 8.5,
"description" : "Installment Interest Rate Perc."
},
"ins_apr" : {
"type" : "number",
"format" : "double",
"example" : 12.0,
"description" : "Installment APR."
},
"principal_sum" : {
"type" : "number",
"example" : 2400.0,
"description" : "Installment Amount."
},
"ins_interest_sum" : {
"type" : "number",
"example" : 65.0,
"description" : "Total Installment Interest"
},
"ins_fee_sum" : {
"type" : "integer",
"format" : "int32",
"example" : 50,
"description" : "Total Installment Fee"
},
"ins_periods" : {
"type" : "array",
"description" : "Installment Periods Details",
"items" : {
"$ref" : "#/definitions/Periods"
}
}
}
},
"GetInstallmentDetailsResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetInstallmentDetailsResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetInstallmentDetailsResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetInstallmentDetailsResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetInstallmentDetailsResponse"
}
},
"GetInstallmentConfig" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 220,
"description" : "Product Id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.GetInstallmentConfig"
}
},
"GetInstallmentConfigResponseBody" : {
"type" : "object",
"properties" : {
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 220,
"description" : "Product Id"
},
"ins_max_allowed" : {
"type" : "integer",
"format" : "int32",
"example" : 5,
"description" : "Installment Maximum Allowed"
},
"ins_max_period" : {
"type" : "integer",
"format" : "int32",
"example" : 36,
"description" : "Installment Maximum Period"
},
"ins_fixed_fee" : {
"type" : "integer",
"format" : "int32",
"example" : "280.00",
"description" : "Installment Fixed Fee"
},
"ins_interest" : {
"type" : "number",
"example" : 8.5,
"description" : "Installment Interest Rate Perc"
}
}
},
"GetInstallmentConfigResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetInstallmentConfigResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetInstallmentConfigResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetInstallmentConfigResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetInstallmentConfigResponse"
}
},
"SetInstallmentFee" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "ins_fixed_fee", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 220,
"description" : "Product Id",
"minimum" : 1
},
"ins_fixed_fee" : {
"type" : "integer",
"format" : "int32",
"example" : 300,
"description" : "Installment Fixed Fee",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.SetInstallmentFee"
}
},
"SetInstallmentFeeResponseBody" : {
"type" : "object"
},
"SetInstallmentFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/SetInstallmentFeeResponseHeader"
},
"body" : {
"$ref" : "#/definitions/SetInstallmentFeeResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.SetInstallmentFeeResponse"
}
},
"SetInstallmentFeeResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsGetClaimModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 588260025,
"description" : "acc_id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.PwsGetClaimModel"
}
},
"ClaimResponse" : {
"type" : "object",
"properties" : {
"due_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-09-28",
"description" : "Claim Due Date"
},
"claim_expiry" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-10-25",
"description" : "Claim Expiry Date"
},
"claim_branch" : {
"type" : "string",
"example" : "1501",
"description" : "Claim Branch"
},
"claim_type" : {
"type" : "string",
"example" : "M13",
"description" : "Claim Type"
},
"claim_amount" : {
"type" : "number",
"example" : 8.5,
"description" : "Claim Amount"
},
"reference_number" : {
"type" : "string",
"example" : "584232956",
"description" : "Reference Number"
},
"reference_rbs_number" : {
"type" : "string",
"example" : "584232956",
"description" : "Reference RBS Number"
},
"claim_number" : {
"type" : "string",
"example" : "000004",
"description" : "Claim Number"
}
}
},
"GetClaimResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetClaimResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetClaimResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetClaimResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.chargeCard.pwsmodel.ResponseModel.GetClaimResponse"
}
},
"GetClaimResponseBody" : {
"type" : "object",
"properties" : {
"claims" : {
"type" : "array",
"description" : "Array of Claim Details",
"items" : {
"$ref" : "#/definitions/ClaimResponse"
}
}
}
},
"AcsAuthenticationModel" : {
"type" : "object",
"required" : [ "amount", "authType", "currencyCode", "exponent", "merchantName", "messageCategory", "proxyCard", "tranID" ],
"properties" : {
"tranID" : {
"type" : "string",
"example" : "0fdf0f56-053b-457f-bae1-e77e966f66ca",
"description" : "Unique txn ID generated by ACS for every transaction.",
"minLength" : 0,
"maxLength" : 36
},
"proxyCard" : {
"type" : "string",
"example" : "121345566",
"description" : "This represents the Token Number / Alias Number which will be used in place of Card Number (this would be shared with ACS during Registration).",
"minLength" : 0,
"maxLength" : 40
},
"messageCategory" : {
"type" : "string",
"example" : "01",
"description" : "Txn payment type\n01- Payment\n02- Non Payment.",
"minLength" : 2,
"maxLength" : 2
},
"merchantName" : {
"type" : "string",
"example" : "amazon",
"description" : "Name of Merchant where transaction was initiated.",
"minLength" : 0,
"maxLength" : 40
},
"amount" : {
"type" : "string",
"example" : "100028",
"description" : "Transaction amount in minor units of the ongoing transaction.",
"minLength" : 0,
"maxLength" : 48
},
"currencyCode" : {
"type" : "string",
"example" : "191",
"description" : "Currency in which amount is expressed.",
"minLength" : 3,
"maxLength" : 3
},
"exponent" : {
"type" : "string",
"example" : "2",
"description" : "Minor units of Currency Code.",
"minLength" : 1,
"maxLength" : 1
},
"authType" : {
"type" : "string",
"example" : "1",
"description" : "Authentication type\n0 - No Client Authentication – (Only OTP Delivery)\n1- Single authentication\n2- Dual authentication",
"minLength" : 1,
"maxLength" : 1
},
"otp" : {
"type" : "string",
"example" : "7878675645342312345678909865432",
"description" : "OTP [If Encrypted OTP is sent in this field]. MB Server has to send the same to Card Holder."
},
"encvalue" : {
"type" : "string",
"example" : "b6fd1fcc8f0129693664fe101a637d99",
"description" : "Encrypted dynamic DEK using KEK"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.acsauthentication.AcsAuthenticationModel"
}
},
"AcsAuthenticationResponseModel" : {
"type" : "object",
"required" : [ "description", "oobType", "proxyCard", "resultCode", "tranId" ],
"properties" : {
"resultCode" : {
"type" : "string",
"example" : "00",
"description" : "Result code to indicate whether transaction was success or failed\n• 00-Success\n• 01-Declined",
"minLength" : 2,
"maxLength" : 2
},
"description" : {
"type" : "string",
"description" : "Result description",
"minLength" : 0,
"maxLength" : 100
},
"oobType" : {
"type" : "string",
"example" : "biometric",
"description" : "Performed authentication method\nIf Zero, values would be\n[OTP Sent]\nIf Single, values would be\n[biometric (or) pattern]\nIf Dual, values will be comma separated\nbiometric, pattern",
"minLength" : 0,
"maxLength" : 255
},
"proxyCard" : {
"type" : "string",
"example" : "121345566",
"description" : "card proxy number received in request.",
"minLength" : 0,
"maxLength" : 40
},
"tranId" : {
"type" : "string",
"example" : "0fdf0f56-053b-457f-bae1-e77e966f66ca",
"description" : "Unique txn ID generated by ACS for every transaction.",
"minLength" : 0,
"maxLength" : 36
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.acsauthentication.AcsAuthenticationResponseModel"
}
},
"AuthUnblockModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "rid" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"rid" : {
"type" : "integer",
"format" : "int64",
"example" : 5754,
"description" : "Unique ID for transaction",
"minimum" : 1
}
},
"description" : "This web service unblocks an authorisation.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.authunblock.AuthUnblockModel"
}
},
"AuthUnblockResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeader"
},
"body" : {
"$ref" : "#/definitions/AuthUnblockResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.transaction.ResponseModel.AuthUnblockResponseModel"
}
},
"ResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"AuthUnblockResponseModelBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "transaction added to unblock queue",
"description" : "Unblock authorisation response message",
"minLength" : 0,
"maxLength" : 100
}
}
},
"ApiBasic" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.ApiBasic"
}
},
"ResponseHeaderMCTSR" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"MasterComTxnSearchResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeaderMCTSR"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ResponseHeaderMCTSR"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.responseModel.MasterComTxnSearchResponseModel"
}
},
"MasterComTxnSearchModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acquirerRefNumber" : {
"type" : "string",
"example" : "05436847276000293995738",
"description" : "CONDITIONAL: Acquirer Reference Number. If provided bankNetRefNumber may not be used. This field is required and applicable if primaryAccountNum is not provided.",
"pattern" : "^[0-9]{0,23}$"
},
"bankNetRefNumber" : {
"type" : "string",
"description" : "CONDITIONAL: Banknet Reference Number. If provided acquirerRefNumber may not be used."
},
"primaryNumber" : {
"type" : "integer",
"format" : "int64",
"example" : 5488888888887192,
"description" : "CONDITIONAL: Public token or pan number.If length is equal to 16 digit or greater than 16 digit,it will be considered as pan number. If less than 16 digit it will be considered as public token . This field is required and applicable if acquirerRefNum is not provided"
},
"transAmountFrom" : {
"type" : "number",
"example" : 10000.0,
"description" : "Transaction amount lower limit value to be searched.\n\nFormat : Numeric"
},
"transAmountTo" : {
"type" : "number",
"example" : 20050.0,
"description" : "Transaction amount upper limit value to be searched.\n\nFormat : Numeric"
},
"referenceSetId" : {
"type" : "integer",
"format" : "int64",
"example" : 20050,
"description" : "Unique identifier for clearing summary (settlement). This field will be used if authorisation or clearing is internal\nFormat : Numeric"
},
"tranStartDate" : {
"type" : "string",
"example" : "2021-02-17",
"description" : "Transaction Date min search range. The search range is a maximum of 30 days, and searches can be completed for up to 730 days of history. \n\nFormat : Date (yyyy-MM-dd)",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"tranEndDate" : {
"type" : "string",
"example" : "2021-03-17",
"description" : "Transaction Date max search range. The search range is a maximum of 30 days, and searches can be completed for up to 730 days of history.\n\nFormat : Date (yyyy-MM-dd)",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.MasterComTxnSearchModel"
}
},
"McClaimModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "authTransactionId", "claimType", "clearingTransactionId", "client_id", "disputedAmount", "disputedCurrency" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"disputedAmount" : {
"type" : "number",
"example" : 100.0,
"description" : "Amount disputed in the claim\n\nFormat : Numeric"
},
"disputedCurrency" : {
"type" : "string",
"example" : "826",
"description" : "Currency of amount disputed in the claim. disputedCurrency can be provided as standard alpha code or numeric code(must be three digit ISO-4217 standard numeric currency code)",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[0-9]{3}$"
},
"claimType" : {
"type" : "string",
"example" : "Standard",
"description" : "Claim tyoe\n\nFormat : String\n\nAccepted value : Standard",
"pattern" : "^[Standard,STANDARD,standard]{0,10}$"
},
"clearingTransactionId" : {
"type" : "string",
"example" : "ccCnaMDqmto4wnL+BSUKSdzROqGJ7YELoKhEvluycwKNg3XTzSfaIJhFDkl9hW081B5tTqFFiAwCpcocPdB2My4t7DtSTk63VXDl1CySA8Y=",
"description" : "The Clearing Transaction Identifier from Clearing Summary Results.\n\nValid Format : Alphanumeric Special character (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)"
},
"authTransactionId" : {
"type" : "string",
"example" : "aaCnaMDqmto4wnL+BSUKSdzROqGJ7YELoKhEvluycwKNg3XTzSfaIJhFDkl9hW081B5tTqFFiAwCpcocPdB2My4t7DtSTk63VXDl1CySA8Y=",
"description" : "The Authorization Transaction Identifier from Authorization Summary Results.\n\nValid Format : Alphanumeric Special character (~!@#$%^&*()_+{}|:\"<>?,./;'[]-=)"
},
"referenceSetId" : {
"type" : "integer",
"format" : "int64",
"example" : 20050,
"description" : "Unique identifier for clearing summary (settlement). This field will be used if authorisation or clearing is internal\nFormat : Numeric"
},
"acquirerRefNumber" : {
"type" : "string",
"example" : "05436847276000293995738",
"description" : "Acquirer Reference Number",
"pattern" : "^[0-9]{0,23}$"
},
"authorizationDateTime" : {
"type" : "string"
},
"authenticationId" : {
"type" : "string",
"example" : "858082",
"description" : "Authentication Id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.McClaimModel"
}
},
"ResponseBodyMCTSR" : {
"type" : "object",
"properties" : {
"claimId" : {
"type" : "string"
}
}
},
"McClaimResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeaderMCTSR"
},
"body" : {
"$ref" : "#/definitions/ResponseBodyMCTSR"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.responseModel.McClaimResponseModel"
}
},
"McClaimGetModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "claimId", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"claimId" : {
"type" : "integer",
"format" : "int64",
"example" : 200002020654,
"description" : "Claim Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.McClaimGetModel"
}
},
"McCbDataModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "chargeBackType", "claimId", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"claimId" : {
"type" : "integer",
"format" : "int64",
"example" : 200002042336,
"description" : "Claim Id where the chargeback will be added",
"minimum" : 1
},
"chargeBackType" : {
"type" : "string",
"example" : "200002042336",
"description" : "<p>\nChargeback type\n<ul>\n<li>CHARGEBACK - First chargeback</li>\n<li>ARB_CHARGEBACK - Second chargeback</li>\n</ul>\n</p>"
},
"reasonCode" : {
"type" : "string",
"example" : "4853",
"description" : "Chargeback Reason Code provides the chargeback receiver with the reason for sending the chargeback."
},
"currency" : {
"type" : "string",
"example" : "USD",
"description" : "The chargeback currency. The data should be standard currency alpha code or numeric code"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.McCbDataModel"
}
},
"McCbRequestModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "chargeBackType", "claimId", "client_id", "currencyCcy", "disputedAmt", "documentIndicator", "reasonCode" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"claimId" : {
"type" : "integer",
"format" : "int64",
"example" : 200002042336,
"description" : "Claim Id where the chargeback will be added",
"minimum" : 1
},
"disputedAmt" : {
"type" : "number",
"example" : 100.0,
"description" : "Amount of CB should be OT amount (DE4). US Issuers should always submit in USD. For more details refer to the GCMS Reference Manual.",
"minimum" : 1
},
"chargeBackType" : {
"type" : "string",
"example" : "CHARGEBACK",
"description" : "<p>\nChargeback type\n<ul>\n<li>CHARGEBACK - First chargeback</li>\n<li>ARB_CHARGEBACK - Second chargeback</li>\n</ul>\n</p>"
},
"currencyCcy" : {
"type" : "string",
"example" : "USD",
"description" : "The chargeback currency. The data should be standard currency alpha code or numeric code"
},
"documentIndicator" : {
"type" : "boolean",
"example" : false,
"description" : "Document Indicator defines if a document is required for the dispute."
},
"reasonCode" : {
"type" : "string",
"example" : "4853",
"description" : "Chargeback Reason Code provides the chargeback receiver with the reason for sending the chargeback."
},
"credPostedAsPurchase" : {
"type" : "string",
"example" : "false",
"description" : "Indicator to notify this is a credit posted as a purchase.\n\nOnly applicable to reason codes of 4853 and 4860. Defaults to false."
},
"isPartialCb" : {
"type" : "boolean",
"example" : false,
"description" : "Indicates a partial chargeback. Defaults to false."
},
"messageTxt" : {
"type" : "string",
"example" : "This is a test message text",
"description" : "Member message text to be used for the chargeback.",
"minLength" : 0,
"maxLength" : 100
},
"settlementDate" : {
"type" : "string",
"example" : "2021-06-15",
"description" : "CONDITIONAL: Required for Argentina and Uruguay's Settlement Service participation ID codes (LA00003201, LA00003202, LA00085801, LA00085802, LA00084011, LA00084012). The date may not be prior to the current date or beyond 90 days from the current date."
},
"localTax1IVA" : {
"type" : "number",
"example" : 0.6,
"description" : "Applies only to LAC installments (Argentina and Uruguay). PDS 1015. Contains the VAT amount for the installment fee."
},
"installmentFee" : {
"type" : "number",
"example" : 1.2,
"description" : "Applies only to LAC installments (Argentina and Uruguay). PDS 1028. Contains the VAT amount for the installment fee."
},
"editExclusionCode" : {
"type" : "string",
"example" : "BO",
"description" : "Edit exclusion code to bypass clearing system edits."
},
"refundNotReceivedIndicator" : {
"type" : "boolean",
"example" : true,
"description" : "Cardholder/Issuer did not receive refund when a first chargeback was rejected by Collaboration with reason code 5000 indicating refund provided. 20 days after rejection of CB through collaboration.\n\nCONDITIONAL: this field is only applicable if chargebackType is CHARGEBACK."
},
"includeCurrencyConversionAssessmentCCA" : {
"type" : "boolean",
"example" : false,
"description" : "Currency Conversion Assessment amount applied for full first chargeback, to indicate, if Currency Conversion Assessment was included or not for qualified transactions."
},
"token" : {
"type" : "integer",
"format" : "int64",
"description" : "Public token. This is optional field and can be passed if settelemnt is internal"
},
"acquirerRefNumber" : {
"type" : "string",
"description" : "Acquirer reference number. This is optional field and can be passed if settelemnt is internal"
},
"authenticationId" : {
"type" : "string",
"description" : "Authentication Id. This is optional field and can be passed if settelemnt is internal"
},
"fileName" : {
"type" : "string"
},
"fileData" : {
"type" : "string"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.McCbRequestModel"
}
},
"McCbStatusModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "chargeBackId", "claimId", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"chargeBackId" : {
"type" : "integer",
"format" : "int64",
"example" : 300003030530,
"description" : "Chargeback Id",
"minimum" : 1
},
"claimId" : {
"type" : "integer",
"format" : "int64",
"example" : 200002042336,
"description" : "Claim Id where the chargeback will be added",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.chargeback.McCbStatusModel"
}
},
"WalletProviderDecisioningInfo" : {
"type" : "object",
"properties" : {
"recommendedDecision" : {
"type" : "string",
"enum" : [ "APPROVED", "DECLINED", "REQUIRE_ADDITIONAL_AUTHENTICATION" ]
},
"recommendationStandardVersion" : {
"type" : "string"
},
"deviceScore" : {
"type" : "string"
},
"accountScore" : {
"type" : "string"
},
"phoneNumberScore" : {
"type" : "string"
},
"recommendationReasons" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
},
"AuthorizeService" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string"
},
"paymentNetwork" : {
"type" : "string"
},
"services" : {
"type" : "array",
"items" : {
"type" : "object"
}
},
"cardInfo" : {
"$ref" : "#/definitions/CardInfo"
},
"correlationId" : {
"type" : "string"
},
"tokenUniqueReference" : {
"type" : "string"
},
"tokenRequestorId" : {
"type" : "string"
},
"walletId" : {
"type" : "string"
},
"paymentAppInstanceId" : {
"type" : "string"
},
"accountIdHash" : {
"type" : "string"
},
"mobileNumberSuffix" : {
"type" : "string"
},
"activeTokenCount" : {
"type" : "string"
},
"deviceInfo" : {
"$ref" : "#/definitions/DeviceInfo"
},
"walletProviderDecisioningInfo" : {
"$ref" : "#/definitions/WalletProviderDecisioningInfo"
},
"tspDecisioningInfo" : {
"$ref" : "#/definitions/TspDecisioningInfo"
},
"tokenType" : {
"type" : "string"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.AuthorizeService"
}
},
"DeviceInfo" : {
"type" : "object",
"properties" : {
"deviceName" : {
"type" : "string"
},
"serialNumber" : {
"type" : "string"
},
"formFactor" : {
"type" : "string"
},
"isoDeviceType" : {
"type" : "string"
},
"osName" : {
"type" : "string"
},
"osVersion" : {
"type" : "string"
},
"imei" : {
"type" : "string"
},
"msisdn" : {
"type" : "string"
},
"paymentTypes" : {
"type" : "array",
"items" : {
"type" : "object"
}
},
"storageTechnology" : {
"type" : "string"
},
"cardCaptureTechnology" : {
"type" : "string"
}
}
},
"CardInfo" : {
"type" : "object",
"properties" : {
"encryptedData" : {
"type" : "string"
},
"publicKeyFingerprint" : {
"type" : "string"
},
"encryptedKey" : {
"type" : "string"
},
"oaepHashingAlgorithm" : {
"type" : "string"
},
"iv" : {
"type" : "string"
},
"panUniqueReference" : {
"type" : "string"
},
"tokens" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"TspDecisioningInfo" : {
"type" : "object",
"properties" : {
"recommendedDecision" : {
"type" : "string",
"enum" : [ "APPROVED", "DECLINED", "REQUIRE_ADDITIONAL_AUTHENTICATION" ]
},
"tokenScore" : {
"type" : "string"
}
}
},
"BillingAddress" : {
"type" : "object",
"properties" : {
"line1" : {
"type" : "string"
},
"line2" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"countrySubdivision" : {
"type" : "string"
},
"postalCode" : {
"type" : "string"
},
"country" : {
"type" : "string"
}
}
},
"EncryptedPayload" : {
"type" : "object",
"properties" : {
"encryptedData" : {
"$ref" : "#/definitions/EncryptedData"
},
"publicKeyFingerprint" : {
"type" : "string"
},
"encryptedKey" : {
"type" : "string"
},
"oaepHashingAlgorithm" : {
"type" : "string"
},
"iv" : {
"type" : "string"
}
}
},
"EncryptedData" : {
"type" : "object",
"properties" : {
"accountNumber" : {
"type" : "string"
},
"expiryMonth" : {
"type" : "string"
},
"expiryYear" : {
"type" : "string"
},
"securityCode" : {
"type" : "string"
},
"cardholder" : {
"type" : "string"
},
"billingAddress" : {
"$ref" : "#/definitions/BillingAddress"
}
}
},
"AuthorizeServiceResponse" : {
"type" : "object",
"properties" : {
"responseId" : {
"type" : "string"
},
"services" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"decision" : {
"type" : "string"
},
"activationMethods" : {
"type" : "array",
"items" : {
"type" : "object"
}
},
"panSequenceNumber" : {
"type" : "string"
},
"issuerProductConfigId" : {
"type" : "string"
},
"encryptedPayload" : {
"$ref" : "#/definitions/EncryptedPayload"
},
"cvcResponse" : {
"type" : "string"
},
"avsResponse" : {
"type" : "string"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.AuthorizeServiceResponse"
}
},
"AuthorizeBinding" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string"
},
"paymentNetwork" : {
"type" : "string"
},
"tokenRequestorId" : {
"type" : "string"
},
"tokenUniqueReference" : {
"type" : "string"
},
"panUniqueReference" : {
"type" : "string"
},
"walletAccountEmailAddressHash" : {
"type" : "string"
},
"clientWalletAccountId" : {
"type" : "string"
},
"locale" : {
"type" : "string"
},
"deviceInfo" : {
"$ref" : "#/definitions/DeviceInfo"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.AuthorizeBinding"
}
},
"AuthorizeBindingResponse" : {
"type" : "object",
"properties" : {
"responseId" : {
"type" : "string"
},
"decision" : {
"type" : "string"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.AuthorizeBindingResponse"
}
},
"RequestActivationMethods" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string"
},
"paymentNetwork" : {
"type" : "string"
},
"services" : {
"type" : "array",
"items" : {
"type" : "object"
}
},
"cardInfo" : {
"$ref" : "#/definitions/CardInfo"
},
"correlationId" : {
"type" : "string"
},
"tokenRequestorId" : {
"type" : "string"
},
"tokenUniqueReference" : {
"type" : "string"
},
"walletId" : {
"type" : "string"
},
"paymentAppInstanceId" : {
"type" : "string"
},
"accountIdHash" : {
"type" : "string"
},
"mobileNumberSuffix" : {
"type" : "string"
},
"tokenType" : {
"type" : "string"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.RequestActivationMethods"
}
},
"RequestActivationMethodsResponse" : {
"type" : "object",
"properties" : {
"responseId" : {
"type" : "string"
},
"activationMethods" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ActivationMethod"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.RequestActivationMethodsResponse"
}
},
"ActivationMethod" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
},
"DeliverActivationCode" : {
"type" : "object",
"properties" : {
"requestId" : {
"type" : "string"
},
"paymentNetwork" : {
"type" : "string"
},
"tokenUniqueReference" : {
"type" : "string"
},
"correlationId" : {
"type" : "string"
},
"activationCode" : {
"type" : "string"
},
"expirationDateTime" : {
"type" : "string"
},
"activationMethod" : {
"$ref" : "#/definitions/ActivationMethod"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.DeliverActivationCode"
}
},
"DeliverActivationCodeResponse" : {
"type" : "object",
"properties" : {
"responseId" : {
"type" : "string"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.predigitization.DeliverActivationCodeResponse"
}
},
"PaymentInfo" : {
"type" : "object",
"required" : [ "CardExpiryMonth", "CardExpiryYear", "CardNumber" ],
"properties" : {
"CardNumber" : {
"type" : "string",
"description" : "Payment card number used in transaction. Length - between 13 and 19 Characters"
},
"CardExpiryMonth" : {
"type" : "string",
"description" : "Expiration month"
},
"CardExpiryYear" : {
"type" : "string",
"description" : "Expiration year. For 3DS1 Transactions this value is 4-digits e.g. 2019. For 3DS2 Transactions this value is 2-digits e.g. 19."
},
"CardType" : {
"type" : "string",
"description" : "Card or account type e.g. Debit or Credit.",
"enum" : [ "CREDIT", "DEBIT", "NOTAPPLICABLE" ]
},
"CardHolderName" : {
"type" : "string",
"description" : "Name of the cardholder. Length - Up to 45 Characters"
}
}
},
"CardholderSelectionInfo" : {
"type" : "object",
"properties" : {
"Type" : {
"type" : "string",
"description" : "Type describing the cardholder selection e.g. Primary (P) or Secondary (S) cardholder.",
"enum" : [ "P", "S" ]
},
"Name" : {
"type" : "string",
"description" : "The name of the selected cardholder. Only needed if Secondary cardholder is selected to match against."
}
},
"description" : "Object defining the consumers selection during the Cardholder Selection OTP flow. This feature is only populated and enabled for Issuers supporting this flow."
},
"MerchantInfo" : {
"type" : "object",
"required" : [ "MerchantURL" ],
"properties" : {
"AcquirerId" : {
"type" : "string",
"description" : "AcquirerId for the merchant performing the purchase request. Length - Up to 11 Characters"
},
"AcquirerCountryCode" : {
"type" : "string",
"example" : "840",
"description" : "Country code of the Acquirer. ISO 3166-1 Numeric format. Issuers need to be aware of the acquirer country code when the acquirer country differs from the merchant country and the acquirer is in the EEA (this could mean that the transaction is covered by PSD2). Note: Currently only available on Mastercard EMV 3DS transactions where extension data is present. Will be available in future EMV versions."
},
"MerchantId" : {
"type" : "string",
"description" : "MerchantId for the merchant performing the purchase request."
},
"MerchantName" : {
"type" : "string",
"description" : "Merchant Name for the merchant performing the purchase request. Length - Up to 40 Characters"
},
"MerchantURL" : {
"type" : "string",
"description" : "URL or App Name for the merchant's website or app. Length - Up to 2048 Characters"
},
"MerchantCategoryCode" : {
"type" : "string",
"description" : "Code used to describe the merchant's type of business product or service."
},
"MerchantCountryCode" : {
"type" : "string",
"description" : "Country code of the merchant. For 3DS1 transactions this value is alpha-2 format e.g. US. For 3DS2 transactions this value is numeric-3 format e.g. 840."
}
}
},
"BasicTransactionInfo" : {
"type" : "object",
"properties" : {
"TransactionTimeStamp" : {
"type" : "string",
"description" : "Transaction timestamp in UTC per ISO 8601 UTC. Length - 24 Characters e.g 2019-03-21T20:55:49.000Z"
},
"TransactionAmount" : {
"type" : "number",
"description" : "Transaction Amount (raw amount, example 1000 for $10.00). Length - Up to 48 Characters"
},
"TransactionCurrency" : {
"type" : "string",
"description" : "ISO 4217 3 digit numeric standard.[ISO 4217 Link] https://en.wikipedia.org/wiki/ISO_4217 Length - 3 Characters"
},
"TransactionExponent" : {
"type" : "integer",
"format" : "int32",
"description" : "Exponent for formatting the given currency ISO 4217 code. Length - 1 Character"
},
"TransactionType" : {
"type" : "string",
"description" : "Type of the transaction.",
"enum" : [ "PURCHASE", "CARDADD" ]
},
"MandatedRegion" : {
"type" : "string",
"description" : "A value describing the region in which mandates may apply to the current transaction. Added to support the new PSD2 transactions in the EEA. A value of EEA will denote that the transaction falls under the PSD2 mandates, otherwise the value will be null. Note - you must account for new values being added to this field over time due to new regulations being rolled out in other regions",
"enum" : [ "EEA", "NONE", "UNKNOWN" ]
},
"Channel" : {
"type" : "string",
"description" : "Channel in which the transaction occurs.",
"enum" : [ "WEB", "APP", "MWEB", "THREERI" ]
}
}
},
"StepupRequest" : {
"type" : "object",
"required" : [ "IssuerId", "MessageVersion", "ProcessorId", "StepupCounter", "StepupRequestId", "TransactionId" ],
"properties" : {
"ProcessorId" : {
"type" : "string",
"description" : "Cardinal provided identifier for the partner. Length - Up to 24 Characters"
},
"IssuerId" : {
"type" : "string",
"description" : "Cardinal provided identifier for the partner. Length - Up to 24 Characters"
},
"TransactionId" : {
"type" : "string",
"description" : "VCAS generated transaction reference id. Length - Up to 36 Characters. 3DS 1.0.2 - 28 character alpha-numeric. EMV 3DS - 36 character GUID."
},
"DSTransactionId" : {
"type" : "string",
"description" : "Directory Server (DS) generated transaction reference id. GUID Format. Note: EMV 3DS Transactions only"
},
"StepupRequestId" : {
"type" : "string",
"description" : "Unique identifier to identify the particular Stepup request. Length will be 36 Characters."
},
"StepupCounter" : {
"type" : "integer",
"format" : "int32",
"description" : "Counter for tracking the number of Stepups. Each stepup can go from Stepup -> InitiateAction -> Validate. If the user requests a \"resend\" via the browser templates it will initiate another Stepup request."
},
"DeviceLocale" : {
"type" : "string",
"description" : "Device Locale from the browser header or from the app’s language settings. This value can be a single locale value or multiple concatenated together via commas. In 3DS1 this value will be directly from the browser’s “Accept-Language” header. However, in 3DS2 this is not available due to new flows so this will be a single language value following BCP 47 format e.g. en-US or en,es-PE;q=0.9,es;q=0.8"
},
"DeviceUserAgent" : {
"type" : "string",
"description" : "Device user agent from the browser header or the app's device identifier. Length - Up to 2048 Characters"
},
"MessageVersion" : {
"type" : "string",
"description" : "Version of the message based on 3DS spec. Examples - 1.0.2, 2.1.0, 2.2.0"
},
"RDXMessageVersion" : {
"type" : "string",
"description" : "Version of the RDX protocol being used. This will be used to enable new features without breaking current integrations. Example: 2.2.0 and 2.2.1"
},
"StepupReason" : {
"type" : "string",
"description" : "Used to identify the reason the Stepup request was initiated. Only available for Cardholder Resend, future values and scenarios may be added.",
"enum" : [ "CARDHOLDER_RESEND" ]
},
"MerchantInfo" : {
"$ref" : "#/definitions/MerchantInfo"
},
"PaymentInfo" : {
"$ref" : "#/definitions/PaymentInfo"
},
"TransactionInfo" : {
"$ref" : "#/definitions/BasicTransactionInfo"
},
"CardholderSelectionInfo" : {
"$ref" : "#/definitions/CardholderSelectionInfo"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.vcas.StepupRequest"
}
},
"Credential" : {
"type" : "object",
"required" : [ "Id", "Type" ],
"properties" : {
"Id" : {
"type" : "string",
"description" : "Identifier for the credential requested, this will be passed on the InitiateAction request as well as the ValidateRequest. Length will be 36 Characters. The Id must be unique per credential object returned. The Id is used to distinguish the specific authenticate type in preceding InitiateAction and ValidateRequest calls."
},
"Type" : {
"type" : "string",
"description" : "Type of the Credential used for stepup, this is meta data and will not be used in any business logic",
"enum" : [ "OTPEMAIL", "OTPSMS", "OTPIVR", "KBASINGLE", "KBAMULTI", "BIOMETRIC", "OUTOFBANDOTHER" ]
},
"Text" : {
"type" : "string",
"description" : "Dynamic data to be displayed to the cardholder i.e. masked phone number or email address. Note: certain browser screen templates will only be able to show a certain number of characters before showing an elipsis (...). Up to 35 characters. Note: in EMV SDK flows the text space is limited. Up to 40 characters."
}
}
},
"WhyInfo" : {
"type" : "object",
"properties" : {
"Label" : {
"type" : "string",
"description" : "Label to be displayed to the Cardholder for the \"why\" information section."
},
"Text" : {
"type" : "string",
"description" : "Text provided by the Issuer to be displayed to the Cardholder to explain why the Cardholder is being asked to perform the authentication task. Note: Carriage return is supported in this data element and is represented by an “\\n”."
}
},
"description" : "Object defining dynamic text values that can be shown to the consumer during the challenge flow. These fields will be mapped directly to both browser templates and SDK info fields. Note: this field is also configurable for SDK screens today via our template configuration. If this value is passed on RDX it will override the current configurable value."
},
"StepupResponse" : {
"type" : "object",
"required" : [ "Credentials", "IssuerId", "ProcessorId", "Status", "StepupRequestId", "TransactionId" ],
"properties" : {
"ProcessorId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 24 Characters"
},
"IssuerId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 24 Characters"
},
"TransactionId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 36 Characters"
},
"StepupRequestId" : {
"type" : "string",
"description" : "Echoed from Request. Length - 36 Characters"
},
"StepupType" : {
"type" : "string",
"description" : "Used to identify what type of stepup.",
"enum" : [ "CHOICE", "OTP", "KBA", "BIOMETRIC", "OUTOFBAND", "OTP_AND_KBA", "OTP_CHOICE_AND_KBA" ]
},
"Language" : {
"type" : "string",
"description" : "Language to display the instructions and prompt to the cardholder. This value will decide which template is loaded, provided the correct template language is available. If not provided, the language is selected based on Issuer configuration and browser preference e.g. en-US. Length - Up to 8 Characters"
},
"Status" : {
"type" : "string",
"description" : "ERROR is returned on any interal/technical issues. ATTEMPTS is only supported for 1.0.2 transactions. REJECTED is only supported for 2.x.x transactions. AUTHENTICATED will return a Y back to the merchant",
"enum" : [ "SUCCESS", "ERROR", "BLOCKED", "FAILURE", "FAILWITHFEEDBACK", "ATTEMPTS", "AUTHENTICATED", "REJECTED" ]
},
"RiskIndicator" : {
"type" : "string",
"description" : "If returned, this value will be used in the creation of certain Authentication Values (AV) for EMV 3DS. The value passed must conform to the current AV value the Issuer is using. This may also depend on the card brand of the transaction. For example, CAVV and IAV accept different values. On Challenge responses (Stepup, Initiate, Validate) this value is currently ignored for CAVV usages in favor of mapping to the “Credential Type”. For Enhanced IAV SPA2 usage, if passed, this value will override the mapping to the “Credential Type”. Note: This field is only available for EMV 3DS transactions and not available on 3DS 1 transactions Note: The value here will be converted to the Hexadecimal equivalent. Please see “VCAS Enhanced AV” document for more details on current AVs available and the corresponding values. "
},
"Credentials" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Credential"
}
},
"Reason" : {
"$ref" : "#/definitions/Reason"
},
"Error" : {
"$ref" : "#/definitions/ErrorMessage"
},
"WhyInfo" : {
"$ref" : "#/definitions/WhyInfo"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.vcas.StepupResponse"
}
},
"ErrorMessage" : {
"type" : "object",
"properties" : {
"ReferenceNumber" : {
"type" : "string",
"description" : "System reference number for the error message. Length - Up to 15 Characters"
},
"Description" : {
"type" : "string",
"description" : "A description of the error. Length - Up to 50 Characters"
},
"Message" : {
"type" : "string",
"description" : "A message that will be displayed to the customer on the error screen. Length - Up to 100 Characters"
}
}
},
"Reason" : {
"type" : "object",
"properties" : {
"ReasonCode" : {
"type" : "string",
"description" : "Used by the issuer for informational purposes. Length - Up to 32 Characters"
},
"ReasonDescription" : {
"type" : "string",
"description" : "Used by the issuer for informational purposes. Length - Up to 256 Characters"
}
}
},
"InitiateActionRequest" : {
"type" : "object",
"required" : [ "Credentials", "IssuerId", "MessageVersion", "ProcessorId", "StepupCounter", "StepupRequestId", "TransactionId" ],
"properties" : {
"ProcessorId" : {
"type" : "string",
"description" : "Cardinal provided identifier for the partner. Length - Up to 24 Characters"
},
"IssuerId" : {
"type" : "string",
"description" : "Cardinal provided identifier for the partner. Length - Up to 24 Characters"
},
"TransactionId" : {
"type" : "string",
"description" : "VCAS generated transaction reference id. Length - Up to 36 Characters. 3DS 1.0.2 - 28 character alpha-numeric. EMV 3DS - 36 character GUID."
},
"DSTransactionId" : {
"type" : "string",
"description" : "Directory Server (DS) generated transaction reference id. GUID Format. Note: EMV 3DS Transactions only"
},
"StepupRequestId" : {
"type" : "string",
"description" : "Unique identifier to identify the particular Stepup request. Length - 36 Characters"
},
"StepupType" : {
"type" : "string",
"description" : "Used to identify what type of stepup.",
"enum" : [ "CHOICE", "OTP", "KBA", "BIOMETRIC", "OUTOFBAND", "OTP_AND_KBA", "OTP_CHOICE_AND_KBA" ]
},
"StepupCounter" : {
"type" : "integer",
"format" : "int32",
"description" : "Counter for tracking the number of Stepups. Each stepup can go from Stepup -> InitiateAction -> Validate. If the user requests a \"resend\" via the browser templates it will initiate another Stepup request."
},
"OtpReferenceCode" : {
"type" : "string",
"description" : "This is a unique value generated with each new OTP value or “VerificationToken”. In the instance where the consumer can receive multiple OTPs for the same transaction, this can be leveraged to show the consumer which OTP the system is expecting to be entered. This value should be sent in the SMS or Email along with the VerificationToken and then displayed on the consumer screen."
},
"VerificationToken" : {
"type" : "string",
"description" : "Token to be sent to cardholder."
},
"MessageVersion" : {
"type" : "string",
"description" : "Version of the message based on 3DS spec. Examples - 1.0.2, 2.1.0, 2.2.0"
},
"RDXMessageVersion" : {
"type" : "string",
"description" : "Version of the RDX protocol being used. This will be used to enable new features without breaking current integrations. Example: 2.2.0 and 2.2.1"
},
"Credentials" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Credential"
}
},
"MerchantInfo" : {
"$ref" : "#/definitions/MerchantInfo"
},
"PaymentInfo" : {
"$ref" : "#/definitions/PaymentInfo"
},
"TransactionInfo" : {
"$ref" : "#/definitions/BasicTransactionInfo"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.vcas.InitiateActionRequest"
}
},
"InitiateActionResponse" : {
"type" : "object",
"required" : [ "Credentials", "IssuerId", "ProcessorId", "Status", "StepupRequestId", "TransactionId" ],
"properties" : {
"ProcessorId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 24 Characters"
},
"IssuerId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 24 Characters"
},
"TransactionId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 36 Characters"
},
"StepupRequestId" : {
"type" : "string",
"description" : "Echoed from Request. Length - 36 Characters"
},
"Language" : {
"type" : "string",
"description" : "Language to display the instructions and prompt to the cardholder. This value will decide which template is loaded, provided the correct template language is available. If not provided, the language is selected based on Issuer configuration and browser preference e.g. en-US. Length - Up to 8 Characters"
},
"Status" : {
"type" : "string",
"description" : "ERROR is returned on any interal/technical issues. ATTEMPTS is only supported for 1.0.2 transactions. REJECTED is only supported for 2.x.x transactions. AUTHENTICATED will return a Y back to merchant",
"enum" : [ "SUCCESS", "ERROR", "BLOCKED", "FAILURE", "ATTEMPTS", "AUTHENTICATED", "FAILWITHFEEDBACK", "STEPUP", "REJECTED" ]
},
"RiskIndicator" : {
"type" : "string",
"description" : "If returned, this value will be used in the creation of certain Authentication Values (AV) for EMV 3DS. The value passed must conform to the current AV value the Issuer is using. This may also depend on the card brand of the transaction. For example, CAVV and IAV accept different values. On Challenge responses (Stepup, Initiate, Validate) this value is currently ignored for CAVV usages in favor of mapping to the “Credential Type”. For Enhanced IAV SPA2 usage, if passed, this value will override the mapping to the “Credential Type”. Note: This field is only available for EMV 3DS transactions and not available on 3DS 1 transactions Note: The value here will be converted to the Hexadecimal equivalent. Please see “VCAS Enhanced AV” document for more details on current AVs available and the corresponding values. "
},
"Credentials" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Credential"
}
},
"Reason" : {
"$ref" : "#/definitions/Reason"
},
"Error" : {
"$ref" : "#/definitions/ErrorMessage"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.vcas.InitiateActionResponse"
}
},
"ValidateRequest" : {
"type" : "object",
"required" : [ "CredentialResponse", "IssuerId", "MessageVersion", "ProcessorId", "StepupCounter", "StepupRequestId", "TransactionId" ],
"properties" : {
"ProcessorId" : {
"type" : "string",
"description" : "Cardinal provided identifier for the partner. Length - Up to 24 Characters"
},
"IssuerId" : {
"type" : "string",
"description" : "Cardinal provided identifier for the partner. Length - Up to 24 Characters"
},
"TransactionId" : {
"type" : "string",
"description" : "VCAS generated transaction reference id. Length - Up to 36 Characters. 3DS 1.0.2 - 28 character alpha-numeric. EMV 3DS - 36 character GUID."
},
"StepupType" : {
"type" : "string",
"description" : "Used to identify what type of stepup.",
"enum" : [ "CHOICE", "OTP", "KBA", "BIOMETRIC", "OUTOFBAND", "OTP_AND_KBA", "OTP_CHOICE_AND_KBA" ]
},
"DSTransactionId" : {
"type" : "string",
"description" : "Directory Server (DS) generated transaction reference id. GUID Format. Note: EMV 3DS Transactions only"
},
"FirstFactorOutcome" : {
"type" : "string",
"description" : "Will provide the outcome of the first authentication. Success, Failure, and Retry should be the only valid values. However, a status of Pending, FailWithFeedback, Blocked, Rejected, and Attempts can be returned if an Issuer returned one of these Status on the first RDX Validate response.",
"enum" : [ "SUCCESS", "FAILURE", "RETRY", "PENDING", "FAILWITHFEEDBACK", "BLOCKED", "REJECTED", "ATTEMPTS" ]
},
"StepupRequestId" : {
"type" : "string",
"description" : "Unique identifier to identify the particular Stepup request. Length - 36 Characters"
},
"StepupCounter" : {
"type" : "integer",
"format" : "int32",
"description" : "Counter for tracking the number of Stepups. Each stepup can go from Stepup -> InitiateAction -> Validate. If the user requests a \"resend\" via the browser templates it will initiate another Stepup request."
},
"MessageVersion" : {
"type" : "string",
"description" : "Version of the message based on 3DS spec. Examples - 1.0.2, 2.1.0, 2.2.0"
},
"RDXMessageVersion" : {
"type" : "string",
"description" : "Version of the RDX protocol being used. This will be used to enable new features without breaking current integrations. Example: 2.2.0 and 2.2.1"
},
"CredentialResponse" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CredentialValidate"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.vcas.ValidateRequest"
}
},
"CredentialValidate" : {
"type" : "object",
"properties" : {
"Id" : {
"type" : "string",
"description" : "Id value from the StepupResponse->Credential. Length will be 36 Characters."
},
"Type" : {
"type" : "string",
"description" : "Type of the Credential used for stepup, this is meta data and will not be used in any business logic",
"enum" : [ "OTPEMAIL", "OTPSMS", "OTPIVR", "KBASINGLE", "KBAMULTI_MAY_BE_SUPPORTED_IN_FUTURE_VERSIONS_OF_VCAS_", "BIOMETRIC", "OUTOFBANDOTHER" ]
},
"Value" : {
"type" : "string",
"description" : "Value provided by the cardholder."
}
}
},
"ValidateResponse" : {
"type" : "object",
"required" : [ "IssuerId", "ProcessorId", "Status", "StepupRequestId", "TransactionId" ],
"properties" : {
"ProcessorId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 24 Characters"
},
"IssuerId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 24 Characters"
},
"TransactionId" : {
"type" : "string",
"description" : "Echoed from Request. Length - Up to 36 Characters"
},
"StepupRequestId" : {
"type" : "string",
"description" : "Echoed from Request. Length - 36 Characters"
},
"Language" : {
"type" : "string",
"description" : "Language to display the instructions and prompt to the cardholder. This value will decide which template is loaded, provided the correct template language is available. If not provided, the language is selected based on Issuer configuration and browser preference e.g. en-US. Length - Up to 8 Characters"
},
"CredentialId" : {
"type" : "string",
"description" : "ID value from StepupResponse->Credential. Length - 36 Characters"
},
"Status" : {
"type" : "string",
"description" : "Status of the validation request. RETRY status will alllow the customer to re-attempt validation. PENDING status will initiate a Validate Request from VCAS to the partner after a agreed upon time period and will only be used when StepUpResponse->Type is OutOfBand. STEPUP can be returned to allow the customer to challenged again. BLOCKED is returned when the customer's card has been disabled and content is displayed to the user before returning the status back. FAILURE is returned when the customer is not authorized and status is immediately returned. ERROR is returned when an internal/technical error has occurred. ATTEMPTS is only supported for 1.0.2 transactions. REJECTED is only supported for 2.x.x transactions",
"enum" : [ "SUCCESS", "FAILURE", "RETRY", "PENDING", "BLOCKED", "STEPUP", "ERROR", "ATTEMPTS", "FAILWITHFEEDBACK", "REJECTED" ]
},
"RiskIndicator" : {
"type" : "string",
"description" : "If returned, this value will be used in the creation of certain Authentication Values (AV) for EMV 3DS. The value passed must conform to the current AV value the Issuer is using. This may also depend on the card brand of the transaction. For example, CAVV and IAV accept different values. On Challenge responses (Stepup, Initiate, Validate) this value is currently ignored for CAVV usages in favor of mapping to the “Credential Type”. For Enhanced IAV SPA2 usage, if passed, this value will override the mapping to the “Credential Type”. Note: This field is only available for EMV 3DS transactions and not available on 3DS 1 transactions Note: The value here will be converted to the Hexadecimal equivalent. Please see “VCAS Enhanced AV” document for more details on current AVs available and the corresponding values. "
},
"Reason" : {
"$ref" : "#/definitions/Reason"
},
"Error" : {
"$ref" : "#/definitions/ErrorMessage"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.vcas.ValidateResponse"
}
},
"PwsCreateFeeTemplateModel" : {
"type" : "object",
"required" : [ "amount_referenced", "api_call_unique_identifier", "applied_to", "client_id", "effective_date", "fee_descr", "fee_title", "fee_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"external_fee_reference_id" : {
"type" : "string",
"example" : "N/A",
"description" : "External Fee Reference Id"
},
"external_fee_reference_descr" : {
"type" : "string",
"example" : "N/A",
"description" : "External Fee Reference Descr"
},
"fee_type" : {
"type" : "string",
"example" : "FLP",
"description" : "<p>Fee Type that is to be applied.</br>Possible Options are:</p><table >\n<tbody>\n<tr>\n<th ><strong>fee_type</strong></th>\n<th ><strong>fee_type_name</strong></th>\n<th ><strong>fee_type_description</strong></th>\n<th ><strong>fee_condition_usage</strong></th>\n</tr>\n<tr>\n<td >AUT</td>\n<td >Transaction Authorization Fee</td>\n<td>The fee is charged at transaction level during the Authorization Process. It is used in the Fraud Rules Engine</td>\n<td>1</td>\n</tr>\n<tr>\n<td >PER</td>\n<td >Periodic Fee</td>\n<td>Fee applied based on a predefined frequency</td>\n<td>2</td>\n</tr>\n<tr>\n<td >ADH</td>\n<td >Ad-Hoc Fee</td>\n<td>The fee is charged sporadically.</td>\n<td>0</td>\n</tr>\n<tr>\n<td >MSC</td>\n<td >Miscellaneous Fee</td>\n<td>Catch-All Fee triggered over API. Allows custom amount over an API call or a Billing Descriptor</td>\n<td>0</td>\n</tr>\n<tr>\n<td >FLP</td>\n<td >Late Payment Fee</td>\n<td>The fee is charged at the end of the Billing Cycle in case of a late payment or missed payment on account.</td>\n<td>0</td>\n</tr>\n<tr>\n<td >FRB</td>\n<td >Fee Rebate</td>\n<td>The fee rebate resulted by a reversal, etc.</td>\n<td>0</td>\n</tr>\n<tr>\n<td >FOL</td>\n<td >Over-the-Limit-Fee</td>\n<td>The fee is charged when the Credit Limit was exceeded and overdraft was applied</td>\n<td>2</td>\n</tr>\n<tr>\n<td >FCC</td>\n<td >Currency Conversion Fee</td>\n<td>The fee is charged when the currency conversion process took place.</td>\n<td>2</td>\n</tr>\n<tr>\n<td >DOR</td>\n<td >Dormancy Fee</td>\n<td>The fee is charged when the account is dormant during certain period of time determined by the Condition Function</td>\n<td>1</td>\n</tr>\n</tbody>\n</table>\n",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "AUT", "PER", "ADH", "MSC", "FLP", "FRB", "FOL", "FCC", "DOR" ]
},
"fee_title" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Title",
"minLength" : 1,
"maxLength" : 200,
"pattern" : "^[^<>/;`%]*$"
},
"fee_descr" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Description",
"minLength" : 1,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"condition_function_call" : {
"type" : "string",
"example" : "</>",
"description" : "<p>Condition Function Call (to determine if the fee should be applied or not.</br>Empty string means that the fee can be applied unconditionally</p>)"
},
"effective_date" : {
"type" : "string",
"example" : "2020-11-19",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>MAN: Api Charge Fee</li><li>SPE: Special Event</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "BLC", "ANN", "DAY", "MAN", "SPE" ]
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>The amout percentage is counted from</br>\n possible options are:\n <ul><li>N/A: Amount is irrelevant</li>\n <li>TXN: transaction</li>\n <li>OWD: Amount owed</li>\n <li>ATA: Aggregated amount of all transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li>\n <li>ATD: Aggregated amount of debit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li>\n <li>ATC: Aggregated amount of credit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li><li>BAL: Statement Balance</li><li>DUE:Minimum Due</li> <li>OLA: Over Limit Amount</li></ul></p>\n",
"minLength" : 0,
"maxLength" : 3
},
"concurrency" : {
"type" : "boolean",
"example" : false,
"description" : "If set to TRUE, then the fee will possibly be concurrent with other fees in the same Fee Priority Section"
},
"fee_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Fee Priority Section (to decide about how to apply concurrent fees belonging to the same Fee Priority Section).</br>If concurrency = FALSE, this parameter must be NULL</p>",
"minimum" : 0,
"maximum" : 9
},
"fee_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current fee in presence of multiple fees from the same Fee Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
},
"special_actions" : {
"type" : "string",
"example" : "Generic Fee Applied to TXN",
"description" : "Function call for a function making special actions"
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Rule Id"
},
"fee_basis" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "This parameter regulates in which case to apply the fee (of course, provided the rule is triggered):\n<ul><li>1: Apply only if the transaction is approved</li>\n<li>2: Apply only if the transaction is declined</li>\n<li>3: Apply only mo matter the transaction is approved or declined</li>\n<li>0: Irrelevant: The rule is not a subject for a fee (fee_id IS NULL)</li></ul>",
"minimum" : 0,
"maximum" : 3
},
"is_fee_rebate" : {
"type" : "boolean",
"example" : false,
"description" : "This field indicate if the fee template include rebate fee or not"
},
"taxable" : {
"type" : "boolean",
"example" : false,
"description" : "Taxable Fee. If this field is true then for the calculation tax_fee_percent will be taken from product level"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.PwsCreateFeeTemplateModel"
}
},
"CreateFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateFeeHeader"
},
"body" : {
"$ref" : "#/definitions/CreateFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.CreateFeeResponse"
}
},
"CreateFeeBody" : {
"type" : "object",
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
}
}
},
"CreateFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateFeeTemplateModel" : {
"type" : "object",
"required" : [ "amount_referenced", "api_call_unique_identifier", "applied_to", "client_id", "effective_date", "fee_descr", "fee_id", "fee_title", "fee_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Template Id",
"minimum" : 1
},
"external_fee_reference_id" : {
"type" : "string",
"example" : "N/A",
"description" : "External Fee Reference Id"
},
"external_fee_reference_descr" : {
"type" : "string",
"example" : "N/A",
"description" : "External Fee Reference Descr"
},
"fee_type" : {
"type" : "string",
"example" : "FLP",
"description" : "<p>Fee Type that is to be applied.</br>Possible Options are:</p><table >\n<tbody>\n<tr>\n<th ><strong>fee_type</strong></th>\n<th ><strong>fee_type_name</strong></th>\n<th ><strong>fee_type_description</strong></th>\n<th ><strong>fee_condition_usage</strong></th>\n</tr>\n<tr>\n<td >AUT</td>\n<td >Transaction Authorization Fee</td>\n<td>The fee is charged at transaction level during the Authorization Process. It is used in the Fraud Rules Engine</td>\n<td>1</td>\n</tr>\n<tr>\n<td >PER</td>\n<td >Periodic Fee</td>\n<td>Fee applied based on a predefined frequency</td>\n<td>2</td>\n</tr>\n<tr>\n<td >ADH</td>\n<td >Ad-Hoc Fee</td>\n<td>The fee is charged sporadically.</td>\n<td>0</td>\n</tr>\n<tr>\n<td >MSC</td>\n<td >Miscellaneous Fee</td>\n<td>Catch-All Fee triggered over API. Allows custom amount over an API call or a Billing Descriptor</td>\n<td>0</td>\n</tr>\n<tr>\n<td >FLP</td>\n<td >Late Payment Fee</td>\n<td>The fee is charged at the end of the Billing Cycle in case of a late payment or missed payment on account.</td>\n<td>0</td>\n</tr>\n<tr>\n<td >FRB</td>\n<td >Fee Rebate</td>\n<td>The fee rebate resulted by a reversal, etc.</td>\n<td>0</td>\n</tr>\n<tr>\n<td >FOL</td>\n<td >Over-the-Limit-Fee</td>\n<td>The fee is charged when the Credit Limit was exceeded and overdraft was applied</td>\n<td>2</td>\n</tr>\n<tr>\n<td >FCC</td>\n<td >Currency Conversion Fee</td>\n<td>The fee is charged when the currency conversion process took place.</td>\n<td>2</td>\n</tr>\n<tr>\n<td >DOR</td>\n<td >Dormancy Fee</td>\n<td>The fee is charged when the account is dormant during certain period of time determined by the Condition Function</td>\n<td>1</td>\n</tr>\n</tbody>\n</table>\n",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "AUT", "PER", "ADH", "MSC", "FLP", "FRB", "FOL", "FCC", "DOR" ]
},
"fee_title" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Title",
"minLength" : 1,
"maxLength" : 200,
"pattern" : "^[^<>/;`%]*$"
},
"fee_descr" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Description",
"minLength" : 1,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"condition_function_call" : {
"type" : "string",
"example" : "</>",
"description" : "<p>Condition Function Call (to determine if the fee should be applied or not.</br>Empty string means that the fee can be applied unconditionally</p>)"
},
"effective_date" : {
"type" : "string",
"example" : "2020-11-19",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>MAN: Api Charge Fee</li><li>SPE: Special Event</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "BLC", "ANN", "DAY", "MAN", "SPE" ]
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>The amout percentage is counted from</br>\n possible options are:\n <ul><li>N/A: Amount is irrelevant</li>\n <li>TXN: transaction</li>\n <li>OWD: Amount owed</li>\n <li>ATA: Aggregated amount of all transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li>\n <li>ATD: Aggregated amount of debit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li>\n <li>ATC: Aggregated amount of credit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li><li>BAL: Statement Balance</li><li>DUE:Minimum Due</li> <li>OLA: Over Limit Amount</li></ul></p>\n",
"minLength" : 0,
"maxLength" : 3
},
"concurrency" : {
"type" : "boolean",
"example" : false,
"description" : "If set to TRUE, then the fee will possibly be concurrent with other fees in the same Fee Priority Section"
},
"fee_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Fee Priority Section (to decide about how to apply concurrent fees belonging to the same Fee Priority Section).</br>If concurrency = FALSE, this parameter must be NULL</p>",
"minimum" : 0,
"maximum" : 9
},
"fee_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current fee in presence of multiple fees from the same Fee Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
},
"special_actions" : {
"type" : "string",
"example" : "Generic Fee Applied to TXN",
"description" : "Function call for a function making special actions"
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Rule Id"
},
"fee_basis" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "This parameter regulates in which case to apply the fee (of course, provided the rule is triggered):\n<ul><li>1: Apply only if the transaction is approved</li>\n<li>2: Apply only if the transaction is declined</li>\n<li>3: Apply only mo matter the transaction is approved or declined</li>\n<li>0: Irrelevant: The rule is not a subject for a fee (fee_id IS NULL)</li></ul>",
"minimum" : 0,
"maximum" : 3
},
"is_fee_rebate" : {
"type" : "boolean",
"example" : false,
"description" : "This field indicate if the fee template include rebate fee or not"
},
"taxable" : {
"type" : "boolean",
"example" : false,
"description" : "Taxable Fee. If this field is true then for the calculation tax_fee_percent will be taken from product level"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.UpdateFeeTemplateModel"
}
},
"UpdateFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateFeeHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.UpdateFeeResponse"
}
},
"UpdateFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee Id 1 updated successfully",
"description" : "Message indicating the fee update"
}
}
},
"UpdateFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsGetFeeTemplateModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"fee_rate_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Fee Rate Id. [Optional]"
},
"fee_type" : {
"type" : "string",
"description" : "Fee Type. [Optional]"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.PwsGetFeeTemplateModel"
}
},
"GetCurrentFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetCurrentFeeHeader"
},
"body" : {
"$ref" : "#/definitions/GetCurrentFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetCurrentFeeResponse"
}
},
"GetCurrentFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetCurrentFeeBody" : {
"type" : "object",
"required" : [ "applied_to", "effective_date", "fee_descr", "fee_priority_section", "fee_sectional_priority", "fee_title", "fee_type" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 123456,
"description" : "client Id"
},
"fee_type" : {
"type" : "string",
"example" : "FEE",
"description" : "<p>Fee Type that is to be applied.</br>Possible Options are:<ul><li>FEE: General Fee</li>n<li>FCC: Currency Conversion Fee</li>\n<li>FFT: Foreign transaction Fee</li>\n<li>COL: Over-Limit Charge</li>\n<li>FLP: Late Payment Fee</li></ul></p>",
"enum" : [ "FEE", "FCC", "FFT", "COL", "FLP" ]
},
"fee_title" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Title"
},
"fee_descr" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Description"
},
"condition_function_call" : {
"type" : "string",
"example" : "</>",
"description" : "<p>Condition Function Call (to determine if the fee should be applied or not.</br>Empty string means that the fee can be applied unconditionally</p>)"
},
"effective_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-19",
"description" : "Effective Date"
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"enum" : [ "TXN", "BLC", "AANN", "DAY", "ONC" ]
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "The amout percentage is counted from"
},
"concurrency" : {
"type" : "boolean",
"example" : true,
"description" : "If set to TRUE, then the fee will possibly be concurrent with other fees in the same Fee Priority Section"
},
"fee_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Fee Priority Section (to decide about how to apply concurrent fees belonging to the same Fee Priority Section).</br>If concurrency = FALSE, this parameter must be NULL</p>",
"minimum" : 0,
"maximum" : 9
},
"fee_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current fee in presence of multiple fees from the same Fee Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
},
"special_actions" : {
"type" : "string",
"description" : "Function call for a function making special actions"
},
"priority_section_name" : {
"type" : "string",
"example" : "ATM Withdrawls",
"description" : "Priority Section Name"
}
}
},
"GetFeeTemplaetHistoricModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "fee_rate_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"fee_rate_id" : {
"type" : "integer",
"format" : "int32",
"example" : 13,
"description" : "Fee Template Id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.GetFeeTemplaetHistoricModel"
}
},
"GetHistoricFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetHistoricFeeBody" : {
"type" : "object",
"required" : [ "applied_to", "effective_date", "fee_descr", "fee_priority_section", "fee_sectional_priority", "fee_title", "fee_type" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 123456,
"description" : "client Id"
},
"fee_type" : {
"type" : "string",
"example" : "FEE",
"description" : "<p>Fee Type that is to be applied.</br>Possible Options are:<ul><li>FEE: General Fee</li>n<li>FCC: Currency Conversion Fee</li>\n<li>FFT: Foreign transaction Fee</li>\n<li>COL: Over-Limit Charge</li>\n<li>FLP: Late Payment Fee</li></ul></p>",
"enum" : [ "FEE", "FCC", "FFT", "COL", "FLP" ]
},
"fee_title" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Title"
},
"fee_descr" : {
"type" : "string",
"example" : "Generic Fee",
"description" : "Fee Description"
},
"condition_function_call" : {
"type" : "string",
"example" : "</>",
"description" : "<p>Condition Function Call (to determine if the fee should be applied or not.</br>Empty string means that the fee can be applied unconditionally</p>)"
},
"effective_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-19",
"description" : "Effective Date"
},
"expired_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-11-19",
"description" : "Expired Date"
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence Number"
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"enum" : [ "TXN", "BLC", "AANN", "DAY", "ONC" ]
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "The amout percentage is counted from"
},
"concurrency" : {
"type" : "boolean",
"example" : true,
"description" : "If set to TRUE, then the fee will possibly be concurrent with other fees in the same Fee Priority Section"
},
"fee_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Fee Priority Section (to decide about how to apply concurrent fees belonging to the same Fee Priority Section).</br>If concurrency = FALSE, this parameter must be NULL</p>",
"minimum" : 0,
"maximum" : 9
},
"fee_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current fee in presence of multiple fees from the same Fee Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
},
"special_actions" : {
"type" : "string",
"description" : "Function call for a function making special actions"
},
"priority_section_name" : {
"type" : "string",
"example" : "ATM Withdrawls",
"description" : "Priority Section Name"
},
"changed_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:12",
"description" : "Changed Date"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Change Event"
}
}
},
"GetFeeHistoricResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetHistoricFeeHeader"
},
"body" : {
"$ref" : "#/definitions/GetHistoricFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetFeeHistoricResponse"
}
},
"ProductFeeModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "fee_applied_to", "fee_id", "fee_rate_fixed", "fee_rate_fixed_grace", "fee_rate_logic", "fee_rate_logic_grace", "fee_rate_perc", "fee_rate_perc_grace", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"fee_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Fee in Percents of the balance owed. </br>Default:0.00</p>",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed fee that is not relative to amount_referenced (expressed in the account's billing currency).</br> Default:0.00</p>",
"minimum" : 0.0,
"exclusiveMinimum" : false
},
"fee_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Fee in Percents of the balance owed during the Grace Period",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period",
"minimum" : 0.0,
"exclusiveMinimum" : false
},
"fee_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee for the grace period computed and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"description" : "<p>Elevated (Penalty) Fee in Percents of the balance owed [For each day of the Late Payments].</br>Default:0.00</p>",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed_elevated" : {
"type" : "number",
"description" : "<p>Elevated (Penalty) fee applied [For each day of the Late Payments].</br>Default:0.00</p>",
"minimum" : 0
},
"fee_rate_logic_elevated" : {
"type" : "string",
"description" : "<p>Relation between elevated fee rates computed based on APR and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_rate_min_perc" : {
"type" : "number",
"format" : "double",
"description" : "Minimum charge charged in Percents of the balance owed",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_min_fixed" : {
"type" : "number",
"description" : "Minimum charge charged ",
"minimum" : 0
},
"fee_rate_min_logic" : {
"type" : "string",
"description" : " <p>Relation between minimum charge rates computed based on percents and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_rate_max_perc" : {
"type" : "number",
"format" : "double",
"description" : "Maximum fee charged in Percents of the balance owed",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_max_fixed" : {
"type" : "number",
"description" : "Maximum fee charged ",
"minimum" : 0
},
"fee_rate_max_logic" : {
"type" : "string",
"description" : "<p> Relation between maximum fee rates computed based on percents and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1,
"description" : "Fee Template Id",
"minimum" : 1
},
"effective_date" : {
"type" : "string",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"fee_applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "BLC", "ANN", "DAY", "ONC" ]
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 111,
"description" : "product id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.ProductFeeModel"
}
},
"CreateProductFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee id 1 applied to product id 111 successfully",
"description" : "message indicating fee applied to product"
}
}
},
"CreateProductFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateProductFeeHeader"
},
"body" : {
"$ref" : "#/definitions/CreateProductFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.CreateProductFeeResponse"
}
},
"CreateProductFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateProductFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateProductFeeHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateProductFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.UpdateProductFeeResponse"
}
},
"UpdateProductFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee Configuration Updated successfully for prod_id 111",
"description" : "message indicating fee update for product"
}
}
},
"UpdateProductFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsProductIdModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 103,
"description" : "product Id",
"minimum" : 1
}
},
"description" : "View Interest/Charge Rate applied to product",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.PwsProductIdModel"
}
},
"GetProductFeeBody" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace", "fee_descr" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 111,
"description" : "product Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_descr" : {
"type" : "string",
"example" : "fee applied for transaction",
"description" : "Fee Description"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
}
}
},
"GetProductFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetProductFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetProductFeeHeader"
},
"body" : {
"$ref" : "#/definitions/GetProductFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetProductFeeResponse"
}
},
"PwsGetProductFeeHistoricModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "applied_to", "client_id", "fee_id", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 495,
"description" : "product Id",
"minimum" : 1
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 95,
"description" : "Fee Id",
"minimum" : 1
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.PwsGetProductFeeHistoricModel"
}
},
"GetProductFeeHistoryResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetProductFeeHistoryHeader"
},
"body" : {
"$ref" : "#/definitions/GetProductFeeHistoryBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetProductFeeHistoryResponse"
}
},
"GetProductFeeHistoryHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetProductFeeHistoryBody" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace", "fee_descr" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 111,
"description" : "product Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_descr" : {
"type" : "string",
"example" : "fee applied for transaction",
"description" : "Fee Description"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence Number"
},
"changed_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:12",
"description" : "Changed Date"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Change Event"
}
}
},
"AccountFeeModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "effective_date", "fee_applied_to", "fee_id", "fee_rate_fixed", "fee_rate_fixed_grace", "fee_rate_logic", "fee_rate_logic_grace", "fee_rate_perc", "fee_rate_perc_grace" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"fee_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Fee in Percents of the balance owed. </br>Default:0.00</p>",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed fee that is not relative to amount_referenced (expressed in the account's billing currency).</br> Default:0.00</p>",
"minimum" : 0.0,
"exclusiveMinimum" : false
},
"fee_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Fee in Percents of the balance owed during the Grace Period",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period",
"minimum" : 0.0,
"exclusiveMinimum" : false
},
"fee_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee for the grace period computed and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"description" : "<p>Elevated (Penalty) Fee in Percents of the balance owed [For each day of the Late Payments].</br>Default:0.00</p>",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed_elevated" : {
"type" : "number",
"description" : "<p>Elevated (Penalty) fee applied [For each day of the Late Payments].</br>Default:0.00</p>",
"minimum" : 0
},
"fee_rate_logic_elevated" : {
"type" : "string",
"description" : "<p>Relation between elevated fee rates computed based on APR and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_rate_min_perc" : {
"type" : "number",
"format" : "double",
"description" : "Minimum charge charged in Percents of the balance owed",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_min_fixed" : {
"type" : "number",
"description" : "Minimum charge charged ",
"minimum" : 0
},
"fee_rate_min_logic" : {
"type" : "string",
"description" : " <p>Relation between minimum charge rates computed based on percents and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_rate_max_perc" : {
"type" : "number",
"format" : "double",
"description" : "Maximum fee charged in Percents of the balance owed",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_max_fixed" : {
"type" : "number",
"description" : "Maximum fee charged ",
"minimum" : 0
},
"fee_rate_max_logic" : {
"type" : "string",
"description" : "<p> Relation between maximum fee rates computed based on percents and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1,
"description" : "Fee Template Id",
"minimum" : 1
},
"effective_date" : {
"type" : "string",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"fee_applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "BLC", "ANN", "DAY", "ONC" ]
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 465591301,
"description" : "account Id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.AccountFeeModel"
}
},
"CreateAccountFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateAccountFeeHeader"
},
"body" : {
"$ref" : "#/definitions/CreateAccountFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.CreateAccountFeeResponse"
}
},
"CreateAccountFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee id 1 applied to acc_id 465591301 successfully",
"description" : "message indicating fee applied to account"
}
}
},
"CreateAccountFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateAccountFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateAccountFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateAccountFeeHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateAccountFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.UpdateAccountFeeResponse"
}
},
"UpdateAccountFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee Configuration Updated successfully for acc_id 465591301",
"description" : "message indicating fee update for account"
}
}
},
"PwsAccountIdModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 856276925,
"description" : "account Id",
"minimum" : 1
}
},
"description" : "View Rewards applied to an account",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.PwsAccountIdModel"
}
},
"GetAccountFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"productResponse" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 111,
"description" : "product Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
}
}
},
"GetAccountFeeBody" : {
"type" : "object",
"properties" : {
"accountResponseList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/accountResponse"
}
},
"groupResponseList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/groupResponse"
}
},
"productResponseList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/productResponse"
}
}
}
},
"accountResponse" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 465591301,
"description" : "account Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
}
}
},
"GetAccountFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountFeeHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetAccountFeeResponse"
}
},
"groupResponse" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Credit group Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
}
}
},
"PwsGetAccountFeeHistoryModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "applied_to", "client_id", "fee_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 465591301,
"description" : "account Id",
"minimum" : 1
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1,
"description" : "Fee Id",
"minimum" : 1
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.PwsGetAccountFeeHistoryModel"
}
},
"GetAccountFeeHistroryResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountFeeHistoryHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountFeeHistoryBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetAccountFeeHistroryResponse"
}
},
"GetAccountFeeHistoryBody" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace", "fee_descr" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 465591301,
"description" : "account Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_descr" : {
"type" : "string",
"example" : "fee applied for transaction",
"description" : "Fee Description"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence Number"
},
"changed_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:12",
"description" : "Changed Date"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Change Event"
}
}
},
"GetAccountFeeHistoryHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GroupFeeModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "fee_applied_to", "fee_basis", "fee_id", "fee_rate_fixed", "fee_rate_fixed_grace", "fee_rate_logic", "fee_rate_logic_grace", "fee_rate_perc", "fee_rate_perc_grace", "group_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"fee_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Fee in Percents of the balance owed. </br>Default:0.00</p>",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed fee that is not relative to amount_referenced (expressed in the account's billing currency).</br> Default:0.00</p>",
"minimum" : 0.0,
"exclusiveMinimum" : false
},
"fee_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Fee in Percents of the balance owed during the Grace Period",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period",
"minimum" : 0.0,
"exclusiveMinimum" : false
},
"fee_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee for the grace period computed and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"description" : "<p>Elevated (Penalty) Fee in Percents of the balance owed [For each day of the Late Payments].</br>Default:0.00</p>",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_fixed_elevated" : {
"type" : "number",
"description" : "<p>Elevated (Penalty) fee applied [For each day of the Late Payments].</br>Default:0.00</p>",
"minimum" : 0
},
"fee_rate_logic_elevated" : {
"type" : "string",
"description" : "<p>Relation between elevated fee rates computed based on APR and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_rate_min_perc" : {
"type" : "number",
"format" : "double",
"description" : "Minimum charge charged in Percents of the balance owed",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_min_fixed" : {
"type" : "number",
"description" : "Minimum charge charged ",
"minimum" : 0
},
"fee_rate_min_logic" : {
"type" : "string",
"description" : " <p>Relation between minimum charge rates computed based on percents and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_rate_max_perc" : {
"type" : "number",
"format" : "double",
"description" : "Maximum fee charged in Percents of the balance owed",
"minimum" : 0,
"maximum" : 100
},
"fee_rate_max_fixed" : {
"type" : "number",
"description" : "Maximum fee charged ",
"minimum" : 0
},
"fee_rate_max_logic" : {
"type" : "string",
"description" : "<p> Relation between maximum fee rates computed based on percents and fixed amount.</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"pattern" : "^[SUM,MIN,MAX,AVG]{3}$"
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1,
"description" : "Fee Template Id",
"minimum" : 1
},
"effective_date" : {
"type" : "string",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"fee_applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "BLC", "ANN", "DAY", "ONC" ]
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Group Id"
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"description" : "Rule Id"
},
"fee_basis" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "This parameter regulates in which case to apply the fee (of course, provided the rule is triggered):\n<ul><li>1: Apply only if the transaction is approved</li>\n<li>2: Apply only if the transaction is declined</li>\n<li>3: Apply only mo matter the transaction is approved or declined</li>\n<li>0: Irrelevant: The rule is not a subject for a fee (fee_id IS NULL)</li></ul>",
"maximum" : 3
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.GroupFeeModel"
}
},
"CreateGroupFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateGroupFeeHeader"
},
"body" : {
"$ref" : "#/definitions/CreateGroupFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.CreateGroupFeeResponse"
}
},
"CreateGroupFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"CreateGroupFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee id 1 applied to credit group id 1 successfully",
"description" : "message indicating fee applied to credit group"
}
}
},
"UpdateGroupFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateGroupFeeBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Fee Configuration Updated successfully for credit group 1",
"description" : "message indicating fee update for credit group"
}
}
},
"UpdateGroupFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateGroupFeeHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateGroupFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.UpdateGroupFeeResponse"
}
},
"PwsGroupIdModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "group_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "Group Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.creditgroup.PwsGroupIdModel"
}
},
"GetGroupFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetGroupFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetGroupFeeHeader"
},
"body" : {
"$ref" : "#/definitions/GetGroupFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetGroupFeeResponse"
}
},
"GetGroupFeeBody" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace", "fee_descr" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Credit group Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_descr" : {
"type" : "string",
"example" : "fee applied for transaction",
"description" : "Fee Description"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
}
}
},
"PwsGetGroupFeeHistoryModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "applied_to", "client_id", "fee_id", "group_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1195,
"description" : "group Id"
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1,
"description" : "Fee Template Id"
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li>\n <li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.PwsGetGroupFeeHistoryModel"
}
},
"GetGroupFeeHistoryHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetGroupFeeHistoryResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetGroupFeeHistoryHeader"
},
"body" : {
"$ref" : "#/definitions/GetGroupFeeHistoryBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetGroupFeeHistoryResponse"
}
},
"GetGroupFeeHistoryBody" : {
"type" : "object",
"required" : [ "charge_rate_fixed", "charge_rate_fixed_elevated", "charge_rate_fixed_grace", "charge_rate_logic", "charge_rate_logic_elevated", "charge_rate_logic_grace", "charge_rate_max_fixed", "charge_rate_max_logic", "charge_rate_max_perc", "charge_rate_min_fixed", "charge_rate_min_logic", "charge_rate_min_perc", "charge_rate_perc", "charge_rate_perc_elevated", "charge_rate_perc_grace", "fee_descr" ],
"properties" : {
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Credit group Id"
},
"charge_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed,Default=0.00"
},
"charge_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency,default=0.00"
},
"charge_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between fee computed based on APR and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_grace" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Charge Rate APR in Percents of the balance owed during the Grace Period"
},
"charge_rate_logic_grace" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between charge rates for the grace period computed based on APR and fixed amount:</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_perc_elevated" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Elevated (Penalty) Charge Rate APR in Percents of the balance owed [For each day of the Late Payments],default:0.00"
},
"charge_rate_fixed_elevated" : {
"type" : "number",
"example" : 1.0,
"description" : "Elevated (Penalty) charge charged [For each day of the Late Payments],default:0.00"
},
"charge_rate_logic_elevated" : {
"type" : "string",
"example" : "AVG",
"description" : "<p>Relation between elevated charge rates computed based on APR and fixed amount:</p>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_min_perc" : {
"type" : "number",
"format" : "float",
"example" : 1.0,
"description" : "Minimum charge charged in Percents of the balance owed"
},
"charge_rate_min_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Minimum charge charged "
},
"charge_rate_min_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between minimum charge rates computed based on percents and fixed amount::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"charge_rate_max_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "Maximum charge charged in Percents of the balance owed"
},
"charge_rate_max_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum charge charged "
},
"charge_rate_max_logic" : {
"type" : "string",
"example" : "AVG",
"description" : "<p> Relation between maximum charge rates computed based on percents and fixed amount:::</br>\nThe value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li>MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>"
},
"fee_descr" : {
"type" : "string",
"example" : "fee applied for transaction",
"description" : "Fee Description"
},
"charge_rate_fixed_grace" : {
"type" : "number",
"example" : 1.0,
"description" : "Fixed charge Rate in the account's Billing Currency during the Grace Period"
},
"effective_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:13",
"description" : "Effective Date"
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence Number"
},
"changed_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-11-20 11:12:12",
"description" : "Changed Date"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Change Event"
}
}
},
"PwsGetManualFeeModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 842914345,
"description" : "account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.PwsGetManualFeeModel"
}
},
"GetManualFeeBody" : {
"type" : "object",
"properties" : {
"cycle_id" : {
"type" : "integer",
"format" : "int32",
"example" : 32,
"description" : "Billing Cycle Id"
},
"operational_day" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-03-20",
"description" : "Operational Day"
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 98,
"description" : "Fee Id"
},
"charge_amt" : {
"type" : "number",
"example" : 1.0,
"description" : "Charge Amount"
},
"charge_source" : {
"type" : "string",
"example" : "M",
"description" : "Source from which charge is applied",
"enum" : [ "M", "A", "D", "B" ]
},
"cre_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-03-18 11:12:13",
"description" : "Created Date"
},
"fee_title" : {
"type" : "string",
"example" : "Manual Fee",
"description" : "Fee Title"
},
"fee_descr" : {
"type" : "string",
"example" : "Manual Fee",
"description" : "Fee Description"
}
}
},
"GetManualFeeResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetManualFeeHeader"
},
"body" : {
"$ref" : "#/definitions/GetManualFeeBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetManualFeeResponse"
}
},
"GetManualFeeHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"ApplyRebateFeeModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "input_id", "input_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type" : {
"type" : "string",
"example" : "a",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; Account</li>\n<li class=\"docBullet\">g ==&gt; Group</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[g,a,t,G,A,T]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 695534277,
"description" : "Group Id /token/ account number.</br>Pass group_id when input_type is 'g'.</br>Pass account number when input_type is 'a'.</br>Pass token when input_type is 't'.",
"minimum" : 1
},
"fee_amount" : {
"type" : "number",
"example" : 0.0,
"description" : "Amount that is charged as rebate fee"
},
"ext_fee_reference_id" : {
"type" : "string",
"description" : "Fee Reference Id from external system.</br>It is optional when fee_id is provided"
},
"fee_id" : {
"type" : "integer",
"format" : "int64",
"example" : 71,
"description" : "Fee id which is applied at group/account level.</br>It is optional when ext_fee_reference_id is provided."
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsmodel.feemodel.ApplyRebateFeeModel"
}
},
"ApplyRebateFeeResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"ApplyRebateFeeResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ApplyRebateFeeResponseModelHeader"
},
"body" : {
"$ref" : "#/definitions/ApplyRebateFeeResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.ApplyRebateFeeResponseModel"
}
},
"ApplyRebateFeeResponseModelBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Miscellaneous Fee Applied successfully for 465591301",
"description" : "message indicating rebate fee applied to account/group"
}
}
},
"GetAccountFeeDetailsResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountFeeDetailsHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountFeeDetailsBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.feeresponsemodel.GetAccountFeeDetailsResponse"
}
},
"GetAccountFeeDetailsHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountFeeDetailsBody" : {
"type" : "object",
"properties" : {
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 465591301,
"description" : "account Id"
},
"cycle_id" : {
"type" : "integer",
"format" : "int32",
"example" : 5,
"description" : "account Billing Cycle when transaction was posted"
},
"transaction_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-01-30",
"description" : "transaction Date"
},
"fee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Fee Id"
},
"applied_to" : {
"type" : "string",
"example" : "TXN",
"description" : "<p>Fee Applied to.</br><ul><li> TXN: transaction</li>\n<li>BLC: Billing Cycle (Period)</li>\n<li>ANN: Annually</li>\n<li>DAY: Daily (Computed during the overnight computational cycle)</li>\n<li>ONC: Once (non-recurring charge)</li></ul></p>"
},
"rid" : {
"type" : "integer",
"format" : "int64",
"example" : 492784,
"description" : "The RID of the transaction, which initiated the fee (ignored unless applied_to = 'TXN')"
},
"charge_amt" : {
"type" : "number",
"example" : 1.0,
"description" : "Charge Amount computed in Billing Currency"
},
"charge_source" : {
"type" : "string",
"example" : "T",
"description" : "<p> When the charge (fee) was computed related to fee applied_to</br><ul><li>T: transaction initiated fee</li>\n<li>D: Daily Fee computed during the daily overnight cycle</li>\n<li>B: Billing Period Fee computed after at end of the billing cycle</li>\n<li> A: Annual Fee computed during the Annual Routine</li></ul></p>"
},
"interest_rate_id" : {
"type" : "integer",
"format" : "int64",
"example" : 66,
"description" : "<p>Interest Rate ID for transaction Interest classification; </br>It is determined during the transaction Level Charges Computations.</br>If set to -1, that means the fee is not a subject for an interest</p>"
},
"posted_state" : {
"type" : "string",
"example" : "S",
"description" : "<p>When transaction is posted (settled or reversed) it contains the actual state:</br>\n<ul><li>S: Settled</li><li> R: Reversed</li><li> C: Cancelled</li><li> N: Not yet fully processed</li></ul></p>"
},
"posted_cycle_id" : {
"type" : "integer",
"format" : "int32",
"example" : 5,
"description" : "account Billing Cycle in which the transaction became posted. 0 is kept for 'N' (Not yet fully processed) status"
},
"posted_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-01-30 ",
"description" : "Date when the transaction was fully processed (Settled or Reversed)"
},
"set_charge_amt" : {
"type" : "number",
"example" : 10.0,
"description" : "Charge Amount after Setttlement in Billing Currency"
},
"unpaid_amt" : {
"type" : "number",
"example" : 10.0,
"description" : "The amount of the fee which is currently remaining unpaid"
},
"unpaid_interest_amt" : {
"type" : "number",
"example" : 0.0,
"description" : "The amount of the interest earned by the fee which is currently remaining unpaid"
},
"interest_amt_WP" : {
"type" : "number",
"example" : 0.0,
"description" : "Interest Amount computed but can be waived (WP)"
},
"previous_unpaid_amt" : {
"type" : "number",
"example" : 0.0,
"description" : "The amount of the transaction, which was unpaid before the last payment applied (we need this for average daily balances)"
},
"previous_unpaid_interest_amt" : {
"type" : "number",
"example" : 0.0,
"description" : "The amount of interest earned by the fee, which was unpaid before the last daily interest computation"
},
"last_payment_applied_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-01-30 ",
"description" : "The date when the payment was applied last time to the given fee"
},
"cre_dt" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-01-30 11:12:13",
"description" : "Date / Time of Fee Computation"
}
}
},
"PwsCreateRewardTemplateModel" : {
"type" : "object",
"required" : [ "amount_referenced", "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "reward_descr", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title",
"minLength" : 0,
"maxLength" : 200,
"pattern" : "^[^<>/;`%]*$"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description",
"minLength" : 0,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-27",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-27",
"description" : "Expiration Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "<p> The amount percentage is counted from.</br>Possible options are:<ul><li> N/A: Amount is irrelevant</li>\n<li>TXN: Amount, transaction (DE49)</li>\n<li>SET: Amount, Settlement (DE50)</li>\n<li>BIL: Amount, Cardholder Billing Currency (DE51)</li></ul></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "SET", "BIL" ]
},
"concurrency" : {
"type" : "boolean",
"example" : false,
"description" : "If set to TRUE, then the reward will possibly be concurrent with other rewards in the same Reward Priority Section"
},
"reward_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Reward Priority Section (to decide about how to apply concurrent rewards belonging to the same Reward Priority Section)\n</br> If concurrency = FALSE, this parameter must be NULL </p>",
"minimum" : 0,
"maximum" : 9
},
"reward_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current reward in presence of multiple rewards from the same Reward Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsCreateRewardTemplateModel"
}
},
"CreateRewardBody" : {
"type" : "object",
"properties" : {
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1,
"description" : "Reward Id"
}
}
},
"CreateRewardResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateRewardHeader"
},
"body" : {
"$ref" : "#/definitions/CreateRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.CreateRewardResponseModel"
}
},
"CreateRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsUpdateRewardTemplateModel" : {
"type" : "object",
"required" : [ "amount_referenced", "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "reward_descr", "reward_id", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title",
"minLength" : 0,
"maxLength" : 200,
"pattern" : "^[^<>/;`%]*$"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description",
"minLength" : 0,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-27",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-27",
"description" : "Expiration Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "<p> The amount percentage is counted from.</br>Possible options are:<ul><li> N/A: Amount is irrelevant</li>\n<li>TXN: Amount, transaction (DE49)</li>\n<li>SET: Amount, Settlement (DE50)</li>\n<li>BIL: Amount, Cardholder Billing Currency (DE51)</li></ul></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "SET", "BIL" ]
},
"concurrency" : {
"type" : "boolean",
"example" : false,
"description" : "If set to TRUE, then the reward will possibly be concurrent with other rewards in the same Reward Priority Section"
},
"reward_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Reward Priority Section (to decide about how to apply concurrent rewards belonging to the same Reward Priority Section)\n</br> If concurrency = FALSE, this parameter must be NULL </p>",
"minimum" : 0,
"maximum" : 9
},
"reward_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current reward in presence of multiple rewards from the same Reward Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsUpdateRewardTemplateModel"
}
},
"UpdateRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateRewardHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.UpdateRewardResponse"
}
},
"UpdateRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward Id 1 updated successfully",
"description" : "Message indicating the reward update"
}
}
},
"PwsGetRewardTemplateModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 0,
"description" : "Reward_id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetRewardTemplateModel"
}
},
"GetRewardBody" : {
"type" : "object",
"required" : [ "amount_referenced", "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "reward_descr", "reward_id", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title",
"minLength" : 0,
"maxLength" : 200,
"pattern" : "^[^<>/;`%]*$"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description",
"minLength" : 0,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-27",
"description" : "Effective Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-27",
"description" : "Expiration Date",
"pattern" : "\\d{4}-\\d{2}-\\d{2}"
},
"amount_referenced" : {
"type" : "string",
"example" : "TXN",
"description" : "<p> The amount percentage is counted from.</br>Possible options are:<ul><li> N/A: Amount is irrelevant</li>\n<li>TXN: Amount, transaction (DE49)</li>\n<li>SET: Amount, Settlement (DE50)</li>\n<li>BIL: Amount, Cardholder Billing Currency (DE51)</li></ul></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$",
"enum" : [ "TXN", "SET", "BIL" ]
},
"concurrency" : {
"type" : "boolean",
"example" : false,
"description" : "If set to TRUE, then the reward will possibly be concurrent with other rewards in the same Reward Priority Section"
},
"reward_priority_section" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Reward Priority Section (to decide about how to apply concurrent rewards belonging to the same Reward Priority Section)\n</br> If concurrency = FALSE, this parameter must be NULL </p>",
"minimum" : 0,
"maximum" : 9
},
"reward_sectional_priority" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Priority of the current reward in presence of multiple rewards from the same Reward Priority Section (0 is the highest prioority)",
"minimum" : 0,
"maximum" : 9
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"priority_section_name" : {
"type" : "string",
"example" : "Default Reward Priority Section",
"description" : "Description for reward_priority_section"
}
}
},
"GetRewardTemplateResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetRewardHeader"
},
"body" : {
"$ref" : "#/definitions/GetRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetRewardTemplateResponse"
}
},
"GetRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsApplyProductRewardModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "prod_id", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"prod_id" : {
"type" : "integer",
"format" : "int64",
"example" : 95,
"description" : "product Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsApplyProductRewardModel"
}
},
"ApplyProductRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward id 5 applied to product 95 successfully",
"description" : "Response message"
}
}
},
"ApplyProductRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"ApplyProductRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ApplyProductRewardHeader"
},
"body" : {
"$ref" : "#/definitions/ApplyProductRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.ApplyProductRewardResponse"
}
},
"UpdateProductRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateProductRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward Configuration Updated successfully for prod_id 95",
"description" : "Response message"
}
}
},
"UpdateProductRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateProductRewardHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateProductRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.UpdateProductRewardResponse"
}
},
"PwsGetProductRewardModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int64",
"example" : 95,
"description" : "product Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetProductRewardModel"
}
},
"GetProductRewardBody" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "prod_id", "reward_descr", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"prod_id" : {
"type" : "integer",
"format" : "int64",
"example" : 95,
"description" : "product Id",
"minimum" : 1
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description"
},
"currency_code" : {
"type" : "string",
"example" : "GBP",
"description" : "currency symbol representation for fixed_rate_currency"
}
}
},
"GetProductRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetProductRewardHeader"
},
"body" : {
"$ref" : "#/definitions/GetProductRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetProductRewardResponse"
}
},
"GetProductRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsGetProdutRewardHistoryModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "prod_id", "reward_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int64",
"example" : 95,
"description" : "product Id",
"minimum" : 1
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 50,
"description" : "Reward Id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetProdutRewardHistoryModel"
}
},
"GetProductRewardHistoryHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetProductRewardHistoryBody" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "prod_id", "reward_descr", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"prod_id" : {
"type" : "integer",
"format" : "int64",
"example" : 95,
"description" : "product Id",
"minimum" : 1
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence number for change management"
},
"change_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-02-27 11:12:13",
"description" : "Date and time that specify when there was changes in account reward configuration"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Event that indicate the what operation was made on account reward configuration"
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description"
},
"currency_code" : {
"type" : "string",
"example" : "GBP",
"description" : "currency symbol representation for fixed_rate_currency"
}
}
},
"GetProductRewardHistoryResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetProductRewardHistoryHeader"
},
"body" : {
"$ref" : "#/definitions/GetProductRewardHistoryBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetProductRewardHistoryResponse"
}
},
"PwsApplyGroupRewardModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "group_id", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"group_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "group Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsApplyGroupRewardModel"
}
},
"ApplyGroupRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ApplyGroupRewardHeader"
},
"body" : {
"$ref" : "#/definitions/ApplyGroupRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.ApplyGroupRewardResponse"
}
},
"ApplyGroupRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"ApplyGroupRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward id 5 applied to group_id 1195 successfully",
"description" : "Response message"
}
}
},
"UpdateGroupRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward Configuration Updated successfully for group_id 1195",
"description" : "Response message"
}
}
},
"UpdateGroupRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateGroupRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateGroupRewardHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateGroupRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.UpdateGroupRewardResponse"
}
},
"PwsGetGroupRewardModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "group_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1195,
"description" : "group Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetGroupRewardModel"
}
},
"GetGroupRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetGroupRewardHeader"
},
"body" : {
"$ref" : "#/definitions/GetGroupRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetGroupRewardResponse"
}
},
"GetGroupRewardBody" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "group_id", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "reward_descr", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"group_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "group Id",
"minimum" : 1
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description"
},
"currency_code" : {
"type" : "string",
"example" : "GBP",
"description" : "currency symbol representation for fixed_rate_currency"
}
}
},
"GetGroupRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsGetGroupRewardHistoryModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "group_id", "reward_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int64",
"example" : 1195,
"description" : "group Id",
"minimum" : 1
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetGroupRewardHistoryModel"
}
},
"GetGroupRewardHistoryResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetGroupRewardHistoryHeader"
},
"body" : {
"$ref" : "#/definitions/GetGroupRewardHistoryBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetGroupRewardHistoryResponse"
}
},
"GetGroupRewardHistoryHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetGroupRewardHistoryBody" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "group_id", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "reward_descr", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"group_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "group Id",
"minimum" : 1
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence number for change management"
},
"change_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-02-27 11:12:13",
"description" : "Date and time that specify when there was changes in account reward configuration"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Event that indicate the what operation was made on account reward configuration"
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description"
},
"currency_code" : {
"type" : "string",
"example" : "GBP",
"description" : "currency symbol representation for fixed_rate_currency"
}
}
},
"PwsApplyAccountRewardModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 619672609,
"description" : "account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsApplyAccountRewardModel"
}
},
"ApplyAccountRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward id 5 applied to acc_id 150922641 successfully",
"description" : "Response message"
}
}
},
"ApplyAccountRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ApplyAccountRewardHeader"
},
"body" : {
"$ref" : "#/definitions/ApplyAccountRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.ApplyAccountRewardResponse"
}
},
"ApplyAccountRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateAccountRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateAccountRewardHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateAccountRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.UpdateAccountRewardResponse"
}
},
"UpdateAccountRewardBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Reward Configuration Updated successfully for acc_id 150922641",
"description" : "Response message"
}
}
},
"UpdateAccountRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PwsGetAccountRewardModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 619672609,
"description" : "account Id",
"minimum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetAccountRewardModel"
}
},
"GetAccountRewardHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountRewardResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountRewardHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountRewardBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetAccountRewardResponse"
}
},
"GetAccountRewardBody" : {
"type" : "object"
},
"PwsGetAccountRewardHistoryModel" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "reward_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 619672609,
"description" : "account Id",
"minimum" : 1
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 19,
"description" : "Reward Id"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.pwsrewardmodel.PwsGetAccountRewardHistoryModel"
}
},
"GetAccountRewardHistoryResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountRewardHistoryHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountRewardHistoryBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.paycredit.model.paycreditresponsemodel.rewardresponsemodel.GetAccountRewardHistoryResponse"
}
},
"GetAccountRewardHistoryHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountRewardHistoryBody" : {
"type" : "object",
"required" : [ "acc_id", "api_call_unique_identifier", "client_id", "effective_date", "expiration_date", "fixed_rate_currency", "max_annual_reward", "max_daily_reward", "max_monthly_reward", "max_weekly_reward", "points_expiration_timeline", "reward_descr", "reward_id", "reward_rate_fixed", "reward_rate_logic", "reward_rate_perc", "reward_title" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"reward_rate_perc" : {
"type" : "number",
"format" : "double",
"example" : 1.0,
"description" : "<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>",
"maximum" : 100
},
"reward_rate_fixed" : {
"type" : "number",
"example" : 1.0,
"description" : "<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>"
},
"reward_rate_logic" : {
"type" : "string",
"example" : "SUM",
"description" : "<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li>\n<li> MIN: Minimum of two amounts</li>\n<li>MAX: Maximum of two amounts</li>\n<li>AVG: Average of two amounts</li></ul>",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"reward_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5,
"description" : "Reward Id",
"minimum" : 1
},
"fixed_rate_currency" : {
"type" : "string",
"example" : "826",
"description" : "Currency used for configuring fixed rates (including max/min): ISO-n3 currency code",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"max_daily_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'"
},
"max_weekly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded weekly (calendar weekly); -1.00 mean 'Not Set'"
},
"max_monthly_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded monthly (calendar month); -1.00 mean 'Not Set'"
},
"max_annual_reward" : {
"type" : "number",
"example" : 1.0,
"description" : "Maximum reward amount that can be awarded annually (calendar year); -1.00 mean 'Not Set'"
},
"points_expiration_timeline" : {
"type" : "string",
"example" : "LEN",
"description" : "<p>Timeline, where the reward points expire.</br> Options:\n<ul><li>NVR: Never</li>\n<li> MON: End of the current month (the month when the rewards was earned)</li>\n<li>QRT: End of the current quarter</li>\n<li>ANN: End of the current year</li>\n<li>LEN: Length in days from the transaction's settlement date to the expiration date </li></p>",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[^<>/;`%]*$"
},
"points_expiration_length" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Ignored unless points_expiration_timeline = 'LEN'; in that case, the number of days the points are valid after the transaction's date"
},
"expiration_date" : {
"type" : "string",
"example" : "2022-02-23 10:11:12",
"description" : "Expiration Date"
},
"effective_date" : {
"type" : "string",
"example" : "2021-02-23 10:11:12",
"description" : "Effective Date"
},
"acc_id" : {
"type" : "integer",
"format" : "int64",
"example" : 619672609,
"description" : "account Id",
"minimum" : 1
},
"seq_no" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Sequence number for change management"
},
"change_date" : {
"type" : "string",
"format" : "date-time",
"example" : "2021-02-27 11:12:13",
"description" : "Date and time that specify when there was changes in account reward configuration"
},
"change_event" : {
"type" : "string",
"example" : "U",
"description" : "Event that indicate the what operation was made on account reward configuration"
},
"reward_title" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Title"
},
"reward_descr" : {
"type" : "string",
"example" : "Generic Reward",
"description" : "Reward Description"
},
"currency_code" : {
"type" : "string",
"example" : "GBP",
"description" : "currency symbol representation for fixed_rate_currency"
}
}
},
"CreateAccountModel" : {
"type" : "object",
"required" : [ "ac_bill_ccy", "ac_parent_id", "ac_set_ccy", "account_name", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"account_name" : {
"type" : "string",
"example" : "Akshay Patel",
"description" : "account holder name.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;,`%]*$"
},
"ac_parent_id" : {
"type" : "integer",
"format" : "int64",
"example" : 542283189,
"description" : "Parent account. Newly created accounts under a parent account will have parent child hierarchy.",
"minimum" : 1
},
"ac_desc" : {
"type" : "string",
"example" : "New account Desc",
"description" : "Description for the account holder.",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;,`%]*$"
},
"ac_ext_ref" : {
"type" : "string",
"example" : "0",
"description" : "account external reference.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;,`%]*$"
},
"ac_set_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Settlement currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[0-9]{3}$"
},
"ac_bill_ccy" : {
"type" : "string",
"example" : "048",
"description" : "Billing currency (Three digit ISO_4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[0-9]{3}$"
},
"crd_prdct_id" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "Card product id. (Need to input correct product id for your card so it will inherit full required properties and be fully linked with business.)"
},
"cu_id" : {
"type" : "integer",
"format" : "int64",
"example" : 583198689,
"description" : "Customer Id to link the newly created account to the provided customer. You can get customer id after creating customer using <a href=\"#operation/pws_create_customer\" class=\"external-link\">pws_create_customer</a>"
}
},
"description" : "-- This web service creates accounts.\n\n-- All accounts are created under a Banking.Live parent account.\n\n--The accounts will have a parent child hierarchy. \n\n-- An account is created for a card automatically once a new card is created, unless a pre-existing account is designated.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.CreateAccountModel"
}
},
"CreateAccountResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateAccountHeader"
},
"body" : {
"$ref" : "#/definitions/CreateAccountBody"
}
},
"description" : "This is create account response model",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.CreateAccountResponse"
}
},
"CreateAccountHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"CreateAccountBody" : {
"type" : "object",
"properties" : {
"ac_id" : {
"type" : "integer",
"format" : "int32",
"example" : 9876542,
"description" : "Newly Created account ID."
}
}
},
"EditAccountModel" : {
"type" : "object",
"required" : [ "ac_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"account_name" : {
"type" : "string",
"example" : "Akshay Patel",
"description" : "account holder name.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;,`%]*$"
},
"ac_desc" : {
"type" : "string",
"example" : "New account Desc",
"description" : "Description for the account holder.",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;,`%]*$"
},
"ac_ext_ref" : {
"type" : "string",
"example" : "0",
"description" : "account external reference.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;,`%]*$"
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "account id . Pass this id to update the details.",
"minimum" : 1
},
"guarantee_amount" : {
"type" : "number",
"example" : 0.0,
"description" : "Guarantee Amount(credit related editable field)"
},
"guarantee_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Guarantee Type Id(credit related editable field)"
}
},
"description" : "This web service allows to edit account details.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.EditAccountModel"
}
},
"EditAccountBody" : {
"type" : "object"
},
"EditAccountResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/EditAccountHeader"
},
"body" : {
"$ref" : "#/definitions/EditAccountBody"
}
},
"description" : "This model contains response when we edit account detail",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.EditAccountResponse"
}
},
"EditAccountHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountModel" : {
"type" : "object",
"required" : [ "ac_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "account Number/Identifier.",
"minimum" : 1
}
},
"description" : "This web service retrieves the status of an account. \n-- The status of an account can be:\n\n 0 = Pre-live inactive\n 1 = live : An account will be active during account create\n10 = live but under alert watch\n30 = awaiting closure\n40 = closed for transactions but still reported\n50 = closed, not reported, remaining on system\n60 = closed, flagged for removal\n99 = suspended",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.GetAccountModel"
}
},
"GetAccountDetailBody" : {
"type" : "object",
"properties" : {
"ac_name" : {
"type" : "string",
"example" : "Akhshay Patel",
"description" : "account name",
"minLength" : 0,
"maxLength" : 50
},
"ac_ext_ref" : {
"type" : "string",
"description" : "account External Reference",
"minLength" : 0,
"maxLength" : 50
},
"ac_desc" : {
"type" : "string",
"example" : "New account",
"description" : "account Description",
"minLength" : 0,
"maxLength" : 100
},
"ac_parent" : {
"type" : "integer",
"format" : "int32",
"example" : 122222,
"description" : "Parent account Id"
},
"bill_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Billing currency(Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"set_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Settlement currency(Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"cre_dt" : {
"type" : "string",
"example" : "2021-01-27 08:10:39.281233",
"description" : "Created Date"
},
"ac_status" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>The status of the account can be:</p>\n<ul>\n<li class=\"docBullet\">0 = Pre-live inactive</li>\n<li class=\"docBullet\">1 = live : account is active</li>\n<li class=\"docBullet\">10 = live but under alert watch</li>\n<li class=\"docBullet\">30 = awaiting closure</li>\n<li class=\"docBullet\">40 = closed for transactions but still reported</li>\n<li class=\"docBullet\">50 = closed, not reported, remaining on system</li>\n<li class=\"docBullet\">60 = closed, flagged for removal</li>\n<li class=\"docBullet\">99 = suspended</li>\n</ul>"
}
}
},
"GetAccountDetailResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountDetailHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountDetailBody"
}
},
"description" : "This model gives us the response detail of Get account web services",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.GetAccountDetailResponse"
}
},
"GetAccountDetailHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"AccountListModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"cu_id" : {
"type" : "integer",
"format" : "int64",
"example" : 5838689,
"description" : "Customer Id to list account of the provided customer."
},
"cu_ref" : {
"type" : "string",
"description" : "Customer Reference",
"minLength" : 0,
"maxLength" : 50
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 542283189,
"description" : "Parent account number\n\n Conditional : If any other parameter values are passed, ac_id is optional. Otherwise ac_id is mandatory"
},
"ac_ext_ref" : {
"type" : "string",
"example" : "O",
"description" : "Account external reference"
}
},
"description" : "This web service retrieves a list available accounts under a parent account or customer ID. If both ac_id and cu_id is passed in request ac_id is given priority.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.AccountListModel"
}
},
"AccountListResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/AccountListHeader"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AccountListBody"
}
}
},
"description" : "This model contains response when we call account list api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.AccountListResponse"
}
},
"AccountListHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"AccountListBody" : {
"type" : "object",
"properties" : {
"ac_id" : {
"type" : "integer",
"format" : "int32",
"example" : 732021388,
"description" : "account Id"
},
"ac_name" : {
"type" : "string",
"example" : "Akhsay Patel",
"description" : "account Name",
"minLength" : 0,
"maxLength" : 50
},
"ac_parent" : {
"type" : "integer",
"format" : "int32",
"example" : 122222,
"description" : "Parent account Id"
},
"ac_ext_ref" : {
"type" : "string",
"description" : "account External Reference",
"minLength" : 0,
"maxLength" : 50
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 123456,
"description" : "client id of account"
},
"bill_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Currency Code",
"minLength" : 3,
"maxLength" : 3
},
"bal_blk_amt" : {
"type" : "number",
"example" : 100.0,
"description" : "Blocked Balance Amount"
},
"crd_prdct_id" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "Card product id. (Need to input correct product id for your card so it will inherit full required properties and be fully linked with business.)"
},
"bal_act_amt" : {
"type" : "number",
"example" : 10000.0,
"description" : "Actual Balance Amount"
},
"cre_dt" : {
"type" : "string",
"example" : "2019-12-03T08:03:12Z",
"description" : "Created Date"
},
"cu_ref" : {
"type" : "string",
"description" : "Customer Ref",
"minLength" : 0,
"maxLength" : 50
}
}
},
"GetAccountStatusHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetAccountStatusBody" : {
"type" : "object",
"properties" : {
"ac_status" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>The status of the account can be:</p>\n<ul>\n<li class=\"docBullet\">0 = Pre-live inactive</li>\n<li class=\"docBullet\">1 = live : account is active</li>\n<li class=\"docBullet\">10 = live but under alert watch</li>\n<li class=\"docBullet\">30 = awaiting closure</li>\n<li class=\"docBullet\">40 = closed for transactions but still reported</li>\n<li class=\"docBullet\">50 = closed, not reported, remaining on system</li>\n<li class=\"docBullet\">60 = closed, flagged for removal</li>\n<li class=\"docBullet\">99 = suspended</li>\n</ul>"
}
}
},
"GetAccountStatusResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetAccountStatusHeader"
},
"body" : {
"$ref" : "#/definitions/GetAccountStatusBody"
}
},
"description" : "This model contains the response detail of get account status api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.GetAccountStatusResponse"
}
},
"GetBalanceModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "input_id", "input_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type" : {
"type" : "string",
"example" : "t",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 520872406,
"description" : "Public token / account number.Pass public token when input type is t./Pass account number when input type is a.",
"minimum" : 1
}
},
"description" : "-- This web service retrieves the card balance available for a specific card/token or account.\n-- It returns current (actual) balance, available (pending) balance and blocked balance.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.GetBalanceModel"
}
},
"GetBalanceBody" : {
"type" : "object",
"properties" : {
"bal_pnd_amt" : {
"type" : "number",
"example" : 100.0,
"description" : "Pending Balance Amount"
},
"bal_blk_amt" : {
"type" : "number",
"example" : 100.0,
"description" : "Blocked Balance Amount"
},
"bal_act_amt" : {
"type" : "number",
"example" : 10000.0,
"description" : "Actual Balance Amount"
},
"bal_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Billing currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"bal_avail_amt" : {
"type" : "number",
"example" : 9900.0,
"description" : "Available Balance Amount"
}
}
},
"GetBalanceHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetBalanceResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetBalanceHeader"
},
"body" : {
"$ref" : "#/definitions/GetBalanceBody"
}
},
"description" : "This model contains the information of get balance api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.GetBalanceResponse"
}
},
"StatementModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "input_id", "input_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type" : {
"type" : "string",
"example" : "a",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "Public token / account number.Pass public token when input type is t./Pass account number when input type is a.",
"minimum" : 1
},
"date_from" : {
"type" : "string",
"example" : "2020-01-24 13:13:08",
"description" : "From Date,accepted format yyyy-mm-dd hh:mm:ss.",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"date_to" : {
"type" : "string",
"example" : "2025-10-24 13:13:08",
"description" : "To Date,accepted format yyyy-mm-dd hh:mm:ss",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"statement_type" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : " <ul>\n<li class=\"docBullet\">statement_type =1 returns statement for this account.</li>\n<li class=\"docBullet\">statement_type =2 returns statement for this account AND all accounts below it, keeping each account in its billing currency.</li>\n<li class=\"docBullet\">statement_type =3 returns statement for this account, returning all rows in billing currency of main account.</li>\n</ul>",
"maximum" : 3
}
},
"description" : "-- This web service retrieves statements for a card/token.\n-- The statement includes load balance, spent balance and transactions.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.statement.StatementModel"
}
},
"GetStatementBody" : {
"type" : "object",
"properties" : {
"txn_id" : {
"type" : "integer",
"format" : "int64",
"example" : 91191931,
"description" : "transaction Id"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 545398123,
"description" : "Public Token"
},
"type" : {
"type" : "string",
"example" : "Load",
"description" : "<p>transaction Types:</p>\n<ul>\n<li class=\"docBullet\">Au = Authorization.</li>\n<li class=\"docBullet\">Ad = Advisement.</li>\n<li class=\"docBullet\">Re = Reversals.</li>\n<li class=\"docBullet\">Se = Settlement.</li>\n<li class=\"docBullet\">Cb = chargeback.</li>\n<li class=\"docBullet\">Lo = Load.</li>\n<li class=\"docBullet\">Un = UnLoad.</li>\n<li class=\"docBullet\">Ra = rules applied.</li>\n</ul>"
},
"type_detail" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Transaction Type Details :<ul><li class=\"docBullet\">0 = Shop Spend</li><li class=\"docBullet\">1 = ATM withdrawal</li><li class=\"docBullet\">2 = Adjustment Credits</li><li class=\"docBullet\">3 = Cheque guarantee(funds guaranteed)</li><li class=\"docBullet\">4 = Cheque verification(funds available but not guaranteed)</li><li class=\"docBullet\">5 = Euro-Cheque</li><li class=\"docBullet\">6 = Traveler cheque</li><li class=\"docBullet\">7 = Letter of credit</li><li class=\"docBullet\">8 = Giro(postal banking)</li><li class=\"docBullet\">9 = Debits (goods with cash back)</li><li class=\"docBullet\">10 = Fees : Wirecard</li><li class=\"docBullet\">11 = Visa quasi-cash (POS) transactions</li><li class=\"docBullet\">12 = Cash Disbursement</li><li class=\"docBullet\">17 = Debits (for cash advances)</li><li class=\"docBullet\">18 = Unique Transaction (requires unique MCC)</li><li class=\"docBullet\">19 = Adjustment debits (goods and services with cash back)</li><li class=\"docBullet\">20 = Credits (for refund)</li><li class=\"docBullet\">21 = Credits (for deposit)</li><li class=\"docBullet\">22 = Credits - Card Load</li><li class=\"docBullet\">23 = Debits - Card Unload</li><li class=\"docBullet\">28 = Credits (for Payment Transaction)</li><li class=\"docBullet\">30 = Balance inquiry service</li><li class=\"docBullet\">91 = PIN unblock transactions</li><li class=\"docBullet\">92 = PIN change transactions</li><li class=\"docBullet\">252 = Fee: Load1</li><li class=\"docBullet\">253 = Fee: Load2</li><li class=\"docBullet\">254 = Fee: Reload1</li><li class=\"docBullet\">255 = Fee: Reload2</li><li class=\"docBullet\">256 = Fee: Balance Enquiry</li><li class=\"docBullet\">257 = Fee: Upgrade Card</li><li class=\"docBullet\">258 = Fee: Pin Change</li><li class=\"docBullet\">259 = Blocked Amount Posting</li><li class=\"docBullet\">261 = Fee: IVR Balance Enquiry</li><li class=\"docBullet\">262 = Fee: SMS Balance Enquiry</li><li class=\"docBullet\">269 = Monthly Service Fee</li><li class=\"docBullet\">270 = PIN change transactions</li><li class=\"docBullet\">271 = Fee: ATM Balance Enquiry</li><li class=\"docBullet\">272 = Balance Enquiry Fee - IVR</li><li class=\"docBullet\">282 = Card Issue Fee (Physical)</li><li class=\"docBullet\">283 = Administration Fee</li><li class=\"docBullet\">284 = Card Replacement Fee</li><li class=\"docBullet\">295 = Fees Adjustment - Credit</li><li class=\"docBullet\">296 = Fees Adjustment - Debit</li><li class=\"docBullet\">299 = Recurring Fees</li><li class=\"docBullet\">400 = Load</li><li class=\"docBullet\">405 = Unload</li><li class=\"docBullet\">410 = Balance Transfer - Debit</li><li class=\"docBullet\">411 = Balance Transfer - Credit</li></ul>"
},
"status" : {
"type" : "string",
"example" : "Approved & Settled",
"description" : "Following are the list of transaction status:<ul> <li class=\"docBullet\">1 = Normal Spend-Approved (not Settled)</li>\n<li class=\"docBullet\">2 = Normal Spend-Declined </li>\n<li class=\"docBullet\">3 = Normal Spend-Approved then Reversed</li>\n<li class=\"docBullet\">4 = Zero Amt Auth (bal/pin change etc)-Approved</li>\n<li class=\"docBullet\">5 = Zero Amt Auth (bal/pin change etc)-Declined</li>\n<li class=\"docBullet\">10 = Normal Spend-Declined then Partial Reversal</li>\n<li class=\"docBullet\">11 = Normal Spend-Approved then Partial Reversal</li>\n<li class=\"docBullet\">12 = Normal Partial Spend-Approved not Settled</li>\n<li class=\"docBullet\">14 = Normal Spend-Approved then Unblocked</li>\n<li class=\"docBullet\">15 = Normal Spend-Approved then Unblocked Failed</li>\n<li class=\"docBullet\">16 = Normal Spend-Approved then Advisement</li>\n<li class=\"docBullet\">17 = ATM Approved & Settled</li>\n<li class=\"docBullet\">18 = ATM -Declined</li>\n<li class=\"docBullet\">19 = Normal Spend - Declined then Advisement</li>\n<li class=\"docBullet\">20 = Reversal-Manual unblock (Paymentology generated)</li>\n<li class=\"docBullet\">21 = Reversal-Auto Unblock (Paymentology generated)</li>\n<li class=\"docBullet\">24 = Reversal-Scheme delivered-Approved</li>\n<li class=\"docBullet\">25 = Reversal-Scheme delivered-Declined</li>\n<li class=\"docBullet\">26 = Reversal-Partial- Scheme delivered-Approved</li>\n<li class=\"docBullet\">30 = Advisement-Approved Spend, preceeding spend exists (Balance impacting)</li>\n<li class=\"docBullet\">31 = Advisement-Approved Spend (Not balance impacting)</li>\n<li class=\"docBullet\">32 = Advisement-Approved Spend, No preceeding spend (balance impacting)</li>\n<li class=\"docBullet\">35 = Advisement-Reversal (0420), preceeding spend exists (Balance impacting)</li>\n<li class=\"docBullet\">36 = Advisement-Reversal (0420), No preceeding spend (Not balance impacting)</li>\n<li class=\"docBullet\">37 = Reversal-Manual unblock (Paymentology generated)</li>\n<li class=\"docBullet\">38 = Reversal-Auto Unblock (Paymentology generated)</li>\n<li class=\"docBullet\">501 = Normal Spend-Approved-Now Settled</li>\n<li class=\"docBullet\">502 = Normal Spend-Declined-Now Settled</li>\n<li class=\"docBullet\">503 = Normal Spend-Approved then Reversed-Now Settled</li>\n<li class=\"docBullet\">504 = Zero Amt Auth (bal/pin change etc)-Approved-Now Settled</li>\n<li class=\"docBullet\">505 = Zero Amt Auth (bal/pin change etc)-Declined-Now Settled</li>\n<li class=\"docBullet\">510 = Normal Spend-Declined then Partial Reversal-Now Settled</li>\n<li class=\"docBullet\">511 = Normal Spend-Approved then Partial Reversal-Now Settled</li>\n<li class=\"docBullet\">524 = Reversal-Scheme delivered-Approved-Now Settled</li>\n<li class=\"docBullet\">525 = Reversal-Scheme delivered-Declined-Now Settled</li>\n<li class=\"docBullet\">530 = Advisement-Approved Spend, preceeding spend exists (Balance impacting)-Now Settled</li>\n<li class=\"docBullet\">531 = Advisement-Declined Spend (Not balance impacting)-Now Settled</li>\n<li class=\"docBullet\">532 = Advisement-Approved Spend, No preceeding spend (balance impacting)-Now Settled</li>\n<li class=\"docBullet\">535 = Advisement-Reversal (0420), preceeding spend exists (Balance impacting)-Now Settled</li>\n<li class=\"docBullet\">536 = Advisement-Reversal (0420), No preceeding spend (Not balance impacting)-Now Settled</li>\n<li class=\"docBullet\">1000 = Settlement-No preceeding spend</li>\n<li class=\"docBullet\">1001 = Settlement-Full match to spend</li>\n<li class=\"docBullet\">1002 = Settlement-Partial match to spend</li>\n<li class=\"docBullet\">1005 = Settlement-Auth had been declined</li>\n<li class=\"docBullet\">1006 = Settlment-Advisement had been declined</li>\n<li class=\"docBullet\">1007 = Settlement-No auth, just reversal received</li>\n<li class=\"docBullet\">1010 = Settlement reversed by a settlement reversal</li>\n<li class=\"docBullet\">1011 = Settlement reversal (reversed a preceeding settlement)</li>\n<li class=\"docBullet\">1012 = Settlement reversal (No preceeding settlemnt found)</li>\n<li class=\"docBullet\">1030 = Load-Settled</li>\n<li class=\"docBullet\">1031 = Unload-Settled</li>\n<li class=\"docBullet\">1035 = Balance transfer (out) Settled</li>\n<li class=\"docBullet\">1036 = Balance transfer (in)-Settled</li></ul>"
},
"date" : {
"type" : "string",
"format" : "date-time",
"example" : "2019-11-22 16:50:31.080413",
"description" : "transaction Date in format yyyy-MM-dd'T'HH:mm:ss.SSS"
},
"ac_id" : {
"type" : "integer",
"format" : "int32",
"example" : 117079743,
"description" : "account Id"
},
"description" : {
"type" : "string",
"example" : "Paymentology",
"description" : "Description",
"minLength" : 0,
"maxLength" : 100
},
"spend_ccy" : {
"type" : "string",
"example" : "GBP",
"description" : "Spend currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"spend_sym" : {
"type" : "string",
"example" : "£",
"description" : "Spend Currencies symbols : Eg. $,£ etc."
},
"spend_amt" : {
"type" : "number",
"example" : 53.89,
"description" : "Total amount spent in decimal"
},
"card_ccy" : {
"type" : "string",
"example" : "400",
"description" : "card Currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"card_sym" : {
"type" : "string",
"example" : "$",
"description" : "card Currencies symbols : Eg. $,£ etc."
},
"txn_amt" : {
"type" : "number",
"example" : 1190.25,
"description" : "transaction Amount"
},
"fees" : {
"type" : "number",
"example" : 0.0,
"description" : "transaction Fees"
},
"aval" : {
"type" : "number",
"example" : 1190.0,
"description" : "Available Balance "
},
"post_block" : {
"type" : "number",
"example" : 0.0,
"description" : "Blocked amount that need to be settle"
},
"post_pend" : {
"type" : "number",
"example" : 0.0,
"description" : "Actual remaining amount"
},
"note" : {
"type" : "string",
"example" : "debit/credit note",
"description" : "transaction Notes"
},
"is_debit" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Is transaction Debit/Credit. Debit =>0 | Credit =>1 "
}
}
},
"GetStatementHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetStatementResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetStatementHeader"
},
"body" : {
"$ref" : "#/definitions/GetStatementBody"
}
},
"description" : "This model contains the information of account statement",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.GetStatementResponse"
}
},
"LoadBalanceModel" : {
"type" : "object",
"required" : [ "act_blk_pnd", "amount", "api_call_unique_identifier", "client_id", "cr_dr", "input_id", "input_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type" : {
"type" : "string",
"example" : "t",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 520872406,
"description" : "Public token / account number.Pass public token when input type is t./Pass account number when input type is a.",
"minimum" : 1
},
"amount" : {
"type" : "number",
"example" : 100.1,
"description" : "Amount to load or unload."
},
"amt_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Amount currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).",
"pattern" : "^[0-9]{3}$"
},
"act_blk_pnd" : {
"type" : "string",
"example" : "a",
"description" : "<p>Amount Status:</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; update actual amount</li>\n<li class=\"docBullet\">b ==&gt; update blocked amount</li>\n</ul>",
"pattern" : "^[a,b]{1}$"
},
"load_fee" : {
"type" : "number",
"example" : 12.12,
"description" : "Fee amount while load/unload balance."
},
"load_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Load Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).",
"pattern" : "^[0-9]{3}$"
},
"source" : {
"type" : "string",
"example" : "paymentology",
"description" : "Specify a note about source of load.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"cr_dr" : {
"type" : "string",
"example" : "c",
"description" : "<ul>\n<li class=\"docBullet\">Credit [c/C]= add balance in the account/token.</li>\n<li class=\"docBullet\">Debit [d/D] = deduct balance in the account/token.</li>\n</ul>",
"pattern" : "^[c,C,d,D]{1}$"
},
"unload_option" : {
"type" : "string",
"example" : "3",
"description" : "<p>Unload option :</p>\n<ul>\n<li class=\"docBullet\">1 ==&gt; Decline unload if balance is insufficient.</li>\n<li class=\"docBullet\">2 ==&gt; Balance reduces to negative if insufficient.</li>\n<li class=\"docBullet\">3 ==&gt; Balance reduces to zero if insufficient balance. DEFAULT if not passed unload_option.</li>\n</ul>",
"pattern" : "^[1-3]{1}$"
},
"note" : {
"type" : "string",
"example" : "Balance load from Paymentology",
"description" : "Something about load/unload note.",
"minLength" : 0,
"maxLength" : 500,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"load_fee_type" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>Load Fee Type.Possible values are</p>\n<ul>\n<li class=\"docBullet\">:0 ==&gt; Load fee not applicable.</li>\n<li class=\"docBullet\">1 ==&gt; Load fee applicable.</li>\n</ul>\n<p>If not passed then default as 0</p>"
}
},
"description" : "-- This web service loads (credits) and unloads (debits) the balance of a card/token or account.\n\n-- Either load (credit) or unload (debit) based on cr_dr value. ( cr_dr ==> c = Credit / cr_dr ==> d = Debit).\n\n-- Load amounts must be in decimals of up to two digits.\n\n-- Use either token or account id in the input_id field, to load or unload the balance.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.LoadBalanceModel"
}
},
"LoadBalanceBody" : {
"type" : "object",
"properties" : {
"load_amt" : {
"type" : "number",
"example" : 1200.1244,
"description" : "Load or Unload Amount"
},
"bill_blk_amt" : {
"type" : "number",
"example" : 100.1,
"description" : "Blocked Balance Amount"
},
"bill_act_amt" : {
"type" : "number",
"example" : 100.1,
"description" : "Actual Balance Amount"
},
"bill_pnd_amt" : {
"type" : "number",
"example" : 100.1,
"description" : "Pending Balance Amount"
},
"bal_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Balance Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)."
}
}
},
"LoadBalanceHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"LoadBalanceResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/LoadBalanceHeader"
},
"body" : {
"$ref" : "#/definitions/LoadBalanceBody"
}
},
"description" : "This model contains the information of Load Balance Api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.LoadBalanceResponse"
}
},
"SetAccountModel" : {
"type" : "object",
"required" : [ "ac_id", "ac_status", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"ac_id" : {
"type" : "integer",
"format" : "int32",
"example" : 479823917,
"description" : "account Number/Identifier.",
"minimum" : 1
},
"ac_status" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>The status of the account can be:</p>\n<ul>\n<li class=\"docBullet\">0 = Pre-live inactive</li>\n<li class=\"docBullet\">1 = live : account is active</li>\n<li class=\"docBullet\">10 = live but under alert watch</li>\n<li class=\"docBullet\">30 = awaiting closure</li>\n<li class=\"docBullet\">40 = closed for transactions but still reported</li>\n<li class=\"docBullet\">50 = closed, not reported, remaining on system</li>\n<li class=\"docBullet\">60 = closed, flagged for removal</li>\n<li class=\"docBullet\">99 = suspended</li>\n</ul>"
}
},
"description" : "This web service set the status of an account",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.SetAccountModel"
}
},
"SetAcccountStatusHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"SetAccountStatusBody" : {
"type" : "object",
"properties" : {
"ac_status" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>The status of the account can be:</p>\n<ul>\n<li class=\"docBullet\">0 = Pre-live inactive</li>\n<li class=\"docBullet\">1 = live : account is active</li>\n<li class=\"docBullet\">10 = live but under alert watch</li>\n<li class=\"docBullet\">30 = awaiting closure</li>\n<li class=\"docBullet\">40 = closed for transactions but still reported</li>\n<li class=\"docBullet\">50 = closed, not reported, remaining on system</li>\n<li class=\"docBullet\">60 = closed, flagged for removal</li>\n<li class=\"docBullet\">99 = suspended</li>\n</ul>"
}
}
},
"SetAccountStatusResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/SetAcccountStatusHeader"
},
"body" : {
"$ref" : "#/definitions/SetAccountStatusBody"
}
},
"description" : "This model contains the response detail of set account status api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.SetAccountStatusResponse"
}
},
"DefaultCardAccountModel" : {
"type" : "object",
"required" : [ "account_new", "account_old", "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"account_old" : {
"type" : "integer",
"format" : "int64",
"example" : 912039665,
"description" : "account number old.",
"minimum" : 1
},
"account_new" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "account number new. This will alter old account for card with new account.",
"minimum" : 1
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card.",
"minimum" : 1
}
},
"description" : "This web service allows to alter the default account for a card token.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.DefaultCardAccountModel"
}
},
"DefaultCardAccountBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Set default account success",
"description" : "Message for Description"
}
}
},
"SetDefaultCardAccountResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/DefaultCardAccountHeader"
},
"body" : {
"$ref" : "#/definitions/DefaultCardAccountBody"
}
},
"description" : "This model contain response message when we set default card account",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.SetDefaultCardAccountResponse"
}
},
"DefaultCardAccountHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateBalanceModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "balance_list", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"balance_list" : {
"type" : "array",
"description" : "list of account/token with corresponding balance to update",
"items" : {
"$ref" : "#/definitions/UpdateAccountBalance"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.UpdateBalanceModel"
}
},
"UpdateAccountBalance" : {
"type" : "object",
"required" : [ "act_balance", "bill_ccy", "blk_balance", "input_id", "input_type" ],
"properties" : {
"ac_ext_ref" : {
"type" : "string",
"description" : "account external reference.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;,`%]*$"
},
"input_type" : {
"type" : "string",
"example" : "a",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 4798239197,
"description" : "Public token / account number.Pass public token when input type is t./Pass account number when input type is a.",
"minimum" : 1
},
"act_balance" : {
"type" : "number",
"example" : 1007.1,
"description" : "Actual Balance"
},
"blk_balance" : {
"type" : "number",
"example" : -79.1,
"description" : "Blocked Balance"
},
"bill_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Balance Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).",
"pattern" : "^[0-9]{3}$"
}
}
},
"UpdateBalanceResponse" : {
"type" : "object",
"properties" : {
"header" : {
"description" : "Response Header contains success/failure status",
"$ref" : "#/definitions/UpdateBalanceResponseHeader"
},
"body" : {
"description" : "Response Body contains detail status of api call",
"$ref" : "#/definitions/UpdateBalanceResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.UpdateBalanceResponse"
}
},
"UpdateBalanceResponseBody" : {
"type" : "object",
"properties" : {
"total_count" : {
"type" : "integer",
"format" : "int32",
"example" : 20,
"description" : "Total Count"
},
"total_success" : {
"type" : "integer",
"format" : "int32",
"example" : 19,
"description" : "Total Success Count"
},
"total_failed" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Total Failed Count"
},
"failed_note" : {
"type" : "string",
"example" : "66961569677:Invalid account id;",
"description" : "Failed reason in format \"input_id:message;\""
}
}
},
"UpdateBalanceResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"FundTransferModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "input_id_from", "input_id_to", "input_type_from", "input_type_to", "transfer_amt" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type_from" : {
"type" : "string",
"example" : "t",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id_from" : {
"type" : "integer",
"format" : "int64",
"example" : 918808281,
"description" : "Public token for the card or account id"
},
"input_type_to" : {
"type" : "string",
"example" : "t",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id_to" : {
"type" : "integer",
"format" : "int64",
"example" : 368288349,
"description" : "Public token for the card or account id"
},
"source" : {
"type" : "string"
},
"client_note" : {
"type" : "string"
},
"transfer_amt" : {
"type" : "number",
"example" : 100.1,
"description" : "Transfer amount"
},
"transfer_fee_amt" : {
"type" : "string",
"example" : "100.10",
"description" : "Transfer amount fee",
"pattern" : "((\\d+)((\\.\\d{1,4})?))$"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.FundTransferModel"
}
},
"BlockLoadModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "flag", "input_id", "input_type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type" : {
"type" : "string",
"example" : "a",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n<li class=\"docBullet\">g ==&gt; Group</li>\n</ul>",
"pattern" : "^[t,a,g,T,A,G]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "Public token / account number /Group Id.Pass public token when input type is t./Pass account number when input type is a./Pass Group Id when iput type is g.",
"minimum" : 1
},
"flag" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<ul><li class=\"docBullet\">0 = Block load</li><li class=\"docBullet\">1 = Ublock load</li></ul>",
"minimum" : 0,
"maximum" : 1
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.BlockLoadModel"
}
},
"CreateBlocktBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "Load block success",
"description" : "Load block success"
}
}
},
"BlockLoadModelResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreateBlockHeader"
},
"body" : {
"$ref" : "#/definitions/CreateBlocktBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.BlockLoadModelResponse"
}
},
"CreateBlockHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PostTransactionModel" : {
"type" : "object",
"required" : [ "amount", "api_call_unique_identifier", "client_id", "input_id", "input_type", "txn_code" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"input_type" : {
"type" : "string",
"example" : "t",
"description" : "<p>Input Type :</p>\n<ul>\n<li class=\"docBullet\">a ==&gt; account</li>\n<li class=\"docBullet\">t ==&gt; Token</li>\n</ul>",
"pattern" : "^[t,a,T,A]{1}$"
},
"input_id" : {
"type" : "integer",
"format" : "int64",
"example" : 520872406,
"description" : "Public token / account number.</br> Pass public token when input type is 't'.</br>Pass account number when input type is 'a'.",
"minimum" : 1
},
"txn_code" : {
"type" : "string",
"example" : "Payment",
"description" : "Transaction code that is setup at product level"
},
"amount" : {
"type" : "number",
"example" : 100.1,
"description" : "Amount to load or unload."
},
"txn_source" : {
"type" : "string",
"example" : "paymentology",
"description" : "Specify a note about source of load.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"note" : {
"type" : "string",
"example" : "Balance load from Paymentology",
"description" : "Something about post debit or credit on the account note.",
"minLength" : 0,
"maxLength" : 150,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"mcc_code" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Merchant Category Code"
},
"ext_txn_reference_id" : {
"type" : "string",
"description" : "Reference ID from external system"
},
"operational_day" : {
"type" : "string",
"description" : "Operational Day"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.account.PostTransactionModel"
}
},
"CreditFinancialAdjustmentResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"CreditFinancialAdjustmentResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CreditFinancialAdjustmentResponseHeader"
},
"body" : {
"$ref" : "#/definitions/CreditFinancialAdjustmentResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.accountresponsemodel.CreditFinancialAdjustmentResponse"
}
},
"CreditFinancialAdjustmentResponseBody" : {
"type" : "object",
"properties" : {
"load_amt" : {
"type" : "number",
"example" : 1200.1244,
"description" : "Load or Unload Amount"
},
"credit_limit_available" : {
"type" : "number",
"example" : 15000.1,
"description" : "Available Credit Limit"
},
"credit_balance" : {
"type" : "number",
"example" : 100.1,
"description" : "Actual Credit Balance Amount"
},
"bal_blk_amt" : {
"type" : "number",
"example" : 100.1,
"description" : "Blocked Balance Amount"
},
"bal_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Balance Currency (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)."
}
}
},
"UpdateCardDetailsModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token.",
"minimum" : 1
},
"ch_title" : {
"type" : "string",
"example" : "Mr",
"description" : "card Holder Title.",
"minLength" : 0,
"maxLength" : 10
},
"ch_fname" : {
"type" : "string",
"example" : "Akshay",
"description" : "card Holder First Name.",
"minLength" : 0,
"maxLength" : 50
},
"ch_sname" : {
"type" : "string",
"example" : "Patel",
"description" : "card Holder SurName.",
"minLength" : 0,
"maxLength" : 50
},
"ch_addr1" : {
"type" : "string",
"example" : "London 1",
"description" : "card Holder Address 1",
"minLength" : 0,
"maxLength" : 100
},
"ch_addr2" : {
"type" : "string",
"example" : "London 2",
"description" : "card Holder Address 2.",
"minLength" : 0,
"maxLength" : 100
},
"ch_pcode" : {
"type" : "string",
"example" : "0988",
"description" : "card Holder Postal Code.",
"minLength" : 0,
"maxLength" : 15
},
"ch_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "card Holder City.",
"minLength" : 0,
"maxLength" : 50
},
"ch_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "card Holder Country.",
"minLength" : 0,
"maxLength" : 50
},
"ch_email" : {
"type" : "string",
"example" : "patel@paymentology.com",
"description" : "card Holder Email.",
"minLength" : 0,
"maxLength" : 60
},
"ch_mobile" : {
"type" : "string",
"example" : "+9779858545625",
"description" : "card Holder Mobile Number. phone number format i.e 00 (country code ) phone number or + (country code) phone number.",
"minLength" : 0,
"maxLength" : 20
},
"ch_del_method" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>delivery method for card :</p>\n<ul>\n<li class=\"docBullet\">0 &ndash; Standard mail</li>\n<li class=\"docBullet\">1 &ndash; Registered mail</li>\n<li class=\"docBullet\">2 &ndash; Direct delivery (courier) RFU</li>\n</ul>",
"maximum" : 32967
},
"del_fname" : {
"type" : "string",
"example" : "Rohan",
"description" : "delivery First Name.",
"minLength" : 0,
"maxLength" : 50
},
"del_sname" : {
"type" : "string",
"example" : "Ale",
"description" : "delivery Last Name.",
"minLength" : 0,
"maxLength" : 50
},
"del_addr1" : {
"type" : "string",
"example" : "Rambazar-13",
"description" : "delivery Address 1.",
"minLength" : 0,
"maxLength" : 100
},
"del_addr2" : {
"type" : "string",
"example" : "Rambazar-19",
"description" : "delivery Address2.",
"minLength" : 0,
"maxLength" : 100
},
"del_pcode" : {
"type" : "string",
"example" : "9777",
"description" : "delivery postal code.",
"minLength" : 0,
"maxLength" : 15
},
"del_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "delivery City.",
"minLength" : 0,
"maxLength" : 50
},
"del_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "delivery Country.",
"minLength" : 0,
"maxLength" : 50
},
"del_code" : {
"type" : "string",
"example" : "0",
"description" : "Delivery Code, carriers with same del_code, will be grouped to be send to a specified delivery address.",
"pattern" : "^[0-9]{0,5}$"
},
"bulk_delv_add_code" : {
"type" : "string",
"example" : "0",
"description" : "Bulk delivery address code, allows processor and manufacturer to agree a pre-defined delivery address.This codes is agreed seperately with manufacturer.",
"pattern" : "^[0-9]{0,5}$"
},
"del_email" : {
"type" : "string",
"example" : "rohan@paymentology.com",
"description" : "delivery Email.",
"minLength" : 0,
"maxLength" : 60
},
"del_mobile" : {
"type" : "string",
"example" : "+9779846552252",
"description" : "delivery Mobile Number. hone number format i.e 00 (country code ) phone number or + (country code) phone number.",
"minLength" : 0,
"maxLength" : 20
},
"emboss_name" : {
"type" : "string",
"example" : "Akshay Patel",
"description" : "Emboss name : name that appears on front of card.",
"minLength" : 0,
"maxLength" : 22
},
"product_ref" : {
"type" : "string",
"example" : "product reference",
"description" : "product Reference.",
"minLength" : 0,
"maxLength" : 50
},
"custom_1" : {
"type" : "string",
"example" : "Test custom",
"description" : "Customer special details, i.e. QR code If custom_1 ==> 1, then we will provide : MMYY+Public Token (MMYY ->the date of card creation ). If custom_1 value other than \"1\" , PT will include what ever client input in the same field in create.",
"minLength" : 0,
"maxLength" : 255
},
"envelope_ref" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies envelope type.",
"maximum" : 32767
},
"carrier_type" : {
"type" : "string",
"example" : "1",
"description" : "Allows client to stipulate carrier type (card packaging type choice - for shipment to customer) possible."
},
"pur_title" : {
"type" : "string",
"example" : "Mr",
"description" : "Purchaser Title",
"minLength" : 0,
"maxLength" : 10
},
"pur_fname" : {
"type" : "string",
"example" : "Rohan",
"description" : "Purchaser First Name.",
"minLength" : 0,
"maxLength" : 50
},
"pur_sname" : {
"type" : "string",
"example" : "Ale",
"description" : "Purchaser Last Name.",
"minLength" : 0,
"maxLength" : 50
},
"pur_addr1" : {
"type" : "string",
"example" : "London",
"description" : "Purchaser address 1",
"minLength" : 0,
"maxLength" : 50
},
"pur_addr2" : {
"type" : "string",
"example" : "London",
"description" : "Purchaser address 2",
"minLength" : 0,
"maxLength" : 50
},
"pur_pcode" : {
"type" : "string",
"example" : "00977",
"description" : "Purchaser postal code",
"minLength" : 0,
"maxLength" : 15
},
"pur_city" : {
"type" : "string",
"example" : "London",
"description" : "Purchaser City",
"minLength" : 0,
"maxLength" : 50
},
"pur_country" : {
"type" : "string",
"example" : "UK",
"description" : "Purchaser Country",
"minLength" : 0,
"maxLength" : 50
},
"pur_email" : {
"type" : "string",
"example" : "rohan@gmail.com",
"description" : "Purchaser email"
},
"pur_mobile" : {
"type" : "string",
"description" : "Purchaser Mobile",
"minLength" : 0,
"maxLength" : 20
},
"pur_pass_code" : {
"type" : "string",
"description" : "Purchaser pass code",
"minLength" : 0,
"maxLength" : 10
},
"pur_cust_type" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Purchaser customer type",
"maximum" : 1
},
"atm_lang" : {
"type" : "string",
"example" : "01",
"description" : "Language to be used in ATM <ul><li class=\"docBullet\">01 ==> Chinese</li><li class=\"docBullet\">02 ==> English</li><li class=\"docBullet\">03 ==> Portugese</li><li class=\"docBullet\">04 ==> Spanish</li></ul>",
"minLength" : 0,
"maxLength" : 2,
"pattern" : "^[01,02,04,03]{2}$"
},
"perso_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide cvv in perso file. 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >RFU</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv</td>\n</tr>\n<tr>\n<td >3</td>\n<td>RFU</td>\n</tr>\n<tr>\n<td >4</td>\n<td>RFU</td>\n</tr>\n<tr>\n<td >5</td>\n<td>RFU</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 01000 (Determine to show or hide CVV in perso (xml) file).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
}
},
"description" : "-- This web service allow users to edit cardholder/delivery details for a card.\n-- Pass the card token in the web service.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.UpdateCardDetailsModel"
}
},
"UpdateCardDetailsResponseBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "card holder edit success",
"description" : "message"
}
}
},
"UpdateCardDetailsResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"UpdateCardDetailsResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/UpdateCardDetailsResponseHeader"
},
"body" : {
"$ref" : "#/definitions/UpdateCardDetailsResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.UpdateCardDetailsResponseModel"
}
},
"TokFlagEditModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "tok_flags", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"tok_flags" : {
"type" : "string",
"example" : "00000000000001100000000000000001",
"description" : "<p>Flags for token to assign various tasks to the card. 0 ==>Flag inactive | 1==> Flag Active . Descriptions for each tok flag bits are given below : </p>\n<table>\n <thead>\n <tr></td><td><strong>TOK_DESCRIPTION</strong></td><td><strong>BIT_POSITION</strong></td>\n </tr>\n </thead>\n <tbody>\n<tr><td title =\"After every transaction, send card balance to the scheme, to allow for balance to be displayed, \ni.e. for ATM transactions\">Send card bal in De54 in next auth</td><td>3</td></tr>\n<tr><td title =\"Should the maximum number of pin retries be exceded, then enable pin unblocking on chip card.\nSend to issuer to unblock\">Send pin unblock to card</td><td>4</td></tr>\n<tr><td title =\"Only allow ecommerce transactions (including MDES and VTS transactions)\">Set card to decline all tranasaction except ecommerce</td><td>5</td></tr>\n<tr><td title =\"Set card to decline all Contactless transaction\">Set card to decline all Contactless transaction</td><td>6</td></tr>\n<tr><td title =\"Decline all ecommerce transactions (including MDES and VTS transactions)\">Set card to decline all Ecommerce</td><td>9</td></tr>\n<tr><td title =\"Decline all ATM Cash withdrawal transactions\">Set card to decline all ATM</td><td>10</td></tr>\n<tr><td title =\"Do not allow any balance enquiry transactions\">Set card to decline Bal enquiry over auth</td><td>11</td></tr>\n<tr><td title =\"In the case of POS transactions, the cash disbursement of a portion of the transaction amount is not allowed. The merchant cannot give cash to cardholder as part of the transaction.\">Set card to decline cash back txns</td><td>12</td></tr>\n<tr><td title =\"No transactions are allowed that will credit the card balance, including refunds to the card.\">Set card to decline Auth credit pur/refund (DE3_1=20)</td><td>14</td></tr>\n<tr><td title =\"No payments allowed, only POS and ecommerce transactions and. i.e. MC MoneySend, credit card installments, etc\">Set card to decline credit payment (DE3_1=28)</td><td>19</td></tr>\n<tr><td title =\"Only transactions in the base currency are allowed, decline any transaction in a non-base currency\">Set card to decline non base currency txn</td><td>20</td></tr>\n<tr><td title =\"No account verification requests should be allowed\">Set card to decline all account enq (de61_7=8)</td><td>21</td></tr>\n<tr><td title =\"Only approve transactions where the card is present. If card not present, decline transaction\">Set card to decline card not present txns</td><td>22</td></tr>\n<tr><td title =\"card Where the card information is provided but neither the cardholder or the card are physically present (i.e. mail-order) decline the transaction. \">Set card to decline Cardholder not present txns</td><td>23</td></tr>\n<tr><td title =\"CATM Fallback - where a chip-card is used at chip-capable ATM, do not allow fallback to magnetic strip\">Set card to decline failover to mag at emv capable atm</td><td>24</td></tr>\n<tr><td title =\"ATM Fallback - where a chip-card is used at an ATM (chip-capable or not) do not allow fallback to magnetic stripe\">Set card to decline mag at atm</td><td>25</td></tr>\n<tr><td title =\"POS Fallback - where a chip-card is used at chip-capable POS, allow fallback to to magnetic strip\">Alow if fallback chp->mag at chp capable pos DE22_1=80</td><td>26</td></tr>\n<tr><td title =\"POS Fallback - when the magnetic strip is used for a transaction, only allow the transaction of the entire track can be read, i.e. only PAN sent then decline transaction\">Allow if de22_1=02 & De48_88 =Y</td><td>27</td></tr>\n<tr><td title =\"Set card to approve if AVS match fails\">Set card to approve if AVS match fails</td><td>28</td></tr>\n<tr><td title =\"Do not allow subscription transactions, decline recurring transactions\">Set card to decline Recurring transaction</td><td>29</td></tr>\n</tbody>\n</table>",
"minLength" : 32,
"maxLength" : 32,
"pattern" : "^[0-1]{32}$"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token.",
"minimum" : 1
}
},
"description" : "-- Various transactional checks could be assigned to this field. It is a Bitmap Bit(32) field, giving the ability to configure services to the card.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.TokFlagEditModel"
}
},
"TokFlagEditResponseBody" : {
"type" : "object"
},
"TokFlagEditResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/TokFlagEditResponseHeader"
},
"body" : {
"$ref" : "#/definitions/TokFlagEditResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.TokFlagEditResponseModel"
}
},
"TokFlagEditResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"Enroll3DSModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card.",
"minimum" : 1
},
"language" : {
"type" : "string",
"example" : "en",
"description" : "<ul><li >The languages used for all interactions with the cardholder (authentication page,etc. Comma separated list of ISO 639-1 codes).</li><li >Required when product is setup with TouchTech ACS</li><ul>"
},
"manager" : {
"type" : "string",
"example" : "self",
"description" : "<ul><li >The method used to authenticate an online transaction.<ul><li class=\"docBullet\">self = Issuer sending SMS</li><li class=\"docBullet\">touchtech = Touchtech sending SMS</li></ul></li><li >Required when product is setup with TouchTech ACS</li><ul>\n"
},
"pam" : {
"type" : "string",
"description" : "<ul><li >Personal account Message. card user’s personal message for their account given by the customer.</li><li>Optional when product is setup with FSS ACS</li>",
"minLength" : 0,
"maxLength" : 45
},
"authentication_type" : {
"type" : "string",
"description" : "Type of OOB to be used.<ul><li >0 : No OOB </li><li>1 : OOB Supported</li><li>Required when product is setup with FSS ACS</li></ul>",
"minLength" : 0,
"maxLength" : 1,
"pattern" : "^[0-1]{1}$"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.Enroll3DSModel"
}
},
"Enroll3DSResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/Enroll3DSResponseModelHeader"
},
"body" : {
"$ref" : "#/definitions/Enroll3DSResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.Enroll3DSResponseModel"
}
},
"Enroll3DSResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"Enroll3DSResponseModelBody" : {
"type" : "object",
"properties" : {
"cardToken" : {
"type" : "string",
"example" : "895b81a9d7d16a81eea58dfe311b8f190437399de7c53417ce120ccbc3258980",
"description" : "<ul><li class=\"docBullet\">Touchtech : The card identifier used to reference an enrolled card during all interactions between Touchtech and the card issuer</li><li class=\"docBullet\">Fss : Unique Number of request to FSS during Enrollment.</li><ul>"
}
}
},
"GenerateFileModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "batch_id", "client_id", "sub_client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"sub_client_id" : {
"type" : "string",
"example" : "202477103850920",
"description" : "Unique identifier for the sub client . They are created under parent client id.",
"minLength" : 0,
"maxLength" : 16,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"batch_id" : {
"type" : "string",
"example" : "batch_001",
"description" : "Special identifier for card generation file.",
"minLength" : 0,
"maxLength" : 16,
"pattern" : "^[^<>'\"/;,`%]*$"
}
},
"description" : "-- This web service generates a card file and pushes the file to the SFTP folder for the client.\n-- The card file contains PAN, CVV, expiry, public token and card reference.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.GenerateFileModel"
}
},
"CardDetailsModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card.",
"minimum" : 1
}
},
"description" : "-- This web service retrieves card holder details, along with token flag details and descriptions.\n\n-- Pass a public token and client ID, to retrieve card details",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.CardDetailsModel"
}
},
"GetCardDetailsResponseBody" : {
"type" : "object",
"required" : [ "image_name", "token" ],
"properties" : {
"ch_title" : {
"type" : "string",
"example" : "Mr",
"description" : "card Holder Title.",
"minLength" : 0,
"maxLength" : 10
},
"ch_fname" : {
"type" : "string",
"example" : "Akshay",
"description" : "card Holder First Name.",
"minLength" : 0,
"maxLength" : 30
},
"ch_sname" : {
"type" : "string",
"example" : "Patel",
"description" : "card Holder SurName.",
"minLength" : 0,
"maxLength" : 30
},
"ch_addr1" : {
"type" : "string",
"example" : "London 1",
"description" : "card Holder Address 1.",
"minLength" : 0,
"maxLength" : 100
},
"ch_addr2" : {
"type" : "string",
"example" : "London 2",
"description" : "card Holder Address 2.",
"minLength" : 0,
"maxLength" : 100
},
"ch_pcode" : {
"type" : "string",
"example" : "0988",
"description" : "card Holder Postal Code.",
"minLength" : 0,
"maxLength" : 15
},
"ch_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "card Holder City.",
"minLength" : 0,
"maxLength" : 50
},
"ch_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "card Holder Country.",
"minLength" : 0,
"maxLength" : 50
},
"ch_email" : {
"type" : "string",
"example" : "patel@paymentology.com",
"description" : "card Holder Email.",
"minLength" : 0,
"maxLength" : 60
},
"ch_mobile" : {
"type" : "string",
"example" : "9858545625",
"description" : "card Holder Mobile Number.",
"minLength" : 0,
"maxLength" : 20
},
"del_title" : {
"type" : "string",
"example" : "Mr",
"description" : "delivery Title.",
"minLength" : 0,
"maxLength" : 10
},
"del_fname" : {
"type" : "string",
"example" : "Rohan",
"description" : "delivery First Name.",
"minLength" : 0,
"maxLength" : 30
},
"del_sname" : {
"type" : "string",
"example" : "Ale",
"description" : "delivery Last Name.",
"minLength" : 0,
"maxLength" : 30
},
"del_addr1" : {
"type" : "string",
"example" : "Rambazar-13",
"description" : "delivery Address 1.",
"minLength" : 0,
"maxLength" : 100
},
"del_addr2" : {
"type" : "string",
"example" : "Rambazar-19",
"description" : "delivery Address2.",
"minLength" : 0,
"maxLength" : 100
},
"del_pcode" : {
"type" : "string",
"example" : "9777",
"description" : "delivery postal code.",
"minLength" : 0,
"maxLength" : 15
},
"del_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "delivery City.",
"minLength" : 0,
"maxLength" : 50
},
"del_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "delivery Country.",
"minLength" : 0,
"maxLength" : 50
},
"del_email" : {
"type" : "string",
"example" : "rohan@paymentology.com",
"description" : "delivery Email.",
"minLength" : 0,
"maxLength" : 60
},
"del_mobile" : {
"type" : "string",
"example" : "9846552252",
"description" : "delivery Mobile Number.",
"minLength" : 0,
"maxLength" : 20
},
"pur_title" : {
"type" : "string",
"example" : "Mr",
"description" : "delivery Title.",
"minLength" : 0,
"maxLength" : 10
},
"pur_fname" : {
"type" : "string",
"example" : "Rohan",
"description" : "delivery First Name.",
"minLength" : 0,
"maxLength" : 30
},
"pur_sname" : {
"type" : "string",
"example" : "Ale",
"description" : "delivery Last Name.",
"minLength" : 0,
"maxLength" : 30
},
"pur_addr1" : {
"type" : "string",
"example" : "Rambazar-13",
"description" : "delivery Address 1.",
"minLength" : 0,
"maxLength" : 100
},
"pur_addr2" : {
"type" : "string",
"example" : "Rambazar-19",
"description" : "delivery Address2.",
"minLength" : 0,
"maxLength" : 100
},
"pur_pcode" : {
"type" : "string",
"example" : "9777",
"description" : "delivery postal code.",
"minLength" : 0,
"maxLength" : 15
},
"pur_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "delivery City.",
"minLength" : 0,
"maxLength" : 50
},
"pur_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "delivery Country.",
"minLength" : 0,
"maxLength" : 50
},
"pur_email" : {
"type" : "string",
"example" : "rohan@paymentology.com",
"description" : "delivery Email.",
"minLength" : 0,
"maxLength" : 60
},
"pur_mobile" : {
"type" : "string",
"example" : "9846552252",
"description" : "delivery Mobile Number.",
"minLength" : 0,
"maxLength" : 20
},
"pur_cust_type" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Purchaser customer type."
},
"exp_date" : {
"type" : "string",
"example" : "2409",
"description" : "Expiry Date in YYMM format",
"minLength" : 4,
"maxLength" : 4
},
"emboss_name" : {
"type" : "string",
"example" : "Akshay Patel",
"description" : "Emboss name : name that appears on front of card.",
"minLength" : 0,
"maxLength" : 30
},
"card_type" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "<ul>\n<li class=\"docBullet\">1 ==&gt;Physical</li>\n<li class=\"docBullet\">2 ==&gt; Virtual card</li>\n<li class=\"docBullet\">3==&gt;Converted(Virtual to Physical)</li>\n</ul>"
},
"product_ref" : {
"type" : "string",
"example" : "product reference",
"description" : "product Reference.",
"minLength" : 0,
"maxLength" : 60
},
"custom_1" : {
"type" : "string",
"example" : "Test Custom",
"description" : "Customer special details, i.e. QR code\nIf custom_1 ==> 1, then we will provide : MMYY+Public Token (MMYY ->the date of card creation ).\nIf custom_1 value other than \"1\" , PT will include what ever client input in the same field in create.\n",
"minLength" : 0,
"maxLength" : 255
},
"envelope_ref" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies envelope type."
},
"carrier_type" : {
"type" : "string",
"example" : "1",
"description" : "Allows client to stipulate carrier type (card packaging type choice - for shipment to customer) possible."
},
"status_nwk" : {
"type" : "integer",
"format" : "int32",
"example" : 1000,
"description" : "<p>Status network :</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n</ul>"
},
"pin_rem_onl" : {
"type" : "integer",
"format" : "int32",
"example" : 3,
"description" : "pin remaining online "
},
"pin_rem_chp" : {
"type" : "integer",
"format" : "int32",
"example" : 3,
"description" : "pin remaining chip"
},
"cre_dt" : {
"type" : "string",
"example" : "2021-01-27 08:10:39.281233",
"description" : "Created Date"
},
"ac_parent" : {
"type" : "integer",
"format" : "int64",
"example" : 542283189,
"description" : "Parent account number."
},
"atm_lang_preference" : {
"type" : "string",
"example" : "01",
"description" : "Language to be used in ATM <ul><li class=\"docBullet\">01 ==> Chinese</li><li class=\"docBullet\">02 ==> English</li><li class=\"docBullet\">03 ==> Portugese</li><li class=\"docBullet\">04 ==> Spanish</li></ul>",
"minLength" : 2,
"maxLength" : 2
},
"ccy_bill" : {
"type" : "string",
"example" : "826",
"description" : "Billing currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"ch_dob" : {
"type" : "string",
"example" : "1998-01-02",
"description" : "card Holder Date of Birth,format yyyy-mm-dd."
},
"chip_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Chip currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 45,
"description" : "product Id"
},
"prod_name" : {
"type" : "string",
"example" : "Plastic card",
"description" : "product Name"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token."
},
"perso_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>\n Configuration for sensitive data\n</p>\n<table>\n<tbody>\n<tr>\n<th><strong>Position</strong></th>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n<tr>\n<td>1</td>\n<td>RFU</td>\n <td>Reserved for future</td>\n</tr>\n<tr>\n<td>2</td>\n<td>CVV</td>\n <td>0 : Hide Cvv, 1 : Show Cvv</td>\n</tr>\n<tr>\n<td>3</td>\n<td>RFU</td>\n <td>Reserved for future</td>\n</tr>\n<tr>\n<td>4</td>\n<td>RFU</td>\n <td>Reserved for future</td>\n</tr>\n<tr>\n<td>5</td>\n<td>Emboss Name</td>\n<td>0 : Lower case, 1 : Upper case</td>\n</tr>\n</tbody>\n</table>\n<p>\n Default value : 01001\n Means show cvv and save emboss name as uppercase\n</p>",
"minLength" : 5,
"maxLength" : 5
},
"load_status" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Enable or disable load for a card.0 ==> don't allow to load | 1 ==> Allow load for a card"
},
"image_name" : {
"type" : "string",
"example" : "paymentology",
"description" : "Image template name for the card to be generated.",
"minLength" : 0,
"maxLength" : 50
},
"tok_flag" : {
"type" : "array",
"description" : "Flags for token to assign various tasks to the card. 0 ==>Flag inactive | 1==> Flag Active",
"items" : {
"$ref" : "#/definitions/TokFlag"
}
}
}
},
"TokFlag" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string",
"example" : "send_bal",
"description" : "description"
},
"details" : {
"type" : "string",
"example" : "Send card bal in De54 in next auth",
"description" : "details"
},
"status" : {
"type" : "string",
"example" : "on",
"description" : "status"
},
"bit_pos" : {
"type" : "integer",
"format" : "int32",
"example" : 3,
"description" : "bit_pos"
}
}
},
"GetCardDetailsResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetCardDetailsResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetCardDetailsResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.GetCardDetailsResponseModel"
}
},
"GetCardDetailsResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"CardHistoryModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "date_from", "date_to", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token ",
"minimum" : 1
},
"date_from" : {
"type" : "string",
"example" : "2020-10-24 13:13:08",
"description" : "From Date,accepted format yyyy-mm-dd hh:mm:ss.",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"date_to" : {
"type" : "string",
"example" : "2021-12-31 23:59:59",
"description" : "To Date,accepted format yyyy-mm-dd hh:mm:ss",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"http_filter" : {
"type" : "string",
"description" : "<ul>\n<li class=\"docBullet\">g or G ==&gt; For retrieve actions like (pws_get_balance)</li>\n<li class=\"docBullet\">p or P ==&gt; For insert,update, delete actions like (pws_load_balance)</li>\n<li class=\"docBullet\">If not send or its value is null, then retrieves data for both\n</ul>",
"pattern" : "^[p,P,g,G]{1}$"
},
"text_search" : {
"type" : "string",
"example" : " ",
"description" : "Wild card search"
},
"card_account" : {
"type" : "string",
"example" : "b",
"description" : "<ul>\n<li class=\"docBullet\">a or A = retrieves account related only</li>\n<li class=\"docBullet\">c or C =retrieves card related only</li>\n<li class=\"docBullet\">b or B =retrieves both card and account related</li>\n</ul>",
"pattern" : "^[a,A,b,B,c,C]{1}$"
}
},
"description" : "-- This web service gets the history of a card/token.\n-- It serves as an audit log by saving the life cycle of a card from creation to activities, like\n load card, get balance, set/get status etc.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.cardhistory.CardHistoryModel"
}
},
"CardHistoryResponseModelBody" : {
"type" : "object",
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574857485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique"
},
"request_body" : {
"type" : "string",
"example" : "{\"api_call_unique_identifier\": \"32153auaia64i78\", \"client_id\": 123456, \"token\": 571295607}",
"description" : "API request JSON string"
},
"response_body" : {
"type" : "string",
"example" : "{ \"header\": { \"error_id\": 0, \"error_desc\": \"success\" }, \"body\":{ \"status_nwk\" : 1000 } }",
"description" : "API response JSON string"
},
"request_date_time" : {
"type" : "string",
"example" : "2019-12-24 13:13:08",
"description" : "API request date time in format yyyy-MM-dd hh:mm:ss"
},
"status" : {
"type" : "string",
"example" : "s",
"description" : "Success/Failure status. <ul><li class=\"docBullet\">s=success</li><li class=\"docBullet\">f=failed</li></ul>"
},
"app_name" : {
"type" : "string",
"example" : "PayApi",
"description" : "Application from where API is requested"
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1234567,
"description" : "Unique identifier for the client which Paymentology will provide at outset"
},
"api_name" : {
"type" : "string",
"example" : "pws_get_card_status",
"description" : "Api Name"
},
"response_date_time" : {
"type" : "string",
"example" : "2019-12-24 13:13:08",
"description" : "API Response date time in format yyyy-MM-dd hh:mm:ss"
}
}
},
"CardHistoryResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CardHistoryResponseModelHeader"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CardHistoryResponseModelBody"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.CardHistoryResponseModel"
}
},
"CardHistoryResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"CardImageModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "image_delivery", "image_fields", "image_name", "token", "xml_fields" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card.",
"minimum" : 1
},
"image_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide pan,cvv,expiry,token,emboss_name in response image . 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >pan</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv </td>\n</tr>\n<tr>\n<td >3</td>\n<td>expiry</td>\n</tr>\n<tr>\n<td >4</td>\n<td>emboss_name</td>\n</tr>\n<tr>\n<td >5</td>\n<td>token</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
},
"xml_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide pan,cvv,expiry,token,emboss_name in response json . 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >pan</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv. (This can be overrided from client level setting to show or hide cvv) </td>\n</tr>\n<tr>\n<td >3</td>\n<td>expiry</td>\n</tr>\n<tr>\n<td >4</td>\n<td>token</td>\n</tr>\n<tr>\n<td >5</td>\n<td>emboss_name</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
},
"image_delivery" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>How to deliver image back to client. Example :</p>\n<ul>\n<li class=\"docBullet\">1==&gt; Image in plain base64, encrypted pan, cvv,token,expiry,emboss_name).</li>\n<li class=\"docBullet\">2 ==&gt; Image in byte encrypted ,encrypted pan, cvv,token,expiry,emboss_name.</li>\n<li class=\"docBullet\">3 ==&gt; Data details JSON (encrypted pan,cvv,token,expiry,emboss_name but no image.</li>\n<li class=\"docBullet\">4 ==&gt; Image in byte encrypted , masked pan back, cvv,token,expiry,emboss_name.</li>\n</ul>",
"minimum" : 1,
"maximum" : 5
},
"image_name" : {
"type" : "string",
"example" : "paymentology",
"description" : "Image template name for the card to be generated. This field is case sensitive. card image has to be populated as configured in PayControl.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>'\"/;,`%]*$"
}
},
"description" : "-- This web service gets card image details (PAN, CVV, expiry or image details; based on public token provided.)\n-- Response data is based on image_delivery input fields.\n-- Provide token, image_name etc.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.CardImageModel"
}
},
"GetCardImageResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetCardImageResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetCardImageResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetCardImageResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.GetCardImageResponseModel"
}
},
"GetCardImageResponseBody" : {
"type" : "object",
"properties" : {
"cvv" : {
"type" : "string",
"example" : "***",
"description" : "card security code",
"minLength" : 3,
"maxLength" : 3
},
"image_base64" : {
"type" : "string",
"example" : "ZSBzaG9ydCB2Z=",
"description" : "Image data in base64 form"
},
"epan" : {
"type" : "string",
"example" : "***********",
"description" : "Encrypted pan number"
},
"emboss_name" : {
"type" : "string",
"example" : "JOHN DOVE",
"description" : "Name that appears in card",
"minLength" : 0,
"maxLength" : 30
},
"expiry" : {
"type" : "string",
"example" : "03/21",
"description" : "Expiry in MM/YY format",
"minLength" : 5,
"maxLength" : 5
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 788193393,
"description" : "Public token for card created"
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 788193393,
"description" : "account id in response"
},
"mpan" : {
"type" : "string",
"example" : "5445*****434**4354",
"description" : "masked pan. Returned only when image_delivery = 4",
"minLength" : 16,
"maxLength" : 16
}
}
},
"CardListModel" : {
"type" : "object",
"required" : [ "ac_id", "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 542283189,
"description" : "account number"
},
"cu_id" : {
"type" : "integer",
"format" : "int32",
"description" : "Customer Id"
},
"cu_ref" : {
"type" : "string",
"description" : "Customer Reference",
"minLength" : 0,
"maxLength" : 50
}
},
"description" : "-- This web service retrieves a list of available cards tokens.\n-- The list is displayed in a hierarchy. Every card linked to an account or parent account is retrieved.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.CardListModel"
}
},
"CardListResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CardListResponseModelHeader"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CardListResponseModelBody"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.CardListResponseModel"
}
},
"CardListResponseModelBody" : {
"type" : "object",
"required" : [ "image_name" ],
"properties" : {
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 792736698,
"description" : "account Number"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 883940706,
"description" : "Public Token"
},
"status_nwk" : {
"type" : "integer",
"format" : "int32",
"example" : 1000,
"description" : "<p>Status network :</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n<li class=\"docBullet\">1199: Void card - report DE39=05</li></ul>"
},
"product_id" : {
"type" : "integer",
"format" : "int32",
"example" : 234,
"description" : "product id of card"
},
"is_default" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Indicates what default account linked with card at multi-card-account hierarchy"
},
"is_active_ccy" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Active currency at multiple account linkage with card\n"
},
"cre_dt" : {
"type" : "string",
"example" : "2019-11-29T09:11:11Z",
"description" : "card/token created Date in ISO 8601 format"
},
"tran_ccy" : {
"type" : "string",
"example" : "826",
"description" : "transaction currency code. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)",
"minLength" : 3,
"maxLength" : 3
},
"bal_blk_amt" : {
"type" : "number",
"example" : 100.0,
"description" : "Blocked Balance Amount"
},
"bal_act_amt" : {
"type" : "number",
"example" : 10000.0,
"description" : "Actual Balance Amount"
},
"cu_ref" : {
"type" : "string",
"description" : "Customer Ref",
"minLength" : 0,
"maxLength" : 50
},
"card_type" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "<ul>\n<li class=\"docBullet\">1 ==&gt;Physical</li>\n<li class=\"docBullet\">2 ==&gt; Virtual card</li>\n<li class=\"docBullet\">3==&gt;Converted(Virtual to Physical)</li>\n</ul>"
},
"image_name" : {
"type" : "string",
"example" : "paymentology",
"description" : "Image template name for the card to be generated.",
"minLength" : 0,
"maxLength" : 50
}
}
},
"CardListResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetCardModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
}
},
"description" : "This api is used to get card status",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.GetCardModel"
}
},
"GetCardStatusResponseBody" : {
"type" : "object",
"properties" : {
"status_nwk" : {
"type" : "integer",
"format" : "int32",
"example" : 1000,
"description" : "<p>Status network :</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n<li class=\"docBullet\">1199: Void card - report DE39=05</li></ul>"
}
}
},
"GetCardStatusResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetCardStatusResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetCardStatusResponseHeader"
},
"body" : {
"$ref" : "#/definitions/GetCardStatusResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.GetCardStatusResponseModel"
}
},
"GetPanModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "pan_options", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token ",
"minimum" : 1
},
"pan_options" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "<ul>\n<li class=\"docBullet\">2 = first six digits</li>\n<li class=\"docBullet\">3 = last four digits</li>\n<li class=\"docBullet\">4 = first 6 + last 4 digits</li>\n</ul>",
"minimum" : 2,
"maximum" : 4
}
},
"description" : "-- This web service retrieves the PAN number for an existing card's token.\n-- The PAN number is retrieved based on the following options:\n\n2 ==> first six digits\n3 ==> last four digits\n4 --> first 6 + last 4 digits",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.GetPanModel"
}
},
"GetPanNumberResponseModelBody" : {
"type" : "object",
"properties" : {
"pan" : {
"type" : "string",
"example" : "545454******7384",
"description" : "masked pan",
"minLength" : 16,
"maxLength" : 16
}
}
},
"GetPanNumberResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"GetPanNumberResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetPanNumberResponseModelHeader"
},
"body" : {
"$ref" : "#/definitions/GetPanNumberResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.GetPanNumberResponseModel"
}
},
"PersoDataModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token",
"minimum" : 1
}
},
"description" : "-- This web service retrieves Perso Data for a card (token).\n\n",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.PersoDataModel"
}
},
"PersoDataResponseModelBody" : {
"type" : "object",
"properties" : {
"track1" : {
"type" : "string",
"example" : "5C3F8F885CD5275D0191368A9A11D275E17F623688FA32EB3FA465E16BD98C8C7139CA0BE477BE8E4FF4E84493297DA4B974C6CFDA44633B6EAA49A4892E6D812B284E66BE1F5AB0AC1E586CD9FF9C25",
"description" : "Track 1"
},
"track2" : {
"type" : "string",
"example" : "5BC6ECD02D9E8D5F22170FBC75F5366D024E1D2153C06AFF9E8FF2C896BF2F8C60CC79BBB4186EB9612F1FD2F1EC4DCE",
"description" : "Track 2"
},
"cvv2" : {
"type" : "string",
"example" : "F80E138479C53AE411547A25431361C3",
"description" : "cvv2"
},
"emboss_name" : {
"type" : "string",
"example" : "f0d5b769827d198774dd49a350c56497",
"description" : "Name that appears in card"
},
"track2_chip" : {
"type" : "string",
"example" : "5BC6ECD02D9E8D5F22170FBC75F5366D024E1D2153C06AFF9E8FF2C896BF2F8CAB192F0510EA8968FC7A48E31864DF3C",
"description" : "Track 2 Chip"
},
"icvv" : {
"type" : "string",
"example" : "805EA2120D75C2CB14605598832383DF",
"description" : "icvv"
},
"track3" : {
"type" : "string",
"description" : "Track 3"
}
}
},
"PersoDataResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PersoDataResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/PersoDataResponseModelHeader"
},
"body" : {
"$ref" : "#/definitions/PersoDataResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.PersoDataResponseModel"
}
},
"LinkAccountCardModel" : {
"type" : "object",
"required" : [ "ac_id", "action", "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "account Id",
"minimum" : 1
},
"action" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<p>action type :</p>\n<ul>\n<li class=\"docBullet\">0 ==&gt; Link card and account</li>\n<li class=\"docBullet\">1 ==&gt; Unlink card and account</li>\n</ul>",
"enum" : [ 0, 1 ]
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.LinkAccountCardModel"
}
},
"LinkAccountCardResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/LinkAccountCardResponseModelHeader"
},
"body" : {
"$ref" : "#/definitions/LinkAccountCardResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.LinkAccountCardResponseModel"
}
},
"LinkAccountCardResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"LinkAccountCardResponseModelBody" : {
"type" : "object",
"properties" : {
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 10035620,
"description" : "Public token"
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 102489020,
"description" : "account id"
}
}
},
"ListCardLinkedAccountModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"date_from" : {
"type" : "string",
"example" : "2017-10-24 13:13:08",
"description" : " From date,accepted format yyyy-mm-dd HH:mm:ss.",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"date_to" : {
"type" : "string",
"example" : "2017-10-24 13:13:08",
"description" : " To date,accepted format yyyy-mm-dd HH:mm:ss",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
}
},
"description" : "This web service allows to get list of accounts linked with card token",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.ListCardLinkedAccountModel"
}
},
"CardRenewModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "card_action", "client_id", "image_delivery", "image_fields", "image_name", "token", "xml_fields" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"status_nwk" : {
"type" : "integer",
"format" : "int32",
"example" : 1000,
"description" : "<p>Status network :&nbsp;<br />Allowed values for renewal</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n</ul>\n<p>Disallowed values for renewal&nbsp;<br />Below are also values for status_nwk but they are not allowed in card renewal.<br />we set card status_nwk into below values through pws_set_card_status web service and only process for card renewal.</p>\n<ul>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n</ul>"
},
"image_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide pan,cvv,expiry,token,emboss_name in response image . 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >pan</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv</td>\n</tr>\n<tr>\n<td >3</td>\n<td>expiry</td>\n</tr>\n<tr>\n<td >4</td>\n<td>emboss_name</td>\n</tr>\n<tr>\n<td >5</td>\n<td>token</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
},
"xml_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide pan,cvv,expiry,token,emboss_name in response json . 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >pan</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv</td>\n</tr>\n<tr>\n<td >3</td>\n<td>expiry</td>\n</tr>\n<tr>\n<td >4</td>\n<td>token</td>\n</tr>\n<tr>\n<td >5</td>\n<td>emboss_name</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
},
"image_delivery" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>How to deliver image back to client. Example :</p>\n<ul>\n<li class=\"docBullet\">1==&gt; Image in plain base64, encrypted pan, cvv,token,expiry,emboss_name).</li>\n<li class=\"docBullet\">2 ==&gt; Image in byte encrypted ,encrypted pan, cvv,token,expiry,emboss_name.</li>\n<li class=\"docBullet\">3 ==&gt; Data details JSON (encrypted pan,cvv,token,expiry,emboss_name but no image.</li>\n<li class=\"docBullet\">4 ==&gt; Image in byte encrypted , masked pan back, cvv,token,expiry,emboss_name.</li>\n</ul>",
"minimum" : 1,
"maximum" : 4
},
"image_name" : {
"type" : "string",
"example" : "paymentology",
"description" : "Image template name for the card to be generated. This field is case sensitive. card image has to be populated as configured in PayControl.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>\"/;,`%]*$"
},
"tok_flags" : {
"type" : "string",
"example" : "00000000000000000000000000000000",
"description" : "<p>Flags for token to assign various tasks to the card. 0 ==>Flag inactive | 1==> Flag Active . Descriptions for each tok flag bits are given below : </p>\n<table>\n <thead>\n <tr></td><td><strong>TOK_DESCRIPTION</strong></td><td><strong>BIT_POSITION</strong></td>\n </tr>\n </thead>\n <tbody>\n<tr><td title =\"After every transaction, send card balance to the scheme, to allow for balance to be displayed, \ni.e. for ATM transactions\">Send card bal in De54 in next auth</td><td>3</td></tr>\n<tr><td title =\"Should the maximum number of pin retries be exceded, then enable pin unblocking on chip card.\nSend to issuer to unblock\">Send pin unblock to card</td><td>4</td></tr>\n<tr><td title =\"Only allow ecommerce transactions (including MDES and VTS transactions)\">Set card to decline all tranasaction except ecommerce</td><td>5</td></tr>\n<tr><td title =\"Set card to decline all Contactless transaction\">Set card to decline all Contactless transaction</td><td>6</td></tr>\n<tr><td title =\"Decline all ecommerce transactions (including MDES and VTS transactions)\">Set card to decline all Ecommerce</td><td>9</td></tr>\n<tr><td title =\"Decline all ATM Cash withdrawal transactions\">Set card to decline all ATM</td><td>10</td></tr>\n<tr><td title =\"Do not allow any balance enquiry transactions\">Set card to decline Bal enquiry over auth</td><td>11</td></tr>\n<tr><td title =\"In the case of POS transactions, the cash disbursement of a portion of the transaction amount is not allowed. The merchant cannot give cash to cardholder as part of the transaction.\">Set card to decline cash back txns</td><td>12</td></tr>\n<tr><td title =\"No transactions are allowed that will credit the card balance, including refunds to the card.\">Set card to decline Auth credit pur/refund (DE3_1=20)</td><td>14</td></tr>\n<tr><td title =\"No payments allowed, only POS and ecommerce transactions and. i.e. MC MoneySend, credit card installments, etc\">Set card to decline credit payment (DE3_1=28)</td><td>19</td></tr>\n<tr><td title =\"Only transactions in the base currency are allowed, decline any transaction in a non-base currency\">Set card to decline non base currency txn</td><td>20</td></tr>\n<tr><td title =\"No account verification requests should be allowed\">Set card to decline all account enq (de61_7=8)</td><td>21</td></tr>\n<tr><td title =\"Only approve transactions where the card is present. If card not present, decline transaction\">Set card to decline card not present txns</td><td>22</td></tr>\n<tr><td title =\"card Where the card information is provided but neither the cardholder or the card are physically present (i.e. mail-order) decline the transaction. \">Set card to decline Cardholder not present txns</td><td>23</td></tr>\n<tr><td title =\"CATM Fallback - where a chip-card is used at chip-capable ATM, do not allow fallback to magnetic strip\">Set card to decline failover to mag at emv capable atm</td><td>24</td></tr>\n<tr><td title =\"ATM Fallback - where a chip-card is used at an ATM (chip-capable or not) do not allow fallback to magnetic stripe\">Set card to decline mag at atm</td><td>25</td></tr>\n<tr><td title =\"POS Fallback - where a chip-card is used at chip-capable POS, allow fallback to to magnetic strip\">Alow if fallback chp->mag at chp capable pos DE22_1=80</td><td>26</td></tr>\n<tr><td title =\"POS Fallback - when the magnetic strip is used for a transaction, only allow the transaction of the entire track can be read, i.e. only PAN sent then decline transaction\">Allow if de22_1=02 & De48_88 =Y</td><td>27</td></tr>\n<tr><td title =\"Set card to approve if AVS match fails\">Set card to approve if AVS match fails</td><td>28</td></tr>\n<tr><td title =\"Do not allow subscription transactions, decline recurring transactions\">Set card to decline Recurring transaction</td><td>29</td></tr>\n</tbody>\n</table>",
"pattern" : "^[0-1]{32}$"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 422477992,
"description" : "Public token for the card",
"minimum" : 1
},
"card_action" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>card action :</p>\n<ul>\n<li class=\"docBullet\">1==&gt;Replacement (new pan + new token + new expiry generated)</li>\n<li class=\"docBullet\">2==&gt; Renew (old pan + old token + new expiry generated)</li>\n</ul>",
"minimum" : 1,
"maximum" : 2
},
"reason" : {
"type" : "string",
"example" : "Lost my card",
"description" : "Reason for renewal or replacment",
"minLength" : 0,
"maxLength" : 255,
"pattern" : "^[^<>/;`%]*$"
},
"crd_prdct_id" : {
"type" : "integer",
"format" : "int32",
"example" : 300,
"description" : "card product id. If not sent default card product id is used."
},
"exp_date" : {
"type" : "string",
"example" : "2022-02-14 12:12:12",
"description" : "Expiry date for renewal or replacment. if not provided, default 2 years expiry date,accepted format yyyy-mm-dd hh:mm:ss.",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
}
},
"description" : "Creation of a new card in reference to the old one. It will have input parameters to specify the following.\n\n--Existing card Token\n--Replacement or Renewal \n--Reason for Replacement\n--Keep the old pin / Generate new pin\n--Expiry Date ",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.CardRenewModel"
}
},
"CardRenewResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/CardRenewResponseModelHeader"
},
"body" : {
"$ref" : "#/definitions/CardRenewResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.CardRenewResponseModel"
}
},
"CardRenewResponseModelBody" : {
"type" : "object",
"properties" : {
"cvv" : {
"type" : "string",
"example" : "***",
"description" : "card security code",
"minLength" : 3,
"maxLength" : 3
},
"image_base64" : {
"type" : "string",
"example" : "ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
"description" : "Image data in base64 form"
},
"epan" : {
"type" : "string",
"example" : "***********",
"description" : "Encrypted pan numbe",
"minLength" : 32,
"maxLength" : 32
},
"emboss_name" : {
"type" : "string",
"example" : "JOHN DOVE",
"description" : "Name that appears in card",
"minLength" : 0,
"maxLength" : 30
},
"expiry" : {
"type" : "string",
"example" : "03/21",
"description" : "Expiry in MM/YY format",
"minLength" : 5,
"maxLength" : 5
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 788193393,
"description" : "Public token for card created"
}
}
},
"CardRenewResponseModelHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"CardRenewModelV3" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "card_action", "client_id", "image_delivery", "image_fields", "image_name", "token", "xml_fields" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"status_nwk" : {
"type" : "integer",
"format" : "int32",
"example" : 1000,
"description" : "<p>Status network :&nbsp;<br />Allowed values for renewal</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n</ul>\n<p>Disallowed values for renewal&nbsp;<br />Below are also values for status_nwk but they are not allowed in card renewal.<br />we set card status_nwk into below values through pws_set_card_status web service and only process for card renewal.</p>\n<ul>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n</ul>"
},
"image_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide pan,cvv,expiry,token,emboss_name in response image . 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >pan</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv</td>\n</tr>\n<tr>\n<td >3</td>\n<td>expiry</td>\n</tr>\n<tr>\n<td >4</td>\n<td>emboss_name</td>\n</tr>\n<tr>\n<td >5</td>\n<td>token</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
},
"xml_fields" : {
"type" : "string",
"example" : "11111",
"description" : "<p>Show or hide pan,cvv,expiry,token,emboss_name in response json . 1 means show and 0 means hide</p>\n<table >\n<tbody>\n<tr>\n<th ><strong>Position</strong></th>\n<th ><strong>Field</strong></th>\n</tr>\n<tr>\n<td >1</td>\n<td >pan</td>\n</tr>\n<tr>\n<td >2</td>\n<td >cvv</td>\n</tr>\n<tr>\n<td >3</td>\n<td>expiry</td>\n</tr>\n<tr>\n<td >4</td>\n<td>token</td>\n</tr>\n<tr>\n<td >5</td>\n<td>emboss_name</td>\n</tr>\n</tbody>\n</table>\n<p>EG : 00111 (Hide pan and cvv but show expiry token, emboss_name).</p>",
"minLength" : 5,
"maxLength" : 5,
"pattern" : "^[0-1]{5}$"
},
"image_delivery" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>How to deliver image back to client. Example :</p>\n<ul>\n<li class=\"docBullet\">1==&gt; Image in plain base64, encrypted pan, cvv,token,expiry,emboss_name).</li>\n<li class=\"docBullet\">2 ==&gt; Image in byte encrypted ,encrypted pan, cvv,token,expiry,emboss_name.</li>\n<li class=\"docBullet\">3 ==&gt; Data details JSON (encrypted pan,cvv,token,expiry,emboss_name but no image.</li>\n<li class=\"docBullet\">4 ==&gt; Image in byte encrypted , masked pan back, cvv,token,expiry,emboss_name.</li>\n</ul>",
"minimum" : 1,
"maximum" : 4
},
"image_name" : {
"type" : "string",
"example" : "paymentology",
"description" : "Image template name for the card to be generated. This field is case sensitive. card image has to be populated as configured in PayControl.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>\"/;,`%]*$"
},
"tok_flags" : {
"type" : "string",
"example" : "00000000000000000000000000000000",
"description" : "<p>Flags for token to assign various tasks to the card. 0 ==>Flag inactive | 1==> Flag Active . Descriptions for each tok flag bits are given below : </p>\n<table>\n <thead>\n <tr></td><td><strong>TOK_DESCRIPTION</strong></td><td><strong>BIT_POSITION</strong></td>\n </tr>\n </thead>\n <tbody>\n<tr><td title =\"After every transaction, send card balance to the scheme, to allow for balance to be displayed, \ni.e. for ATM transactions\">Send card bal in De54 in next auth</td><td>3</td></tr>\n<tr><td title =\"Should the maximum number of pin retries be exceded, then enable pin unblocking on chip card.\nSend to issuer to unblock\">Send pin unblock to card</td><td>4</td></tr>\n<tr><td title =\"Only allow ecommerce transactions (including MDES and VTS transactions)\">Set card to decline all tranasaction except ecommerce</td><td>5</td></tr>\n<tr><td title =\"Set card to decline all Contactless transaction\">Set card to decline all Contactless transaction</td><td>6</td></tr>\n<tr><td title =\"Decline all ecommerce transactions (including MDES and VTS transactions)\">Set card to decline all Ecommerce</td><td>9</td></tr>\n<tr><td title =\"Decline all ATM Cash withdrawal transactions\">Set card to decline all ATM</td><td>10</td></tr>\n<tr><td title =\"Do not allow any balance enquiry transactions\">Set card to decline Bal enquiry over auth</td><td>11</td></tr>\n<tr><td title =\"In the case of POS transactions, the cash disbursement of a portion of the transaction amount is not allowed. The merchant cannot give cash to cardholder as part of the transaction.\">Set card to decline cash back txns</td><td>12</td></tr>\n<tr><td title =\"No transactions are allowed that will credit the card balance, including refunds to the card.\">Set card to decline Auth credit pur/refund (DE3_1=20)</td><td>14</td></tr>\n<tr><td title =\"No payments allowed, only POS and ecommerce transactions and. i.e. MC MoneySend, credit card installments, etc\">Set card to decline credit payment (DE3_1=28)</td><td>19</td></tr>\n<tr><td title =\"Only transactions in the base currency are allowed, decline any transaction in a non-base currency\">Set card to decline non base currency txn</td><td>20</td></tr>\n<tr><td title =\"No account verification requests should be allowed\">Set card to decline all account enq (de61_7=8)</td><td>21</td></tr>\n<tr><td title =\"Only approve transactions where the card is present. If card not present, decline transaction\">Set card to decline card not present txns</td><td>22</td></tr>\n<tr><td title =\"card Where the card information is provided but neither the cardholder or the card are physically present (i.e. mail-order) decline the transaction. \">Set card to decline Cardholder not present txns</td><td>23</td></tr>\n<tr><td title =\"CATM Fallback - where a chip-card is used at chip-capable ATM, do not allow fallback to magnetic strip\">Set card to decline failover to mag at emv capable atm</td><td>24</td></tr>\n<tr><td title =\"ATM Fallback - where a chip-card is used at an ATM (chip-capable or not) do not allow fallback to magnetic stripe\">Set card to decline mag at atm</td><td>25</td></tr>\n<tr><td title =\"POS Fallback - where a chip-card is used at chip-capable POS, allow fallback to to magnetic strip\">Alow if fallback chp->mag at chp capable pos DE22_1=80</td><td>26</td></tr>\n<tr><td title =\"POS Fallback - when the magnetic strip is used for a transaction, only allow the transaction of the entire track can be read, i.e. only PAN sent then decline transaction\">Allow if de22_1=02 & De48_88 =Y</td><td>27</td></tr>\n<tr><td title =\"Set card to approve if AVS match fails\">Set card to approve if AVS match fails</td><td>28</td></tr>\n<tr><td title =\"Do not allow subscription transactions, decline recurring transactions\">Set card to decline Recurring transaction</td><td>29</td></tr>\n</tbody>\n</table>",
"pattern" : "^[0-1]{32}$"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 422477992,
"description" : "Public token for the card",
"minimum" : 1
},
"card_action" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>card action :</p>\n<ul>\n<li class=\"docBullet\">1==&gt;Replacement (new pan + new token + new expiry generated)</li>\n<li class=\"docBullet\">2==&gt; Renew (old pan + old token + new expiry generated)</li>\n</ul>",
"minimum" : 1,
"maximum" : 2
},
"reason" : {
"type" : "string",
"example" : "Lost my card",
"description" : "Reason for renewal or replacment",
"minLength" : 0,
"maxLength" : 255,
"pattern" : "^[^<>/;`%]*$"
},
"crd_prdct_id" : {
"type" : "integer",
"format" : "int32",
"example" : 300,
"description" : "card product id. If not sent default card product id is used."
},
"exp_date" : {
"type" : "string",
"example" : "2022-02-14 12:12:12",
"description" : "Expiry date for renewal or replacment. if not provided, default 2 years expiry date,accepted format yyyy-mm-dd hh:mm:ss.",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"del_title" : {
"type" : "string",
"example" : "Mr",
"description" : "delivery Title.",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
},
"del_fname" : {
"type" : "string",
"example" : "Rohan",
"description" : "delivery First Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"emboss_name" : {
"type" : "string",
"example" : "Akshay Patel",
"description" : "Emboss name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"del_sname" : {
"type" : "string",
"example" : "Ale",
"description" : "delivery Last Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"del_addr1" : {
"type" : "string",
"example" : "Nadipur",
"description" : "delivery Address 1.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_addr2" : {
"type" : "string",
"example" : "Nadipur",
"description" : "delivery Adderess2.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_pcode" : {
"type" : "string",
"example" : "09877",
"description" : "delivery Postal Code.",
"minLength" : 0,
"maxLength" : 15,
"pattern" : "^[^<>/;`%]*$"
},
"del_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "delivery City.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "delivery Country.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_email" : {
"type" : "string",
"example" : "Rohan@paymentology.com",
"description" : "delivery Email.",
"minLength" : 0,
"maxLength" : 60,
"pattern" : "^[^<>/;`%]*$"
},
"del_mobile" : {
"type" : "string",
"example" : "98456565545",
"description" : "delivery Mobile. phone number format i.e 00 (contry code ) phone number or + (country code) phone number.",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"del_pass_code" : {
"type" : "string",
"example" : "0001",
"description" : "delivery Pass Code.",
"pattern" : "^[^<>/;`%]*$"
},
"del_method" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>delivery method for card :</p>\n<ul>\n<li class=\"docBullet\">0 &ndash; Standard mail</li>\n<li class=\"docBullet\">1 &ndash; Registered mail</li>\n<li class=\"docBullet\">2 &ndash; Direct delivery (courier) RFU</li>\n</ul>"
},
"del_account" : {
"type" : "integer",
"format" : "int32",
"example" : 1225456,
"description" : "delivery account Number."
},
"del_region" : {
"type" : "string",
"example" : "ENG",
"description" : "delivery Holder Region.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"bulk_delv_add_code" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Bulk delivery address code, allows processor and manufacturer to agree a pre-defined delivery address."
},
"del_code" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "delivery Code, carriers with same del_code, will be grouped to be send to a specified delivery address."
},
"pur_title" : {
"type" : "string",
"example" : "Mr",
"description" : "Purchaser Title.",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
},
"pur_fname" : {
"type" : "string",
"example" : "Rohit",
"description" : "Purchaser First Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"pur_sname" : {
"type" : "string",
"example" : "Thapa",
"description" : "Purchaser Last Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"pur_addr1" : {
"type" : "string",
"example" : "Rambajar",
"description" : "Purchaser Address1.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_addr2" : {
"type" : "string",
"example" : "Rambajar2",
"description" : "Purchaser Address2",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_pcode" : {
"type" : "string",
"example" : "0988",
"description" : "Purchaser Postal Code.",
"minLength" : 0,
"maxLength" : 15,
"pattern" : "^[^<>/;`%]*$"
},
"pur_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "Purchaser City.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "Purchaser Country.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_email" : {
"type" : "string",
"example" : "Rohit@paymentology.com",
"description" : "Purchaser Email.",
"minLength" : 0,
"maxLength" : 60,
"pattern" : "^[^<>/;`%]*$"
},
"pur_mobile" : {
"type" : "string",
"example" : "9845262622",
"description" : "Purchaser Mobile,phone number format i.e 00 (contry code ) phone number or + (country code) phone number.",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"pur_account" : {
"type" : "integer",
"format" : "int32",
"example" : 122222,
"description" : "Purchaser account Number"
},
"pur_cust_type" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Purchaser Customer type"
},
"card_manuf_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "card manufacturer id (If not passed then will take default manuf id will be taken from manufacturer table)\n"
},
"pur_pass_code" : {
"type" : "string",
"example" : "pass code",
"description" : "Purchaser pass code (can be stored against card for customer authentication [i.e. activation stage], or Paymentology can generate)\n",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
},
"carrier_type" : {
"type" : "string",
"example" : "1",
"description" : "Allows client to stipulate carrier type (card packaging type choice - for shipment to customer). Possible\n\n"
},
"carrier_insrt1" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies insert 1 to be included with Carrier in Envelope\n",
"maximum" : 32767
},
"carrier_insrt2" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies insert 2 to be included with Carrier in Envelope\n",
"maximum" : 32767
},
"carrier_lang" : {
"type" : "string",
"example" : "ENG",
"description" : "Language to be used in carrier notes and labels(iso 3166-1, character three digits).",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>\"/;`%]*$"
},
"envelope_ref" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies envelope type\n",
"maximum" : 32767
},
"ext_line1" : {
"type" : "string",
"example" : "ALD07",
"description" : "Extra card text line 1, allows additional line for subjective requirements i.e. extra text in the card\n",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"ext_line2" : {
"type" : "string",
"example" : "ALD07",
"description" : "Extra card text line 2, allows additional line for subjective requirements i.e. extra text in the card\n",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"custom_1" : {
"type" : "string",
"example" : "custom1",
"description" : "\t\nstring [ 0 .. 255 ] characters\nCustomer special details, i.e. QR code If custom_1 ==> 1, then we will provide : MMYY+Public Token (MMYY ->the date of card creation ). If custom_1 value other than \"1\" , PT will include what ever client input in the same field in create.",
"minLength" : 0,
"maxLength" : 255,
"pattern" : "^[^<>/;`%]*$"
},
"emboss_line4" : {
"type" : "string",
"description" : "Emboss line 4, front of card additional text i.e. public token\n",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"track_3" : {
"type" : "string",
"example" : "track3",
"description" : "Track 3, Mag stripe\n",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"fulfil1" : {
"type" : "string",
"example" : "fulfil1",
"description" : "Future field 1RFU\n",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"fulfil2" : {
"type" : "string",
"example" : "fulfil2",
"description" : "Future field 2RFU\n",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"product_ref" : {
"type" : "string",
"description" : "product identifier, i.e. physical card design reference used by the card printer.",
"minLength" : 0,
"maxLength" : 60,
"pattern" : "^[^<>\"/;`%]*$"
},
"client_card_ref" : {
"type" : "string",
"example" : "client choice",
"description" : "Unique client reference relating to order, card or customer where present should always be quoted in correspondence",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;`%]*$"
}
},
"description" : "Creation of a new card in reference to the old one. It will have input parameters to specify the following.\n\n--Existing card Token\n--Replacement or Renewal \n--Reason for Replacement\n--Keep the old pin / Generate new pin\n--Expiry Date ",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.CardRenewModelV3"
}
},
"SetCardModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "status_nwk", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"status_nwk" : {
"type" : "string",
"example" : "1000",
"description" : "<p>Status network :</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n<li class=\"docBullet\">1199: Void card - report DE39=05</li></ul>"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card\n",
"minimum" : 1
},
"action" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<ul>\n<li class=\"docBullet\">1 ==&gt; Normal card status change.</li>\n<li class=\"docBullet\">2 ==&gt; card status change once any card is renewed.</li>\n</ul>\n<p><br />If not provided then default action = 1.<br />If renewed card not found and we send action = 2 , then it will act as normal card status change</p>"
},
"note" : {
"type" : "string",
"description" : "Short note of card status change",
"minLength" : 0,
"maxLength" : 200
}
},
"description" : "-- This web service sets the status for a token(card) and verifies the system and network status of a card.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.SetCardModel"
}
},
"SetCardStatusResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/SetCardStatusResponseHeader"
},
"body" : {
"$ref" : "#/definitions/SetCardStatusResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.responsemodel.SetCardStatusResponseModel"
}
},
"SetCardStatusResponseBody" : {
"type" : "object",
"properties" : {
"status_nwk" : {
"type" : "integer",
"format" : "int32",
"example" : 1041,
"description" : "<p>Status network :</p>\n<ul>\n<li class=\"docBullet\">1000 : Fully Operational DE39=00</li>\n<li class=\"docBullet\">1001 : Refer to Issuer DE39= 01</li>\n<li class=\"docBullet\">1004 : Capture card DE39=04</li>\n<li class=\"docBullet\">1005 : Decline All Txns DE39=05</li>\n<li class=\"docBullet\">1008 : Honour with ID DE39=08</li>\n<li class=\"docBullet\">1041 : Lost card - Capture DE39= 41</li>\n<li class=\"docBullet\">1043 : Stolen card - Capture DE39=43</li>\n<li class=\"docBullet\">1054 : Expired card - report DE39=54</li>\n<li class=\"docBullet\">1199: Void card - report DE39=05</li></ul>"
}
}
},
"SetCardStatusResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"SetDefaultCcyModel" : {
"type" : "object",
"required" : [ "ac_id", "api_call_unique_identifier", "client_id", "is_active", "token", "tran_ccy" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card.",
"minimum" : 1
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "account number.",
"minimum" : 1
},
"tran_ccy" : {
"type" : "string",
"example" : "826",
"description" : "Currency code.(Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD).",
"minLength" : 3,
"maxLength" : 3,
"pattern" : "^[0-9]{3}$"
},
"is_active" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "<ul>\n<li class=\"docBullet\">0 = Not-Active</li>\n<li class=\"docBullet\">&nbsp;1 = Active</li>\n</ul>",
"enum" : [ 0, 1 ]
}
},
"description" : "This web service allows to set active currency for the linked accounts with card",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.SetDefaultCcyModel"
}
},
"VirtualToPhysicalModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "image_name", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 479823917,
"description" : "Public token ",
"minimum" : 1
},
"del_title" : {
"type" : "string",
"example" : "Mr",
"description" : "delivery Title.",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
},
"del_fname" : {
"type" : "string",
"example" : "Rohan",
"description" : "delivery First Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"emboss_name" : {
"type" : "string",
"example" : "Akshay Patel",
"description" : "Emboss name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"del_sname" : {
"type" : "string",
"example" : "Ale",
"description" : "delivery Last Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"del_addr1" : {
"type" : "string",
"example" : "Nadipur",
"description" : "delivery Address 1.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_addr2" : {
"type" : "string",
"example" : "Nadipur",
"description" : "delivery Adderess2.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_pcode" : {
"type" : "string",
"example" : "09877",
"description" : "delivery Postal Code.",
"minLength" : 0,
"maxLength" : 15,
"pattern" : "^[^<>/;`%]*$"
},
"del_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "delivery City.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "delivery Country.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"del_email" : {
"type" : "string",
"example" : "Rohan@paymentology.com",
"description" : "delivery Email.",
"minLength" : 0,
"maxLength" : 60,
"pattern" : "^[^<>/;`%]*$"
},
"del_mobile" : {
"type" : "string",
"example" : "98456565545",
"description" : "delivery Mobile. phone number format i.e 00 (contry code ) phone number or + (country code) phone number.",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"del_pass_code" : {
"type" : "string",
"example" : "0001",
"description" : "delivery Pass Code.",
"pattern" : "^[^<>/;`%]*$"
},
"del_method" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>delivery method for card :</p>\n<ul>\n<li class=\"docBullet\">0 &ndash; Standard mail</li>\n<li class=\"docBullet\">1 &ndash; Registered mail</li>\n<li class=\"docBullet\">2 &ndash; Direct delivery (courier) RFU</li>\n</ul>"
},
"del_account" : {
"type" : "integer",
"format" : "int32",
"example" : 1225456,
"description" : "delivery account Number."
},
"del_region" : {
"type" : "string",
"example" : "ENG",
"description" : "delivery Holder Region.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"bulk_delv_add_code" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Bulk delivery address code, allows processor and manufacturer to agree a pre-defined delivery address."
},
"del_code" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "delivery Code, carriers with same del_code, will be grouped to be send to a specified delivery address."
},
"pur_title" : {
"type" : "string",
"example" : "Mr",
"description" : "Purchaser Title.",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
},
"pur_fname" : {
"type" : "string",
"example" : "Rohit",
"description" : "Purchaser First Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"pur_sname" : {
"type" : "string",
"example" : "Thapa",
"description" : "Purchaser Last Name.",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"pur_addr1" : {
"type" : "string",
"example" : "Rambajar",
"description" : "Purchaser Address1.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_addr2" : {
"type" : "string",
"example" : "Rambajar2",
"description" : "Purchaser Address2",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_pcode" : {
"type" : "string",
"example" : "0988",
"description" : "Purchaser Postal Code.",
"minLength" : 0,
"maxLength" : 15,
"pattern" : "^[^<>/;`%]*$"
},
"pur_city" : {
"type" : "string",
"example" : "Pokhara",
"description" : "Purchaser City.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_country" : {
"type" : "string",
"example" : "Nepal",
"description" : "Purchaser Country.",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"pur_email" : {
"type" : "string",
"example" : "Rohit@paymentology.com",
"description" : "Purchaser Email.",
"minLength" : 0,
"maxLength" : 60,
"pattern" : "^[^<>/;`%]*$"
},
"pur_mobile" : {
"type" : "string",
"example" : "9845262622",
"description" : "Purchaser Mobile,phone number format i.e 00 (contry code ) phone number or + (country code) phone number.",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"pur_account" : {
"type" : "integer",
"format" : "int32",
"example" : 122222,
"description" : "Purchaser account Number"
},
"card_manuf_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "card manufacturer id (If not passed then will take default manuf id will be taken from manufacturer table)\n"
},
"pur_pass_code" : {
"type" : "string",
"example" : "pass code",
"description" : "Purchaser pass code (can be stored against card for customer authentication [i.e. activation stage], or Paymentology can generate)\n",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
},
"carrier_type" : {
"type" : "string",
"example" : "1",
"description" : "Allows client to stipulate carrier type (card packaging type choice - for shipment to customer). Possible\n\n"
},
"carrier_insrt1" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies insert 1 to be included with Carrier in Envelope\n",
"maximum" : 32767
},
"carrier_insrt2" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies insert 2 to be included with Carrier in Envelope\n",
"maximum" : 32767
},
"carrier_lang" : {
"type" : "string",
"example" : "ENG",
"description" : "Language to be used in carrier notes and labels(iso 3166-1, character three digits).",
"minLength" : 0,
"maxLength" : 3,
"pattern" : "^[^<>\"/;`%]*$"
},
"envelope_ref" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Identifies envelope type\n",
"maximum" : 32767
},
"ext_line1" : {
"type" : "string",
"example" : "ALD07",
"description" : "Extra card text line 1, allows additional line for subjective requirements i.e. extra text in the card\n",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"ext_line2" : {
"type" : "string",
"example" : "ALD07",
"description" : "Extra card text line 2, allows additional line for subjective requirements i.e. extra text in the card\n",
"minLength" : 0,
"maxLength" : 20,
"pattern" : "^[^<>/;`%]*$"
},
"custom_1" : {
"type" : "string",
"example" : "custom1",
"description" : "\t\nstring [ 0 .. 255 ] characters\nCustomer special details, i.e. QR code If custom_1 ==> 1, then we will provide : MMYY+Public Token (MMYY ->the date of card creation ). If custom_1 value other than \"1\" , PT will include what ever client input in the same field in create.",
"minLength" : 0,
"maxLength" : 255,
"pattern" : "^[^<>/;`%]*$"
},
"emboss_line4" : {
"type" : "string",
"description" : "Emboss line 4, front of card additional text i.e. public token\n",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>/;`%]*$"
},
"track_3" : {
"type" : "string",
"example" : "track3",
"description" : "Track 3, Mag stripe\n",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"fulfil1" : {
"type" : "string",
"example" : "fulfil1",
"description" : "Future field 1RFU\n",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"fulfil2" : {
"type" : "string",
"example" : "fulfil2",
"description" : "Future field 2RFU\n",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"product_ref" : {
"type" : "string",
"description" : "product identifier, i.e. physical card design reference used by the card printer.",
"minLength" : 0,
"maxLength" : 60,
"pattern" : "^[^<>\"/;`%]*$"
},
"client_card_ref" : {
"type" : "string",
"example" : "client choice",
"description" : "Unique client reference relating to order, card or customer where present should always be quoted in correspondence",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;`%]*$"
},
"exp_date" : {
"type" : "string",
"example" : "2025-01-01 00:00:00",
"description" : "Expiry Date,accepted format yyyy-mm-dd hh:mm:ss",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
},
"image_name" : {
"type" : "string",
"example" : "paymentology",
"description" : "image template name for the card to be generated",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
}
},
"description" : "-- This web service allows to convert virtual cards to physical cards.\n-- Once the card is converted to physical, it goes through the manufacturing process.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.card.VirtualToPhysicalModel"
}
},
"CreateGroupModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "group_desc", "group_name", "group_type", "risk_level" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_name" : {
"type" : "string",
"example" : "Testing group",
"description" : "group Name",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"group_desc" : {
"type" : "string",
"example" : "Testing group Description",
"description" : "group Description",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;`%]*$"
},
"group_type" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "Indicates the type of group. They are listed below:<ul>\n<li class=\"docBullet\" >group_type =2 indicates General Container</li>\n<li class=\"docBullet\" >group_type =3 indicates Fees group</li>\n<li class=\"docBullet\" >group_type =4 indicates Auth activities</li>\n<li class=\"docBullet\" >group_type =5 indicates Settlement Activities</li>\n<li class=\"docBullet\" >group_type =6 indicates Scheduled Tasks</li>\n<li class=\"docBullet\" >group_type =7 indicates Fraud Assessment</li>\n<li class=\"docBullet\" >group_type =8 indicates AI rules</li>\n<li class=\"docBullet\" >group_type =9 indicates wallet Interactions</li>\n</ul>",
"minimum" : 2,
"maximum" : 9
},
"risk_level" : {
"type" : "string",
"example" : "Default",
"description" : "Risk Level .Supported Value for risk level are : <ul>\n<li class=\"docBullet\" >Default</li>\n<li class=\"docBullet\" >Low</li>\n<li class=\"docBullet\" >Very Low</li>\n<li class=\"docBullet\" >High</li>\n<li class=\"docBullet\" >Very High</li>\n<li class=\"docBullet\" >Custom</li>\n</ul>",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
}
},
"description" : "This web service allows to Create groups",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.CreateGroupModel"
}
},
"CreateGroupResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeader"
},
"body" : {
"$ref" : "#/definitions/CreateGroupResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.responsemodel.CreateGroupResponseModel"
}
},
"CreateGroupResponseModelBody" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"example" : 183,
"description" : "Newly Created group Id"
}
}
},
"CreateProductGroupTemplateModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "groups", "prod_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 383,
"description" : "product Id",
"minimum" : 1
},
"groups" : {
"type" : "string",
"example" : "1267",
"description" : "comma separated group Id's.",
"pattern" : "^\\d+(,\\d+)*$"
}
},
"description" : "This web service allows to create default product group template which will be inherited to all new cards created under that product",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.CreateProductGroupTemplateModel"
}
},
"EditGroupModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "group_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1267,
"description" : "group id",
"minimum" : 1
},
"group_name" : {
"type" : "string",
"example" : "Testing group",
"description" : "group Name",
"minLength" : 0,
"maxLength" : 50,
"pattern" : "^[^<>/;`%]*$"
},
"group_desc" : {
"type" : "string",
"example" : "Testing group Description",
"description" : "group Description",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;`%]*$"
},
"group_type" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "Indicates the type of group. They are listed below:<ul>\n<li class=\"docBullet\" >group_type =2 indicates General Container</li>\n<li class=\"docBullet\" >group_type =3 indicates Fees group</li>\n<li class=\"docBullet\" >group_type =4 indicates Auth activities</li>\n<li class=\"docBullet\" >group_type =5 indicates Settlement Activities</li>\n<li class=\"docBullet\" >group_type =6 indicates Scheduled Tasks</li>\n<li class=\"docBullet\" >group_type =7 indicates Fraud Assessment</li>\n<li class=\"docBullet\" >group_type =8 indicates AI rules</li>\n<li class=\"docBullet\" >group_type =9 indicates wallet Interactions</li>\n</ul>",
"minimum" : 2,
"maximum" : 9
},
"risk_level" : {
"type" : "string",
"example" : "Default",
"description" : "Risk Level .Supported Value for risk level are : <ul><li class=\"docBullet\">Default</li><li class=\"docBullet\">Low</li><li class=\"docBullet\">Very Low</li><li class=\"docBullet\">High</li><li class=\"docBullet\">Very High</li><li class=\"docBullet\">Custom</li></ul>",
"minLength" : 0,
"maxLength" : 10,
"pattern" : "^[^<>/;`%]*$"
}
},
"description" : "This web service allows to Edit group's details.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.EditGroupModel"
}
},
"EditProductGroupTemplateModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "groups", "prod_id", "status" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"prod_id" : {
"type" : "integer",
"format" : "int32",
"example" : 383,
"description" : "product Id",
"minimum" : 1
},
"groups" : {
"type" : "string",
"example" : "1267",
"description" : "comma separated group Id's.",
"pattern" : "^\\d+(,\\d+)*$"
},
"status" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "status can be <ul><li class=\"docBullet\">1=enabled</li><li class=\"docBullet\">0=disabled</li></ul>",
"maximum" : 1
}
},
"description" : "This web service allows to Edit default product group template which will be inherited to all new cards created under that product",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.EditProductGroupTemplateModel"
}
},
"ListGroupModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"description" : "group Id. Returns data for provided group Id only"
}
},
"description" : "This web service allows to list groups",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.ListGroupModel"
}
},
"GroupListResponseModelBody" : {
"type" : "object",
"properties" : {
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 103,
"description" : "group Id"
},
"group_desc" : {
"type" : "string",
"example" : "Container For Fraud rules",
"description" : "group Description",
"minLength" : 0,
"maxLength" : 100
},
"group_name" : {
"type" : "string",
"example" : "Test group",
"description" : "group Name",
"minLength" : 0,
"maxLength" : 50
},
"group_type" : {
"type" : "string",
"example" : "General Container",
"description" : "group Type",
"minLength" : 0,
"maxLength" : 50
},
"risk_level" : {
"type" : "string",
"example" : "Default",
"description" : "Risk Level",
"minLength" : 0,
"maxLength" : 10
}
}
},
"GroupListResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeader"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/GroupListResponseModelBody"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.responsemodel.GroupListResponseModel"
}
},
"SearchInternal" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.meawallet.customerservice.SearchInternal"
}
},
"PSGetCvv2Model" : {
"type" : "object",
"required" : [ "client_id", "token" ],
"properties" : {
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
}
},
"description" : "This web service allows to get cvv2 for a card/token.\n Pass public token and api will retrieve back AES encrypted cvv2.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.paysecurecard.PSGetCvv2Model"
}
},
"GetCVV2Response" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetCvv2Header"
},
"body" : {
"$ref" : "#/definitions/GetCvv2Body"
}
},
"description" : "This model contains response details of get cvv2 api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.paysecureresponsemodel.GetCVV2Response"
}
},
"GetCvv2Body" : {
"type" : "object",
"properties" : {
"secret" : {
"type" : "string",
"example" : "+AyrdXnhXhc=",
"description" : "Encrypted CVV2 back"
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV)",
"minLength" : 16,
"maxLength" : 16
}
}
},
"GetCvv2Header" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PSGetPanModel" : {
"type" : "object",
"required" : [ "client_id", "token" ],
"properties" : {
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
}
},
"description" : "This web service allows to get pan for a card/token.\n Pass public token and api will retrieve back AES encrypted pan.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.paysecurecard.PSGetPanModel"
}
},
"GetPanResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/GetPanHeader"
},
"body" : {
"$ref" : "#/definitions/GetPanBody"
}
},
"description" : "This model contains the response details of get pan api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.paysecureresponsemodel.GetPanResponse"
}
},
"GetPanBody" : {
"type" : "object",
"properties" : {
"secret" : {
"type" : "string",
"example" : "+AyrdXnhXhc=",
"description" : "Encrypted Pan back"
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV)",
"minLength" : 16,
"maxLength" : 16
}
}
},
"GetPanHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PSGetPinModel" : {
"type" : "object",
"required" : [ "client_id", "iv", "token" ],
"properties" : {
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"cvv2" : {
"type" : "string",
"example" : "+AyrdXnhXhc=",
"description" : "AES Encrypted cvv2 of the card"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV) used while encryption",
"minLength" : 16,
"maxLength" : 16
}
},
"description" : "This web service allows to get pin for a card/token.\n Pass public token and api will retrieve back AES encrypted pin.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.paysecurecard.PSGetPinModel"
}
},
"PaySecureGetPinResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/PaySecureGetPinHeader"
},
"body" : {
"$ref" : "#/definitions/PaySecureGetPinBody"
}
},
"description" : "This model contains the response details of get pin api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.paysecureresponsemodel.PaySecureGetPinResponse"
}
},
"PaySecureGetPinHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PaySecureGetPinBody" : {
"type" : "object",
"properties" : {
"secret" : {
"type" : "string",
"example" : "+AyrdXnhXhc=",
"description" : "Encrypted pin back"
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV)",
"minLength" : 16,
"maxLength" : 16
}
}
},
"PSSetPinModel" : {
"type" : "object",
"required" : [ "client_id", "iv", "pin", "token" ],
"properties" : {
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"pin" : {
"type" : "string",
"example" : "+AyrdXnhXhXb6qbV2L6d1F92YUc=",
"description" : "AES Encrypted pin Block"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card",
"minimum" : 1
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV) used while encryption",
"minLength" : 16,
"maxLength" : 16
}
},
"description" : "This web service allows to set pin for a card/token.\nclient should pass AES encrypted pin to api.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.paysecurecard.PSSetPinModel"
}
},
"PaySecureSetPinHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PaySecureSetPinResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/PaySecureSetPinHeader"
},
"body" : {
"$ref" : "#/definitions/PaySecureSetPinBody"
}
},
"description" : "This model contains the response details of paysecure set pin api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.paysecureresponsemodel.PaySecureSetPinResponse"
}
},
"PaySecureSetPinBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "pin set success",
"description" : "information"
}
}
},
"PSVerifyPinModel" : {
"type" : "object",
"required" : [ "client_id", "iv", "pan", "pin_block" ],
"properties" : {
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"pan" : {
"type" : "string",
"example" : "+AyrdXnhXhXb6qbV2L6d1F92YUc=",
"description" : "AES Encrypted PAN"
},
"pin_block" : {
"type" : "string",
"example" : "+AyrdXnhXhXb6qbV2L6d1F92YUc=",
"description" : "AES Encrypted pin Block"
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV) used while encryption"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for the card"
}
},
"description" : "This web service allows to verify pin for provided pan.\nclient should pass AES encrypted pin & pan to api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.paysecurecard.PSVerifyPinModel"
}
},
"PaySecurePinVerifyResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/PinVerifyHeader"
},
"body" : {
"$ref" : "#/definitions/PinVerifyBody"
}
},
"description" : "This model contains the response details of paysecure pin verify api",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.paysecureresponsemodel.PaySecurePinVerifyResponse"
}
},
"PinVerifyBody" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"example" : "pin Verified",
"description" : "short information"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 894394434,
"description" : "public token"
}
}
},
"PinVerifyHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PsPanToToken" : {
"type" : "object",
"required" : [ "client_id", "cvv2", "expiry", "iv", "pan" ],
"properties" : {
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"pan" : {
"type" : "string",
"example" : "+AyrdXnhXhXb6qbV2L6d1F92YNj=",
"description" : "AES Encrypted PAN"
},
"cvv2" : {
"type" : "string",
"example" : "+NyuNUEimdODnelI6qbV2L6d1F92YUc=",
"description" : "AES Encrypted Cvv2"
},
"expiry" : {
"type" : "string",
"example" : "+RyrdXnhXhXb6qbV2L6d1F92Y7l=",
"description" : "AES Encrypted Expiry"
},
"iv" : {
"type" : "string",
"example" : "Xb6qbV2L6d1F92YU",
"description" : "16 bits initialization vector (IV) used while encryption"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.paysecurecard.PsPanToToken"
}
},
"PaySecurePanToTokenResponse" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/PaySecurePanToTokenResponseHeader"
},
"body" : {
"$ref" : "#/definitions/PaySecurePanToTokenResponseBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.apiresponsemodel.paysecureresponsemodel.PaySecurePanToTokenResponse"
}
},
"PaySecurePanToTokenResponseHeader" : {
"type" : "object",
"properties" : {
"error_id" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "error id"
},
"error_desc" : {
"type" : "string",
"example" : "success",
"description" : "error message"
}
}
},
"PaySecurePanToTokenResponseBody" : {
"type" : "object",
"properties" : {
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 9845739047,
"description" : "public token back"
}
}
},
"LoadAlertEditModel" : {
"type" : "object",
"required" : [ "action_id", "action_name", "api_call_unique_identifier", "body", "client_id", "rule_id", "sub", "to", "type" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"example" : 366,
"description" : "Id of rule in which we want to add decline action.Rule Id is returned when creating rule.",
"minimum" : 1
},
"action_name" : {
"type" : "string",
"example" : "decline",
"description" : "<p>This is just a name given to decline action</p></br>Eg.Decline for decline action.</br>Alert for Alert action",
"minLength" : 0,
"maxLength" : 30,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"action_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Alert action Id that is to be updated"
},
"sub" : {
"type" : "string",
"example" : "sub",
"description" : "Subject",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"body" : {
"type" : "string",
"example" : "test message",
"description" : ",message container",
"minLength" : 0,
"maxLength" : 200,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"type" : {
"type" : "string",
"example" : "2",
"description" : "<p>action Type Values of type can be :\"1\" or \"2\" or \"1,2\".</p>\n<ul>\n<li class=\"docBullet\" >\"1\"-–indicate sending alert through sms</li>\n<li class=\"docBullet\" >\"2\" --indicates sending alert through email</li>\n<li class=\"docBullet\" >\"1,2\" --indicates sending alert through both email and sms</li><ul>"
},
"to" : {
"type" : "string",
"example" : "me",
"description" : "<p>Recepient :Value of to can be :</p>\n<ul>\n<li class=\"docBullet\" >me</li>\n<li class=\"docBullet\" >cardholder</li>\n<li class=\"docBullet\" >parent_account_owner</li>\n<li class=\"docBullet\" >cust_service_1</li>\n<li class=\"docBullet\" >aml_team</li>\n<li class=\"docBullet\" >custom</li>\n</ul>",
"minLength" : 0,
"maxLength" : 150,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"phone" : {
"type" : "string",
"example" : "9845665455",
"description" : "<p>Phone Number mandatory when type is one of the following:</p>\n <ul>\n<li>type==\"1\"</li>\n<li>type=\"1,2\"</li>\n</ul>\n",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>'\"/;,`%]*$"
},
"email" : {
"type" : "string",
"example" : "Test@paymentology.com",
"description" : "<p>Email Id mandatory when type is one of the following:</p>\n<ul>\n<li>type==\"2\"</li>\n <li>type==\"1,2\"</li>\n</ul>",
"minLength" : 0,
"maxLength" : 200
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.action.LoadAlertEditModel"
}
},
"CreateBasicRuleModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "group_id", "limit_type", "limit_value", "scope" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1267,
"description" : "Group id"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token. Required when scope=C"
},
"scope" : {
"type" : "string",
"example" : "G",
"description" : "Rule applicable scope. Values of scope can be : <ul><li class=\"docBullet\">C = Direct card rules</li><li class=\"docBullet\">G = Group rules</li></ul>",
"pattern" : "^[GC]{1}$"
},
"limit_type" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Limit type values are configurable by client.",
"minimum" : 1
},
"limit_value" : {
"type" : "string",
"example" : "(5,0,10)",
"description" : "<p>Limit Value. Format depends on scope value.</p><ul><li class=\"docBullet\">When scope is 'C' : Decimal number example \"5\".</li><li class=\"docBullet\">When scope is 'G' : Limit value with default limit, minimum limit and maximum limit \"(default,min,max)\" like \"(5,0,10)\" where 5 is default value 0 is minimum limit and 10 is maximum limit</li></ul>"
}
},
"description" : "This web service allows to set Limits for restricting ATM and ECOM transactions",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.CreateBasicRuleModel"
}
},
"CreateRuleResponseModelBody" : {
"type" : "object",
"properties" : {
"rule_id" : {
"type" : "integer",
"format" : "int64",
"example" : 103,
"description" : "Rule Id"
}
}
},
"CreateRuleResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeader"
},
"body" : {
"$ref" : "#/definitions/CreateRuleResponseModelBody"
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.responsemodel.CreateRuleResponseModel"
}
},
"FinancialRuleModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "limit_type", "scope" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"amount_limit" : {
"type" : "number",
"example" : 1000.0,
"description" : "Amount limit for daily /weekly /monthly /yearly cash limit\n Required when limit_type is 1-32"
},
"txn_amount_limit" : {
"type" : "number",
"example" : 500.0,
"description" : "Per transaction amount limit can be set when limit_type is 1-32"
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1267,
"description" : "Group Id \nRequired when scope=G"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token of card. Required when scope=C"
},
"scope" : {
"type" : "string",
"example" : "G",
"description" : "Rule applicable scope. Values of scope can be : <ul><li class=\"docBullet\">C=Direct card rules (These rules are held at individual card level and therefore can be personalized per card holder.)</li><li class=\"docBullet\">G=Group rules (These rules are more generic to card program and typically used to set upper limit controls.)</li></ul>",
"pattern" : "^[GC]{1}$"
},
"limit_type" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "<p>Limit type can be:</p>\n<ul>\n<li class=\"docBullet\">1-Daily ATM Cash Limit</li>\n<li class=\"docBullet\">2-Weekly ATM Cash Limit</li>\n<li class=\"docBullet\">3-Monthly ATM Cash Limit</li>\n<li class=\"docBullet\">4-Yearly ATM Cash Limit</li>\n<li class=\"docBullet\">5-Daily ECOM Limit</li>\n<li class=\"docBullet\">6-Weekly ECOM Limit</li>\n<li class=\"docBullet\">7-Monthly ECOM Limit</li>\n<li class=\"docBullet\">8-Yearly ECOM Limit</li>\n<li class=\"docBullet\">9-Daily ATM Txn Count</li>\n<li class=\"docBullet\">10-Daily POS Txn Count</li>\n<li class=\"docBullet\">11-Daily ECOM Txn Count</li>\n<li class=\"docBullet\">12-Daily MOTO Txn Count</li>\n<li class=\"docBullet\">13-Weekly ATM Txn Count</li>\n<li class=\"docBullet\">14-Weekly ATM POS Count</li>\n<li class=\"docBullet\">15-Weekly ECOM Txn Count</li>\n<li class=\"docBullet\">16-Weekly MOTO Txn Count</li>\n<li class=\"docBullet\">17-Monthly ATM Txn Count</li>\n<li class=\"docBullet\">18-Monthly POS Txn Count</li>\n<li class=\"docBullet\">19-Monthly ECOM Txn Count</li>\n<li class=\"docBullet\">20-Monthly MOTO Txn Count</li>\n<li class=\"docBullet\">21-Yearly ATM Txn Count</li>\n<li class=\"docBullet\">22-Yearly POS Txn Count</li>\n<li class=\"docBullet\">23-Yearly ECOM Txn Count</li>\n<li class=\"docBullet\">24-Yearly MOTO Txn Count</li>\n<li class=\"docBullet\">25-Daily POS Limit</li>\n<li class=\"docBullet\">26-Weekly POS Limit</li>\n<li class=\"docBullet\">27-Monthly POS Limit</li>\n<li class=\"docBullet\">28-Yearly POS Limit</li>\n<li class=\"docBullet\">29-Daily MOTO Limit</li>\n<li class=\"docBullet\">30-Weekly MOTO Limit</li>\n<li class=\"docBullet\">31-Monthly MOTO Limit</li>\n<li class=\"docBullet\">32-Yearly MOTO Limit</li>\n<li class=\"docBullet\">33-LifeTime Card Limit(ATM+POS) transactions</li>\n</ul>",
"minimum" : 1,
"maximum" : 33
},
"txn_count" : {
"type" : "integer",
"format" : "int32",
"example" : 500,
"description" : "Number of transaction allowed for daily /weekly /monthly /yearly transaction.\n\n Required when limit_type is 9-12 or 21-24"
},
"action_decline" : {
"type" : "string",
"example" : "61",
"description" : "Decline action,de39 response code <ul> <li class=\"docBullet\">57 = Txn not permitted</li> <li class=\"docBullet\">03 = Invalid merchant</li> <li class=\"docBullet\">04 = Capture card</li> <li class=\"docBullet\">05 = Do not honour</li> <li class=\"docBullet\">12 = Invalid txn</li> <li class=\"docBullet\">13 = Invalid amt</li> <li class=\"docBullet\">14 = Invalid card no</li> <li class=\"docBullet\">30 = Format error</li> <li class=\"docBullet\">41 = Lost card</li> <li class=\"docBullet\">43 = Stolen card</li> <li class=\"docBullet\">51 = Insufficient funds</li> <li class=\"docBullet\">54 = Expired card</li> <li class=\"docBullet\">55 = Invalid pin</li> <li class=\"docBullet\">57 = Txn not allowed</li> <li class=\"docBullet\">58 = Invalid txn/terminal</li> <li class=\"docBullet\">61 = Exceed cash limit</li> <li class=\"docBullet\">62 = Restricted card</li> <li class=\"docBullet\">63 = Security violation</li> <li class=\"docBullet\">71 = Pin not changed</li> <li class=\"docBullet\">75 = Pin tries exceeded</li> <li class=\"docBullet\">88 = crypto Fail</li> <li class=\"docBullet\">96 = System error</li> <li class=\"docBullet\">70 = Contact card issuer</li> </ul>",
"minLength" : 2,
"maxLength" : 2,
"pattern" : "^57$|^03$|^04$|^05$|^12$|^13$|^14$|^30$|^41$|^43$|^51$|^54$|^55$|^57$|^58$|^61$|^62$|^63$|^71$|^75$|^88$|^96$|^70$"
}
},
"description" : "This web service allows to set limits for restricting ATM and ECOM transactions \n limit type can be:\n1-Daily ATM Cash Limit\n2-Weekly ATM Cash Limit\n3-Monthly ATM Cash Limit\n4-Yearly ATM Cash Limit\n5-Daily ECOM Limit\n6-Weekly ECOM Limit\n7-Monthly ECOM Limit\n8-Yearly ECOM Limit\n9-Daily ATM Txn Count\n10-Daily POS Txn Count\n11-Daily ECOM Txn Count\n12-Daily MOTO Txn Count",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.FinancialRuleModel"
}
},
"CreateRulesModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "parameters", "rule_desc", "rule_name", "rule_type", "scope", "severity" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"rule_name" : {
"type" : "string",
"example" : "Fraud Rule",
"description" : "Rule name",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;`%]*$"
},
"scope" : {
"type" : "string",
"example" : "G",
"description" : "Rule applicable scope. Values of scope can be : <ul><li class=\"docBullet\">C=Direct card rules (These rules are held at individual card level and therefore can be personalized per card holder.)</li><li class=\"docBullet\">G=Group rules (These rules are more generic to card program and typically used to set upper limit controls.)</li></ul>",
"pattern" : "^[GC]{1}$"
},
"rule_type" : {
"type" : "string",
"example" : "Au",
"description" : "Rule Type : <ul><li class=\"docBullet\">Au = Authorisation</li><li class=\"docBullet\">Se = Settlement</li><li class=\"docBullet\">Sc = Scheduled</li><li class=\"docBullet\">Lo = Load</li><li class=\"docBullet\">Un = Unload</li><li class=\"docBullet\">Ot = Others</li><li class=\"docBullet\">Da = Deactivated</li></ul>",
"minLength" : 2,
"maxLength" : 2
},
"severity" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Severity evel. It can be 0(lowest)-10(highest) ",
"minimum" : 0,
"maximum" : 10
},
"rule_desc" : {
"type" : "string",
"example" : "Fraud Rule Description",
"description" : "Rule description. Description should specific and should describe rule in a concise manner.",
"minLength" : 0,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"parameters" : {
"type" : "string",
"example" : "MCC:6011,4444,1234,5543;TXN_CCY:826,400;CTRY:GBR,USA",
"description" : "Parameters for rules.<ul><li class=\"docBullet\">format of parameter is TAG:VALUE </li><li class=\"docBullet\">parameter can be combination of multiple TAG:VALUE separated by semicolon(;) </li><li class=\"docBullet\">VALUE can contain comma(,) separated multiple values </li><li class=\"docBullet\">Accepted TAGS are MCC,TXN_CCY,CTRY</li><li class=\"docBullet\">TXN_CCY=> transaction Currency DE49. (Three digit Numeric ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)</li> <li class=\"docBullet\">MCC=> Merchant category code DE18.</li><li class=\"docBullet\">CTRY=> Country (DE43_5). <ul><li>For Master card (Alpha Three country ISO codes. i.e. : Afghanistan → AFG, Australia → AUS) </li><li>For VISA (Alpha Two country ISO codes . i.e. : Afghanistan → AF, Australia → AU) </li><li>For Both (MC & VISA) :(Comma separated Alpha Three country ISO codes & Alpha Two country ISO codes i.e Afghanistan-> AFG,AF , Australia → AUS,AU )</li> </ul> </li></ul>"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "Public token for card. Required in case of scope 'C'"
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1267,
"description" : "Group Id. Required in case of scope 'G'"
},
"suitable_for_estimate" : {
"type" : "boolean",
"example" : false,
"description" : " <ul><li class=\"docBullet\">True = Rule is for limit check like (amount limit or transaction count limit)</li><li class=\"docBullet\">False =Rule is not for limit check like (amount limit or transaction count limit)</li></ul>"
},
"action_decline" : {
"type" : "string",
"example" : "05",
"description" : "Decline action,de39 response code <ul> <li class=\"docBullet\">57 = Txn not permitted</li> <li class=\"docBullet\">03 = Invalid merchant</li> <li class=\"docBullet\">04 = Capture card</li> <li class=\"docBullet\">05 = Do not honour</li> <li class=\"docBullet\">12 = Invalid txn</li> <li class=\"docBullet\">13 = Invalid amt</li> <li class=\"docBullet\">14 = Invalid card no</li> <li class=\"docBullet\">30 = Format Error</li> <li class=\"docBullet\">41 = Lost card</li> <li class=\"docBullet\">43 = Stolen card</li> <li class=\"docBullet\">51 = Insufficient Funds</li> <li class=\"docBullet\">54 = Expired card</li> <li class=\"docBullet\">55 = Invalid pin</li> <li class=\"docBullet\">57 = Txn not allowed</li> <li class=\"docBullet\">58 = Invalid txn/terminal</li> <li class=\"docBullet\">61 = Exceed Cash Limit</li> <li class=\"docBullet\">62 = Restricted card</li> <li class=\"docBullet\">63 = Security violation</li> <li class=\"docBullet\">71 = pin not changed</li> <li class=\"docBullet\">75 = Pin tries exceeded</li> <li class=\"docBullet\">88 = crypto Fail</li> <li class=\"docBullet\">96 = System error</li> <li class=\"docBullet\">70 = Contact card issuer</li> </ul>",
"minLength" : 2,
"maxLength" : 2,
"pattern" : "^57$|^03$|^04$|^05$|^12$|^13$|^14$|^30$|^41$|^43$|^51$|^54$|^55$|^57$|^58$|^61$|^62$|^63$|^71$|^75$|^88$|^96$|^70$"
}
},
"description" : "This web service allows to create different types of rules",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.CreateRulesModel"
}
},
"EnableDisableRulesModel" : {
"type" : "object",
"required" : [ "action", "api_call_unique_identifier", "client_id", "date_to", "rule_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"action" : {
"type" : "integer",
"format" : "int32",
"example" : 1,
"description" : "Indicate the type of action for link and unlink the rule \n 1--indicates Unlink Rule\n 2--indicates Link Rule",
"minimum" : 1
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "public token for card",
"minimum" : 1
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"example" : 365,
"description" : "Rule Id to Link/Unlink From card",
"minimum" : 1
},
"date_to" : {
"type" : "string",
"example" : "2022-07-05 13:59:13",
"description" : "Till Date To the Rule will not trigger",
"pattern" : "\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}:\\d{2}"
}
},
"description" : "This web service allows to link and unlink rule from card",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.EnableDisableRulesModel"
}
},
"EditRulesModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "parameters", "rule_id" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"rule_name" : {
"type" : "string",
"example" : "Fraud Rule",
"description" : "Rule Name",
"minLength" : 0,
"maxLength" : 100,
"pattern" : "^[^<>/;`%]*$"
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"example" : 87,
"description" : "Rule Id",
"minimum" : 1
},
"rule_type" : {
"type" : "string",
"example" : "Au",
"description" : "Rule Type : <ul><li class=\"docBullet\">Au = authorisation</li><li class=\"docBullet\">Se = Settlement</li><li class=\"docBullet\">Sc = Scheduled</li><li class=\"docBullet\">Lo = Load</li><li class=\"docBullet\">Un = Unload</li><li class=\"docBullet\">Ot = Others</li><li class=\"docBullet\">Da = Deactivated</li></ul>",
"minLength" : 2,
"maxLength" : 2
},
"severity" : {
"type" : "integer",
"format" : "int32",
"example" : 0,
"description" : "Severity Level. It can be 0(lowest)-10(highest) ",
"minimum" : 0,
"maximum" : 10
},
"rule_desc" : {
"type" : "string",
"example" : "Fraud Rule Description",
"description" : "Rule Description",
"minLength" : 0,
"maxLength" : 1000,
"pattern" : "^[^<>/;`%]*$"
},
"parameters" : {
"type" : "string",
"example" : "MCC:6011,4444,1234,5543;TXN_CCY:826,400;CTRY:GBR,USA",
"description" : "Parameters for rules.<ul><li class=\"docBullet\">format of parameter is TAG:VALUE </li><li class=\"docBullet\">parameter can be combination of multiple TAG:VALUE separated by semicolon(;) </li><li class=\"docBullet\">VALUE can contain comma(,) separated multiple values </li><li class=\"docBullet\">Accepted TAGS are MCC,TXN_CCY,CTRY</li><li class=\"docBullet\">TXN_CCY=> transaction Currency DE49. (Three digit Numeric ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)</li> <li class=\"docBullet\">MCC=> Merchant category code DE18.</li><li class=\"docBullet\">CTRY=> Country (DE43_5). <ul><li>For Master card (Alpha Three country ISO codes. i.e. : Afghanistan → AFG, Australia → AUS) </li><li>For VISA (Alpha Two country ISO codes . i.e. : Afghanistan → AF, Australia → AU) </li><li>For Both (MC & VISA) :(Comma separated Alpha Three country ISO codes & Alpha Two country ISO codes i.e Afghanistan-> AFG,AF , Australia → AUS,AU )</li> </ul> </li></ul>"
},
"suitable_for_estimate" : {
"type" : "boolean",
"example" : false,
"description" : " <ul><li class=\"docBullet\">True = Rule is for limit check like (amount limit or transaction count limit)</li><li class=\"docBullet\">False =Rule is not for limit check like (amount limit or transaction count limit)</li></ul>"
}
},
"description" : "This web service allows to edit different types of rules",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.EditRulesModel"
}
},
"ManageRuleGroupModel" : {
"type" : "object",
"required" : [ "action", "api_call_unique_identifier", "client_id", "token" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "public token for card",
"minimum" : 1
},
"action" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "<p>action can be</p>\n<ul>\n<li class=\"docBullet\">1==&gt;View</li>\n<li class=\"docBullet\">2==&gt;Link</li>\n<li class=\"docBullet\">3==&gt;UnLink</li>\n<li class=\"docBullet\">4==&gt;Link Overriding Previous List</li>\n</ul>",
"minimum" : 1,
"maximum" : 4
},
"groups" : {
"type" : "string",
"example" : "1267",
"description" : "comma separated group Id's. We can get group Id from <a class=\"external-link\" href=\"#operation/pws_group_list\"> list group</a> ",
"pattern" : "^\\d+(,\\d+)*$"
}
},
"description" : "This web service allows to Link/unlink/view groups for a card.",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.group.ManageRuleGroupModel"
}
},
"ManageRuleGroupResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeader"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ManageRuleGroupResponseModelBody"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.responsemodel.ManageRuleGroupResponseModel"
}
},
"ManageRuleGroupResponseModelBody" : {
"type" : "object",
"properties" : {
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 103,
"description" : "group Id"
},
"group_desc" : {
"type" : "string",
"example" : "Container For Fraud rules ",
"description" : "group Description"
},
"group_name" : {
"type" : "string",
"example" : "Test group",
"description" : "group Name"
}
}
},
"ListRulesModel" : {
"type" : "object",
"required" : [ "api_call_unique_identifier", "client_id", "mode" ],
"properties" : {
"api_call_unique_identifier" : {
"type" : "string",
"example" : "438574845790657485",
"description" : "Unique number that must be passed at each API request. Identifier to make each API request unique",
"minLength" : 1,
"maxLength" : 40
},
"client_id" : {
"type" : "integer",
"format" : "int32",
"example" : 760131,
"description" : "Unique identifier for the client which Paymentology will provide at outset",
"minimum" : 1
},
"user_id" : {
"type" : "string",
"example" : "760131",
"description" : "User Id of the Customer who triggered the API request.",
"minLength" : 0,
"maxLength" : 50
},
"remarks" : {
"type" : "string",
"example" : "Creating card For Customer",
"description" : "Remarks for API request",
"minLength" : 0,
"maxLength" : 200
},
"rule_id" : {
"type" : "integer",
"format" : "int64",
"example" : 366,
"description" : "Rule Id. If you pass rule id , single rule will be retrieved. if mode==4, rule_id is mandatory"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 311012081,
"description" : "public token for card. getting rule linked with specific token. if mode==1, token is mandatory"
},
"group_id" : {
"type" : "integer",
"format" : "int32",
"example" : 1267,
"description" : "group Id. rules under given group id. if mode==2 ,group_id is mandatory"
},
"ac_id" : {
"type" : "integer",
"format" : "int32",
"example" : 479823917,
"description" : "account Id. Get All rules for Cards under linked to this Parent account. if mode==3, ac_id is mandatory"
},
"mode" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "<p>Getting list based on mode value. mode can be</p><ul><li class=\"docBullet\">1=token (token mandatory in this mode)</li><li class=\"docBullet\">2=group_id (group_id mandatory in this mode)</li><li class=\"docBullet\">3=ac_id (ac_id mandatory in this mode)</li><li class=\"docBullet\">4=rule_id (rule_id mandatory in this mode)</li></ul>",
"minimum" : 1,
"maximum" : 4
}
},
"description" : "This web service allows to list different rule",
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.ListRulesModel"
}
},
"ListRulesResponseModelBody" : {
"type" : "object",
"required" : [ "scope" ],
"properties" : {
"rule_id" : {
"type" : "integer",
"format" : "int32",
"example" : 153,
"description" : "Rule Id"
},
"rule_desc" : {
"type" : "string",
"example" : "Daily MOTO Txn Count",
"description" : "Rule Description",
"minLength" : 0,
"maxLength" : 1000
},
"rule_name" : {
"type" : "string",
"example" : "Daily MOTO Txn Count",
"description" : "Rule Name",
"minLength" : 0,
"maxLength" : 100
},
"max_value" : {
"type" : "number",
"example" : 5000.0,
"description" : "Max limiting amount"
},
"ac_id" : {
"type" : "integer",
"format" : "int64",
"example" : 749153081,
"description" : "account Id"
},
"token" : {
"type" : "integer",
"format" : "int64",
"example" : 336869349,
"description" : "Public Token"
},
"rule_status" : {
"type" : "string",
"example" : "enabled",
"description" : "Rule Status. Rule is enabled or disabled for token"
},
"value" : {
"type" : "number",
"example" : 500.0,
"description" : "Limit Value for Daily/Weekly/Monthly/Yearly Cash Limit/Txn Count."
},
"remaining_value" : {
"type" : "number",
"example" : 50.0,
"description" : "Remaining Value for Daily/Weekly/Monthly/Yearly Cash Limit/Txn Count."
},
"remaining_count" : {
"type" : "number",
"example" : 50.0,
"description" : "Remaining Count for Number of transaction allowed for Daily /Weekly /Monthly / Yearly count"
},
"txn_limit_amount" : {
"type" : "number",
"example" : 100.0,
"description" : "Per transaction Limit Amount"
},
"scope" : {
"type" : "string",
"example" : "G",
"description" : "Rule Applicable Scope. Values of scope can be : <ul><li class=\"docBullet\">C=DIRECT card rules</li><li class=\"docBullet\">G=group rules</li></ul>"
}
}
},
"ListRulesResponseModel" : {
"type" : "object",
"properties" : {
"header" : {
"$ref" : "#/definitions/ResponseHeader"
},
"body" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ListRulesResponseModelBody"
}
}
},
"x-className" : {
"type" : "string",
"format" : "com.paymentology.payapi.v1.model.rules.responsemodel.ListRulesResponseModel"
}
},
"AccountLimitModel" : {
"type" : "object",
"required" : [ "ac_id", "a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment