v1
latestOpenAPI 3.1.02026-07-24170121.2 MBResiduals
Agent Residuals Details
This API provides Residual details for a specific merchant.
get/v1/agent_residual/details
Query parameters
bankinteger
<table>
<tr>
<td>
<strong>Description:</strong>
</td>
<td>Represents bank number.
</td>
</tr>
<tr>
<td><strong>Required:</strong></td>
<td>Yes</td>
</tr>
<tr>
<td><strong>Format:</strong></td>
<td>Numeric</td>
</tr>
<tr>
<td><strong>Example:</strong></td>
<td>1234</td>
</tr>
</table>
from_datestring
<table>
<tr>
<td>
<strong>Description:</strong>
</td>
<td>Residual start date.</td>
</tr>
<tr>
<td><strong>Required:</strong></td>
<td>Yes</td>
</tr>
<tr>
<td><strong>Format:</strong></td>
<td>Date: YYYY-MM-DD</td>
</tr>
<tr>
<td><strong>Example:</strong></td>
<td>2021-04-01</td>
</tr>
</table>
to_datestring
<table>
<tr>
<td>
<strong>Description:</strong>
</td>
<td>Residual end date.
</td>
</tr>
<tr>
<td><strong>Required:</strong></td>
<td>Yes</td>
</tr>
<tr>
<td><strong>Format:</strong></td>
<td>Date: YYYY-MM-DD</td>
</tr>
<tr>
<td><strong>Example:</strong></td>
<td>2021-04-30</td>
</tr>
</table>
midinteger
<table>
<tr>
<td>
<strong>Description:</strong>
</td>
<td>A unique number that represents a merchant.
</td>
</tr>
<tr>
<td><strong>Required:</strong></td>
<td>Optional</td>
</tr>
<tr>
<td><strong>Format:</strong></td>
<td>Numeric</td>
</tr>
<tr>
<td><strong>Example:</strong></td>
<td>0567000000000001</td>
</tr>
</table>
limitinteger
<table>
<tr>
<td>
<strong>Description:</strong>
</td>
<td>A number that represents number of <strong>'Agent Residual Details'</strong> per page.
</td>
</tr>
<tr>
<td><strong>Required:</strong></td>
<td>Optional</td>
</tr>
<tr>
<td><strong>Format:</strong></td>
<td>Numeric</td>
</tr>
<tr>
<td><strong>Default:</strong></td>
<td>25</td>
</tr>
<tr><td><strong>Example:</strong></td><td>25</td></tr>
</table>
Headers
Acceptstring
MUST be sent with every endpoint.
Content-Typestring
MUST be sent when passing Data (Post and Patch calls).
Response
OK
object required