Delete repayment plan
curl --request DELETE \
--url https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId} \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.DeleteAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'DELETE',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.delete(url, headers=headers)
print(response.text){
"Success": false,
"ResultCode": "8025",
"Message": "The repayment plan cannot be deleted because it is used by other records.",
"Errors": [
{
"Code": "8025",
"Message": "The repayment plan cannot be deleted because it is used by other records."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "8010",
"Message": "Bank account not found.",
"Errors": [
{
"Code": "8010",
"Message": "Bank account not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Repayment plans
Delete repayment plan
Deletes the repayment plan and its commission rates.
DELETE
/
api
/
v1
/
finance
/
bank-accounts
/
{bankAccountId}
/
repayment-plans
/
{repaymentPlanId}
Delete repayment plan
curl --request DELETE \
--url https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId} \
--header 'Authorization: Bearer <token>' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.DeleteAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'DELETE',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/finance/bank-accounts/{bankAccountId}/repayment-plans/{repaymentPlanId}"
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>"
}
response = requests.delete(url, headers=headers)
print(response.text){
"Success": false,
"ResultCode": "8025",
"Message": "The repayment plan cannot be deleted because it is used by other records.",
"Errors": [
{
"Code": "8025",
"Message": "The repayment plan cannot be deleted because it is used by other records."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "8010",
"Message": "Bank account not found.",
"Errors": [
{
"Code": "8010",
"Message": "Bank account not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}A repayment plan used by other records cannot be deleted (
8025); the plan’s own commission rates are not part of this check, they are deleted with the plan.
Error codes
Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.| Code | HTTP | Meaning |
|---|---|---|
8010 | 404 | Bank account not found |
8020 | 404 | Repayment plan not found |
8025 | 400 | The repayment plan cannot be deleted because it is used by other records |
Authorizations
Headers
Path Parameters
Response
No Content