Operations addressed under /loan — 7 operations.
mobile-bff-redirect-get-loan-list-by-customer-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-loan-list-by-customer-id; this entry declares none of its own.
Declared as Route-bound but absent from the route template, so not sendable: customerId.
Response body, read from the service source
The route declares its response as IEnumerable<LoanDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
CustomerId | Guid? | yes |
ProposalId | Guid? | yes |
CustomerApplicationId | Guid? | yes |
CustomerAccountId | Guid? | yes |
LoanProductId | Guid | no |
LoanNumber | string | no |
FundingSource | int? | yes |
OrganizationId | Guid? | yes |
CurrencyNumber | string | no |
Amount | decimal? | yes |
LoanDate | DateTime? | yes |
Status | int? | yes |
ExchangeRate | decimal? | yes |
AccountingEntryId | Guid? | yes |
LoanCloseDate | DateTime? | yes |
LoanCloseType | int? | yes |
CustomerRiskId | Guid? | yes |
AllotmentQueryId | Guid? | yes |
ParentLoanId | Guid? | yes |
CancelDate | DateTime? | yes |
CancelReason | int? | yes |
CancelDescription | string | no |
LatePenaltyRate | decimal? | yes |
EarlyPaymentDiscountRate | decimal? | yes |
AccrualStatus | int? | yes |
ExternalReference | string | no |
ExternalTransactionid | string | no |
VendorExternalId | Guid? | yes |
StatusContext | string | no |
PartnerId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizemobile-bff-redirect-get-loan-list-by-customer-id › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
mobile-bff-service-dynamic-get-loan-details-by-external-reference
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-loan-details-by-external-reference; this entry declares none of its own.
Response body, read from the service source
The route declares its response as LoanDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
ChannelType | int? | yes |
Id | Guid? | yes |
CustomerId | Guid? | yes |
ProposalId | Guid? | yes |
CustomerApplicationId | Guid? | yes |
CustomerAccountId | Guid? | yes |
LoanProductId | Guid | no |
LoanNumber | string | no |
FundingSource | int? | yes |
OrganizationId | Guid? | yes |
CurrencyNumber | string | no |
Amount | decimal? | yes |
LoanDate | DateTime? | yes |
Status | int? | yes |
ExchangeRate | decimal? | yes |
AccountingEntryId | Guid? | yes |
LoanCloseDate | DateTime? | yes |
LoanCloseType | int? | yes |
CustomerRiskId | Guid? | yes |
AllotmentQueryId | Guid? | yes |
ParentLoanId | Guid? | yes |
CancelDate | DateTime? | yes |
CancelReason | int? | yes |
CancelDescription | string | no |
LatePenaltyRate | decimal? | yes |
EarlyPaymentDiscountRate | decimal? | yes |
AccrualStatus | int? | yes |
ExternalReference | string | no |
ExternalTransactionid | string | no |
VendorExternalId | Guid? | yes |
StatusContext | string | no |
PartnerId | Guid? | yes |
Disbursements | List<BaseVendorDisbursementDto> (collection) | no |
PaybackPlans | List<LoanPaybackPlanDto> (collection) | no |
CollateralUsages | List<LoanCollateralUsageBaseDto> (collection) | no |
Expenses | List<LoanExpenseBaseDto> (collection) | no |
Orders | List<LoanOrderBaseDto> (collection) | no |
Delegations | List<LoanDelegationBaseDto> (collection) | no |
Guarantors | List<GetLoanGuarantorDto> (collection) | no |
ReturnPayments | List<LoanReturnPaymentBaseDto> (collection) | no |
Insurances | List<InsuranceDto> (collection) | no |
Merchants | List<string> (collection) | no |
PoolDefinitionRates | List<LoanPoolDefinitionRateDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
ERR_LOAN_91 | 400 | LOAN_MULTIPLE_ROW_FOUND |
path Parameters
externalReferenceHeaders
partnerCodemobile-bff-service-dynamic-get-loan-details-by-external-reference › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
accountingEntryIdaccrualStatusallotmentQueryIdamountcancelDatecancelDescriptioncancelReasoncurrencyNumbercustomerAccountIdcustomerApplicationIdcustomerIdcustomerRiskIdearlyPaymentDiscountRateexchangeRateexternalReferenceexternalTransactionidfundingSourceidlatePenaltyRateloanCloseDateloanCloseTypeloanDateloanNumberloanProductIdorganizationIdparentLoanIdproposalIdstatusvendorExternalIdmobile-bff-redirect-get-unpaid-installment-list-by-customer-id-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-unpaid-installment-list-by-customer-id-bpmn; this entry declares none of its own.
Read from the caller's token, not from the request: customerId.
mobile-bff-redirect-get-unpaid-installment-list-by-customer-id-bpmn › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
currentDatedelayedInstallmentCountupcomingPaymentAmountupcomingPaymentDatemobile-bff-service-dynamic-calculate-installment-payment-amount-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target calculate-installment-payment-amount-bpmn; this entry declares none of its own.
Request body description
The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit installmentId, which this document nevertheless marks required because the catalog declares it so.
mobile-bff-service-dynamic-calculate-installment-payment-amount-bpmn › Request Body
installmentIdmobile-bff-service-dynamic-calculate-installment-payment-amount-bpmn › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
installmentmobile-bff-redirect-calculate-installments-debt-amount-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target calculate-installments-debt-amount-bpmn; this entry declares none of its own.
mobile-bff-redirect-calculate-installments-debt-amount-bpmn › Request Body
installmentIdListmobile-bff-redirect-calculate-installments-debt-amount-bpmn › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
totalRemainingAmountmobile-bff-redirect-get-loan-details-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-loan-details-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as LoanDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
ChannelType | int? | yes |
Id | Guid? | yes |
CustomerId | Guid? | yes |
ProposalId | Guid? | yes |
CustomerApplicationId | Guid? | yes |
CustomerAccountId | Guid? | yes |
LoanProductId | Guid | no |
LoanNumber | string | no |
FundingSource | int? | yes |
OrganizationId | Guid? | yes |
CurrencyNumber | string | no |
Amount | decimal? | yes |
LoanDate | DateTime? | yes |
Status | int? | yes |
ExchangeRate | decimal? | yes |
AccountingEntryId | Guid? | yes |
LoanCloseDate | DateTime? | yes |
LoanCloseType | int? | yes |
CustomerRiskId | Guid? | yes |
AllotmentQueryId | Guid? | yes |
ParentLoanId | Guid? | yes |
CancelDate | DateTime? | yes |
CancelReason | int? | yes |
CancelDescription | string | no |
LatePenaltyRate | decimal? | yes |
EarlyPaymentDiscountRate | decimal? | yes |
AccrualStatus | int? | yes |
ExternalReference | string | no |
ExternalTransactionid | string | no |
VendorExternalId | Guid? | yes |
StatusContext | string | no |
PartnerId | Guid? | yes |
Disbursements | List<BaseVendorDisbursementDto> (collection) | no |
PaybackPlans | List<LoanPaybackPlanDto> (collection) | no |
CollateralUsages | List<LoanCollateralUsageBaseDto> (collection) | no |
Expenses | List<LoanExpenseBaseDto> (collection) | no |
Orders | List<LoanOrderBaseDto> (collection) | no |
Delegations | List<LoanDelegationBaseDto> (collection) | no |
Guarantors | List<GetLoanGuarantorDto> (collection) | no |
ReturnPayments | List<LoanReturnPaymentBaseDto> (collection) | no |
Insurances | List<InsuranceDto> (collection) | no |
Merchants | List<string> (collection) | no |
PoolDefinitionRates | List<LoanPoolDefinitionRateDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_LOAN_17 | 400 | LOAN_MUST_NOT_BE_NULL |
path Parameters
idmobile-bff-redirect-get-loan-details-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
accountingEntryIdaccrualStatusallotmentQueryIdamountcancelDatecancelDescriptioncancelReasoncurrencyNumbercustomerAccountIdcustomerApplicationIdcustomerIdcustomerRiskIdearlyPaymentDiscountRateexchangeRateexternalReferenceexternalTransactionidfundingSourceidlatePenaltyRateloanCloseDateloanCloseTypeloanDateloanNumberloanProductIdorganizationIdparentLoanIdpartnerIdproposalIdstatusvendorExternalIdmobile-bff-redirect-calculate-installment-payment-amount-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target calculate-installment-payment-amount-bpmn; this entry declares none of its own.
Request body description
The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation. Not every field below is accepted: the platform selects which of them this operation admits and drops the rest. Of the fields below, the binder does not admit installmentId, which this document nevertheless marks required because the catalog declares it so.
mobile-bff-redirect-calculate-installment-payment-amount-bpmn › Request Body
installmentIdmobile-bff-redirect-calculate-installment-payment-amount-bpmn › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
installment