Generate Pay Statement Report

POST {{baseUrl}}/decisioning/v2/customers/{{customerId}}/payStatement

Generate Pay Statement Extraction Report for the given customer. This service accepts asset IDs of the stored pay statements to generate a Pay Statement Extraction Report.

This is a premium service. The billing rate is the variable rate for Pay Statement Extraction Report under the current subscription plan. The billable event is the successful generation of a Pay Statement Extraction Report.

Supported regions:

Request Params

Request Body

{"paystatementReport"=>{"assetIds"=>["{{assetId}}"], "extractEarnings"=>true, "extractDeductions"=>true, "extractDirectDeposit"=>true}, "reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}]}

HEADERS