Calculate the estimated payment timing given the deduction date, payment source, and disbursement method. Can be used to calculate timing for a payment.
Request
This endpoint expects an object.
paymentSourceIdstringRequired
ID of payment source.
paymentDestinationIdstringRequired
ID of payment destination.
estimatedDeductionDatedatetimeOptional
Date the payment is scheduled to be deducted from the payer's account. Use this field if the payment has not yet been deducted.
processedAtdatetimeOptional
Date the payment was processed. Use this field if the payment has already been deducted.
paymentDestinationOptionsobjectOptional
Options for the payment destination. Depending on the payment destination, this may include things such as check delivery method.
Response
This endpoint returns an object
estimatedProcessingDatedatetime
Estimated date the payment will be or was processed.
businessDaysinteger
Number of business days between the estimated processing date and the estimated settlement date. This does not take into account bank holidays or weekends.
estimatedProcessingTimeinteger
Estimated payment time in days. This time takes into account bank holidays and weekends.
estimatedSettlementDatedatetime
Estimated date the payment will be or was settled. This is the same as the request's deductionDate plus the paymentTiming.