Residuals
| Fields | Description | Type | Filterable | Required | Readonly |
|---|---|---|---|---|---|
| id | Unique ID of the residual agent | Integer | No | No | Yes |
| mid | The merchant identification number | Integer | Yes | No | Yes |
| date | Date and time when the residual was processed | Datetime | Yes | No | Yes |
| acquirer | Acquirer Object | Object | No | No | Yes |
| acquirer.id | ID of the acquirer bank | Integer | No | No | Yes |
| merchant | Merchant Object | Object | No | No | Yes |
| merchant.id | Unique ID of the merchant | Integer | No | No | Yes |
| merchant.dba | Merchant DBA Object | Object | No | No | Yes |
| merchant.dba.id | DBA ID of the merchant | Integer | No | No | Yes |
| merchant.sales | Merchant Sales Object | Object | No | No | Yes |
| merchant.sales.count | The total merchant sales count | Integer | No | No | Yes |
| merchant.sales.amount | The total merchant sales amount | Decimal | No | No | Yes |
| user | User Object | Object | No | No | Yes |
| user.id | ID of the user | Integer | No | No | Yes |
| split | User split in percentage | Integer | No | No | Yes |
| revenue | User revenue | Decimal | No | No | Yes |
| expense | The expense of the user | Decimal | No | No | Yes |
| adjustment | Adjustment Object | Object | No | No | Yes |
| adjustment.amount | The total amount of adjusted funds | Decimal | No | No | Yes |
| adjustment.details | Array Of Adjustment Details Objects | Object | No | No | Yes |
| adjustment.details.amount | The amount of adjusted funds | Decimal | No | No | Yes |
| adjustment.details.category | The category of adjusted funds | String | No | No | Yes |
| adjustment.details.note | Note for the adjustment | String | No | No | Yes |
| profit | The profit of the user | Decimal | No | No | Yes |
| publishedOn | Date and time when the agent residual was published | Datetime | No | No | Yes |
| held | Held Object | Object | No | No | Yes |
| held.on | Date and time when the agent residual was held | Datetime | No | No | Yes |
| held.note | Note for the held | String | No | No | Yes |
| held.releasedOn | Date and time when the agent residual was released | Datetime | No | No | Yes |
| residual | Residual Object | Object | No | No | Yes |
| residual.id | Unique ID of the residual | Integer | No | No | Yes |
| subAgent | Subagent Object | Object | No | No | Yes |
| subAgent.user | Subagent User Object | Object | No | No | Yes |
| subAgent.user.id | ID of the subagent user | Integer | No | No | Yes |
| subAgent.revenue | The revenue of the subagent | Decimal | No | No | Yes |
| subAgent.expense | The expense of the subagent | Decimal | No | No | Yes |
| subAgent.profit | The profit of the subagent | Decimal | No | No | Yes |
| subAgent.publishedOn | Date and time when the subagent residual was published | Datetime | No | No | Yes |
| subAgent.held | Subagent Held Object | Object | No | No | Yes |
| subAgent.held.on | Date and time when the subagent residual was held | Datetime | No | No | Yes |
| subAgent.note | Note for the held | String | No | No | Yes |
| subAgent.releasedOn | Date and time when the subagent residual was held | Datetime | No | No | Yes |
Modified at 2025-08-09 05:39:42