Lending operations on the platform - loan status, payment schedule and amortization, transaction history, installment statuses and loan simulation. This is the only SoFi Tech Solutions contract that declares a bearer token security scheme in the specification itself, and its info.version still carries a 1.0.0-SNAPSHOT marker.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sofi-tech-solutions-loan-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{"openapi":"3.0.1","info":{"title":"Loan API","description":"cfa-loan","contact":{"name":"CDP","url":"https://www.technisys.com","email":"info@technisys.com"},"version":"1.0.0-SNAPSHOT"},"servers":[{"url":"lending-{corename}.{env}.gpsrv.com/lending/"}],"tags":[{"name":"Loan","description":"Loan management endpoints."}],"paths":{"/1.0/updateLoanStatus":{"post":{"tags":["Loan"],"summary":"Update Loan Status","description":"Use the Update Loan Status to set a loan to charge-off status. In the future, this supports scenarios like bankruptcy.\n\nFor optional parameters, do not pass an empty string or null value.","operationId":"lending_post_updateLoanStatus","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["loanId","loanStatus","loanStatusReasonCode","subProductId","transactionId","apiLogin","apiTransKey","providerId"],"type":"object","properties":{"apiLogin":{"type":"string","description":"Provider's web service username, as provided by Galileo for the requesting IP address.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","default":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by Galileo for the requesting IP address.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","default":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Galileo-issued unique provider identifier.\nPattern: Max 10 digits\nExample: `9999`","default":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","default":"984513-395483653-4483483478"},"providerTransactionId":{"type":"string","description":"An optional provider-generated ID for the API request.\nPattern: Max 60 characters\nExample: `\"47823438032233777\"`"},"providerTimestamp":{"type":"string","description":"An optional provider-generated timestamp for the API request.\nPattern: Max 60 characters\nExample: `\"2017-05-01 13:01:01\"`"},"loanStatus":{"title":"loanStatus","type":"string","description":"Status of the loan.","enum":["charge_off"],"default":"charge_off"},"loanStatusReasonCode":{"title":"loanStatusReasonCode","type":"integer","description":"Code associated with the reason for charging off a loan. Possible values:\n\n* `1010` — Divorce\n* `1011` — Deceased\n* `1012` — Incarcerated\n* `1013` — Income Loss\n* `1014` — Medical\n* `1015` — Refuse to pay\n* `1016` — Unknown \nPattern: 4-digit code.\nExample: `\"1016\"`.","format":"int32","default":1016},"loanId":{"title":"loanId","maxLength":30,"minLength":1,"type":"string","description":"Unique identifier for the loan.\nPattern: Max 30 characters\nExample: `\"450825953\"`.","default":"450825953"},"subProductId":{"title":"subProductId","maxLength":15,"minLength":1,"type":"string","description":"Identifier for the loan subproduct.\nPattern: Max 15 characters.\nExample: `\"442824720\"`.","default":"442824720"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A Galileo-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"type":"object","description":"A structure for the response data. It can be empty but usually will contain information.","required":["loan_balance","loan_id","loan_status","total_charge_off_amount"],"properties":{"loan_status":{"title":"loan_status","type":"string","description":"Status of the loan.","example":"charge_off","enum":["charge_off"]},"loan_id":{"title":"loan_id","type":"string","description":"Galileo-generated identifier for the loan","example":"450825953"},"loan_balance":{"title":"loan_balance","type":"number","description":"Total balance remaining on the loan. In case of charge off the loan balance will be $0.00.","example":10000},"total_charge_off_amount":{"title":"total_charge_off_amount","type":"number","description":"Total amount that was charged off on the loan, inclusive of fees and interest","example":10000}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"response\": {\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.215,\n \"response_data\": {\n \"loan_status\": \"charge_off\",\n \"loan_id\": 11118001000000140,\n \"loan_balance\": 0,\n \"total_charge_off_amount\": 500\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": 145267123234243\n },\n \"system_timestamp\": \"2022-11-10 14:14:17\",\n \"rtoken\": \"cf5ad196-18ae-4334-8da3-4c47c82fec19\",\n \"errors\": \"\"\n }\n}\n"}}},"application/xml":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A Galileo-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"type":"object","description":"A structure for the response data. It can be empty but usually will contain information.","required":["loan_balance","loan_id","loan_status","total_charge_off_amount"],"properties":{"loan_status":{"title":"loan_status","type":"string","description":"Status of the loan.","example":"charge_off","enum":["charge_off"]},"loan_id":{"title":"loan_id","type":"string","description":"Galileo-generated identifier for the loan","example":"450825953"},"loan_balance":{"title":"loan_balance","type":"number","description":"Total balance remaining on the loan. In case of charge off the loan balance will be $0.00.","example":10000},"total_charge_off_amount":{"title":"total_charge_off_amount","type":"number","description":"Total amount that was charged off on the loan, inclusive of fees and interest","example":10000}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"<?xml version=\"1.0\" ?>\n<response>\n <status_code>0</status_code>\n <status>Success</status>\n <processing_time>0215</processing_time>\n <response_data>\n <loan_status>charge_off</loan_status>\n <loan_id>11118001000000140</loan_id>\n <loan_balance>0</loan_balance>\n <total_charge_off_amount>500</total_charge_off_amount>\n </response_data>\n <echo>\n <provider_transaction_id/>\n <provider_timestamp/>\n <transaction_id>145267123234243</transaction_id>\n </echo>\n <rtoken>cf5ad196-18ae-4334-8da3-4c47c82fec19</rtoken>\n <system_timestamp>2022-11-10 14:14:17</system_timestamp>\n</response>\n"}}}}}}},"parameters":[{"$ref":"#/components/parameters/ResponseContentTypeHeaderParam"}]},"/1.0/simulateLoan":{"post":{"tags":["Loan"],"summary":"Simulate Loan","description":"Use the Simulate Loan endpoint to present loan terms to individual and business customers. Simulate Loan allows customers to run multiple loan simulations, to compare the different APRs and loan terms, and make an informed decision about the loan offerings. The 36% MAPR is only applicable to individual customer loans, and there is no limit for business customer loans. This endpoint generates the data needed to create loan documents such as the Truth in Lending Act (TILA) document and loan disclosures. You have the option to create a loan with or without a simulation. If the loan is not created the same day as the loan simulation, there is a possibility that the APR might exceed the allowable limit, causing an error in loan creation.\n\n For optional parameters, do not pass an empty string or null value.","operationId":"lending_post_simulateLoan","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["capitalTerm","customerPmtRefNo","loanTerm","subProductId","totalLoanAmount","transactionId","apiLogin","apiTransKey","providerId"],"type":"object","properties":{"apiLogin":{"type":"string","description":"Provider's web service username, as provided by Galileo for the requesting IP address.\nPattern: Max 50 characters\nExample: `\"AbC123-9999\"`","default":"AbC123-9999"},"apiTransKey":{"type":"string","description":"Web service password, as provided by Galileo for the requesting IP address.\nPattern: Max 15 characters\nExample: `\"4sb62fh6w4h7w34g\"`","default":"4sb62fh6w4h7w34g"},"providerId":{"type":"integer","format":"int32","description":"Galileo-issued unique provider identifier.\nPattern: Max 10 digits\nExample: `9999`","default":9999},"transactionId":{"type":"string","maxLength":60,"minLength":1,"description":"A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.\nPattern: Max 60 characters\nExample: `\"984513-395483653-4483483478\"`","default":"984513-395483653-4483483478"},"providerTransactionId":{"type":"string","description":"An optional provider-generated ID for the API request.\nPattern: Max 60 characters\nExample: `\"47823438032233777\"`"},"providerTimestamp":{"type":"string","description":"An optional provider-generated timestamp for the API request.\nPattern: Max 60 characters\nExample: `\"2017-05-01 13:01:01\"`"},"loanTerm":{"title":"loanTerm","maximum":999999999,"minimum":1,"type":"integer","description":"Number of installments to pay off the loan.\nPattern: Min 1 characters and max 9 characters.\nExample: 4.","format":"int32","default":4},"customerType":{"title":"customerType","type":"string","description":"Specifies whether the loan simulation is created for a consumer loan or business loan. If no value is provided, it defaults to INDIVIDUAL.","enum":["BUSINESS","INDIVIDUAL"]},"totalLoanAmount":{"title":"totalLoanAmount","maximum":99999999999999.98,"exclusiveMaximum":false,"minimum":0.01,"exclusiveMinimum":false,"type":"number","description":"Total amount for the loan.\nPattern: Decimal number (14,2).\nExample: `\"700.00\"`.","default":10000},"capitalTerm":{"title":"capitalTerm","maximum":999999999,"minimum":1,"type":"integer","description":"Length of time between payments, in units specified by the subproduct. For example, if you specify “2” and the loan subproduct is set to weeks then installments will be due every two weeks.\nPattern: Max 9 digits.\nExample: `2`.","format":"int32","default":2},"loanApplicationData":{"title":"loanApplicationData","maxLength":4000,"minLength":1,"type":"string","description":"When using the loan simulation, you have the option to pass in comma-separated data from the user's application to store with the simulation for downstream analysis. If a loan is created, this associates the user’s application to the simulation and then to the loan."},"firstInstallmentDueDate":{"title":"firstInstallmentDueDate","type":"string","description":"Due date of the first installment has to be between the 1st and 28th of the month. This field does not apply to bi-weekly subproducts.","format":"date"},"customerPmtRefNo":{"title":"customerPmtRefNo","pattern":"^([0-9]{12}|[0-9]{16})$","type":"string","description":"PRN for the customer’s primary account. Galileo uses the PRN to retrieve customer information, like business name, date of birth, SSN, address, etc. When the loan is created, the `loan_id` will be associated with this PRN. \nPattern: PRN\nExample: `\"074103447228\"`.","default":"909675440"},"loanStartDate":{"title":"loanStartDate","pattern":"yyyy-MM-dd","type":"string","description":"Start date for the loan. This may be different from `loan_creation_date`.","format":"date"},"applicationNumber":{"title":"applicationNumber","maxLength":100,"minLength":1,"type":"string","description":"Unique identifier that you generate for the loan application. This identifier is associated with loan simulations. You can give this identifier to customers for customer service purposes."},"subProductId":{"title":"subProductId","maxLength":15,"minLength":1,"type":"string","description":"Identifier for the loan subproduct.\nPattern: Max 15 characters.\nExample: `\"442824720\"`.","default":"442824720"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A Galileo-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"type":"object","description":"A structure for the response data. It can be empty but usually will contain information.","required":["amortization_schedules","application_number","count_of_installments","first_installment_due_date","initial_projected_maturity_date","installment_amount","interest_rate","late_fee","loan_apr","origination_fee","rate_type","simulation_date","simulation_id","sub_product_id"],"properties":{"simulation_id":{"title":"simulation_id","type":"string","description":"Unique identifier associated with each loan simulation.","example":"450825953"},"interest_rate":{"title":"interest_rate","type":"number","description":"Interest rate applied to the loan, as defined by the subproduct","example":15},"sub_product_id":{"title":"sub_product_id","type":"string","description":"Identifier for the loan subproduct","example":"442824720"},"simulation_date":{"title":"simulation_date","pattern":"yyyy-MM-dd","type":"string","description":"Date the simulated loan is created.","format":"date","example":"2022-01-01"},"initial_projected_maturity_date":{"title":"initial_projected_maturity_date","pattern":"yyyy-MM-dd","type":"string","description":"Projected date when the loan will be paid off. This date is calculated only when a loan is simulated or created and cannot be sent again.","format":"date","example":"2022-07-01"},"itemization_of_amount_financed":{"title":"itemization_of_amount_financed","required":["disbursed_amount","loan_amount","projected_fees_amount","projected_interest_amount"],"type":"object","properties":{"loan_amount":{"title":"loan_amount","type":"number","description":"Total loan amount borrowed by the customer. This is the sum of the `disbursed_amount`, `origination_fee`, and any other fees associated with the loan.","example":10000},"disbursed_amount":{"title":"disbursed_amount","type":"number","description":"Total loan amount disbursed to the customer","example":10000},"projected_interest_amount":{"title":"projected_interest_amount","type":"number","description":"The total interest amount the borrower will be paying","example":10},"projected_fees_amount":{"title":"projected_fees_amount","type":"number","description":"Total fees that the customer is projected to pay over the course of the loan","example":10}}},"origination_fee":{"title":"origination_fee","type":"number","description":"Fee charged at loan creation. Returns 0 if there is no origination fee.","example":0},"rate_type":{"title":"rate_type","type":"string","description":"Indicates whether the interest type is `FIXED` or `VARIABLE.","example":"FIXED","enum":["fixed","variable"]},"application_number":{"title":"application_number","type":"string","description":"Unique identifier that you generate for the loan application. This identifier is associated with loan simulations. You can give this identifier to customers for customer service purposes.","example":"589841564"},"amortization_schedules":{"title":"amortization_schedules","type":"array","items":{"required":["amort_installment_number","amort_payment_amount","amort_payment_balance","amort_payment_due_date","amort_payment_fees","amort_payment_interest","amort_payment_principal"],"type":"object","properties":{"amort_installment_number":{"title":"amort_installment_number","type":"integer","description":"The number of the installment","format":"int32","example":1},"amort_payment_due_date":{"title":"amort_payment_due_date","pattern":"yyyy-MM-dd","type":"string","description":"Date that the payment for this installment is due","format":"date","example":"2022-02-01"},"amort_payment_amount":{"title":"amort_payment_amount","type":"number","description":"Total amount owed for this installment, including the principal amount,interest and fees","example":1740.34},"amort_payment_principal":{"title":"amort_payment_principal","type":"number","description":"Amount owed on the principal loan for this installment","example":1000},"amort_payment_fees":{"title":"amort_payment_fees","type":"number","description":"Fee amount that will be paid in each installment","example":7.51},"amort_payment_interest":{"title":"amort_payment_interest","type":"number","description":"Amount owed on the loan interest for this installment","example":10},"amort_payment_balance":{"title":"amort_payment_balance","type":"number","description":"Remaining balance after this installment is paid","example":2000}}}},"count_of_installments":{"title":"count_of_installments","pattern":"yyyy-MM-dd","type":"integer","description":"Number of installment scheduled","format":"int32","example":4},"installment_amount":{"title":"installment_amount","pattern":"yyyy-MM-dd","type":"number","description":"Payment due at each installment. This is the same amount as `amort_payment_amount`.","example":1740.34},"first_installment_due_date":{"title":"first_installment_due_date","pattern":"yyyy-MM-dd","type":"string","description":"Date the first installment is due","format":"date","example":"2022-02-01"},"loan_apr":{"title":"loan_apr","type":"number","description":"Annual percentage rate for interest charged on the loan. Calculated from the interest defined by the subproduct, the length of the loan, the origination fee (if applicable) and other fees (if applicable).","example":15},"late_fee":{"title":"late_fee","type":"number","description":"Late fee for the loan","example":5}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 4.298,\n \"response_data\": {\n \"loan_apr\": 32.52,\n \"rate_type\": \"fixed\",\n \"origination_fee\": 0.0,\n \"late_fee\": 0.0,\n \"initial_projected_maturity_date\": \"2023-07-21\",\n \"application_number\": null,\n \"itemization_of_amount_financed\": {\n \"loan_amount\": 300.0,\n \"disbursed_amount\": 300.0,\n \"projected_interest_amount\": 0.0,\n\t \"projected_fees_amount\": 9.45\n },\n \"amortization_schedules\": {\n \"amortization_schedule\": [\n {\n \"amort_installment_number\": 1,\n \"amort_payment_due_date\": \"2022-10-30\",\n \"amort_payment_amount\": 77.36,\n \"amort_payment_principal\": 75.00,\n \"amort_payment_fees\": 2.36,\n \"amort_payment_interest\": 0.00,\n \"amort_payment_balance\": 232.09,\n },\n {\n \"amort_installment_number\": 2,\n \"amort_payment_due_date\": \"2022-11-13\",\n \"amort_payment_amount\": 77.36,\n \"amort_payment_principal\": 75.00,\n \"amort_payment_fees\": 2.36,\n \"amort_payment_interest\": 0.00,\n \"amort_payment_balance\": 154.73,\n },\n {\n \"amort_installment_number\": 3,\n \"amort_payment_due_date\": \"2022-11-27\",\n \"amort_payment_amount\": 77.36,\n \"amort_payment_principal\": 75.00,\n \"amort_payment_fees\": 2.36,\n \"amort_payment_interest\": 0.00,\n \"amort_payment_balance\": 77.37,\n },\n {\n \"amort_installment_number\": 4,\n \"amort_payment_due_date\": \"2022-12-11\",\n \"amort_payment_amount\": 77.37,\n \"amort_payment_principal\": 75.00,\n \"amort_payment_fees\": 2.37,\n \"amort_payment_interest\": 0.00,\n \"amort_payment_balance\": 0.00,\n }\n ]\n },\n \"count_of_installments\": 4,\n \"installment_amount\": 77.36,\n \"first_installment_due_date\": \"2022-10-30\",\n \"simulation_id\": \"1676315637005\",\n \"sub_product_id\": \"8008\",\n \"simulation_date\": \"2022-10-16\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": 818517296121222\n },\n \"system_timestamp\": \"2022-10-16 15:36:28\",\n \"rtoken\": \"a0888f94-fed6-4376-9567-3bga83ea902\",\n \"errors\": \"\"\n }\n}\n"}}},"application/xml":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","format":"int32","nullable":true,"description":"The response status code. May return a string for some statuses."},"status":{"type":"string","nullable":true,"description":"The condition of a process or response"},"processing_time":{"type":"number","format":"float","nullable":true,"description":"The time elapsed in processing the transaction"},"echo":{"nullable":true,"description":"A structure that contains transaction ID information","type":"object","properties":{"transaction_id":{"type":"string","nullable":true,"description":"An ID that represents an API transaction"},"provider_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Store a related timestamp for reporting and troubleshooting purposes"},"provider_transaction_id":{"type":"string","nullable":true,"description":"Secondary transaction identifier (generated by a provider)"}},"required":["provider_timestamp","provider_transaction_id","transaction_id"]},"system_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"A system generated timestamp"},"rtoken":{"type":"string","nullable":true,"description":"A Galileo-generated ID used for tracking"},"errors":{"type":"array","description":"A list of errors generated while the request was processed","items":{"type":"string"}},"response_data":{"nullable":true,"type":"object","description":"A structure for the response data. It can be empty but usually will contain information.","required":["amortization_schedules","application_number","count_of_installments","first_installment_due_date","initial_projected_maturity_date","installment_amount","interest_rate","late_fee","loan_apr","origination_fee","rate_type","simulation_date","simulation_id","sub_product_id"],"properties":{"simulation_id":{"title":"simulation_id","type":"string","description":"Unique identifier associated with each loan simulation.","example":"450825953"},"interest_rate":{"title":"interest_rate","type":"number","description":"Interest rate applied to the loan, as defined by the subproduct","example":15},"sub_product_id":{"title":"sub_product_id","type":"string","description":"Identifier for the loan subproduct","example":"442824720"},"simulation_date":{"title":"simulation_date","pattern":"yyyy-MM-dd","type":"string","description":"Date the simulated loan is created.","format":"date","example":"2022-01-01"},"initial_projected_maturity_date":{"title":"initial_projected_maturity_date","pattern":"yyyy-MM-dd","type":"string","description":"Projected date when the loan will be paid off. This date is calculated only when a loan is simulated or created and cannot be sent again.","format":"date","example":"2022-07-01"},"itemization_of_amount_financed":{"title":"itemization_of_amount_financed","required":["disbursed_amount","loan_amount","projected_fees_amount","projected_interest_amount"],"type":"object","properties":{"loan_amount":{"title":"loan_amount","type":"number","description":"Total loan amount borrowed by the customer. This is the sum of the `disbursed_amount`, `origination_fee`, and any other fees associated with the loan.","example":10000},"disbursed_amount":{"title":"disbursed_amount","type":"number","description":"Total loan amount disbursed to the customer","example":10000},"projected_interest_amount":{"title":"projected_interest_amount","type":"number","description":"The total interest amount the borrower will be paying","example":10},"projected_fees_amount":{"title":"projected_fees_amount","type":"number","description":"Total fees that the customer is projected to pay over the course of the loan","example":10}}},"origination_fee":{"title":"origination_fee","type":"number","description":"Fee charged at loan creation. Returns 0 if there is no origination fee.","example":0},"rate_type":{"title":"rate_type","type":"string","description":"Indicates whether the interest type is `FIXED` or `VARIABLE.","example":"FIXED","enum":["fixed","variable"]},"application_number":{"title":"application_number","type":"string","description":"Unique identifier that you generate for the loan application. This identifier is associated with loan simulations. You can give this identifier to customers for customer service purposes.","example":"589841564"},"amortization_schedules":{"title":"amortization_schedules","type":"array","items":{"required":["amort_installment_number","amort_payment_amount","amort_payment_balance","amort_payment_due_date","amort_payment_fees","amort_payment_interest","amort_payment_principal"],"type":"object","properties":{"amort_installment_number":{"title":"amort_installment_number","type":"integer","description":"The number of the installment","format":"int32","example":1},"amort_payment_due_date":{"title":"amort_payment_due_date","pattern":"yyyy-MM-dd","type":"string","description":"Date that the payment for this installment is due","format":"date","example":"2022-02-01"},"amort_payment_amount":{"title":"amort_payment_amount","type":"number","description":"Total amount owed for this installment, including the principal amount,interest and fees","example":1740.34},"amort_payment_principal":{"title":"amort_payment_principal","type":"number","description":"Amount owed on the principal loan for this installment","example":1000},"amort_payment_fees":{"title":"amort_payment_fees","type":"number","description":"Fee amount that will be paid in each installment","example":7.51},"amort_payment_interest":{"title":"amort_payment_interest","type":"number","description":"Amount owed on the loan interest for this installment","example":10},"amort_payment_balance":{"title":"amort_payment_balance","type":"number","description":"Remaining balance after this installment is paid","example":2000}}}},"count_of_installments":{"title":"count_of_installments","pattern":"yyyy-MM-dd","type":"integer","description":"Number of installment scheduled","format":"int32","example":4},"installment_amount":{"title":"installment_amount","pattern":"yyyy-MM-dd","type":"number","description":"Payment due at each installment. This is the same amount as `amort_payment_amount`.","example":1740.34},"first_installment_due_date":{"title":"first_installment_due_date","pattern":"yyyy-MM-dd","type":"string","description":"Date the first installment is due","format":"date","example":"2022-02-01"},"loan_apr":{"title":"loan_apr","type":"number","description":"Annual percentage rate for interest charged on the loan. Calculated from the interest defined by the subproduct, the length of the loan, the origination fee (if applicable) and other fees (if applicable).","example":15},"late_fee":{"title":"late_fee","type":"number","description":"Late fee for the loan","example":5}}}},"required":["echo","processing_time","response_data","rtoken","status","status_code","system_timestamp"]},"examples":{"response":{"value":"<?xml version=\"1.0\" ?>\n<response>\n <status_code>0</status_code>\n <status>Success</status>\n <processing_time>1.386</processing_time>\n <response_data>\n <response_data>\n <amortization_schedules>\n <amortization_schedule>\n <element>\n <amort_installment_number>1</amort_installment_number>\n <amort_payment_amount>77.36</amort_payment_amount>\n <amort_payment_balance>232.09</amort_payment_balance>\n <amort_payment_due_date>2022-1-30</amort_payment_due_date>\n <amort_payment_fees>2.36</amort_payment_fees>\n <amort_payment_interest>0.0</amort_payment_interest>\n <amort_payment_principal>75.0</amort_payment_principal>\n </element>\n <element>\n <amort_installment_number>2</amort_installment_number>\n <amort_payment_amount>77.36</amort_payment_amount>\n <amort_payment_balance>154.73</amort_payment_balance>\n <amort_payment_due_date>2022-10-13</amort_payment_due_date>\n <amort_payment_fees>2.36</amort_payment_fees>\n <amort_payment_interest>0.0</amort_payment_interest>\n <amort_payment_principal>75.0</amort_payment_principal>\n </element>\n <element>\n <amort_installment_number>3</amort_installment_number>\n <amort_payment_amount>77.36</amort_payment_amount>\n <amort_payment_balance>77.37</amort_payment_balance>\n <amort_payment_due_date>2022-10-27</amort_payment_due_date>\n <amort_payment_fees>2.36</amort_
# --- truncated at 32 KB (259 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sofi-technologies/refs/heads/main/openapi/sofi-technologies-loan-api-openapi.json