Choose a language javascript

Enums

This page includes information about the enums employed in our systems. We do from time to time have to add enums, we therefore expose these via an API.


Fetching Enums

GET/enums

import axios from 'axios';
const response = await axios(
{
method: 'get',
url: 'https://api.felloh.com/enums',
headers: {
'Content-Type': 'application/json',
},
}
);

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"
}
}

This endpoint retrieves all enums. Enums are grouped by entity, in alphabetical order.

HTTP Method

POST

HTTP Endpoint

PRODhttps://api.felloh.com/enums

SANDBOXhttps://sandbox.felloh.com/enums

Response

Returns an object containing all enums