backbone-partner-api
Backbone Software is an end to end software solution for lending. It manages the complete lifecycle of borrowers, applications and loan accounts. Using the Backbone API, you can manage borrower accounts, application and payments.
The loan creation flow is as follows:
- Create products
- Create an end user (borrower)
- Create and update an application for an end user
- Create loan account for approved application and specific product
- Disburse funds and collect
Making a request to the Backbone API requires an API key. The key should be provided by Backbone. The request header must include a X-Api-Key header with the API provided.
{id}/{id}/{id}/{id}/{id}/publish/The Backbone platform support the following products:
- Revolving credit
Revolving Credit
Revolving credit allows you provide a line of credit to the end users that renews on monthly basis. With this product, each month, a statement will be generated, describing the transactions that were applied during the statement period, the closing balance of the period and the minimum payment the end user is required to pay. The end user is then expected to repay at least the minimum repayment by the due date. If not paid by the due date the account becomes late. When configuring a Revolving Credit product, you need to
- specify how the minimum repyment is calculated
- specify the day in the month in which the statement is created
- specify the day in the month the repayment is due by
- specify the number of days between the account becoming late and the account becomes in arrears
Authentication
Create a product
Request body
The type of product you are trying to configure. Allowed values are: revolving_credit
The upper limit of the credit amount for loan acounts that are created for this product
A default amount to be used in case an amount is not provided when creating a loan account
Max Interest rate for loan acounts that are created for this product, should be expressed in % not real number i.e. for 5% annual rate you should provide 5 and not 0.05
A default interest to be used in case the rate is not provided when creating a loan account, should be expressed in % not real number i.e. for 5% annual rate you should provide 5 and not 0.05
A readable name for easy recognition of the product
(Releveant only for term loans) The default numebr of instalments to be used in case the the number of instalments is not provided when creating a loan account
(Releveant only for term loans) Grace instalments are the number of instalments in which repayment is not expected to be repaid
(Releveant only for term loans) Grace instalments are the number of instalments in which principal repayment is not expected to be repaid
A list of pre-configured fees which can be used on loan account.
The number of days between account becoming late and account becoming in arrears
There are two types of schedule calculation (we need to add a field for that): Equal principal payments - With this option we take the principal amount and divide by the number of instalments to get the principal repayment of each instalments. We then calculate the interest accrued between instalments based on the principal balance in the account after the instalments.
Even total payments - With this option all the repayments are of the same amount (except the last one sometimes when you have to round the principal amount).
Releveant only for term loans
Should the repayment date be rescheduled due to it being a holiday. Options are:
- “last_business_day_before_the_day” - Moves the repayment date to the last business day before the repayment date
- “first_business_day_after_the_day” - Moves the repayment date to the first business day after the repayment date
- “on_day” - Do not reschedule the repayment date
- “True” means that the interest will be calculated on holidays
- “Flase” means that on holidays, the interest will not be calculated
Options are:
- “day_of_month” - Repayment date is on specific day of the month
- “last_day_of_month” - Last business day of the month
- “first_day_of_month” - First business day of the month
If repayment_date_type is day_of_month then this field specifies the day
Responses
201
This schema describes a Default Fee. Default fees can be used for quick application of fees on a loan account.
Readable name for the fee
Describes whether the fee should be calculated as flat fee or as percetage from the account balance.
For this type of fee, the figure in the amount field will be used to calculate the fee
This type of fee is calculated as percentage of the account balance. The figure in the amount field represents that percentage.
This field represents the amount of the fee or the percentage of the current balance to be calculated as the amount of the fee.
On which event this fee should be applied for
Select this event if you wish that the fee will be automatically applied upon disbursement event
Select this event if you wish that the fee will be automatically applied upon the account going into arrears
Select this event if you wish that the fee will be automatically applied upon the account going into default
Select this event if this fee will be applied using ad hoc API commands
{id}/Authentication
Update the configuration of a specific product
Path variables
A UUID string identifying this Product.
Request body
The type of product you are trying to configure. Allowed values are: revolving_credit
The upper limit of the credit amount for loan acounts that are created for this product
A default amount to be used in case an amount is not provided when creating a loan account
Max Interest rate in % not real number i.e. 5% and not 0.05
Default Interest rate in % not real number i.e. 5% and not 0.05, if not not specified when creating the loan account
A readable name for easy recognition of the product
(Releveant only for term loans) The default numebr of instalments to be used in case the the number of instalments is not provided when creating a loan account
(Releveant only for term loans) Grace instalments are the number of instalments in which repayment is not expected to be repaid
(Releveant only for term loans) Grace instalments are the number of instalments in which principal repayment is not expected to be repaid
A list of pre-configured fees which can be used on loan account. The structure of a fee is: { ‘name’: Readable name for the fee, ‘type’: use flat charge the amount in the “amount” field as a fixed amount, or percent to charge an amount a percentage, as configured in the “amount” field, from the account balance, ‘amount’: the amount of the fee in % or flat according to the “type” field, ‘event’: ‘arrears’, }
The number of days between account becoming late and account becoming in arrears
There are two types of schedule calculation (we need to add a field for that): Equal principal payments - With this option we take the principal amount and divide by the number of instalments to get the principal repayment of each instalments. We then calculate the interest accrued between instalments based on the principal balance in the account after the instalments.
Even total payments - With this option all the repayments are of the same amount (except the last one sometimes when you have to round the principal amount).
(Releveant only for term loans) We have two option for how to reschedule the repayments in the event of an early repayment: from_last_instalment - Choosing this option means that the amount repaid is taken off the principal of the last repayment. If the amount repaid is higher then the principal of the last repayment, then it should be deducted from the instalment before that, and so on, effectively reducing the number of instalments in the loan while all the remaining repayments stay the same in principal and interest amounts.
reduced_instalments - Choosing this option mean that the overall number of instalments stays the same, but the amount of each instalment is reduced. When calculating the new schedule, we need to take the total principal owed and recalculate the amounts for each of the remaining instalment as if it’s a new loan taken nor for that number of instalments.
Should the repayment date be rescheduled due to it being a holiday. Options are: “last_business_day_before_the_day” - Moves the repayment date to the last business day before the repayment date
“first_business_day_after_the_day” - Moves the repayment date to the first business day after the repayment date
“on_day” - Do not reschedule the repayment date
“True” means that the interest will be calculated on holidays
“Flase” means that on holidays, the interest will not be calculated
Options are: “day_of_month” - Repayment date is on specific day of the month
“last_day_of_month” - Last business day of the month
“first_day_of_month” - First business day of the month
If repayment_date_type is day_of_month then this field specifies the day
Responses
200
{id}/Authentication
Update the configuration of a specific product
Path variables
A UUID string identifying this Product.
Request body
The type of product you are trying to configure. Allowed values are: revolving_credit
The upper limit of the credit amount for loan acounts that are created for this product
A default amount to be used in case an amount is not provided when creating a loan account
Max Interest rate in % not real number i.e. 5% and not 0.05
Default Interest rate in % not real number i.e. 5% and not 0.05, if not not specified when creating the loan account
A readable name for easy recognition of the product
(Releveant only for term loans) The default numebr of instalments to be used in case the the number of instalments is not provided when creating a loan account
(Releveant only for term loans) Grace instalments are the number of instalments in which repayment is not expected to be repaid
(Releveant only for term loans) Grace instalments are the number of instalments in which principal repayment is not expected to be repaid
A list of pre-configured fees which can be used on loan account. The structure of a fee is: { ‘name’: Readable name for the fee, ‘type’: use flat charge the amount in the “amount” field as a fixed amount, or percent to charge an amount a percentage, as configured in the “amount” field, from the account balance, ‘amount’: the amount of the fee in % or flat according to the “type” field, ‘event’: ‘arrears’, }
The number of days between account becoming late and account becoming in arrears
There are two types of schedule calculation (we need to add a field for that): Equal principal payments - With this option we take the principal amount and divide by the number of instalments to get the principal repayment of each instalments. We then calculate the interest accrued between instalments based on the principal balance in the account after the instalments.
Even total payments - With this option all the repayments are of the same amount (except the last one sometimes when you have to round the principal amount).
(Releveant only for term loans) We have two option for how to reschedule the repayments in the event of an early repayment: from_last_instalment - Choosing this option means that the amount repaid is taken off the principal of the last repayment. If the amount repaid is higher then the principal of the last repayment, then it should be deducted from the instalment before that, and so on, effectively reducing the number of instalments in the loan while all the remaining repayments stay the same in principal and interest amounts.
reduced_instalments - Choosing this option mean that the overall number of instalments stays the same, but the amount of each instalment is reduced. When calculating the new schedule, we need to take the total principal owed and recalculate the amounts for each of the remaining instalment as if it’s a new loan taken nor for that number of instalments.
Should the repayment date be rescheduled due to it being a holiday. Options are: “last_business_day_before_the_day” - Moves the repayment date to the last business day before the repayment date
“first_business_day_after_the_day” - Moves the repayment date to the first business day after the repayment date
“on_day” - Do not reschedule the repayment date
“True” means that the interest will be calculated on holidays
“Flase” means that on holidays, the interest will not be calculated
Options are: “day_of_month” - Repayment date is on specific day of the month
“last_day_of_month” - Last business day of the month
“first_day_of_month” - First business day of the month
If repayment_date_type is day_of_month then this field specifies the day
Responses
200
{id}/publish/Authentication
Publish a configured product. Once a product is published it cannot be updated
Path variables
A UUID string identifying this Product.
Request body
The type of product you are trying to configure. Allowed values are: revolving_credit
The upper limit of the credit amount for loan acounts that are created for this product
A default amount to be used in case an amount is not provided when creating a loan account
Max Interest rate in % not real number i.e. 5% and not 0.05
Default Interest rate in % not real number i.e. 5% and not 0.05, if not not specified when creating the loan account
A readable name for easy recognition of the product
(Releveant only for term loans) The default numebr of instalments to be used in case the the number of instalments is not provided when creating a loan account
(Releveant only for term loans) Grace instalments are the number of instalments in which repayment is not expected to be repaid
(Releveant only for term loans) Grace instalments are the number of instalments in which principal repayment is not expected to be repaid
A list of pre-configured fees which can be used on loan account. The structure of a fee is: { ‘name’: Readable name for the fee, ‘type’: use flat charge the amount in the “amount” field as a fixed amount, or percent to charge an amount a percentage, as configured in the “amount” field, from the account balance, ‘amount’: the amount of the fee in % or flat according to the “type” field, ‘event’: ‘arrears’, }
The number of days between account becoming late and account becoming in arrears
There are two types of schedule calculation (we need to add a field for that): Equal principal payments - With this option we take the principal amount and divide by the number of instalments to get the principal repayment of each instalments. We then calculate the interest accrued between instalments based on the principal balance in the account after the instalments.
Even total payments - With this option all the repayments are of the same amount (except the last one sometimes when you have to round the principal amount).
(Releveant only for term loans) We have two option for how to reschedule the repayments in the event of an early repayment: from_last_instalment - Choosing this option means that the amount repaid is taken off the principal of the last repayment. If the amount repaid is higher then the principal of the last repayment, then it should be deducted from the instalment before that, and so on, effectively reducing the number of instalments in the loan while all the remaining repayments stay the same in principal and interest amounts.
reduced_instalments - Choosing this option mean that the overall number of instalments stays the same, but the amount of each instalment is reduced. When calculating the new schedule, we need to take the total principal owed and recalculate the amounts for each of the remaining instalment as if it’s a new loan taken nor for that number of instalments.
Should the repayment date be rescheduled due to it being a holiday. Options are: “last_business_day_before_the_day” - Moves the repayment date to the last business day before the repayment date
“first_business_day_after_the_day” - Moves the repayment date to the first business day after the repayment date
“on_day” - Do not reschedule the repayment date
“True” means that the interest will be calculated on holidays
“Flase” means that on holidays, the interest will not be calculated
Options are: “day_of_month” - Repayment date is on specific day of the month
“last_day_of_month” - Last business day of the month
“first_day_of_month” - First business day of the month
If repayment_date_type is day_of_month then this field specifies the day
Responses
201
These operation are used to manage the lifecycle of an end user (borrower). The end user account can be updated all the time. When an application is completed and being processed, Backbone will use the most current details it has on the end user.
{id}/{id}/{id}/Authentication
View set for managing end user account
Request parameters
Number of results to return per page.
The initial index from which to return the results.
Responses
200
Authentication
View set for managing end user account
Request body
Responses
201
{id}/Authentication
View set for managing end user account
Path variables
A UUID string identifying this end user.
Request body
Responses
200
{id}/Authentication
View set for managing end user account
Path variables
A UUID string identifying this end user.
Request body
Responses
200
These operations are used to manage the life cycle of an application. Application can be created for an end user to apply for a specific credit product. After its creation, the end user can’t be changed. The rest of the application data can be updated. Once the application is complete, the “/complete/” request must be issued to trigger the processing of the application.
As long as there isn’t a loan account attached to the application, it can be reopened, updated and withdrawan. Once a loan account is opened for the application it becomes immutable.
{id}/{id}/{id}/{id}/complete/{id}/reopen/{id}/withdraw/Authentication
This endpoint is used to create a new application
Request body
Product ID of the product the end user is applying for
End user ID of the user applying for the product
Amount of credit requested. If not present, then the product default amount will be used.
Number of requested instalments (Relevant only for term loans). If not present, then the product default amount will be used.
Specific interest for the end user. If not present, then the product default amount will be used.
Json structure of additional custom fields
Responses
201
Authentication
This endpoint returns a list of application according to the filter used. By default returns 20 results, starting at offset 0.
Request parameters
Number of results to return per page.
The initial index from which to return the results.
Application ID
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Responses
200
{id}/Authentication
View set for manipulation with applications.
Path variables
A UUID string identifying this application.
Request body
Number of instalments
Interest rate in % not real number i.e. 5% and not 0.05
Responses
200
{id}/Authentication
View set for manipulation with applications.
Path variables
A UUID string identifying this application.
Request body
Number of instalments
Interest rate in % not real number i.e. 5% and not 0.05
Responses
200
{id}/complete/Authentication
This endpoint sets the status of application with ID {id} to complete. This will trigger the processing of the application which results in a “accept”/“decline” decision
Path variables
A UUID string identifying this application.
Request body
Number of instalments
Interest rate in % not real number i.e. 5% and not 0.05
Responses
201
{id}/reopen/Authentication
Sets the status of the application to “incomplete”. This request is only applicable when:
- Application is withdrawen
- Application was processed and a decision given
This reuqest is invalid when a loan account was already created for this application.
Path variables
A UUID string identifying this application.
Request body
Number of instalments
Interest rate in % not real number i.e. 5% and not 0.05
Responses
201
{id}/withdraw/Authentication
This requets will set the application status to withdrawan. This request is only applicable when:
- Application is incomplete
- Application was processed and a decision given
This reuqest is invalid when a loan account was already created for this application.
Path variables
A UUID string identifying this application.
Request body
Number of instalments
Interest rate in % not real number i.e. 5% and not 0.05
Responses
201
{id}/{id}/close/{id}/make_arrears/{id}/make_default/{id}/stop_interest_calculation/{id}/start_interest_calculation/Authentication
This endpoint returns a list of application according to the filter used. By default returns 20 results, starting at offset 0.
Request parameters
Number of results to return per page.
The initial index from which to return the results.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Responses
200
{id}/close/Authentication
This endpoint is used to close a loan account. Once an account is closed, it stops accruing interest, and the outstanding balance is considered as loss.
Path variables
A UUID string identifying this Loan account.
Request body
A string with a readable closing reason
The valid substatuses are paid_in_full or written_off
Responses
201
{id}/make_arrears/Authentication
This endpoint is used to manually set the account status to arrears. Loan accounts go into arrears when a repayment is late for more then the period specified in the arrears tolerance field.
Path variables
A UUID string identifying this Loan account.
Request body
Responses
201
{id}/make_default/Authentication
This endpoint is used to manually set the account status to default.
Path variables
A UUID string identifying this Loan account.
Request body
Responses
201
{id}/stop_interest_calculation/Authentication
This request may be used in cases when a partner whishes to stop interest calculation for a loan. Using this request will stop the interest calcualtion for a loan, until it’s enabled again using Enable interest calculation for a loan account
Path variables
A UUID string identifying this Loan account.
Request body
Responses
201
{id}/start_interest_calculation/Authentication
By default, interest is calculated for active loan accounts. In some scenarios, the partner may choose to disable interest calcualtion for a loan. In that use case, this request will enable it back.
Path variables
A UUID string identifying this Loan account.
Request body
Responses
201
{id}/{id}/revert/Authentication
View set for managing transactions
Request parameters
Number of results to return per page.
The initial index from which to return the results.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Multiple values may be separated by commas.
Responses
200
Authentication
View set for managing transactions
Request body
The ID of the loan you wich to apply the transaction to
The type of the transaction
The transaction adds a disursement to a loan account. If the payments provider module is enable this will disburse funds to the end user bank account.
This transaction adds a repayment transaction to the loan account.If the collections module is enable this will create a repayment request from the collections provider.
A readable name for this fee transation. If the prodcut of the loan account this transaction is created for has a fee with that name, then the amount and fee_type should remain empty. If there isn’t such fee then they are required.
(Only for a non default fee) This field represents the amount of the fee or the percentage of the current balance to be calculated as the amount of the fee.
(Only for a non default fee) Describes whether the fee should be calculated as flat fee or as percetage from the account balance.
For this type of fee, the figure in the amount field will be used to calculate the fee.
This type of fee is calculated as percentage of the account balance. The figure in the amount field represents that percentage.
A unique key for this transaction. This key is very important as it’s serves as a unique identifier for a transactio and the API will ensure this payment is only ever created once. This means that if an API request times out or something goes wrong on your end, you won’t ever accidentally disburse a loan twice or charge the end user twice.
Responses
201
{id}/revert/Authentication
This endpoint is used to revert a specific transaction.
Since all the transactions are linked and depended on one another, reverting a transaction will also revert all the transactions that postdated it.
Only transactions that are is applied status can be reverted. This means that a reuqest to revert an applied transaction would fail, also a request to revert a transaction which one of the transactions that postdate it isn’t applied yet will fail.
Path variables
A UUID string identifying this Transaction.
Request body
Responses
201