Voucher Route

The VoucherRoute object is a master record of a disbursement. It contains all the information and parameters that are set during the process.

Response

Parameters

Field	Type	Description
`TID`	Integer	The Transaction ID (TID) of the payment transaction.
`ReverseTID`	Integer	The TID of the refund transaction.
`UIDx`	Integer	The unique internal identifier for this disbursement.
`DisbursementID`	String	The unique ID from the `/disburse/initiate` call.
`Name`	String	The descriptive name provided for this disbursement batch.
`Status`	String	The initial status of the disbursement process.
`Username`	String	The username of the funder.
`ExpectedTotal`	Integer	The total amount in cents to be disbursed.
`FeesTotal`	Integer	The total fees in cents for the disbursement.
`RollbackTotal`	Integer	The total amount in cents that was rolled back.
`RollbackFeesTotal`	Integer	The total fees in cents that were refunded.
`CostPerManualVoucher`	Integer	The cost per voucher when generating a list of voucher numbers.
`CostPerUserVoucher`	Integer	The cost per voucher when issuing vouchers to end-users.
`VoucherCount`	Integer	The number of vouchers to be created.
`ScheduledTime`	String	The time that the funds were released (UTC).
`ShouldNotify`	Boolean	Indicates if the recipients were notified upon confirmation.
`IsSingleUse`	Boolean	Indicates if the created vouchers are single-use.
`ShowVouchers`	Boolean	Indicates if fees were calculated based on manual voucher cost.
`CheckIDCellMatch`	Boolean	Indicates if MSISDN and ID number validation was enforced.
`URL`	String	The core platform that will handle the transaction of this voucher.
`Community`	String	The community in which the disbursement is being run.

Example Body

{
    "TID": "14966718673",
    "ReverseTID": "14969058673",
    "UIDx": 637,
    "DisbursementID": "7bcddfd9-5b87-4d61-adb7-16f2c0cb32c1",
    "Name": "Disbursement Test #1",
    "Status": "Reversed",
    "Username": "FunderDemo",
    "ExpectedTotal": 208006280,
    "FeesTotal": 99960,
    "RollbackTotal": 208006280,
    "RollbackFeesTotal": 99960,
    "CostPerManualVoucher": 100,
    "CostPerUserVoucher": 10,
    "VoucherCount": 9996,
    "ScheduledTime": "2025/11/06 13:52",
    "ShouldNotify": false,
    "IsSingleUse": true,
    "ShowVouchers": false,
    "CheckIDCellMatch": true,
    "URL": "https://dev1celbux.appspot.com/FAPI?cmd=wbin",
    "Community": "fundingco"
}