Advance PreCalc

SecurityBearer

Request

path Parameters

account_guid required	string <uuid>
version required	string

Request Body schema: application/json

payment_date	string <date-time> Payment Date
amount	number <double> Amount of pre-calculated advance funds
cycle	string (AdvanceCycleType) Enum: "BIWEEKLY" "SEMIMONTHLY" "MONTHLY"

Responses

201

Returns the Advance PreCalc Details

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

get/api/{version}/advances/{account_guid}/precalc

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"payment_date": "2019-08-24T14:15:22Z",
"amount": 0.1,
"cycle": "BIWEEKLY"
}

Response samples

application/json

{"request_id": "string",
"disbursement_amount_requested": 0.1,
"disbursement_fee_requested": 0.1,
"advance_account_details": {"account": {"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
"start_date": "2019-08-24T14:15:22Z",
"limit": 0.1,
"outstanding_balance": 0.1,
"credit_product": "string",
"cycle": "string",
"status": "string",
"payment_summary": {"outstanding_principal": 0.1,
"disbursement_amount": 0.1,
"processing_fees": 0.1,
"carriedbalance_fees": 0.1,
"total_repayment": 0.1,
"number_of_payments": 0
},
"payment_schedule": [{"mob": 0,
"date": "2019-08-24T14:15:22Z",
"disbursement_principal": 0.1,
"disbursement_fee": 0.1,
"total": 0.1,
"fee": 0.1,
"principal": 0.1,
"balance": 0.1,
"paid_principal": 0.1,
"paid_interest": 0.1,
"available_balance": 0.1,
"cycle": "string",
"type": "string",
"status": "string"
}
],
"available_date_range": [{"name": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}
}
}