payback-plans

Operations addressed under /payback-plans — 2 operations.

calculate generic payback plan

POST

https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service

/api/payback-plans/calculate

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

Invokes the aurax-bnpl-bff-service-dynamic-calculate-generic-payback-plan service definition through POST /api/payback-plans/calculate.

Request and response fields are declared on the routing target calculate-generic-payback-plan; this entry declares none of its own.

Response body, read from the service source

The route declares its response as BasePaybackPlanDto.

Field	Declared type	Nullable
`PaymentDate`	`DateOnly`	no
`FirstInstallmentDate`	`DateOnly`	no
`TotalPaymentAmount`	`decimal`	no
`IRR`	`decimal`	no
`XIRR`	`decimal`	no
`EffectiveInterestRate`	`decimal`	no
`CompoundInterestRate`	`decimal`	no
`AverageMaturity`	`int`	no
`Installments`	`List<BaseInstallment>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_PYBCKPLAN_18`	400	`PAYBACK_PLAN_INSTALLMENT_DATE_GREATER_THAN_PAYMENT_DATE`	The installment dates cannot be less than the payment date.
`ERR_PYBCKPLAN_9`	400	`PAYBACK_PLAN_COMPATIBLE_INSTALLMENT_COUNT_CONTROL`	The number of installments in the installment array must be compatible with the installment count.

calculate generic payback plan › Request Body

amount

number · decimal · required

dayDifferentInstallment

string · required

dayInYearCount

string · required

installmentCount

integer · int32 · required

monthlyRepaymentRate

number · decimal · required

paybackPlanMethod

integer · int32 · required

Permitted values — validated against the payback_plan_method parameter.

Value	Meaning
`11`	Irregular Installment
`2`	Equal Installment
`4`	Variable Interest
`10`	Balloon Installment
`12`	Spot Loan

paymentDate

string · date-time · required

object[] · required

annualInterestRate

number · decimal

expenseAmount

number · decimal

firstInstallmentDate

string · date-time

object[]

postponedInstallmentCount

integer · int32

termInDays

integer · int32

totalExpenseAmount

number · decimal

calculate generic payback plan › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/api/payback-plans/calculate

curl https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service/api/payback-plans/calculate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0,
  "annualInterestRate": 0,
  "dayDifferentInstallment": "",
  "dayInYearCount": "",
  "expenseAmount": 0,
  "firstInstallmentDate": "",
  "installmentCount": 0,
  "installments": [
    {
      "balloonPaymentAmount": 0,
      "installmentAmount": 0,
      "installmentDate": "",
      "installmentSequenceNo": 0
    }
  ],
  "monthlyRepaymentRate": 0,
  "paybackPlanMethod": 0,
  "paymentDate": "",
  "postponedInstallmentCount": 0,
  "taxes": [
    {
      "fromProperty": "",
      "taxId": "",
      "taxRate": 0
    }
  ],
  "termInDays": 0,
  "totalExpenseAmount": 0
}'

Example Request Body

{
  "amount": 0,
  "annualInterestRate": 0,
  "dayDifferentInstallment": "",
  "dayInYearCount": "",
  "expenseAmount": 0,
  "firstInstallmentDate": "",
  "installmentCount": 0,
  "installments": [
    {
      "balloonPaymentAmount": 0,
      "installmentAmount": 0,
      "installmentDate": "",
      "installmentSequenceNo": 0
    }
  ],
  "monthlyRepaymentRate": 0,
  "paybackPlanMethod": 0,
  "paymentDate": "",
  "postponedInstallmentCount": 0,
  "taxes": [
    {
      "fromProperty": "",
      "taxId": "",
      "taxRate": 0
    }
  ],
  "termInDays": 0,
  "totalExpenseAmount": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-bnpl-bff-redirect-calculate-payback-plan-external-firm-bpmn

POST

https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service

/payback-plans/calculate

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

aurax-bnpl-bff-redirect-calculate-payback-plan-external-firm-bpmn › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

partners product-categories

Aurax BNPL BFF Service

payback-plans

Operations addressed under /payback-plans — 2 operations.

calculate generic payback plan

POST

https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service

/api/payback-plans/calculate

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

Invokes the aurax-bnpl-bff-service-dynamic-calculate-generic-payback-plan service definition through POST /api/payback-plans/calculate.

Request and response fields are declared on the routing target calculate-generic-payback-plan; this entry declares none of its own.

Response body, read from the service source

The route declares its response as BasePaybackPlanDto.

Field	Declared type	Nullable
`PaymentDate`	`DateOnly`	no
`FirstInstallmentDate`	`DateOnly`	no
`TotalPaymentAmount`	`decimal`	no
`IRR`	`decimal`	no
`XIRR`	`decimal`	no
`EffectiveInterestRate`	`decimal`	no
`CompoundInterestRate`	`decimal`	no
`AverageMaturity`	`int`	no
`Installments`	`List<BaseInstallment>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_PYBCKPLAN_18`	400	`PAYBACK_PLAN_INSTALLMENT_DATE_GREATER_THAN_PAYMENT_DATE`	The installment dates cannot be less than the payment date.
`ERR_PYBCKPLAN_9`	400	`PAYBACK_PLAN_COMPATIBLE_INSTALLMENT_COUNT_CONTROL`	The number of installments in the installment array must be compatible with the installment count.

calculate generic payback plan › Request Body

amount

number · decimal · required

dayDifferentInstallment

string · required

dayInYearCount

string · required

installmentCount

integer · int32 · required

monthlyRepaymentRate

number · decimal · required

paybackPlanMethod

integer · int32 · required

Permitted values — validated against the payback_plan_method parameter.

Value	Meaning
`11`	Irregular Installment
`2`	Equal Installment
`4`	Variable Interest
`10`	Balloon Installment
`12`	Spot Loan

paymentDate

string · date-time · required

object[] · required

annualInterestRate

number · decimal

expenseAmount

number · decimal

firstInstallmentDate

string · date-time

object[]

postponedInstallmentCount

integer · int32

termInDays

integer · int32

totalExpenseAmount

number · decimal

calculate generic payback plan › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

POST/api/payback-plans/calculate

curl https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service/api/payback-plans/calculate \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0,
  "annualInterestRate": 0,
  "dayDifferentInstallment": "",
  "dayInYearCount": "",
  "expenseAmount": 0,
  "firstInstallmentDate": "",
  "installmentCount": 0,
  "installments": [
    {
      "balloonPaymentAmount": 0,
      "installmentAmount": 0,
      "installmentDate": "",
      "installmentSequenceNo": 0
    }
  ],
  "monthlyRepaymentRate": 0,
  "paybackPlanMethod": 0,
  "paymentDate": "",
  "postponedInstallmentCount": 0,
  "taxes": [
    {
      "fromProperty": "",
      "taxId": "",
      "taxRate": 0
    }
  ],
  "termInDays": 0,
  "totalExpenseAmount": 0
}'

Example Request Body

{
  "amount": 0,
  "annualInterestRate": 0,
  "dayDifferentInstallment": "",
  "dayInYearCount": "",
  "expenseAmount": 0,
  "firstInstallmentDate": "",
  "installmentCount": 0,
  "installments": [
    {
      "balloonPaymentAmount": 0,
      "installmentAmount": 0,
      "installmentDate": "",
      "installmentSequenceNo": 0
    }
  ],
  "monthlyRepaymentRate": 0,
  "paybackPlanMethod": 0,
  "paymentDate": "",
  "postponedInstallmentCount": 0,
  "taxes": [
    {
      "fromProperty": "",
      "taxId": "",
      "taxRate": 0
    }
  ],
  "termInDays": 0,
  "totalExpenseAmount": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-bnpl-bff-redirect-calculate-payback-plan-external-firm-bpmn

POST

https://dg-sandbox.dgpays.com/aurax-bnpl-bff-service

/payback-plans/calculate

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

aurax-bnpl-bff-redirect-calculate-payback-plan-external-firm-bpmn › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

partners product-categories