Version 3 vs 4
Version 3 vs 4
Content Changes
Content Changes
==== API Documentation ====
Bellow is description for each API Commands. Bear in mind that for each API command these required parameters must be provided:
<table>
<tr>
<th>Param Name</th><th>Type</th><th>Description</th>
</tr>
<tr>
<td>command</td><td>string</td><td>The command that needs to be executed</td>
</tr>
<tr>
<td>password</td><td>string</td><td>Client's password</td>
</tr>
<tr>
<td>token</td><td>string</td><td>Client's token</td>
</tr>
<tr>
<td>data</td><td>array</td><td>Depending of command may be optional field. Associative array of options supported by request command</td>
</tr>
</table>
Also each API Command will return these fields (along with result):
<table>
<tr>
<th>Param Name</th><th>Type</th><th>Description</th>
</tr>
<tr>
<td>code</td><td>int</td><td>Payment Code result of executed command</td>
</tr>
<tr>
<td>status</td><td>string</td><td>Text description of returned Payment Code</td>
</tr>
<tr>
<td>command</td><td>string</td><td>Executed Command</td>
</tr>
<tr>
<td>result</td><td>mixed</td><td>Result of executed command. See command api docs for details</td>
</tr>
<tr>
<td>request</td><td>mixed</td><td>Input params as received from request (useful for debugging purposes)</td>
</tr>
<tr>
<td>ts</td><td>string</td><td>Request Timestamp</td>
</tr>
<tr>
<td>origin_ip</td><td>string</td><td>IP Address from which request was sent</td>
</tr>
<tr>
<td>debug</td><td>string</td><td>Internal PV2 debugg stuff, always null on production environment</td>
</tr>
<tr>
<td>errors</td><td>array</td><td>Errors (if any)</td>
</tr>
</table>
==== List of API Commands ====
List is available in document hierarchy section below.
==== API Documentation ====
Bellow is description for each API Commands. Bear in mind that for each API command these required parameters must be provided:
<table>
<tr>
<th>Param Name</th><th>Type</th><th>Description</th>
</tr>
<tr>
<td>cmd</td><td>string</td><td>The command that needs to be executed</td>
</tr>
<tr>
<td>password</td><td>string</td><td>Client's password</td>
</tr>
<tr>
<td>token</td><td>string</td><td>Client's token</td>
</tr>
<tr>
<td>data</td><td>array</td><td>Depending of command may be optional field. Associative array of options supported by request command</td>
</tr>
</table>
Also each API Command will return these fields (along with result):
<table>
<tr>
<th>Param Name</th><th>Type</th><th>Description</th>
</tr>
<tr>
<td>code</td><td>int</td><td>Payment Code result of executed command</td>
</tr>
<tr>
<td>status</td><td>string</td><td>Text description of returned Payment Code</td>
</tr>
<tr>
<td>command</td><td>string</td><td>Executed Command</td>
</tr>
<tr>
<td>result</td><td>mixed</td><td>Result of executed command. See command api docs for details</td>
</tr>
<tr>
<td>request</td><td>mixed</td><td>Input params as received from request (useful for debugging purposes)</td>
</tr>
<tr>
<td>ts</td><td>string</td><td>Request Timestamp</td>
</tr>
<tr>
<td>origin_ip</td><td>string</td><td>IP Address from which request was sent</td>
</tr>
<tr>
<td>debug</td><td>string</td><td>Internal PV2 debugg stuff, always null on production environment</td>
</tr>
<tr>
<td>errors</td><td>array</td><td>Errors (if any)</td>
</tr>
</table>
==== List of API Commands ====
List is available in document hierarchy section below.
==== API Documentation ====
Bellow is description for each API Commands. Bear in mind that for each API command these required parameters must be provided:
<table>
<tr>
<th>Param Name</th><th>Type</th><th>Description</th>
</tr>
<tr>
<td>commanmd</td><td>string</td><td>The command that needs to be executed</td>
</tr>
<tr>
<td>password</td><td>string</td><td>Client's password</td>
</tr>
<tr>
<td>token</td><td>string</td><td>Client's token</td>
</tr>
<tr>
<td>data</td><td>array</td><td>Depending of command may be optional field. Associative array of options supported by request command</td>
</tr>
</table>
Also each API Command will return these fields (along with result):
<table>
<tr>
<th>Param Name</th><th>Type</th><th>Description</th>
</tr>
<tr>
<td>code</td><td>int</td><td>Payment Code result of executed command</td>
</tr>
<tr>
<td>status</td><td>string</td><td>Text description of returned Payment Code</td>
</tr>
<tr>
<td>command</td><td>string</td><td>Executed Command</td>
</tr>
<tr>
<td>result</td><td>mixed</td><td>Result of executed command. See command api docs for details</td>
</tr>
<tr>
<td>request</td><td>mixed</td><td>Input params as received from request (useful for debugging purposes)</td>
</tr>
<tr>
<td>ts</td><td>string</td><td>Request Timestamp</td>
</tr>
<tr>
<td>origin_ip</td><td>string</td><td>IP Address from which request was sent</td>
</tr>
<tr>
<td>debug</td><td>string</td><td>Internal PV2 debugg stuff, always null on production environment</td>
</tr>
<tr>
<td>errors</td><td>array</td><td>Errors (if any)</td>
</tr>
</table>
==== List of API Commands ====
List is available in document hierarchy section below.