Enums
Enums, or enumerations, are a cornerstone of the Felloh API, providing a set of named values that represent various options or configurations in our system. By leveraging enums, we enable developers to handle a wide range of functionalities with ease, ensuring a consistent and manageable approach to dealing with multiple states and options.
We occasionally expand our system's capabilities by adding new enums to accommodate evolving requirements. To keep our clients and developers updated with the latest configurations, we expose these enums via an API. This allows for real-time access to the most current set of enums, eliminating the need to manually track updates or changes.
Accessing these enums through our API offers flexibility and ensures that your integrations remain robust and future-proof. It accounts for any additions or modifications that may arise over time, allowing seamless adaptation to new features or changes.
Fetch All
This endpoint retrieves all enums. Enums are grouped by entity, in alphabetical order.
Response
Returns an object containing all enums.
Request
import axios from 'axios';
const response = await axios.get(
'https://api.felloh.com/enums',
{
headers: { 'Content-Type': 'application/json' }
}
);
Response
{
"data": {
"currency": {
"EUX": {
"division_factor": 100,
"major_unit": "EUR",
"minor_unit": "EUX"
},
"GBX": {
"division_factor": 100,
"major_unit": "GBP",
"minor_unit": "GBX"
},
"USX": {
"division_factor": 100,
"major_unit": "USD",
"minor_unit": "USX"
}
},
"organisation": {
"feature": [
"developers",
"risk",
"booking-and-payment",
"users",
"ledger",
"payouts",
"acquirer-reporting",
"organisation",
"audit",
"suppliers",
"chargebacks",
"supplier-payouts"
]
},
"transaction": {
"method": [
"MOTO_OTHER",
"ONLINE",
"MOTO_IN_PERSON"
],
"status": [
"COMPLETE",
"DECLINED",
"REJECTED",
"PAYMENTINPROGRESS",
"PENDING",
"ABANDONED"
],
"type": [
"CARD",
"OPEN_BANKING"
]
},
"user": {
"role": [
"developers:manage:keys",
"developers:manage:webhooks",
"beneficiaries:manage",
"payouts:view",
"payouts:create",
"organisation:risk:statistics",
"organisation:audit",
"booking-and-payment:create-options",
"booking-and-payment:organisation-access",
"booking-and-payment:organisation-access",
"organisation:booking:statistics",
"suppliers:manage",
"users:manage",
"organisation:management",
"ledger:view",
"chargebacks:view",
"booking-and-payment:create:booking",
"booking-and-payment:delete:booking",
"charges:view",
"booking-and-payment:create:payment",
"booking-and-payment:delete:booking",
"booking-and-payment:reassign:booking"
]
}
},
"errors": [],
"meta": {
"code": 200,
"reason": "OK",
"message": "The request was successful",
"request_id": "e79dd7f9-b776-4d50-8ffe-741664d5573f"
}
}