Calculate

Calculate payment timing

POST
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.
paymentSourceId
stringRequired
ID of payment source.
paymentDestinationId
stringRequired
ID of payment destination.
estimatedDeductionDate
datetimeOptional
Date the payment is scheduled to be deducted from the payer's account. Use this field if the payment has not yet been deducted.
processedAt
datetimeOptional
Date the payment was processed. Use this field if the payment has already been deducted.
paymentDestinationOptions
unionOptional
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
estimatedProcessingDate
datetime
Estimated date the payment will be or was processed.
businessDays
integer
Number of business days between the estimated processing date and the estimated settlement date. This does not take into account bank holidays or weekends.
estimatedProcessingTime
integer
Estimated payment time in days. This time takes into account bank holidays and weekends.
estimatedSettlementDate
datetime
Estimated date the payment will be or was settled. This is the same as the request's deductionDate plus the paymentTiming.