loan

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Read from the caller's token, not from the request: 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.

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 cancel-loan-by-external-reference-bff; this entry declares none of its own.

Response body, read from the service source

The route declares its response as CancelLoanByExternalReferenceDto.

Field	Declared type	Nullable
resultCode	string	no
resultMessage	string	no
localTransactionAmount	decimal?	yes
localTransactionCurrency	string	no
localFeeAmount	decimal?	yes
localFeeCurrency	string	no
feeAmount	decimal?	yes
feeCurrency	string	no
feeTrnCodeMatrixId	string	no

Member names are the service's declaration names.

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 cancel-loan-by-external-reference-bpmn; this entry declares none of its own.

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 create-payment-loan-test-bpmn; this entry declares none of its own.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Read from the caller's token, not from the request: customerId.

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-first-installment-date-list; this entry declares none of its own.

Read from the caller's token, not from the request: customerId.

Response body, read from the service source

The route declares its response as CalculateFirstInstallmentDateListDto.

Field	Declared type	Nullable
calculatedInstallmentDate	DateOnly?	yes
AvailableDayOptions	List<AvailableDayOption> (collection)	no

Member names are the service's declaration names.

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-payback-plan-external-firm-bpmn; this entry declares none of its own.

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-payback-plan-external-firm-performance-bpmn; this entry declares none of its own.

Read from the caller's token, not from the request: customerId.

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-payback-plan-external-firm-bff; this entry declares none of its own.

Read from the caller's token, not from the request: customerId.

Response body, read from the service source

The route declares its response as CalculatePaybackPlanDto.

Field	Declared type	Nullable
LoanProductId	Guid	no
ProposalId	Guid	no
PaybackPlanMethod	int	no
DayDifferentInstallment	string	no
DayInYearCount	string	no
AverageMaturity	string	no
ProductTaxListOutput	IEnumerable<GenericTax> (collection)	no
PaybackPlanList	IEnumerable<CalculatedPaybackPlanDto> (collection)	no

Member names are the service's declaration names.

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 create-loan-for-external-firm-bpmn; this entry declares none of its own.

Read from the caller's token, not from the request: customerId.

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 create-loan-for-external-firm-performans-bpmn; this entry declares none of its own.

Read from the caller's token, not from the request: customerId.

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 create-loan-return-payment-bpmn; this entry declares none of its own.

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 create-loan-for-external-firm-bff; this entry declares none of its own.

Read from the caller's token, not from the request: customerId.

Response body, read from the service source

The route declares its response as CreateLoanDto.

Field	Declared type	Nullable
LoanId	Guid	no
VirtualIban	string	no
LoanStatus	int	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Message
ERR_BNPLLOAN_100	400	Due to banking policy rules, your transaction cannot be processed at this time.
ERR_LOAN_16	400	not published in this snapshot
ERR_LOAN_88	400	not published in this snapshot
ERR_LOAN_90	400	not published in this snapshot
ERR_LPRPSL_13	400	not published in this snapshot
ERR_LPRPSL_17	400	not published in this snapshot
ERR_LPRPSL_2	400	not published in this snapshot
ERR_LPRPSL_6	400	not published in this snapshot

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

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 provision-cancel-loan-finalization-for-external-firm-bpmn; this entry declares none of its own.

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 provision-confirm-loan-finalization-for-external-firm-bpmn; this entry declares none of its own.

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-return-payment-list-by-date; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<LoanReturnPaymentExternalDto>.

Field	Declared type	Nullable
ExternalReference	string	no
CustomerId	Guid?	yes
LoanReturnPayments	List<LoanReturnPaymentBaseDto> (collection)	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

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

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-external-firm-loans-details; this entry declares none of its own.

Declared as Route-bound but absent from the route template, so not sendable: beginDate, endDate.

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-external-firm-loans-summary; this entry declares none of its own.

Declared as Route-bound but absent from the route template, so not sendable: beginDate, endDate.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Read from the caller's token, not from the request: customerId.

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.

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.

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.

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 loan-finalization-mobil-test-bpmn; this entry declares none of its own.

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-delayed-installment-count-bpmn; this entry declares none of its own.

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