Operations addressed under /loans — 15 operations.
Cancel Loan Bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bnpl-bff-service-dynamic-aurax-bff-redirect-cancel-loan-bpmn service definition through POST /api/loans/cancel.
Request and response fields are declared on the routing target cancel-loan-bpmn; this entry declares none of its own.
Cancel Loan Bpmn › Request Body
loanCancelDescriptionloanCancelReasonloanIdisLoanDisbursementEditCancel Loan 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 |
reverseAccountingEntryIdaurax-bnpl-bff-service-dynamic-calculate-payback-plan-external-firm-bff
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.
aurax-bnpl-bff-service-dynamic-calculate-payback-plan-external-firm-bff › Request Body
firstInstallmentDateloanCurrencyTypeinstallmentCountaurax-bnpl-bff-service-dynamic-calculate-payback-plan-external-firm-bff › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bnpl-bff-service-dynamic-cancel-loan-by-external-reference-bff
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.
aurax-bnpl-bff-service-dynamic-cancel-loan-by-external-reference-bff › Request Body
externalReferenceloanCancelDescriptionloanCancelReasonaurax-bnpl-bff-service-dynamic-cancel-loan-by-external-reference-bff › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-service-dynamic-create-loan-for-external-firm-bff
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 |
aurax-bnpl-bff-service-dynamic-create-loan-for-external-firm-bff › Request Body
loanCurrencyTypepaybackPlanIdproposalIdbankCodeexternalReferenceloanCampaignIdmccCodemerchantIdaurax-bnpl-bff-service-dynamic-create-loan-for-external-firm-bff › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-service-dynamic-create-loan-finalization-bff
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-finalization-bff; this entry declares none of its own.
Response body, read from the service source
The route declares its response as CreateLoanFinalizationDto.
| Field | Declared type | Nullable |
|---|---|---|
LoanId | Guid | no |
LoanStatus | int | no |
Member names are the service's declaration names.
aurax-bnpl-bff-service-dynamic-create-loan-finalization-bff › Request Body
loanIdmerchantIdaurax-bnpl-bff-service-dynamic-create-loan-finalization-bff › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bnpl-bff-service-dynamic-cretate-available-limit-bff
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 cretate-available-limit-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 AvailableLimitDto.
| Field | Declared type | Nullable |
|---|---|---|
AllotmentAmount | decimal | no |
AllotmentAssignmentId | Guid | no |
AllotmentAssignmentProductId | Guid | no |
AllotmentProductId | Guid | no |
AllotmentQueryId | Guid | no |
AvailableAllotmentAmount | decimal | no |
CurrencyNumber | string | no |
CustomerId | Guid | no |
CustomerProductRisk | decimal? | yes |
CustomerRiskId | Guid | no |
ProductAllotmentAmount | decimal | no |
QueryDate | DateTime | no |
IsLimitAvailable | bool | no |
Member names are the service's declaration names.
aurax-bnpl-bff-service-dynamic-cretate-available-limit-bff › Request Body optional
transactionAmountaurax-bnpl-bff-service-dynamic-cretate-available-limit-bff › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-service-dynamic-provision-cancel-bff
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-bff; this entry declares none of its own.
Response body, read from the service source
The route declares its response as ProvisionCancelLoanFinalizationForExternalFirmDto.
| Field | Declared type | Nullable |
|---|---|---|
LocalFeeAmount | decimal | no |
FeeCurrency | string | no |
LocalTransactionCurrency | string | no |
LocalFeeCurrency | string | no |
FeeAmount | decimal | no |
ResultMessage | string | no |
LocalTransactionAmount | decimal | no |
ResultCode | string | no |
FeeTrnCodeMatrixId | string | no |
Member names are the service's declaration names.
aurax-bnpl-bff-service-dynamic-provision-cancel-bff › Request Body
mainTrnIdoriginalMainTrnIdbillingAmountcardTokenreversalReasonCodetransactionAmountaurax-bnpl-bff-service-dynamic-provision-cancel-bff › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bnpl-bff-service-dynamic-provision-confirm-bff
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-bff; this entry declares none of its own.
Response body, read from the service source
The route declares its response as ProvisionConfirmLoanFinalizationForExternalFirmDto.
| Field | Declared type | Nullable |
|---|---|---|
LocalFeeAmount | decimal | no |
FeeCurrency | string | no |
LocalTransactionCurrency | string | no |
LocalFeeCurrency | string | no |
FeeAmount | decimal | no |
ResultMessage | string | no |
LocalTransactionAmount | decimal | no |
ResultCode | string | no |
FeeTrnCodeMatrixId | string | no |
Member names are the service's declaration names.
aurax-bnpl-bff-service-dynamic-provision-confirm-bff › Request Body
mainTrnIdqrReferencerefTrnIdacquirerInstutionIdbillingAmountbillingCurrencyCodecardTokenchannelTypedescriptionisInternationalisProvisionlocalDateTimemccCodemerchantIdposEntryModeterminalIdterminalTypetransactionAmounttransactionCurrencyCodetrnCodeMatrixIdaurax-bnpl-bff-service-dynamic-provision-confirm-bff › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bnpl-bff-redirect-get-loan-list-by-customer-id
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.
aurax-bnpl-bff-redirect-get-loan-list-by-customer-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-redirect-get-loan-installment-details-by-installment-id
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 InstallmentDto.
| Field | Declared type | Nullable |
|---|---|---|
InstallmentNo | int | no |
InstallmentDate | DateTime | no |
InstallmentTotalAmount | decimal | no |
CollectionStatus | int | no |
IsAccrual | bool | no |
PrincipalAmount | decimal | no |
RemainingPrincipalAmount | decimal | no |
ProfitAmount | decimal | no |
BalloonPaymentAmount | decimal | no |
CalculateInstallmentDate | DateTime? | yes |
IsManual | bool | no |
LoanId | Guid? | yes |
LoanPaybackPlanId | Guid? | yes |
Taxes | List<InstallmentTaxDto> (collection) | no |
CollectionDetails | List<InstallmentDetailDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_30 | 400 | LOAN_INSTALLMENT_MUST_NOT_BE_NULL | Installment cannot be found. :{0} |
path Parameters
installmentIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bnpl-bff-redirect-get-loan-installment-details-by-installment-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-redirect-calculate-first-installment-date-bpmn
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.
aurax-bnpl-bff-redirect-calculate-first-installment-date-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bnpl-bff-redirect-get-loan-details-by-id
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 |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bnpl-bff-redirect-get-loan-details-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.