Generate VOI Report

POST {{baseUrl}}/decisioning/v2/customers/{{customerId}}/voi?callbackUrl=https://openbanking-test/webhook

Generate a Verification of Income (VOI) report for all checking/transaction, savings, and money market accounts for the given customer. This service retrieves up to two years of transaction history for each account and uses this information to generate the VOI report.

This is a premium service. The billing rate is the variable rate for Verification of Income under the current subscription plan. The billable event is the successful generation of a VOI report.

If no account of type checking/transaction, savings, or money market is found, the service will return HTTP 400 Bad Request.

Supported regions: πŸ‡¦πŸ‡Ί

Request Params

KeyDatatypeRequiredDescription
callbackUrlstringA Report Listener URL to receive notifications. The webhook must respond to the Mastercard Open Banking API with 2xx HTTP status code.

Request Body

{"reportCustomFields"=>[{"label"=>"loanID", "value"=>"123456", "shown"=>true}, {"label"=>"loanID", "value"=>"123456", "shown"=>true}], "showNsf"=>false}

HEADERS

KeyDatatypeRequiredDescription
Consent-Receipt-Idstring(Required) A Mastercard Open Banking Consent Receipt ID
Content-Typestring
Acceptstring
App-Keystring
Finicity-App-Tokenstring