Calculate payment timing

Calculate the estimated payment timing given the deduction date, payment source, and disbursement method. Can be used to calculate timing for a payment.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
objectRequired
OR
objectRequired

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.

Errors