{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:mastercard/authentication-create-access-token":{"post":{"operationId":"finance_mastercard_authentication_create_access_token","summary":"Create Access Token","description":"POST /aggregation/v2/partners/authentication","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/authentication-modify-partner-secret":{"post":{"operationId":"finance_mastercard_authentication_modify_partner_secret","summary":"Modify Partner Secret","description":"PUT /aggregation/v2/partners/authentication","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-generate-url":{"post":{"operationId":"finance_mastercard_connect_generate_url","summary":"Generate Connect URL","description":"POST /connect/v2/generate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-generate-lite-url":{"post":{"operationId":"finance_mastercard_connect_generate_lite_url","summary":"Generate Lite Connect URL","description":"POST /connect/v2/generate/lite","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-fix-url-generation":{"post":{"operationId":"finance_mastercard_connect_fix_url_generation","summary":"Generate Fix Connect URL","description":"POST /connect/v2/generate/fix","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-send-connect-email":{"post":{"operationId":"finance_mastercard_connect_send_connect_email","summary":"Send Connect Email","description":"POST /connect/v2/send/email","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-generate-joint-borrower-url":{"post":{"operationId":"finance_mastercard_connect_generate_joint_borrower_url","summary":"Generate Connect URL - Joint Borrower","description":"POST /connect/v2/generate/jointBorrower","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-verify-micro-entry-microdeposits":{"post":{"operationId":"finance_mastercard_connect_verify_micro_entry_microdeposits","summary":"Account Validation Assistant User verification of microdeposits","description":"POST /connect/v2/generate/microentry/verify","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/connect-send-email-joint-borrower":{"post":{"operationId":"finance_mastercard_connect_send_email_joint_borrower","summary":"Send Connect Email - Joint Borrower","description":"POST /connect/v2/send/email/jointBorrower","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-enroll-testing-customer":{"post":{"operationId":"finance_mastercard_customers_enroll_testing_customer","summary":"Add Testing Customer","description":"POST /aggregation/v2/customers/testing","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-enroll-active-customer":{"post":{"operationId":"finance_mastercard_customers_enroll_active_customer","summary":"Add Customer","description":"POST /aggregation/v2/customers/active","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-find-enrolled-users":{"get":{"operationId":"finance_mastercard_customers_find_enrolled_users","summary":"Get Customers","description":"GET /aggregation/v1/customers","tags":["finance"],"parameters":[{"name":"username","in":"query","required":false,"description":"Username for exact match (will return 0 or 1 record)","schema":{"type":"string","description":"Username for exact match (will return 0 or 1 record)"},"example":"customerusername1"},{"name":"type","in":"query","required":false,"description":"\"testing\" or \"active\" to return only customers of that type, or leave empty to return all customers","schema":{"type":"string","description":"\"testing\" or \"active\" to return only customers of that type, or leave empty to return all customers"},"example":"active"},{"name":"search","in":"query","required":false,"description":"The text you wish to match. Leave this empty if you wish to return all customers. Must be URL-encoded (see: [Handling Spaces in…","schema":{"type":"string","description":"The text you wish to match. Leave this empty if you wish to return all customers. Must be URL-encoded (see: [Handling Spaces in…"}},{"name":"start","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":25,"description":"Maximum number of results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-get-with-app-data-by-id":{"get":{"operationId":"finance_mastercard_customers_get_with_app_data_by_id","summary":"Get Customer With App Data by ID","description":"GET /aggregation/v1/customers/{customerId}/application","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-get-by-id":{"get":{"operationId":"finance_mastercard_customers_get_by_id","summary":"Get Customer by ID","description":"GET /aggregation/v1/customers/{customerId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-modify-by-id":{"post":{"operationId":"finance_mastercard_customers_modify_by_id","summary":"Modify Customer by ID","description":"PUT /aggregation/v1/customers/{customerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/customers-remove-by-id":{"post":{"operationId":"finance_mastercard_customers_remove_by_id","summary":"Delete Customer by ID","description":"DELETE /aggregation/v1/customers/{customerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"A customer ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/consumers-get-by-customer-id":{"get":{"operationId":"finance_mastercard_consumers_get_by_customer_id","summary":"Get Consumer For Customer","description":"GET /decisioning/v1/customers/{customerId}/consumer","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/consumers-create-consumer-record":{"post":{"operationId":"finance_mastercard_consumers_create_consumer_record","summary":"Create Consumer","description":"POST /decisioning/v1/customers/{customerId}/consumer","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/consumers-get-by-id":{"get":{"operationId":"finance_mastercard_consumers_get_by_id","summary":"Get Consumer by ID","description":"GET /decisioning/v1/consumers/{consumerId}","tags":["finance"],"parameters":[{"name":"consumerId","in":"query","required":true,"description":"The consumer ID","schema":{"type":"string","description":"The consumer ID"},"example":"0bf46322c167b562e6cbed9d40e19a4c"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/consumers-modify-by-id":{"post":{"operationId":"finance_mastercard_consumers_modify_by_id","summary":"Modify Consumer by ID","description":"PUT /decisioning/v1/consumers/{consumerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["consumerId","body"],"properties":{"consumerId":{"type":"string","description":"The consumer ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-get-by-institution-login":{"get":{"operationId":"finance_mastercard_accounts_get_by_institution_login","summary":"Get Customer Accounts by Institution Login ID","description":"GET /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"institutionLoginId","in":"query","required":true,"description":"The institution login ID","schema":{"type":"string","description":"The institution login ID"},"example":"1007302745"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-refresh-customer-by-institution-login":{"post":{"operationId":"finance_mastercard_accounts_refresh_customer_by_institution_login","summary":"Refresh Customer Accounts by Institution Login ID","description":"POST /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","institutionLoginId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"institutionLoginId":{"type":"string","description":"The institution login ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-refresh-customer-account-by-institution-login":{"post":{"operationId":"finance_mastercard_accounts_refresh_customer_account_by_institution_login","summary":"Refresh Customer Account by Institution Login ID for Data Access Tiers","description":"POST /aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","institutionLoginId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"institutionLoginId":{"type":"string","description":"The institution login ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-remove-by-institution-login":{"post":{"operationId":"finance_mastercard_accounts_remove_by_institution_login","summary":"Delete Customer Accounts by Institution Login ID","description":"DELETE /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","institutionLoginId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"institutionLoginId":{"type":"string","description":"The institution login ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-get-by-id":{"get":{"operationId":"finance_mastercard_accounts_get_by_id","summary":"Get Customer Account by ID","description":"GET /aggregation/v2/customers/{customerId}/accounts/{accountId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-remove-by-customer-id-and-account-id":{"post":{"operationId":"finance_mastercard_accounts_remove_by_customer_id_and_account_id","summary":"Delete Customer Account by ID","description":"DELETE /aggregation/v1/customers/{customerId}/accounts/{accountId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","accountId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"accountId":{"type":"string","description":"The account ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-get-customer-accounts":{"get":{"operationId":"finance_mastercard_accounts_get_customer_accounts","summary":"Get Customer Accounts","description":"GET /aggregation/v1/customers/{customerId}/accounts","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"status","in":"query","required":false,"description":"A filter to fetch account in the given status","schema":{"type":"string","description":"A filter to fetch account in the given status"},"example":"pending"},{"name":"account_type","in":"query","required":false,"description":"A filter to fetch accounts for the given type. Currently supported types: \"ava\"","schema":{"type":"string","description":"A filter to fetch accounts for the given type. Currently supported types: \"ava\""},"example":"ava"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-refresh-customer-aggregation":{"post":{"operationId":"finance_mastercard_accounts_refresh_customer_aggregation","summary":"Refresh Customer Accounts","description":"POST /aggregation/v1/customers/{customerId}/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"A customer ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-refresh-customer-data":{"post":{"operationId":"finance_mastercard_accounts_refresh_customer_data","summary":"Refresh Customer Accounts for Data Access Tiers","description":"POST /aggregation/v2/customers/{customerId}/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"A customer ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-get-customer-institution-accounts":{"get":{"operationId":"finance_mastercard_accounts_get_customer_institution_accounts","summary":"Get Customer Accounts by Institution ID","description":"GET /aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"institutionId","in":"query","required":true,"description":"The institution ID","schema":{"type":"integer","description":"The institution ID"},"example":4222}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-simple-get-basic-info":{"get":{"operationId":"finance_mastercard_accounts_simple_get_basic_info","summary":"Get Customer Accounts by Institution ID (Simple)","description":"GET /aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts/simple","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"institutionId","in":"query","required":true,"description":"The institution ID","schema":{"type":"integer","description":"The institution ID"},"example":4222}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-simple-get-basic-info-2":{"get":{"operationId":"finance_mastercard_accounts_simple_get_basic_info_2","summary":"Get Customer Accounts by Institution Login ID (Simple)","description":"GET /aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts/simple","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"institutionLoginId","in":"query","required":true,"description":"The institution login ID","schema":{"type":"string","description":"The institution login ID"},"example":"1007302745"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-simple-get-basic-info-3":{"get":{"operationId":"finance_mastercard_accounts_simple_get_basic_info_3","summary":"Get Customer Account by ID (Simple)","description":"GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/simple","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/accounts-simple-get-basic-info-4":{"get":{"operationId":"finance_mastercard_accounts_simple_get_basic_info_4","summary":"Get Customer Accounts (Simple)","description":"GET /aggregation/v1/customers/{customerId}/accounts/simple","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/transactions-load-historic-transactions-for-customer-account":{"post":{"operationId":"finance_mastercard_transactions_load_historic_transactions_for_customer_account","summary":"Load Historic Transactions for Customer Account","description":"POST /aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions/historic","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","accountId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"accountId":{"type":"string","description":"The account ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-account-owner-details":{"get":{"operationId":"finance_mastercard_payments_get_account_owner_details","summary":"Get Account Owner","description":"GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/owner","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-account-owner-details-2":{"get":{"operationId":"finance_mastercard_payments_get_account_owner_details_2","summary":"Get Account Owner Details","description":"GET /aggregation/v3/customers/{customerId}/accounts/{accountId}/owner","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"},{"name":"withInsights","in":"query","required":false,"description":"If this parameter is true, Identity Insights data will be returned along with the account owner information","schema":{"type":"boolean","description":"If this parameter is true, Identity Insights data will be returned along with the account owner information"},"example":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/app-registration-create-new-application":{"post":{"operationId":"finance_mastercard_app_registration_create_new_application","summary":"Register App","description":"POST /aggregation/v1/partners/applications","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/app-registration-update-registration":{"post":{"operationId":"finance_mastercard_app_registration_update_registration","summary":"Modify App Registration","description":"PUT /aggregation/v1/partners/applications/{preAppId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["preAppId","body"],"properties":{"preAppId":{"type":"string","description":"The application registration tracking ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/app-registration-get-application-status":{"get":{"operationId":"finance_mastercard_app_registration_get_application_status","summary":"Get App Registration Status","description":"GET /aggregation/v2/partners/applications","tags":["finance"],"parameters":[{"name":"preAppId","in":"query","required":false,"description":"The application registration tracking ID","schema":{"type":"string","description":"The application registration tracking ID"},"example":"2581"},{"name":"applicationId","in":"query","required":false,"description":"The application ID","schema":{"type":"string","description":"The application ID"},"example":"123456789"},{"name":"status","in":"query","required":false,"description":"Look up app registration requests by status","schema":{"type":"string","description":"Look up app registration requests by status"},"example":"P"},{"name":"appName","in":"query","required":false,"description":"Look up app registration requests by app name","schema":{"type":"string","description":"Look up app registration requests by app name"},"example":"Awesome Budget App"},{"name":"submittedDate","in":"query","required":false,"description":"Look up app registration requests by the date they were submitted","schema":{"type":"integer","description":"Look up app registration requests by the date they were submitted"},"example":1607450357},{"name":"modifiedDate","in":"query","required":false,"description":"Look up app registration requests by the date the request was updated. This can be used to determine when a request was updated to \"A\" or…","schema":{"type":"integer","description":"Look up app registration requests by the date the request was updated. This can be used to determine when a request was updated to \"A\" or…"},"example":1607450357},{"name":"page","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"pageSize","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":1,"description":"Maximum number of results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/app-registration-assign-applications":{"post":{"operationId":"finance_mastercard_app_registration_assign_applications","summary":"Set Customer App ID","description":"PUT /aggregation/v1/customers/{customerId}/applications/{applicationId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","applicationId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"applicationId":{"type":"string","description":"The application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/app-registration-migrate-institution-login-accounts":{"post":{"operationId":"finance_mastercard_app_registration_migrate_institution_login_accounts","summary":"Migrate Institution Login Accounts","description":"PUT /aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","institutionLoginId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"institutionLoginId":{"type":"string","description":"The institution login ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/institutions-get-certified-institutions-with-rssd":{"get":{"operationId":"finance_mastercard_institutions_get_certified_institutions_with_rssd","summary":"Get Certified Institutions With RSSD","description":"GET /institution/v2/certifiedInstitutions/rssd","tags":["finance"],"parameters":[{"name":"search","in":"query","required":false,"description":"Search term (financial institution `name` field). Leave empty for all FIs.","schema":{"type":"string","description":"Search term (financial institution `name` field). Leave empty for all FIs."}},{"name":"start","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":25,"description":"Maximum number of results per page"}},{"name":"type","in":"query","required":false,"description":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\"","schema":{"type":"string","description":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\""}},{"name":"supportedCountries","in":"query","required":false,"description":"A list of country codes, '*' for all countries.","schema":{"type":"array","description":"A list of country codes, '*' for all countries."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/institutions-search-financial-institutions":{"get":{"operationId":"finance_mastercard_institutions_search_financial_institutions","summary":"Get Institutions","description":"GET /institution/v2/institutions","tags":["finance"],"parameters":[{"name":"search","in":"query","required":false,"description":"Search term (financial institution `name` field). Leave empty for all FIs.","schema":{"type":"string","description":"Search term (financial institution `name` field). Leave empty for all FIs."}},{"name":"start","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":25,"description":"Maximum number of results per page"}},{"name":"type","in":"query","required":false,"description":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\"","schema":{"type":"string","description":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\""}},{"name":"supportedCountries","in":"query","required":false,"description":"A list of country codes, '*' for all countries.","schema":{"type":"array","description":"A list of country codes, '*' for all countries."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/institutions-list-certified-institutions":{"get":{"operationId":"finance_mastercard_institutions_list_certified_institutions","summary":"Get Certified Institutions","description":"GET /institution/v2/certifiedInstitutions","tags":["finance"],"parameters":[{"name":"search","in":"query","required":false,"description":"Search term (financial institution `name` field). Leave empty for all FIs.","schema":{"type":"string","description":"Search term (financial institution `name` field). Leave empty for all FIs."}},{"name":"start","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":25,"description":"Maximum number of results per page"}},{"name":"type","in":"query","required":false,"description":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\"","schema":{"type":"string","description":"A product type: \"transAgg\", \"ach\", \"stateAgg\", \"voi\", \"voa\", \"aha\", \"availBalance\", \"accountOwner\""}},{"name":"supportedCountries","in":"query","required":false,"description":"A list of country codes, '*' for all countries.","schema":{"type":"array","description":"A list of country codes, '*' for all countries."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/institutions-get-by-id-details":{"get":{"operationId":"finance_mastercard_institutions_get_by_id_details","summary":"Get Institution by ID","description":"GET /institution/v2/institutions/{institutionId}","tags":["finance"],"parameters":[{"name":"institutionId","in":"query","required":true,"description":"The institution ID","schema":{"type":"integer","description":"The institution ID"},"example":4222}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/institutions-get-branding-by-id":{"get":{"operationId":"finance_mastercard_institutions_get_branding_by_id","summary":"Get Institution Branding by ID","description":"GET /institution/v2/institutions/{institutionId}/branding","tags":["finance"],"parameters":[{"name":"institutionId","in":"query","required":true,"description":"The institution ID","schema":{"type":"integer","description":"The institution ID"},"example":4222}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-assets-customer-voareport":{"post":{"operationId":"finance_mastercard_verify_assets_customer_voareport","summary":"Generate VOA Report","description":"POST /decisioning/v2/customers/{customerId}/voa","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-assets-generate-voawith-income-report":{"post":{"operationId":"finance_mastercard_verify_assets_generate_voawith_income_report","summary":"Generate VOA With Income Report","description":"POST /decisioning/v2/customers/{customerId}/voaHistory","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-assets-get-checking-savings-investment-accounts":{"post":{"operationId":"finance_mastercard_verify_assets_get_checking_savings_investment_accounts","summary":"Generate Prequalification (CRA) Report","description":"POST /decisioning/v2/customers/{customerId}/preQualVoa","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-assets-get-asset-summary":{"post":{"operationId":"finance_mastercard_verify_assets_get_asset_summary","summary":"Generate Prequalification (Non-CRA) Report","description":"POST /decisioning/v2/customers/{customerId}/assetSummary","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-create-voireport":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_create_voireport","summary":"Generate VOI Report","description":"POST /decisioning/v2/customers/{customerId}/voi","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-generate-voe-payroll-report":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_generate_voe_payroll_report","summary":"Generate VOE - Payroll Report","description":"POST /decisioning/v2/customers/{customerId}/voePayroll","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-generate-voetransactions-report":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_generate_voetransactions_report","summary":"Generate VOE - Transactions Report","description":"POST /decisioning/v2/customers/{customerId}/voeTransactions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-generate-pay-statement-report":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_generate_pay_statement_report","summary":"Generate Pay Statement Report","description":"POST /decisioning/v2/customers/{customerId}/payStatement","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-generate-voiepaystub-with-tx-ve":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_generate_voiepaystub_with_tx_ve","summary":"Generate VOIE - Paystub (with TXVerify) Report","description":"POST /decisioning/v2/customers/{customerId}/voieTxVerify/withInterview","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-generate-voie-paystub-report":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_generate_voie_paystub_report","summary":"Generate VOIE - Paystub Report","description":"POST /decisioning/v2/customers/{customerId}/voieTxVerify/withStatement","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/verify-income-and-employment-refresh-voiepayroll-report":{"post":{"operationId":"finance_mastercard_verify_income_and_employment_refresh_voiepayroll_report","summary":"Generate VOIE - Payroll Report","description":"POST /decisioning/v2/customers/{customerId}/voiePayroll","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/bank-statements-get-customer-statement-in-pdf":{"get":{"operationId":"finance_mastercard_bank_statements_get_customer_statement_in_pdf","summary":"Get Customer Account Statement","description":"GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/statement","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"},{"name":"index","in":"query","required":false,"description":"Request statements from 1-24. By default, 1 is the most recent statement. Increase the index value to count back (by month) and retrieve…","schema":{"type":"integer","default":1,"description":"Request statements from 1-24. By default, 1 is the most recent statement. Increase the index value to count back (by month) and retrieve…"}},{"name":"type","in":"query","required":false,"description":"The type of statement to retrieve","schema":{"type":"string","description":"The type of statement to retrieve"},"example":"taxStatement"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/bank-statements-generate-report":{"post":{"operationId":"finance_mastercard_bank_statements_generate_report","summary":"Generate Statement Report","description":"POST /decisioning/v2/customers/{customerId}/statement","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/bank-statements-get-multiple-statements":{"get":{"operationId":"finance_mastercard_bank_statements_get_multiple_statements","summary":"Get Customer Account Multiple Statements","description":"GET /aggregation/v3/customers/{customerId}/accounts/{accountId}/statement","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"},{"name":"index","in":"query","required":false,"description":"Request statements with comma-separated indexes between 1-24. The default value is 1 and it will return the most recent statement.…","schema":{"type":"string","default":"1","description":"Request statements with comma-separated indexes between 1-24. The default value is 1 and it will return the most recent statement.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/transactions-get-all-customer-transactions":{"get":{"operationId":"finance_mastercard_transactions_get_all_customer_transactions","summary":"Get All Customer Transactions","description":"GET /aggregation/v3/customers/{customerId}/transactions","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"fromDate","in":"query","required":true,"description":"A start date","schema":{"type":"integer","description":"A start date"},"example":1607450357},{"name":"toDate","in":"query","required":true,"description":"A end date","schema":{"type":"integer","description":"A end date"},"example":1607450357},{"name":"start","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":25,"description":"Maximum number of results per page"}},{"name":"sort","in":"query","required":false,"description":"Date sort order: \"asc\" for ascending, \"desc\" for descending","schema":{"type":"string","default":"desc","description":"Date sort order: \"asc\" for ascending, \"desc\" for descending"}},{"name":"includePending","in":"query","required":false,"description":"If pending transactions must be included","schema":{"type":"boolean","default":false,"description":"If pending transactions must be included"},"example":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/transactions-get-by-id":{"get":{"operationId":"finance_mastercard_transactions_get_by_id","summary":"Get Customer Transaction by ID","description":"GET /aggregation/v2/customers/{customerId}/transactions/{transactionId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"transactionId","in":"query","required":true,"description":"A transaction ID","schema":{"type":"integer","description":"A transaction ID"},"example":21284820852}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/transactions-get-customer-account-transactions":{"get":{"operationId":"finance_mastercard_transactions_get_customer_account_transactions","summary":"Get Customer Account Transactions","description":"GET /aggregation/v4/customers/{customerId}/accounts/{accountId}/transactions","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"},{"name":"fromDate","in":"query","required":true,"description":"A start date","schema":{"type":"integer","description":"A start date"},"example":1607450357},{"name":"toDate","in":"query","required":true,"description":"A end date","schema":{"type":"integer","description":"A end date"},"example":1607450357},{"name":"start","in":"query","required":false,"description":"Index of the page of results to return","schema":{"type":"integer","default":1,"description":"Index of the page of results to return"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of results per page","schema":{"type":"integer","default":25,"description":"Maximum number of results per page"}},{"name":"sort","in":"query","required":false,"description":"Date sort order: \"asc\" for ascending, \"desc\" for descending","schema":{"type":"string","default":"desc","description":"Date sort order: \"asc\" for ascending, \"desc\" for descending"}},{"name":"includePending","in":"query","required":false,"description":"If pending transactions must be included","schema":{"type":"boolean","default":false,"description":"If pending transactions must be included"},"example":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/transactions-get24-months-history-and-generate-report":{"post":{"operationId":"finance_mastercard_transactions_get24_months_history_and_generate_report","summary":"Generate Transactions Report","description":"POST /decisioning/v2/customers/{customerId}/transactions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","toDate","body"],"properties":{"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"customerId":{"type":"string","description":"A customer ID"},"toDate":{"type":"integer","description":"A end date"},"includePending":{"type":"boolean","default":false,"description":"If pending transactions must be included"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/balance-analytics-generate-report":{"post":{"operationId":"finance_mastercard_balance_analytics_generate_report","summary":"Generate Balance Analytics Report - Personal/Business","description":"POST /decisioning/v2/customers/{customerId}/reports/balance-analytics/userTypes/{userType}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","userType","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"userType":{"type":"string","description":"UserType indicates if the request is for a business or personal use case, Allowed values: business/personal."},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/cash-flow-analytics-generate-report":{"post":{"operationId":"finance_mastercard_cash_flow_analytics_generate_report","summary":"Generate Cashflow Analytics Report - Personal/Business","description":"POST /decisioning/v2/customers/{customerId}/reports/cashflow-analytics/userTypes/{userType}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","userType","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"userType":{"type":"string","description":"UserType indicates if the request is for a business or personal use case, Allowed values: business/personal."},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/pay-statements-upload-for-customer":{"post":{"operationId":"finance_mastercard_pay_statements_upload_for_customer","summary":"Store Customer Pay Statement","description":"POST /aggregation/v1/customers/{customerId}/payStatements","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-loan-payment-details":{"get":{"operationId":"finance_mastercard_payments_get_loan_payment_details","summary":"Get Loan Payment Details","description":"GET /aggregation/v2/customers/{customerId}/accounts/{accountId}/loanDetails","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/portfolios-get-most-recent-reports":{"get":{"operationId":"finance_mastercard_portfolios_get_most_recent_reports","summary":"Get Portfolio by Customer","description":"GET /decisioning/v1/customers/{customerId}/portfolios/{portfolioId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"portfolioId","in":"query","required":true,"description":"A portfolio ID with the portfolio version number. Using the portfolio number without a version number will return the most recently…","schema":{"type":"string","description":"A portfolio ID with the portfolio version number. Using the portfolio number without a version number will return the most recently…"},"example":"y4zsgccj4xpw-6-port"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/tx-push-subscribe-notifications":{"post":{"operationId":"finance_mastercard_tx_push_subscribe_notifications","summary":"Subscribe to TxPush Notifications","description":"POST /aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","accountId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"accountId":{"type":"string","description":"The account ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/tx-push-disable-notifications":{"post":{"operationId":"finance_mastercard_tx_push_disable_notifications","summary":"Disable TxPush Notifications","description":"DELETE /aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","accountId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"accountId":{"type":"string","description":"The account ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/tx-push-inject-test-transaction":{"post":{"operationId":"finance_mastercard_tx_push_inject_test_transaction","summary":"Create TxPush Test Transaction","description":"POST /aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","accountId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"accountId":{"type":"string","description":"The account ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/tx-push-delete-subscription":{"post":{"operationId":"finance_mastercard_tx_push_delete_subscription","summary":"Delete TxPush Subscription","description":"DELETE /aggregation/v1/customers/{customerId}/subscriptions/{subscriptionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","subscriptionId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"subscriptionId":{"type":"integer","description":"The subscription ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/portfolios-get-portfolio-by-consumer":{"get":{"operationId":"finance_mastercard_portfolios_get_portfolio_by_consumer","summary":"Get Portfolio by Consumer","description":"GET /decisioning/v1/consumers/{consumerId}/portfolios/{portfolioId}","tags":["finance"],"parameters":[{"name":"consumerId","in":"query","required":true,"description":"The consumer ID","schema":{"type":"string","description":"The consumer ID"},"example":"0bf46322c167b562e6cbed9d40e19a4c"},{"name":"portfolioId","in":"query","required":true,"description":"A portfolio ID with the portfolio version number. Using the portfolio number without a version number will return the most recently…","schema":{"type":"string","description":"A portfolio ID with the portfolio version number. Using the portfolio number without a version number will return the most recently…"},"example":"y4zsgccj4xpw-6-port"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-ach-details":{"get":{"operationId":"finance_mastercard_payments_get_ach_details","summary":"Get Account ACH Details","description":"GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/details","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/reports-get-status":{"get":{"operationId":"finance_mastercard_reports_get_status","summary":"Get Report by Customer and ID","description":"GET /decisioning/v3/customers/{customerId}/reports/{reportId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"reportId","in":"query","required":true,"description":"ID of the report","schema":{"type":"string","description":"ID of the report"},"example":"u4hstnnak45g"},{"name":"onBehalfOf","in":"query","required":false,"description":"The name of the entity you are retrieving the report on behalf of","schema":{"type":"string","description":"The name of the entity you are retrieving the report on behalf of"}},{"name":"purpose","in":"query","required":false,"description":"2-digit code from [Permissible Purpose…","schema":{"type":"string","description":"2-digit code from [Permissible Purpose…"},"example":"3F"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/reports-get-by-consumer-and-id":{"get":{"operationId":"finance_mastercard_reports_get_by_consumer_and_id","summary":"Get Report by Consumer and ID","description":"GET /decisioning/v3/consumers/{consumerId}/reports/{reportId}","tags":["finance"],"parameters":[{"name":"purpose","in":"query","required":false,"description":"2-digit code from [Permissible Purpose…","schema":{"type":"string","description":"2-digit code from [Permissible Purpose…"},"example":"3F"},{"name":"consumerId","in":"query","required":true,"description":"The consumer ID","schema":{"type":"string","description":"The consumer ID"},"example":"0bf46322c167b562e6cbed9d40e19a4c"},{"name":"reportId","in":"query","required":true,"description":"ID of the report","schema":{"type":"string","description":"ID of the report"},"example":"u4hstnnak45g"},{"name":"onBehalfOf","in":"query","required":false,"description":"The name of the entity you are retrieving the report on behalf of","schema":{"type":"string","description":"The name of the entity you are retrieving the report on behalf of"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/reports-by-customer-id":{"get":{"operationId":"finance_mastercard_reports_by_customer_id","summary":"Get Reports by Customer ID","description":"GET /decisioning/v1/customers/{customerId}/reports","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"purpose","in":"query","required":false,"description":"2-digit code from [Permissible Purpose…","schema":{"type":"string","description":"2-digit code from [Permissible Purpose…"},"example":"3F"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/reports-by-consumer-id":{"get":{"operationId":"finance_mastercard_reports_by_consumer_id","summary":"Get Reports by Consumer ID","description":"GET /decisioning/v1/consumers/{consumerId}/reports","tags":["finance"],"parameters":[{"name":"purpose","in":"query","required":false,"description":"2-digit code from [Permissible Purpose…","schema":{"type":"string","description":"2-digit code from [Permissible Purpose…"},"example":"3F"},{"name":"consumerId","in":"query","required":true,"description":"The consumer ID","schema":{"type":"string","description":"The consumer ID"},"example":"0bf46322c167b562e6cbed9d40e19a4c"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/assets-get-binary-file":{"get":{"operationId":"finance_mastercard_assets_get_binary_file","summary":"Get Asset by Customer and ID","description":"GET /aggregation/v1/customers/{customerId}/assets/{assetId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"assetId","in":"query","required":true,"description":"The asset ID","schema":{"type":"string","description":"The asset ID"},"example":"097545c5-1c2a-4f20-a5ef-77f0820344c9-2018601178"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-available-balance-live":{"get":{"operationId":"finance_mastercard_payments_get_available_balance_live","summary":"Get Available Balance - Live","description":"GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance/live","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-latest-cached-balance":{"get":{"operationId":"finance_mastercard_payments_get_latest_cached_balance","summary":"Get Available Balance","description":"GET /aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/cash-flow-generate-report-business":{"post":{"operationId":"finance_mastercard_cash_flow_generate_report_business","summary":"Generate Cash Flow Report - Business","description":"POST /decisioning/v2/customers/{customerId}/cashFlowBusiness","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/cash-flow-generate-personal-report":{"post":{"operationId":"finance_mastercard_cash_flow_generate_personal_report","summary":"Generate Cash Flow Report - Personal","description":"POST /decisioning/v2/customers/{customerId}/cashFlowPersonal","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"callbackUrl":{"type":"string","description":"A Report Listener URL to receive notifications. The webhook must respond to the Finicity API with a 2xx HTTP status code."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/account-validation-assistance-initiate-micro-entries":{"post":{"operationId":"finance_mastercard_account_validation_assistance_initiate_micro_entries","summary":"Initiate Micro Entries","description":"POST /microentry/v1/customers/{customerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/account-validation-assistance-verify-micro-entries":{"post":{"operationId":"finance_mastercard_account_validation_assistance_verify_micro_entries","summary":"Verify Micro Entries","description":"POST /microentry/v1/customers/{customerId}/accounts/{accountId}/amounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","accountId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"accountId":{"type":"string","description":"The account ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/account-validation-assistance-get-micro-entries-details":{"get":{"operationId":"finance_mastercard_account_validation_assistance_get_micro_entries_details","summary":"Get Micro Entries Details","description":"GET /microentry/v1/customers/{customerId}/accounts/{accountId}","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/balance-analytics-generate-analytics-report":{"post":{"operationId":"finance_mastercard_balance_analytics_generate_analytics_report","summary":"Generate Balance Analytics","description":"POST /analytics/balance/v1/customer/{customerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"reference-number":{"type":"string","description":"Partner-provided reference number to correlate reports."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/balance-analytics-generate-fcra-analytics-report":{"post":{"operationId":"finance_mastercard_balance_analytics_generate_fcra_analytics_report","summary":"Generate Balance Analytics - FCRA","description":"POST /analytics/balance/v1/customer/{customerId}/fcra","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"reference-number":{"type":"string","description":"Partner-provided reference number to correlate reports."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/cash-flow-analytics-generate-analytics":{"post":{"operationId":"finance_mastercard_cash_flow_analytics_generate_analytics","summary":"Generate Cash Flow Analytics","description":"POST /analytics/cashflow/v1/customer/{customerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"reference-number":{"type":"string","description":"Partner-provided reference number to correlate reports."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/cash-flow-analytics-generate-fcra-analytics-report":{"post":{"operationId":"finance_mastercard_cash_flow_analytics_generate_fcra_analytics_report","summary":"Generate Cash Flow Analytics - FCRA","description":"POST /analytics/cashflow/v1/customer/{customerId}/fcra","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId","body"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"reference-number":{"type":"string","description":"Partner-provided reference number to correlate reports."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payment-history-generate-customer-payment-report":{"post":{"operationId":"finance_mastercard_payment_history_generate_customer_payment_report","summary":"Generate Payment History","description":"POST /analytics/payment-history/v1/customer/{customerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"reference-number":{"type":"string","description":"Partner-provided reference number to correlate reports."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payment-history-generate-fcra-payment-report":{"post":{"operationId":"finance_mastercard_payment_history_generate_fcra_payment_report","summary":"Generate Payment History - FCRA","description":"POST /analytics/payment-history/v1/customer/{customerId}/fcra","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"customerId":{"type":"string","description":"A customer ID"},"reference-number":{"type":"string","description":"Partner-provided reference number to correlate reports."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/balance-analytics-get-report-data":{"get":{"operationId":"finance_mastercard_balance_analytics_get_report_data","summary":"Get OBB Analytics Report","description":"GET /analytics/data/v1/{obb_report_id}","tags":["finance"],"parameters":[{"name":"obb_report_id","in":"query","required":true,"description":"Report ID generated and returned by OBB products","schema":{"type":"string","description":"Report ID generated and returned by OBB products"},"example":"bcab9592-e032-4e7b-b737-0380619a0573"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/balance-analytics-get-report-data-fcra":{"get":{"operationId":"finance_mastercard_balance_analytics_get_report_data_fcra","summary":"Get OBB Analytics Report - FCRA","description":"GET /analytics/data/v1/{obb_report_id}/fcra","tags":["finance"],"parameters":[{"name":"obb_report_id","in":"query","required":true,"description":"Report ID generated and returned by OBB products","schema":{"type":"string","description":"Report ID generated and returned by OBB products"},"example":"bcab9592-e032-4e7b-b737-0380619a0573"},{"name":"purpose","in":"query","required":true,"description":"2-digit code from [Permissible Purpose…","schema":{"type":"string","description":"2-digit code from [Permissible Purpose…"},"example":"3F"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/third-party-access-generate-key":{"post":{"operationId":"finance_mastercard_third_party_access_generate_key","summary":"Generate Third Party Access Key","description":"POST /aggregation/v1/partners/accessKey","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/third-party-access-update-access":{"post":{"operationId":"finance_mastercard_third_party_access_update_access","summary":"Update Third Party Access","description":"PUT /aggregation/v1/partners/accessKey/{consentReceiptId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["consentReceiptId","body"],"properties":{"consentReceiptId":{"type":"string","description":"Third party access key receipt ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/third-party-access-revoke-partners-access":{"post":{"operationId":"finance_mastercard_third_party_access_revoke_partners_access","summary":"Revoke Third Party Access","description":"DELETE /aggregation/v1/partners/accessKey/{consentReceiptId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["consentReceiptId"],"properties":{"consentReceiptId":{"type":"string","description":"Third party access key receipt ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/businesses-api-get-details-by-customer-id":{"get":{"operationId":"finance_mastercard_businesses_api_get_details_by_customer_id","summary":"Get Business for Customer","description":"GET /business-services/customers/{customer_id}/businesses","tags":["finance"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"Unique identifier of the customer","schema":{"type":"string","description":"Unique identifier of the customer"},"example":"1005061234"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/businesses-api-create-new-business":{"post":{"operationId":"finance_mastercard_businesses_api_create_new_business","summary":"Create a New Business for a Customer","description":"POST /business-services/customers/{customer_id}/businesses","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","body"],"properties":{"customer_id":{"type":"string","description":"Unique identifier of the customer"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/businesses-api-get-details-by-id":{"get":{"operationId":"finance_mastercard_businesses_api_get_details_by_id","summary":"Get Business by ID","description":"GET /business-services/businesses/{business_id}","tags":["finance"],"parameters":[{"name":"business_id","in":"query","required":true,"description":"Unique identifier of the business","schema":{"type":"string","description":"Unique identifier of the business"},"example":"192323"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:mastercard/businesses-api-update-by-id":{"post":{"operationId":"finance_mastercard_businesses_api_update_by_id","summary":"Update Business by ID","description":"PUT /business-services/businesses/{business_id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["business_id","body"],"properties":{"business_id":{"type":"string","description":"Unique identifier of the business"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:mastercard/payments-get-ach-account-details":{"get":{"operationId":"finance_mastercard_payments_get_ach_account_details","summary":"Get ACH Account Details","description":"GET /aggregation/v3/customers/{customerId}/accounts/{accountId}/details","tags":["finance"],"parameters":[{"name":"customerId","in":"query","required":true,"description":"A customer ID","schema":{"type":"string","description":"A customer ID"},"example":"1005061234"},{"name":"accountId","in":"query","required":true,"description":"The account ID","schema":{"type":"string","description":"The account ID"},"example":"5011648377"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}