openapi: 3.2.0 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: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' 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. For 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"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. Pattern: Max 30 characters Example: `"450825953"`.' default: '450825953' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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 - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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\n 0\n Success\n 0215\n \n charge_off\n 11118001000000140\n 0\n 500\n \n \n \n \n 145267123234243\n \n cf5ad196-18ae-4334-8da3-4c47c82fec19\n 2022-11-10 14:14:17\n\n" /1.0/simulateLoan: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' 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. 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' loanTerm: title: loanTerm maximum: 999999999 minimum: 1 type: integer description: 'Number of installments to pay off the loan. Pattern: Min 1 characters and max 9 characters. Example: 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 minimum: 0.01 type: number description: 'Total amount for the loan. Pattern: Decimal number (14,2). Example: `"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. Pattern: Max 9 digits. Example: `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. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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 - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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\n 0\n Success\n 1.386\n \n \n \n \n \n 1\n 77.36\n 232.09\n 2022-1-30\n 2.36\n 0.0\n 75.0\n \n \n 2\n 77.36\n 154.73\n 2022-10-13\n 2.36\n 0.0\n 75.0\n \n \n 3\n 77.36\n 77.37\n 2022-10-27\n 2.36\n 0.0\n 75.0\n \n \n 4\n 77.37\n 0.0\n 2022-10-11\n 2.37\n 0.0\n 75.0\n \n \n \n \n 4\n 2022-10-30\n 2022-12-11\n 77.36\n \n 300.0\n 300.0\n 9.45\n 0.0\n \n 0.0\n 32.52\n 0.0\n fixed\n 2022-10-16\n 1676315637005\n 8008\n \n a0888f94-fed6-4376-9567-3bga83ea902\n Success\n 0\n 2022-10-16 15:36:28\n" /1.0/getLoanTransactionHistory: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Get Loan Transaction History description: 'Use Get Loan Transaction History endpoint to provide a complete history of the transaction data associated with a particular business or consumer loan. Transaction data includes but is not limited to when a loan is created and funds disbursed, when fees were assessed, charged, waived, or reversed, and when a loan was charged off. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_getLoanTransactionHistory requestBody: content: application/x-www-form-urlencoded: schema: required: - loanId - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' sortKey: title: sortKey type: string description: "Sort key of the loan.\nPattern: Max 30 characters. \nExample: `123456`." default: id enum: - id page: title: page minimum: 1 type: integer description: 'Number of the page to retrieve. Pattern: Integar value of 1 or greater. Example: `1`.' format: int32 default: 1 recordCnt: title: recordCnt maximum: 1000 minimum: 1 type: integer description: "Maximum number of records per page to be returned.\nPattern: Max 3 characters. \nExample:`100`." format: int32 default: 100 sortDirection: title: sortDirection type: string description: 'Sort the record in ascending or descending order. Possible values: `ASC` - Ascending or `DESC` - Descending. Default: `ASC`.' default: ASC enum: - ASC - DESC loanId: title: loanId maxLength: 30 minLength: 1 type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' default: '450825953' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - loan_transactions - number_of_pages - page - principal_balance - total_record_count properties: principal_balance: title: principal_balance type: number description: Current principal balance remaining on the loan example: 10000 loan_transactions: type: array items: title: loan_transactions required: - amount_type - charge_code - loan_payment_number - loan_status_reason_code - loan_transaction_date - loan_transaction_effective_date - loan_transaction_id - payment_source - reversal_flag - total_charge_off_amount - transaction_amount - transaction_code type: object properties: loan_transaction_id: title: loan_transaction_id type: string description: Galileo-generated unique identifier for the payment on the loan. This is the same field as `loan_payment_number`provided in the Create Loan Payment API response. example: '450825953' transaction_code: title: transaction_code type: integer description: "Specifies the type of transaction. Possible values: \n\n* `9001` — Loan advance\n* `9099` — Advance reversal\n* `9002` — Regular payment\n* `9098` — Payment reversal\n* `9020` — Payoff\n* `9024` — Charge off\n* `9006` — Past due payment\n* `9005` — Installment past due" format: int32 example: 9006 transaction_amount: title: transaction_amount type: number description: Amount of the transaction example: 100 reversal_flag: title: reversal_flag type: boolean description: Returns `FALSE` by default. Returns `TRUE` on the duplicate transaction record when a loan or payment is reversed. example: true charge_code: title: charge_code type: integer description: "Specifies the fee type that is applied to the transaction. Possible values: \n\n* `8` — Origination fee\n* `9` — Late fee" format: int32 example: 8 loan_transaction_date: title: loan_transaction_date type: string description: Date of the business transaction format: date example: '2023-01-01' loan_transaction_effective_date: title: loan_transaction_effective_date type: string description: The effective date of the transaction. Use for backdating. format: date example: '2023-01-01' loan_payment_number: title: loan_payment_number type: string description: Galileo-generated unique identifier for the payment on the loan. This is the same field as `loan_payment_number`provided in the Create Loan Payment API response. example: '123' payment_source: title: payment_source type: string description: 'Specifies the source of the payment on the loan. Possible values: `USRP`, `SYSP`, `CRDP`, `CSRP`,`IVRP`,`DFRL`,`DWRO`,`PCRP`,`MCRP`,`RCRP`.' example: USRP total_charge_off_amount: title: total_charge_off_amount type: number description: Total amount of the loan that was charged off example: 100 loan_status_reason_code: title: loan_status_reason_code type: integer description: Reason provided for charging off the loan, as provided in the API request format: int32 example: 1010 amount_type: title: amount_type type: integer description: "Specifies whether the transaction was related to principal, interest, or fees. Possible values: \n\n* `4` — Principal\n* `5` — Interest\n* `64` — Fees" format: int32 example: 4 description: Contains all transaction data for the loan page: title: page type: integer description: The page number retrieved in the context of recordset paging format: int32 example: 1 total_record_count: title: total_record_count type: integer description: The total number of records returned. format: int32 example: 10 number_of_pages: title: number_of_pages type: integer description: Total number of pages. format: int32 example: 5 required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "{\n \"status_code\": \"0\",\n \"processing_time\": \"0.30\",\n \"echo\": {\n \"provider_transaction_id\": [],\n \"provider_timestamp\": [],\n \"transaction_id\": \"362516a8-1189-4540-a0e2-a2f9a66771d8\"\n },\n \"system_timestamp\": \"2023-07-27 12:32:06\",\n \"errors\": [],\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"response_data\": {\n \"total_record_count\": \"7\",\n \"page\": \"1\",\n \"number_of_pages\": \"1\",\n \"principal_balance\": \"372.52\",\n \"loan_transactions\": [\n {\n \"loan_transaction_id\": \"110476\",\n \"transaction_code\": \"9001\",\n \"transaction_amount\": \"400.00\",\n \"amount_type\": \"4\",\n \"charge_code\": [],\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": [],\n \"payment_source\": [],\n \"reversal_flag\": \"false\"\n },\n {\n \"loan_transaction_id\": \"110477\",\n \"transaction_code\": \"9002\",\n \"transaction_amount\": \"7.48\",\n \"amount_type\": \"4\",\n \"charge_code\": [],\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": \"16902324986230091\",\n \"payment_source\": \"USRP\",\n \"reversal_flag\": \"false\"\n },\n {\n \"loan_transaction_id\": \"110478\",\n \"transaction_code\": \"9002\",\n \"transaction_amount\": \"2.52\",\n \"amount_type\": \"41\",\n \"charge_code\": \"81\",\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": \"16902324986230091\",\n \"payment_source\": \"USRP\",\n \"reversal_flag\": \"false\"\n },\n {\n \"loan_transaction_id\": \"110479\",\n \"transaction_code\": \"9002\",\n \"transaction_amount\": \"10.00\",\n \"amount_type\": \"4\",\n \"charge_code\": [],\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": \"16902325414500119\",\n \"payment_source\": \"USRP\",\n \"reversal_flag\": \"false\"\n },\n {\n \"loan_transaction_id\": \"110480\",\n \"transaction_code\": \"9002\",\n \"transaction_amount\": \"10.00\",\n \"amount_type\": \"4\",\n \"charge_code\": [],\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": \"16902369713620053\",\n \"payment_source\": \"USRP\",\n \"reversal_flag\": \"false\"\n },\n {\n \"loan_transaction_id\": \"110534\",\n \"transaction_code\": \"9005\",\n \"transaction_amount\": \"52.52\",\n \"amount_type\": \"4\",\n \"charge_code\": [],\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": [],\n \"payment_source\": [],\n \"reversal_flag\": \"false\"\n },\n {\n \"loan_transaction_id\": \"110535\",\n \"transaction_code\": \"9005\",\n \"transaction_amount\": \"2.52\",\n \"amount_type\": \"41\",\n \"charge_code\": \"81\",\n \"total_charge_off_amount\": [],\n \"loan_status_reason_code\": [],\n \"loan_transaction_date\": \"2023-07-08\",\n \"loan_transaction_effective_date\": \"2023-07-08\",\n \"loan_payment_number\": [],\n \"payment_source\": [],\n \"reversal_flag\": \"false\"\n }\n ]\n },\n \"status\": \"Success\"\n }" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - loan_transactions - number_of_pages - page - principal_balance - total_record_count properties: principal_balance: title: principal_balance type: number description: Current principal balance remaining on the loan example: 10000 loan_transactions: type: array items: title: loan_transactions required: - amount_type - charge_code - loan_payment_number - loan_status_reason_code - loan_transaction_date - loan_transaction_effective_date - loan_transaction_id - payment_source - reversal_flag - total_charge_off_amount - transaction_amount - transaction_code type: object properties: loan_transaction_id: title: loan_transaction_id type: string description: Galileo-generated unique identifier for the payment on the loan. This is the same field as `loan_payment_number`provided in the Create Loan Payment API response. example: '450825953' transaction_code: title: transaction_code type: integer description: "Specifies the type of transaction. Possible values: \n\n* `9001` — Loan advance\n* `9099` — Advance reversal\n* `9002` — Regular payment\n* `9098` — Payment reversal\n* `9020` — Payoff\n* `9024` — Charge off\n* `9006` — Past due payment\n* `9005` — Installment past due" format: int32 example: 9006 transaction_amount: title: transaction_amount type: number description: Amount of the transaction example: 100 reversal_flag: title: reversal_flag type: boolean description: Returns `FALSE` by default. Returns `TRUE` on the duplicate transaction record when a loan or payment is reversed. example: true charge_code: title: charge_code type: integer description: "Specifies the fee type that is applied to the transaction. Possible values: \n\n* `8` — Origination fee\n* `9` — Late fee" format: int32 example: 8 loan_transaction_date: title: loan_transaction_date type: string description: Date of the business transaction format: date example: '2023-01-01' loan_transaction_effective_date: title: loan_transaction_effective_date type: string description: The effective date of the transaction. Use for backdating. format: date example: '2023-01-01' loan_payment_number: title: loan_payment_number type: string description: Galileo-generated unique identifier for the payment on the loan. This is the same field as `loan_payment_number`provided in the Create Loan Payment API response. example: '123' payment_source: title: payment_source type: string description: 'Specifies the source of the payment on the loan. Possible values: `USRP`, `SYSP`, `CRDP`, `CSRP`,`IVRP`,`DFRL`,`DWRO`,`PCRP`,`MCRP`,`RCRP`.' example: USRP total_charge_off_amount: title: total_charge_off_amount type: number description: Total amount of the loan that was charged off example: 100 loan_status_reason_code: title: loan_status_reason_code type: integer description: Reason provided for charging off the loan, as provided in the API request format: int32 example: 1010 amount_type: title: amount_type type: integer description: "Specifies whether the transaction was related to principal, interest, or fees. Possible values: \n\n* `4` — Principal\n* `5` — Interest\n* `64` — Fees" format: int32 example: 4 description: Contains all transaction data for the loan page: title: page type: integer description: The page number retrieved in the context of recordset paging format: int32 example: 1 total_record_count: title: total_record_count type: integer description: The total number of records returned. format: int32 example: 10 number_of_pages: title: number_of_pages type: integer description: Total number of pages. format: int32 example: 5 required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n0.30\n\n \n \n 362516a8-1189-4540-a0e2-a2f9a66771d8\n \n 2023-07-27 12:32:06\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n \n 7\n 1\n 1\n 372.52\n \n \n 110476\n 9001\n 400.00\n 4\n \n \n \n 2023-07-08\n 2023-07-08\n \n \n false\n \n \n 110477\n 9002\n 7.48\n 4\n \n \n \n 2023-07-08\n 2023-07-08\n 16902324986230091\n USRP\n false\n \n \n 110478\n 9002\n 2.52\n 41\n 81\n \n \n 2023-07-08\n 2023-07-08\n 16902324986230091\n USRP\n false\n \n \n 110479\n 9002\n 10.00\n 4\n \n \n \n 2023-07-08\n 2023-07-08\n 16902325414500119\n USRP\n false\n \n \n 110480\n 9002\n 10.00\n 4\n \n \n \n 2023-07-08\n 2023-07-08\n 16902369713620053\n USRP\n false\n \n \n 110534\n 9005\n 52.52\n 4\n \n \n \n 2023-07-08\n 2023-07-08\n \n \n false\n \n \n 110535\n 9005\n 2.52\n 41\n 81\n \n \n 2023-07-08\n 2023-07-08\n \n \n false\n \n \n \n Success\n\n" /1.0/getLoanStatus: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Get Loan Status description: 'Use the Get Loan Status endpoint to get the most recent information on a loan. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_getLoanStatus requestBody: content: application/x-www-form-urlencoded: schema: required: - loanId - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' loanId: title: loanId maxLength: 30 minLength: 1 type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' default: '450825953' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - installment_amount - interest_rate - loan_apr - loan_closed_date - loan_creation_date - loan_payment_status - loan_start_date - loan_status - next_installment_amount - next_installment_due_date - number_payments_made - number_payments_remaining - origination_fee - payoff_amount - per_diem_interest_amount - principal_balance - projected_maturity_date - rate_type - total_accrued_interest - total_fees_paid - total_interest_paid - total_principal_paid properties: 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 loan_creation_date: title: loan_creation_date pattern: yyyy-MM-dd type: string description: Date that the loan was created. This may be different from `loan_start_date`. format: date interest_rate: title: interest_rate type: number description: Interest rate applied to the loan, as defined by the subproduct example: 15 rate_type: title: rate_type type: string description: Indicates whether the interest type is `FIXED` or `VARIABLE. example: FIXED enum: - fixed - variable installment_amount: title: installment_amount type: number description: Payment due at each installment. This is the same amount as `amort_payment_amount`. example: 1740.34 next_installment_amount: title: next_installment_amount type: number description: "Payment due at the next installment. For example:\n\n * If an installment is unpaid and due tomorrow, this field is the amount due for tomorrow’s installment.\n * If an installment is partially paid and due tomorrow, this field is the remaining amount due.\n * If no payment is required until the next installment, this field is the next installment amount.\nSimilar logic applies to `next_installment_due_date`." example: 1740.34 next_installment_due_date: title: next_installment_due_date pattern: yyyy-MM-dd type: string description: "Date that the next installment is due. For example:\n\n * If an installment is unpaid and due tomorrow, this field is the due date (tomorrow).\n * If an installment is paid and due tomorrow, this field is the date when the next installment is due.\nSimilar logic applies to `next_installment_amount`. For a loan with a `Completed` or `Charged Off` account status, this field is empty." format: date example: '2022-02-01' principal_balance: title: principal_balance type: number description: Current principal balance remaining on the loan example: 10000 total_principal_paid: title: total_principal_paid type: number description: Principal amount of the loan that is paid off. example: 0 total_interest_paid: title: total_interest_paid type: number description: Interest amount of the loan that is paid off. example: 0 total_fees_paid: title: total_fees_paid type: number description: Total amount paid toward fees, including the origination fee and late fees. example: 0 total_accrued_interest: title: total_accrued_interest type: number description: Total interest accrued on the loan, including interest that has been paid. example: 0 loan_status: title: loan_status type: string description: Status of the loan. example: ACTIVE payoff_amount: title: payoff_amount type: number description: The total amount needed to pay off the remaining principal, accrued interest, and outstanding fees of a loan example: 10000 loan_closed_date: title: loan_closed_date type: string description: Date that the loan was closed, paid off, or charged off format: date example: '2022-06-21' per_diem_interest_amount: title: per_diem_interest_amount type: number description: Daily interest charged on the loan. This amount will update as installments are paid. example: 1.61363 number_payments_made: title: number_payments_made type: integer description: Number of installment payments that the customer has made on the loan. format: int32 example: 0 number_payments_remaining: title: number_payments_remaining type: integer description: Number of installment payments remaining on the loan. format: int32 example: 6 origination_fee: title: origination_fee type: number description: Fee charged at loan creation. Returns 0 if there is no origination fee. example: 0 loan_payment_status: title: loan_payment_status type: string description: Overall status of payments made on the loan. See the list of values in the Loan Payment Status and Loan Status table in the *Reports for Installment Loans* guide. example: OCUR projected_maturity_date: title: projected_maturity_date pattern: yyyy-MM-dd type: string description: Total interest that the customer is projected to pay over the course of the loan format: date example: '2022-07-01' loan_start_date: title: loan_start_date pattern: yyyy-MM-dd type: string description: Start date for the loan. This may be different from `loan_creation_date`. format: date example: '2022-06-02' 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\": 1.386,\n \"response_data\": {\n \"loan_apr\": 0,\n \"loan_creation_date\": \"2022-11-08\",\n \"interest_rate\": 0,\n \"rate_type\": \"fixed\",\n \"installment_amount\": 125,\n \"next_installment_amount\": 250,\n \"next_installment_due_date\": \"2022-11-08\",\n \"principal_balance\": 500,\n \"total_principal_paid\": 0,\n \"total_interest_paid\": 0,\n \"total_fees_paid\": 0,\n \"total_accrued_interest\": 0,\n \"loan_status\": \"Valid\",\n \"payoff_amount\": 500,\n \"loan_closed_date\": \"\",\n \"per_diem_interest_amount\": 0,\n \"number_payments_made\": 0,\n \"number_payments_remaining\": 4,\n \"origination_fee\": 0,\n \"loan_payment_status\": \"OPDE\",\n \"projected_maturity_date\": \"2022-12-20\",\n \"loan_start_date\": \"2022-11-08\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": \"8531bd42-dc77-4b54-81fe-58c3db1ed68f\"\n },\n \"system_timestamp\": \"2022-11-10 13:49:22\",\n \"rtoken\": \"f4b965fd-29fa-46d8-9dca-c2c27552bf95\",\n \"errors\": \"\"\n }\n}\n" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - installment_amount - interest_rate - loan_apr - loan_closed_date - loan_creation_date - loan_payment_status - loan_start_date - loan_status - next_installment_amount - next_installment_due_date - number_payments_made - number_payments_remaining - origination_fee - payoff_amount - per_diem_interest_amount - principal_balance - projected_maturity_date - rate_type - total_accrued_interest - total_fees_paid - total_interest_paid - total_principal_paid properties: 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 loan_creation_date: title: loan_creation_date pattern: yyyy-MM-dd type: string description: Date that the loan was created. This may be different from `loan_start_date`. format: date interest_rate: title: interest_rate type: number description: Interest rate applied to the loan, as defined by the subproduct example: 15 rate_type: title: rate_type type: string description: Indicates whether the interest type is `FIXED` or `VARIABLE. example: FIXED enum: - fixed - variable installment_amount: title: installment_amount type: number description: Payment due at each installment. This is the same amount as `amort_payment_amount`. example: 1740.34 next_installment_amount: title: next_installment_amount type: number description: "Payment due at the next installment. For example:\n\n * If an installment is unpaid and due tomorrow, this field is the amount due for tomorrow’s installment.\n * If an installment is partially paid and due tomorrow, this field is the remaining amount due.\n * If no payment is required until the next installment, this field is the next installment amount.\nSimilar logic applies to `next_installment_due_date`." example: 1740.34 next_installment_due_date: title: next_installment_due_date pattern: yyyy-MM-dd type: string description: "Date that the next installment is due. For example:\n\n * If an installment is unpaid and due tomorrow, this field is the due date (tomorrow).\n * If an installment is paid and due tomorrow, this field is the date when the next installment is due.\nSimilar logic applies to `next_installment_amount`. For a loan with a `Completed` or `Charged Off` account status, this field is empty." format: date example: '2022-02-01' principal_balance: title: principal_balance type: number description: Current principal balance remaining on the loan example: 10000 total_principal_paid: title: total_principal_paid type: number description: Principal amount of the loan that is paid off. example: 0 total_interest_paid: title: total_interest_paid type: number description: Interest amount of the loan that is paid off. example: 0 total_fees_paid: title: total_fees_paid type: number description: Total amount paid toward fees, including the origination fee and late fees. example: 0 total_accrued_interest: title: total_accrued_interest type: number description: Total interest accrued on the loan, including interest that has been paid. example: 0 loan_status: title: loan_status type: string description: Status of the loan. example: ACTIVE payoff_amount: title: payoff_amount type: number description: The total amount needed to pay off the remaining principal, accrued interest, and outstanding fees of a loan example: 10000 loan_closed_date: title: loan_closed_date type: string description: Date that the loan was closed, paid off, or charged off format: date example: '2022-06-21' per_diem_interest_amount: title: per_diem_interest_amount type: number description: Daily interest charged on the loan. This amount will update as installments are paid. example: 1.61363 number_payments_made: title: number_payments_made type: integer description: Number of installment payments that the customer has made on the loan. format: int32 example: 0 number_payments_remaining: title: number_payments_remaining type: integer description: Number of installment payments remaining on the loan. format: int32 example: 6 origination_fee: title: origination_fee type: number description: Fee charged at loan creation. Returns 0 if there is no origination fee. example: 0 loan_payment_status: title: loan_payment_status type: string description: Overall status of payments made on the loan. See the list of values in the Loan Payment Status and Loan Status table in the *Reports for Installment Loans* guide. example: OCUR projected_maturity_date: title: projected_maturity_date pattern: yyyy-MM-dd type: string description: Total interest that the customer is projected to pay over the course of the loan format: date example: '2022-07-01' loan_start_date: title: loan_start_date pattern: yyyy-MM-dd type: string description: Start date for the loan. This may be different from `loan_creation_date`. format: date example: '2022-06-02' required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n Success\n 1.386\n \n 0\n 2022-11-08\n 0\n fixed\n 125\n 250\n 2022-11-08\n 500\n 0\n 0\n 0\n 0\n Valid\n 500\n \n 0\n 0\n 4\n 0\n OPDE\n 2022-12-20\n 2022-11-08\n \n \n \n \n 8531bd42-dc77-4b54-81fe-58c3db1ed68f\n \n f4b965fd-29fa-46d8-9dca-c2c27552bf95\n 2022-11-10 13:49:22\n\n" /1.0/getLoanPaymentSchedule: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Get Loan Payment Schedule description: 'Use the Get Loan Payment Schedule endpoint to get a history of payments made on the loan along with a real-time view of future payments owed. This endpoint reflects changes to the installment amount that can occur for various reasons, like a merchant refund. Get Loan Payment Schedule returns the updated amount owed on future installments, but the due dates remain the same as provided in the amortization schedule. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_getLoanPaymentSchedule requestBody: content: application/x-www-form-urlencoded: schema: required: - loanId - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' loanId: title: loanId maxLength: 30 minLength: 1 type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' default: '450825953' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - late_fee - total_fees_paid - total_interest_paid - total_principal_paid properties: total_principal_paid: title: total_principal_paid type: number description: Principal amount of the loan that is paid off. example: 0 total_interest_paid: title: total_interest_paid type: number description: Interest amount of the loan that is paid off. example: 0 total_fees_paid: title: total_fees_paid type: number description: Total amount paid toward fees, including the origination fee and late fees. example: 0 late_fee: title: late_fee type: number description: Total amount owed on late fees. example: 2000 payments_schedule: title: payments_schedule type: array description: List of payment schedule. items: title: payments_schedule required: - scheduled_amount_due - scheduled_balance_amount - scheduled_due_date - scheduled_installment_number - scheduled_interest_amount - scheduled_late_fee_due - scheduled_principal_amount type: object properties: scheduled_installment_number: title: scheduled_installment_number type: integer description: Indicates the number of the installment. example: 2 scheduled_due_date: title: scheduled_due_date type: string description: Date that the payment for this installment is due. format: date scheduled_amount_due: title: scheduled_amount_due type: number description: Total amount owed for this installment, including the principal amount and interest. example: 857.47 scheduled_principal_amount: title: scheduled_principal_amount type: number description: Amount owed on the principal loan for this installment. example: 2 scheduled_interest_amount: title: scheduled_interest_amount type: number description: Amount owed on the loan interest for this installment. example: 836.67 scheduled_late_fee_due: title: scheduled_late_fee_due type: number description: Late fee amount due for this installment. If no late fee is due, the amount is 0.00. example: 2000 scheduled_balance_amount: title: scheduled_balance_amount type: number description: '2000.00' description: List of payment schedule. payments_history: title: payments_history type: array description: Contains the record for each payment previously made on the loan. If none of the installments are paid, you will not receive the details for `payments_history`. items: title: payments_history required: - hist_payment_amount - hist_payment_date - hist_payment_fees - hist_payment_interest - hist_payment_principal - scheduled_balance_amount type: object properties: hist_payment_date: title: hist_payment_date type: string description: Date that this payment was made. format: date hist_payment_amount: title: hist_payment_amount type: number description: The total amount paid on this payment. example: 2000 hist_payment_principal: title: hist_payment_principal type: number description: Amount paid on the principal loan amount for this payment. example: 2000 hist_payment_interest: title: hist_payment_interest type: number description: Amount paid on the loan interest for this payment. example: 2000 hist_payment_fees: title: hist_payment_fees type: number description: mount paid on loan fees for this payment. example: 2000 scheduled_balance_amount: title: hist_payment_balance type: number description: Remaining balance after this payment was made. example: 2000 hist_payment_source: type: string enum: - USRP - SYSP - CRDP - CSRP - IVRP - DFRL - DWRO - PCRP - MCRP - RCRP - ADLP description: Contains the record for each payment previously made on the loan. If none of the installments are paid, you will not receive the details for `payments_history`. 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\": 1.795,\n \"response_data\": {\n \"total_principal_paid\": 200,\n \"total_interest_paid\": 0,\n \"total_fees_paid\": 0,\n \"late_fee\": 0,\n \"payments_history\": {\n \"key\": [\n {\n \"hist_payment_date\": \"2022-11-10\",\n \"hist_payment_amount\": 100,\n \"hist_payment_interest\": 0,\n \"hist_payment_principal\": 100,\n \"scheduled_balance_amount\": 400,\n \"hist_payment_fees\": 0,\n \"hist_payment_source\": \"USRP\"\n },\n {\n \"hist_payment_date\": \"2022-11-10\",\n \"hist_payment_amount\": 100,\n \"hist_payment_interest\": 0,\n \"hist_payment_principal\": 100,\n \"scheduled_balance_amount\": 300,\n \"hist_payment_fees\": 0,\n \"hist_payment_source\": \"USRP\"\n }\n ]\n },\n \"payments_schedule\": {\n \"key\": [\n {\n \"scheduled_installment_number\": 2,\n \"scheduled_due_date\": \"2022-11-24\",\n \"scheduled_amount_due\": 50,\n \"scheduled_principal_amount\": 50,\n \"scheduled_interest_amount\": 0,\n \"scheduled_late_fee_due\": 0,\n \"scheduled_balance_amount\": 250\n },\n {\n \"scheduled_installment_number\": 3,\n \"scheduled_due_date\": \"2022-12-08\",\n \"scheduled_amount_due\": 125,\n \"scheduled_principal_amount\": 125,\n \"scheduled_interest_amount\": 0,\n \"scheduled_late_fee_due\": 0,\n \"scheduled_balance_amount\": 125\n },\n {\n \"scheduled_installment_number\": 4,\n \"scheduled_due_date\": \"2022-12-22\",\n \"scheduled_amount_due\": 125,\n \"scheduled_principal_amount\": 125,\n \"scheduled_interest_amount\": 0,\n \"scheduled_late_fee_due\": 0,\n \"scheduled_balance_amount\": 0\n }\n ]\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": \"test123123\"\n },\n \"system_timestamp\": \"2022-11-10 13:59:39\",\n \"rtoken\": \"928b808d-3c53-464b-8b2b-65d26329286f\",\n \"errors\": \"\"\n }\n}\n" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - late_fee - total_fees_paid - total_interest_paid - total_principal_paid properties: total_principal_paid: title: total_principal_paid type: number description: Principal amount of the loan that is paid off. example: 0 total_interest_paid: title: total_interest_paid type: number description: Interest amount of the loan that is paid off. example: 0 total_fees_paid: title: total_fees_paid type: number description: Total amount paid toward fees, including the origination fee and late fees. example: 0 late_fee: title: late_fee type: number description: Total amount owed on late fees. example: 2000 payments_schedule: title: payments_schedule type: array description: List of payment schedule. items: title: payments_schedule required: - scheduled_amount_due - scheduled_balance_amount - scheduled_due_date - scheduled_installment_number - scheduled_interest_amount - scheduled_late_fee_due - scheduled_principal_amount type: object properties: scheduled_installment_number: title: scheduled_installment_number type: integer description: Indicates the number of the installment. example: 2 scheduled_due_date: title: scheduled_due_date type: string description: Date that the payment for this installment is due. format: date scheduled_amount_due: title: scheduled_amount_due type: number description: Total amount owed for this installment, including the principal amount and interest. example: 857.47 scheduled_principal_amount: title: scheduled_principal_amount type: number description: Amount owed on the principal loan for this installment. example: 2 scheduled_interest_amount: title: scheduled_interest_amount type: number description: Amount owed on the loan interest for this installment. example: 836.67 scheduled_late_fee_due: title: scheduled_late_fee_due type: number description: Late fee amount due for this installment. If no late fee is due, the amount is 0.00. example: 2000 scheduled_balance_amount: title: scheduled_balance_amount type: number description: '2000.00' description: List of payment schedule. payments_history: title: payments_history type: array description: Contains the record for each payment previously made on the loan. If none of the installments are paid, you will not receive the details for `payments_history`. items: title: payments_history required: - hist_payment_amount - hist_payment_date - hist_payment_fees - hist_payment_interest - hist_payment_principal - scheduled_balance_amount type: object properties: hist_payment_date: title: hist_payment_date type: string description: Date that this payment was made. format: date hist_payment_amount: title: hist_payment_amount type: number description: The total amount paid on this payment. example: 2000 hist_payment_principal: title: hist_payment_principal type: number description: Amount paid on the principal loan amount for this payment. example: 2000 hist_payment_interest: title: hist_payment_interest type: number description: Amount paid on the loan interest for this payment. example: 2000 hist_payment_fees: title: hist_payment_fees type: number description: mount paid on loan fees for this payment. example: 2000 scheduled_balance_amount: title: hist_payment_balance type: number description: Remaining balance after this payment was made. example: 2000 hist_payment_source: type: string enum: - USRP - SYSP - CRDP - CSRP - IVRP - DFRL - DWRO - PCRP - MCRP - RCRP - ADLP description: Contains the record for each payment previously made on the loan. If none of the installments are paid, you will not receive the details for `payments_history`. required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n Success\n 1.795\n \n 200\n 0\n 0\n 0\n \n \n 2022-11-10\n 100\n 0\n 100\n 400\n 0\n USRP\n \n \n 2022-11-10\n 100\n 0\n 100\n 300\n 0\n USRP\n \n \n \n 2\n 2022-11-24\n 50\n 50\n 0\n 0\n 250\n \n \n 3\n 2022-12-08\n 125\n 125\n 0\n 0\n 125\n \n \n 4\n 2022-12-22\n 125\n 125\n 0\n 0\n 0\n \n \n \n \n \n \n test123123\n \n 928b808d-3c53-464b-8b2b-65d26329286f\n 2022-11-10 13:59:39\n" /1.0/getLoanInstallmentStatuses: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Get Loan Installment Statuses description: 'Use the Get Loan Installment Statuses endpoint to view individual installment status across all installments. This returns the details for each installment, including the status, payment due date, date paid, amount paid, and remaining balance. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_getLoanInstallmentStatuses requestBody: content: application/x-www-form-urlencoded: schema: required: - loanId - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' loanId: title: loanId maxLength: 30 minLength: 1 type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' default: '450825953' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - installment_status_details properties: installment_status_details: title: installment_status_details type: array description: Installment status details list items: title: installment_status_details required: - amort_installment_number - amort_payment_amount - amort_payment_due_date - hist_payment_balance - installment_paid_date - installment_status type: object properties: installment_status: title: installment_status type: string description: 'Status for the installment. Possible statuses are: `Scheduled`, `Paid`, `Paid Late`, `Unpaid`.' example: Unpaid installment_paid_date: title: installment_paid_date pattern: yyyy-MM-dd type: string description: Date the installment was completely paid format: date 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 hist_payment_balance: title: hist_payment_balance type: number description: Remaining balance of the installment. Returns '0.00' if an installment is paid. example: 2000 description: Installment status details list 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\": 1.001,\n \"response_data\": {\n \"installment_status_details\": {\n \"installment_status_detail\": [\n {\n \"installment_status\": \"Paid\",\n \"installment_paid_date\": \"2022-11-10\",\n \"amort_installment_number\": 1,\n \"amort_payment_due_date\": \"2022-11-10\",\n \"amort_payment_amount\": 125,\n \"hist_payment_balance\": 0\n },\n {\n \"installment_status\": \"Scheduled\",\n \"installment_paid_date\": \"\",\n \"amort_installment_number\": 2,\n \"amort_payment_due_date\": \"2022-11-24\",\n \"amort_payment_amount\": 125,\n \"hist_payment_balance\": 50\n },\n {\n \"installment_status\": \"Scheduled\",\n \"installment_paid_date\": \"\",\n \"amort_installment_number\": 3,\n \"amort_payment_due_date\": \"2022-12-08\",\n \"amort_payment_amount\": 125,\n \"hist_payment_balance\": 125\n },\n {\n \"installment_status\": \"Scheduled\",\n \"installment_paid_date\": \"\",\n \"amort_installment_number\": 4,\n \"amort_payment_due_date\": \"2022-12-22\",\n \"amort_payment_amount\": 125,\n \"hist_payment_balance\": 125\n }\n ]\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": 12312234\n },\n \"system_timestamp\": \"2022-11-10 13:56:15\",\n \"rtoken\": \"ccb3951a-7d20-4c4c-907f-7b74ec747e9d\",\n \"errors\": \"\"\n }\n}\n" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - installment_status_details properties: installment_status_details: title: installment_status_details type: array description: Installment status details list items: title: installment_status_details required: - amort_installment_number - amort_payment_amount - amort_payment_due_date - hist_payment_balance - installment_paid_date - installment_status type: object properties: installment_status: title: installment_status type: string description: 'Status for the installment. Possible statuses are: `Scheduled`, `Paid`, `Paid Late`, `Unpaid`.' example: Unpaid installment_paid_date: title: installment_paid_date pattern: yyyy-MM-dd type: string description: Date the installment was completely paid format: date 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 hist_payment_balance: title: hist_payment_balance type: number description: Remaining balance of the installment. Returns '0.00' if an installment is paid. example: 2000 description: Installment status details list required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n Success\n 1.001\n \n \n \n Paid\n 2022-11-10\n 1\n 2022-11-10\n \n 0\n \n \n Scheduled\n \n 2\n 2022-11-24\n 125\n 50\n \n \n Scheduled\n \n 3\n 2022-12-08\n 125\n 125\n \n \n Scheduled\n \n 4\n 2022-12-22\n 125\n 125\n \n \n \n \n \n \n 12312234\n \n ccb3951a-7d20-4c4c-907f-7b74ec747e9d\n 2022-11-10 13:56:15\n\n" /1.0/createSMBLoan: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Create SMB Loan description: 'Use the Create SMB Loan endpoint to create a small and midsize business (SMB) installment loan for a customer. Loan subproducts are configured for your installment loans product and are assigned a subproduct ID. Ensure you have the required customer data to create a loan. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_createSMBLoan requestBody: content: application/x-www-form-urlencoded: schema: required: - address1 - capitalTerm - city - countryCode - customerPmtRefNo - disbursementDestinationType - loanTerm - ownerId - postalCode - state - subProductId - taxId - taxIdType - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' 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' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' simulationId: title: simulationId maxLength: 30 minLength: 1 type: string description: 'Unique identifier associated with each loan simulation returned by the Simulate Loan endpoint. Required when creating a loan from a simulation. Do not pass the following fields when the simulationId is provided: `totalLoanAmount`, `loanTerm`, and `capitalTerm`. Pattern: Max 9 characters. Example: `"450825953"`.' taxIdType: title: taxIdType type: string description: "Identifies whether the tax ID is Employer Identification Number (EIN), Social Security Number (SSN), or an Individual Taxpayer Identification Number (ITIN). \nPattern: EIN, SSN, ITIN.\nExample: `\"EIN\"`." enum: - EIN - ITIN - SSN default: EIN taxId: title: taxId pattern: ^[0-9]{9}$ type: string description: 'Loan applicant’s 9 digit taxpayer identification number. Pattern: Exactly 9 digits, no hyphens or other characters. Example: `"222554444"`.' default: '222554444' ownerId: title: ownerId pattern: ^[a-zA-Z0-9]{1,30}$ type: string description: 'Indicates the ownership of the loan assets. Pattern: Max 30 characters. Example: `"845dk-39fdk3fj3-4483483478"`.' default: 9845dk-39fdk3fj3-4483483478 phone: title: phone maxLength: 10 minLength: 10 type: string description: 'Loan applicant’s phone number. Pattern: Exactly 10 digits, no hyphens or other characters. Example: `"1115553333"`.' email: title: email maxLength: 63 minLength: 3 type: string description: 'Loan applicant’s email address. Pattern: Email address, 3–63 characters. Example: `"user@fakedomain.com"`.' address1: title: address1 maxLength: 40 minLength: 4 type: string description: "Loan applicant’s first address line. Cannot be a P.O. box. [Validation rules for address1](ref:api-reference-address1-validation). \nPattern: 4–40 alphanumeric characters.\nExample: `\"33 Maple Street\"`." default: 33 Maple Street address2: title: address2 maxLength: 30 minLength: 1 type: string description: 'Loan applicant’s second address line. Pattern: Max 30 characters. Example: `"#4B"`.' city: title: city maxLength: 30 minLength: 1 type: string description: 'Loan applicant’s city. Pattern: Max 30 characters: letters, spaces, hyphen and period. Example: `"Salt Lake City"`.' default: Salt Lake City state: title: state maxLength: 2 minLength: 2 type: string description: 'Loan applicant’s state or province. Pattern: 2-character state or province abbreviation. Example: `"UT"`.' default: UT postalCode: title: postalCode maxLength: 10 minLength: 5 pattern: ^[a-zA-Z0-9\-\ ]*$ type: string description: 'Loan applicant’s postal code (ZIP code). Pattern: Min 5 characters and max 10 characters (12345, 12345-1234, or K1A-1A1). Example: `"84121"`.' default: '84121' countryCode: title: countryCode type: string description: 'Loan applicant’s country. Three-digit UN M49 country code. Currently the only allowed value is 840 for the USA. Pattern: 3-digit country code.' enum: - '840' default: '840' 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. totalLoanAmount: title: totalLoanAmount maximum: 99999999999999.98 minimum: 0.01 type: number description: 'Total amount for the loan. Pattern: Decimal number (14,2). Example: `"700.00"`.' loanTerm: title: loanTerm maximum: 999999999 minimum: 1 type: integer description: 'Number of installments to pay off the loan. Pattern: Min 1 characters and max 9 characters. Example: 4.' format: int32 default: 4 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. Pattern: Max 9 digits. Example: `2`.' format: int32 default: 2 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 responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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 - late_fee - loan_apr - loan_creation_date - loan_id - loan_start_date - origination_fee - rate_type properties: loan_id: title: loan_id type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' example: '450825953' 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 loan_creation_date: title: loan_creation_date pattern: yyyy-MM-dd type: string description: Date that the loan was created. This may be different from `loan_start_date`. format: date rate_type: title: rate_type type: string description: Indicates whether the interest type is `FIXED` or `VARIABLE. example: FIXED enum: - fixed - variable origination_fee: title: origination_fee type: number description: Fee charged at loan creation. Returns 0 if there is no origination fee. example: 0 late_fee: title: late_fee type: number description: Late fee for the loan example: 5 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' 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' 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 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 loan_start_date: title: loan_start_date pattern: yyyy-MM-dd type: string description: Start date for the loan. This may be different from `loan_creation_date`. format: date example: '2022-06-02' 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' 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\": 3.894,\n \"response_data\": {\n \"loan_apr\": 14.79,\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\": 1231231232,\n \"itemization_of_amount_financed\": {\n \"loan_amount\": 400.0,\n \"disbursed_amount\": 400.0,\n \"projected_interest_amount\": 0.0,\n\t \"projected_fees_amount\": 12.6\n },\n \"amortization_schedules\": {\n \"amortization_schedule\": [\n {\n \"amort_installment_number\": 1,\n \"amort_payment_due_date\": \"2023-02-17\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 378.22,\n },\n {\n \"amort_installment_number\": 2,\n \"amort_payment_due_date\": \"2023-03-03\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 343.84,\n },\n {\n \"amort_installment_number\": 3,\n \"amort_payment_due_date\": \"2023-03-17\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 309.46,\n },\n {\n \"amort_installment_number\": 4,\n \"amort_payment_due_date\": \"2023-03-31\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 275.08,\n },\n\t\t {\n \"amort_installment_number\": 5,\n \"amort_payment_due_date\": \"2023-04-14\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 240.7,\n },\n {\n \"amort_installment_number\": 6,\n \"amort_payment_due_date\": \"2023-04-28\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 206.32,\n },\n {\n \"amort_installment_number\": 7,\n \"amort_payment_due_date\": \"2023-02-17\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 378.22,\n },\n {\n \"amort_installment_number\": 8,\n \"amort_payment_due_date\": \"2023-05-12\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 137.56,\n },\n {\n \"amort_installment_number\": 9,\n \"amort_payment_due_date\": \"2023-06-09\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 103.18,\n },\n {\n \"amort_installment_number\": 10,\n \"amort_payment_due_date\": \"2023-06-23\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 68.8,\n },\n {\n \"amort_installment_number\": 11,\n \"amort_payment_due_date\": \"2023-07-07\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 34.42,\n },\n {\n \"amort_installment_number\": 12,\n \"amort_payment_due_date\": \"2023-07-21\",\n \"amort_payment_amount\": 34.38,\n \"amort_payment_principal\": 33.33,\n \"amort_payment_fees\": 1.05,\n \"amort_payment_interest\": 0.0,\n \"amort_payment_balance\": 0.0,\n }\n ]\n },\n \"count_of_installments\": 12,\n \"installment_amount\": 34.38,\n \"first_installment_due_date\": \"2023-02-17\",\n \"loan_id\": 11118008000000023,\n \"loan_creation_date\": \"2023-02-17\",\n \"loan_start_date\": \"2023-02-17\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": 818517296121222\n },\n \"system_timestamp\": \"2023-02-21 15:36:28\",\n \"rtoken\": \"a0888f94-fed6-4376-9567-3bfa8b3ea902\",\n \"errors\": \"\"\n }\n}\n" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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 - late_fee - loan_apr - loan_creation_date - loan_id - loan_start_date - origination_fee - rate_type properties: loan_id: title: loan_id type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' example: '450825953' 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 loan_creation_date: title: loan_creation_date pattern: yyyy-MM-dd type: string description: Date that the loan was created. This may be different from `loan_start_date`. format: date rate_type: title: rate_type type: string description: Indicates whether the interest type is `FIXED` or `VARIABLE. example: FIXED enum: - fixed - variable origination_fee: title: origination_fee type: number description: Fee charged at loan creation. Returns 0 if there is no origination fee. example: 0 late_fee: title: late_fee type: number description: Late fee for the loan example: 5 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' 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' 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 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 loan_start_date: title: loan_start_date pattern: yyyy-MM-dd type: string description: Start date for the loan. This may be different from `loan_creation_date`. format: date example: '2022-06-02' 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' required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n \n \n \n 818517296121222\n \n \n 3.894\n \n \n \n 1\n 34.38\n 378.22\n 2023-02-17\n 1.05\n 0.0\n 33.33\n \n \n 2\n 34.38\n 343.84\n 2023-03-03\n 1.05\n 0.0\n 33.33\n \n \n 3\n 34.38\n 309.46\n 2023-03-17\n 1.05\n 0.0\n \n \n 4\n 34.38\n 275.08\n 2023-03-31\n 1.05\n 0.0\n 33.33\n \n \n 5\n 34.38\n 240.7\n 2023-04-14\n 1.05\n 0.0\n 33.33\n \n \n 6\n 34.38\n 206.32\n 2023-04-28\n 1.05\n 0.0\n 33.33\n \n \n 7\n 34.38\n 378.22\n 2023-02-17\n 1.05\n 0.0\n 33.33\n \n \n 8\n 34.38\n 137.56\n 2023-05-12\n 1.05\n 0.0\n 33.33\n \n \n 9\n 34.38\n 103.18\n 2023-06-09\n 1.05\n 0.0\n 33.33\n \n \n 10\n 34.38\n 68.8\n 2023-06-23\n 1.05\n 0.0\n 33.33\n \n \n 11\n 34.38\n 34.42\n 2023-07-07\n 1.05\n 0.0\n 33.33\n \n \n 12\n 34.38\n 0.0\n 2023-07-21\n 1.05\n 0.0\n 33.33\n \n \n 1231231232\n 12\n 2023-02-17\n 2023-07-21\n 34.38\n \n 400.0\n 400.0\n 12.6\n 0.0\n \n 0.0\n 14.79\n 2023-02-17\n 11118008000000023\n 2023-02-17\n 0.0\n fixed\n \n a0888f94-fed6-4376-9567-3bfa8b3ea902\n 2023-02-21 15:36:28\n" /1.0/createLoan: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Create Loan description: 'Use the Create Loan endpoint to create a loan offering for a customer. Loan subproducts are configured for your installment loans product and are assigned a subproduct ID. Ensure you have the required customer data to create a loan. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_createLoan requestBody: content: application/x-www-form-urlencoded: schema: required: - address1 - capitalTerm - city - countryCode - customerPmtRefNo - disbursementDestinationType - loanTerm - postalCode - ssn - state - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' 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' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' simulationId: title: simulationId maxLength: 30 minLength: 1 type: string description: 'Unique identifier associated with each loan simulation returned by the Simulate Loan endpoint. Required when creating a loan from a simulation. Do not pass the following fields when the simulationId is provided: `totalLoanAmount`, `loanTerm`, and `capitalTerm`. Pattern: Max 9 characters. Example: `"450825953"`.' ssn: title: ssn maxLength: 9 minLength: 9 pattern: ^[0-9]*$ type: string description: 'Loan applicant’s SSN. Pattern: Exactly 9 digits, no hyphens or other characters. Example: `"222554444"`.' default: '222554444' phone: title: phone maxLength: 10 minLength: 10 type: string description: 'Loan applicant’s phone number. Pattern: Exactly 10 digits, no hyphens or other characters. Example: `"1115553333"`.' email: title: email maxLength: 63 minLength: 3 type: string description: 'Loan applicant’s email address. Pattern: Email address, 3–63 characters. Example: `"user@fakedomain.com"`.' address1: title: address1 maxLength: 40 minLength: 4 type: string description: "Loan applicant’s first address line. Cannot be a P.O. box. [Validation rules for address1](ref:api-reference-address1-validation). \nPattern: 4–40 alphanumeric characters.\nExample: `\"33 Maple Street\"`." default: 33 Maple Street address2: title: address2 maxLength: 30 minLength: 1 type: string description: 'Loan applicant’s second address line. Pattern: Max 30 characters. Example: `"#4B"`.' city: title: city maxLength: 30 minLength: 1 type: string description: 'Loan applicant’s city. Pattern: Max 30 characters: letters, spaces, hyphen and period. Example: `"Salt Lake City"`.' default: Salt Lake City state: title: state maxLength: 2 minLength: 2 type: string description: 'Loan applicant’s state or province. Pattern: 2-character state or province abbreviation. Example: `"UT"`.' default: UT postalCode: title: postalCode maxLength: 10 minLength: 5 pattern: ^[a-zA-Z0-9\-\ ]*$ type: string description: 'Loan applicant’s postal code (ZIP code). Pattern: Min 5 characters and max 10 characters (12345, 12345-1234, or K1A-1A1). Example: `"84121"`.' default: '84121' countryCode: title: countryCode type: string description: 'Loan applicant’s country. Three-digit UN M49 country code. Currently the only allowed value is 840 for the USA. Pattern: 3-digit country code.' enum: - '840' default: '840' occupation: title: occupation maxLength: 25 minLength: 1 type: string description: 'Loan applicant’s occupation. Pattern: Max 25 characters. Example: `"Project Manager"`.' employer: title: employer maxLength: 200 minLength: 1 type: string description: 'Loan applicant’s employer. Pattern: Max 200 characters. Example: `"Kroger Food & Drug"`.' 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. totalLoanAmount: title: totalLoanAmount maximum: 99999999999999.98 minimum: 0.01 type: number description: 'Total amount for the loan. Pattern: Decimal number (14,2). Example: `"700.00"`.' loanTerm: title: loanTerm maximum: 999999999 minimum: 1 type: integer description: 'Number of installments to pay off the loan. Pattern: Min 1 characters and max 9 characters. Example: 4.' format: int32 default: 4 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. Pattern: Max 9 digits. Example: `2`.' format: int32 default: 2 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 responses: '200': description: Success content: application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. properties: errors: type: array items: type: string status: type: string status_code: type: string rtoken: type: string echo: type: object properties: transaction_id: type: string provider_transaction_id: type: string provider_timestamp: type: string processing_time: type: number response_data: type: object system_timestamp: type: string format: date-time required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n Success\n 0.23\n \n 0\n fixed\n 0\n 0\n 2022-12-22\n 1231231232\n \n 500\n 500\n 0\n \n \n \n 1\n 2022-11-10\n 125\n 0\n 375\n 125\n \n \n 2\n 2022-11-24\n 125\n 0\n 250\n 125\n \n \n 3\n 2022-12-08\n 125\n 0\n 125\n 125\n \n \n 4\n 2022-12-22\n 125\n 0\n 0\n 125\n \n \n 4\n 125\n 2022-11-10\n 11118000000426804\n 2022-11-10\n 2022-11-10\n \n \n \n \n 818517296121222\n \n a0888f94-fed6-4376-9567-3bfa8b3ea901\n 2022-11-10 13:45:01\n\n" application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. properties: errors: type: array items: type: string status: type: string status_code: type: string rtoken: type: string echo: type: object properties: transaction_id: type: string provider_transaction_id: type: string provider_timestamp: type: string processing_time: type: number response_data: type: object system_timestamp: type: string format: date-time 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\": 0.23,\n \"response_data\": {\n \"loan_apr\": 0,\n \"rate_type\": \"fixed\",\n \"origination_fee\": 0,\n \"late_fee\": 0,\n \"initial_projected_maturity_date\": \"2022-12-22\",\n \"application_number\": 1231231232,\n \"itemization_of_amount_financed\": {\n \"loan_amount\": 500,\n \"disbursed_amount\": 500,\n \"projected_interest_amount\": 0\n },\n \"amortization_schedules\": {\n \"amortization_schedule\": [\n {\n \"amort_installment_number\": 1,\n \"amort_payment_due_date\": \"2022-11-10\",\n \"amort_payment_principal\": 125,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 375,\n \"amort_payment_amount\": 125\n },\n {\n \"amort_installment_number\": 2,\n \"amort_payment_due_date\": \"2022-11-24\",\n \"amort_payment_principal\": 125,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 250,\n \"amort_payment_amount\": 125\n },\n {\n \"amort_installment_number\": 3,\n \"amort_payment_due_date\": \"2022-12-08\",\n \"amort_payment_principal\": 125,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 125,\n \"amort_payment_amount\": 125\n },\n {\n \"amort_installment_number\": 4,\n \"amort_payment_due_date\": \"2022-12-22\",\n \"amort_payment_principal\": 125,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 0,\n \"amort_payment_amount\": 125\n }\n ]\n },\n \"count_of_installments\": 4,\n \"installment_amount\": 125,\n \"first_installment_due_date\": \"2022-11-10\",\n \"loan_id\": 11118000000426804,\n \"loan_creation_date\": \"2022-11-10\",\n \"loan_start_date\": \"2022-11-10\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": 818517296121222\n },\n \"system_timestamp\": \"2022-11-10 13:45:01\",\n \"rtoken\": \"a0888f94-fed6-4376-9567-3bfa8b3ea901\",\n \"errors\": \"\"\n}\n" /1.0/createLoanPayment: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Create Loan Payment description: 'Use the Create Loan Payment endpoint when a customer requests to make a payment on a loan. The endpoint supports two types of payments today - payments from a primary account where Galileo orchestrates debiting the DDA and paying the loan, or payments from an ''external'' account where the program manager accepts the funds and Galileo only manifests the loan payment. For optional parameters, do not pass an empty string or null value.' operationId: lending_post_createLoanPayment requestBody: content: application/x-www-form-urlencoded: schema: required: - loanId - paymentAccountType - paymentAmount - paymentSource - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' paymentAmount: title: paymentAmount maximum: 99999999999999.98 minimum: 0.01 type: number description: The amount of payment to be applied to the loan. default: 2000 paymentSource: title: paymentSource type: string description: 'Code indicating the source of this payment, as passed in the Create Loan Payment `paymentSource` field. Possible values: `USRP`, `SYSP`, `CRDP`, `CSRP`,`IVRP`,`DFRL`,`DWRO`,`PCRP`,`MCRP`,`RCRP`.' enum: - USRP - SYSP - CRDP - CSRP - IVRP - DFRL - DWRO - PCRP - MCRP - RCRP - ADLP loanId: title: loanId maxLength: 30 minLength: 1 type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' default: '450825953' subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - amount - current_installment_balance - current_installment_due_date - initial_projected_maturity_date - payoff_amount - per_diem_interest_amount - principle_balance properties: amount: title: amount type: number description: The total amount of the payment transaction. example: 4822.3 current_installment_balance: title: current_installment_balance type: number description: Total amount remaining on the current loan installment. If the loan is paid off and the loan status is `Completed`, this amount is $0.00. example: 4738.23 current_installment_due_date: title: current_installment_due_date pattern: yyyy-MM-dd type: string description: Date that the payment for the current loan installment is due. format: date example: '2021-01-01' principle_balance: title: principle_balance type: number description: Current principal balance remaining on the loan. example: 4738.23 loan_status: title: loan_status type: string description: Status of the loan. example: ACTIVE payoff_amount: title: payoff_amount type: number description: The total amount needed to pay off the remaining principal, accrued interest, and outstanding fees of a loan example: 10000 per_diem_interest_amount: title: per_diem_interest_amount type: number description: Daily interest charged on the loan. This amount will update as installments are paid. example: 1.61363 loan_payment_status: title: loan_payment_status type: string description: Overall status of payments made on the loan. See the list of values in the Loan Payment Status and Loan Status table in the *Reports for Installment Loans* guide. example: OCUR 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' dda_new_balance: title: dda_new_balance type: number description: Remaining account balance, if the payment on the loan was made from an account within the Galileo system. example: 25 loan_payment_number: title: loan_payment_number type: string description: Galileo-generated unique identifier for the payment on the loan example: '1234567890' 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.21,\n \"response_data\": {\n \"amount\": 100,\n \"principle_balance\": 300,\n \"current_installment_balance\": 0,\n \"current_installment_due_date\": \"2022-11-10\",\n \"payoff_amount\": 300,\n \"per_diem_interest_amount\": 0,\n \"initial_projected_maturity_date\": \"2022-12-22\",\n \"loan_status\": \"Valid\",\n \"loan_payment_status\": \"OCUR\",\n \"loan_payment_number\": 16681134476700080\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": \"test0234244-agjek8\"\n },\n \"system_timestamp\": \"2022-11-10 13:50:53\",\n \"rtoken\": \"2aac9799-a5eb-4d6c-b208-283774af2403\",\n \"errors\": \"\"\n }\n}\n" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' description: A structure for the response data. It can be empty but usually will contain information. required: - amount - current_installment_balance - current_installment_due_date - initial_projected_maturity_date - payoff_amount - per_diem_interest_amount - principle_balance properties: amount: title: amount type: number description: The total amount of the payment transaction. example: 4822.3 current_installment_balance: title: current_installment_balance type: number description: Total amount remaining on the current loan installment. If the loan is paid off and the loan status is `Completed`, this amount is $0.00. example: 4738.23 current_installment_due_date: title: current_installment_due_date pattern: yyyy-MM-dd type: string description: Date that the payment for the current loan installment is due. format: date example: '2021-01-01' principle_balance: title: principle_balance type: number description: Current principal balance remaining on the loan. example: 4738.23 loan_status: title: loan_status type: string description: Status of the loan. example: ACTIVE payoff_amount: title: payoff_amount type: number description: The total amount needed to pay off the remaining principal, accrued interest, and outstanding fees of a loan example: 10000 per_diem_interest_amount: title: per_diem_interest_amount type: number description: Daily interest charged on the loan. This amount will update as installments are paid. example: 1.61363 loan_payment_status: title: loan_payment_status type: string description: Overall status of payments made on the loan. See the list of values in the Loan Payment Status and Loan Status table in the *Reports for Installment Loans* guide. example: OCUR 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' dda_new_balance: title: dda_new_balance type: number description: Remaining account balance, if the payment on the loan was made from an account within the Galileo system. example: 25 loan_payment_number: title: loan_payment_number type: string description: Galileo-generated unique identifier for the payment on the loan example: '1234567890' required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n Success\n 0.21\n \n 100\n 300\n 0\n 2022-11-10\n 300\n 0\n 2022-12-22\n Valid\n OCUR\n 16681134476700080\n \n \n \n \n test0234244-agjek8\n \n 2aac9799-a5eb-4d6c-b208-283774af2403\n 2022-11-10 13:50:53\n" /1.0/createLoanFromTransactions: parameters: - $ref: '#/components/parameters/ResponseContentTypeHeaderParam' post: tags: - Loan summary: Create Loan From Transactions description: 'Use the Create Loan From Transactions endpoint to create a loan from multiple transactions. Buy Now, Pay Later: Post-purchase enables cardholders with the ability to turn eligible, settled transactions on credit and debit cards into an installment plan or loan. Loan subproducts configured for your installment loans product and are assigned a subproduct ID.' operationId: lending_post_createLoanFromTransactions requestBody: content: application/x-www-form-urlencoded: schema: required: - capitalTerm - customerPmtRefNo - disbursementDestinationType - loanTerm - settlementKeys - 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. Pattern: Max 50 characters Example: `"AbC123-9999"`' default: AbC123-9999 apiTransKey: type: string description: 'Web service password, as provided by Galileo for the requesting IP address. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"`' default: 4sb62fh6w4h7w34g providerId: type: integer format: int32 description: 'Galileo-issued unique provider identifier. Pattern: Max 10 digits Example: `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. Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`' default: 984513-395483653-4483483478 providerTransactionId: type: string description: 'An optional provider-generated ID for the API request. Pattern: Max 60 characters Example: `"47823438032233777"`' providerTimestamp: type: string description: 'An optional provider-generated timestamp for the API request. Pattern: Max 60 characters Example: `"2017-05-01 13:01:01"`' loanTerm: title: loanTerm 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 customerPmtRefNo: title: customerPmtRefNo 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: 074103447228 settlementKeys: title: settlementKeys type: string description: "The settlement IDs and association for each transaction the customer selected. Maximum of 5 transactions. \nPattern: settle_id + association. \nExample: `\"[\"123456:VIS\", \"123457:VIS\"]`." default: '["123456:VIS","123457:VIS"]' 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 capitalTerm: title: capitalTerm 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. Pattern: Max 9 digits. Example: `2`.' format: int32 default: 2 loanApplicationData: title: loanApplicationData 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. subProductId: title: subProductId maxLength: 15 minLength: 1 type: string description: 'Identifier for the loan subproduct. Pattern: Max 15 characters. Example: `"442824720"`.' default: '442824720' responses: '200': description: Success content: application/json: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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 - late_fee - loan_apr - loan_creation_date - loan_id - loan_start_date - origination_fee - rate_type properties: loan_id: title: loan_id type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' example: '450825953' 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 loan_creation_date: title: loan_creation_date pattern: yyyy-MM-dd type: string description: Date that the loan was created. This may be different from `loan_start_date`. format: date rate_type: title: rate_type type: string description: Indicates whether the interest type is `FIXED` or `VARIABLE. example: FIXED enum: - fixed - variable origination_fee: title: origination_fee type: number description: Fee charged at loan creation. Returns 0 if there is no origination fee. example: 0 late_fee: title: late_fee type: number description: Late fee for the loan example: 5 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' 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' 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 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 loan_start_date: title: loan_start_date pattern: yyyy-MM-dd type: string description: Start date for the loan. This may be different from `loan_creation_date`. format: date example: '2022-06-02' 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' 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\": 5.032,\n \"response_data\": {\n \"loan_apr\": 0,\n \"rate_type\": \"fixed\",\n \"origination_fee\": 0,\n \"late_fee\": 0,\n \"initial_projected_maturity_date\": \"2023-12-18\",\n \"application_number\": \"45670123\",\n \"itemization_of_amount_financed\": {\n \"loan_amount\": 500,\n \"disbursed_amount\": 500,\n \"projected_interest_amount\": 0,\n \"projected_fees_amount\": 0\n },\n \"amortization_schedules\": {\n \"amortization_schedule\": [\n {\n \"amort_installment_number\": 1,\n \"amort_payment_due_date\": \"2023-11-05\",\n \"amort_payment_amount\": 125,\n \"amort_payment_principal\": 125,\n \"amort_payment_fees\": 0,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 375\n },\n {\n \"amort_installment_number\": 2,\n \"amort_payment_due_date\": \"2023-11-19\",\n \"amort_payment_amount\": 125,\n \"amort_payment_principal\": 125,\n \"amort_payment_fees\": 0,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 250\n },\n {\n \"amort_installment_number\": 3,\n \"amort_payment_due_date\": \"2023-12-03\",\n \"amort_payment_amount\": 125,\n \"amort_payment_principal\": 125,\n \"amort_payment_fees\": 0,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 125\n },\n {\n \"amort_installment_number\": 4,\n \"amort_payment_due_date\": \"2023-12-17\",\n \"amort_payment_amount\": 125,\n \"amort_payment_principal\": 125,\n \"amort_payment_fees\": 0,\n \"amort_payment_interest\": 0,\n \"amort_payment_balance\": 0\n }\n ]\n },\n \"count_of_installments\": 4,\n \"installment_amount\": 125,\n \"first_installment_due_date\": \"2023-11-05\",\n \"loan_id\": 11118003000000056,\n \"loan_creation_date\": \"2023-11-05\",\n \"loan_start_date\": \"2023-11-05\"\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": \"\",\n \"transaction_id\": \"1234567\"\n },\n \"system_timestamp\": \"2023-12-05 16:04:22\",\n \"rtoken\": \"f3d34901-2e36-41ea-9129-3634898d4bad\",\n \"errors\": \"\"\n }" application/xml: schema: type: object properties: status_code: type: - integer - 'null' format: int32 description: The response status code. May return a string for some statuses. status: type: - string - 'null' description: The condition of a process or response processing_time: type: - number - 'null' format: float description: The time elapsed in processing the transaction echo: description: A structure that contains transaction ID information type: - object - 'null' properties: transaction_id: type: - string - 'null' description: An ID that represents an API transaction provider_timestamp: type: - string - 'null' format: date-time description: Store a related timestamp for reporting and troubleshooting purposes provider_transaction_id: type: - string - 'null' description: Secondary transaction identifier (generated by a provider) required: - provider_timestamp - provider_transaction_id - transaction_id system_timestamp: type: - string - 'null' format: date-time description: A system generated timestamp rtoken: type: - string - 'null' 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: type: - object - 'null' 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 - late_fee - loan_apr - loan_creation_date - loan_id - loan_start_date - origination_fee - rate_type properties: loan_id: title: loan_id type: string description: 'Unique identifier for the loan. Pattern: Max 30 characters Example: `"450825953"`.' example: '450825953' 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 loan_creation_date: title: loan_creation_date pattern: yyyy-MM-dd type: string description: Date that the loan was created. This may be different from `loan_start_date`. format: date rate_type: title: rate_type type: string description: Indicates whether the interest type is `FIXED` or `VARIABLE. example: FIXED enum: - fixed - variable origination_fee: title: origination_fee type: number description: Fee charged at loan creation. Returns 0 if there is no origination fee. example: 0 late_fee: title: late_fee type: number description: Late fee for the loan example: 5 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' 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' 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 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 loan_start_date: title: loan_start_date pattern: yyyy-MM-dd type: string description: Start date for the loan. This may be different from `loan_creation_date`. format: date example: '2022-06-02' 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' required: - echo - processing_time - response_data - rtoken - status - status_code - system_timestamp examples: response: value: "\n\n 0\n Success\n 5.032\n \n 0\n fixed\n 0\n 0\n 2023-12-17\n 45670123\n \n 500\n 500\n 0\n \n \n \n 1\n 2023-11-05\n 125\n 0\n 375\n 125\n \n \n 2\n 2022-11-19\n 125\n 0\n 250\n 125\n \n \n 3\n 2022-12-03\n 125\n 0\n 125\n 125\n \n \n 4\n 2023-12-17\n 125\n 0\n 0\n 125\n \n \n 4\n 125\n 2022-11-05\n 11118000000426804\n 2022-11-05\n 2022-11-05\n \n \n \n \n 1234567\n \n f3d34901-2e36-41ea-9129-3634898d4bad\n 2023-12-05 16:04:22\n\n" components: parameters: ResponseContentTypeHeaderParam: name: response-content-type in: header description: Use `xml` or `json` to specify the type of response. The default value is `xml`. Use this instead of the standard `accept` header. schema: type: string enum: - xml - json default: json securitySchemes: BearerAuth: type: apiKey description: 'Authorization header is required for requests For more information click [here](link)' name: Authorization in: header x-readme: explorer-enabled: true proxy-enabled: true