Falcon offering a financial API has various scenarios developers can face throughout development. The Falcon API is designed to provide the maximum level of information in case of any error to avoid any inconvenience based on different business scenarios. Here is a list of implemented internal errors for other endpoints.
User API
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Message (code, field) |
|---|---|---|---|---|
| Check User | User not found | 404 | NOT_FOUND | - Employee does not exist (1001, null) |
| Check User | Invalid mobile number format | 400 | BAD_REQUEST | - Mobile Number should be a 10 digit number starting with 6, 7, 8 or 9 (1002, mobileNumber) |
| Add User | Input fields invalid format | 400 | BAD_REQUEST | - First Name can contain only alphabets (5050, null) - Last Name can contain only alphabets (5050, null) - Mobile Number should be a 10 digit number starting with 6, 7, 8 or 9 (5050, null) - Date format should be yyyy-mm-dd with valid values (5050, null) - Date of birth should be in past (1211, null) - gender can only contain values FEMALE, MALE (1002, gender) - marriedStatus can only contain values SINGLE, MARRIED (1002, marriedStatus) - KYC address 1 should be between 1 to 100 characters (1002, address1) - KYC address 2 should be between 1 to 100 characters (1002, address2) - KYC address 3 should be between 1 to 100 characters (1002, address3) - KYC city should be between 1 to 30 characters long (1002, city) - KYC state should be between 1 to 30 characters long (1002, state) - KYC zip code is not in correct format (1002, pinCode) - Delivery address 1 should be between 1 to 100 characters (1002, address1) - Delivery address 2 should be between 1 to 100 characters (1002, address2) - Delivery address 3 should be between 1 to 100 characters (1002, address3) - Delivery city should be between 1 to 30 characters long (1002, city) - Delivery state should be between 1 to 30 characters long (1002, state) - Delivery zip code is not in correct format (1002, pinCode) |
| Add User | User already registered | 400 | BAD_REQUEST | - Mobile no already in use. Please enter a different one. (1012, mobile) |
| Update User | User not found | 404 | NOT_FOUND | - Supplied user id does not belong to any registered user (1002, null) |
| Update User | Input fields invalid format | 400 | BAD_REQUEST | - First Name can contain only alphabets (5050, null) - Last Name can contain only alphabets (5050, null) - Mobile Number should be a 10 digit number starting with 6, 7, 8 or 9 (5050, null) - Date format should be yyyy-mm-dd with valid values (5050, null) - Date of birth should be in past (1211, null) - gender can only contain values FEMALE, MALE (1002, gender) - marriedStatus can only contain values SINGLE, MARRIED (1002, marriedStatus) - KYC address 1 should be between 1 to 100 characters (1002, address1) - KYC address 2 should be between 1 to 100 characters (1002, address2) - KYC address 3 should be between 1 to 100 characters (1002, address3) - KYC city should be between 1 to 30 characters long (1002, city) - KYC state should be between 1 to 30 characters long (1002, state) - KYC zip code is not in correct format (1002, pinCode) - Delivery address 1 should be between 1 to 100 characters (1002, address1) - Delivery address 2 should be between 1 to 100 characters (1002, address2) - Delivery address 3 should be between 1 to 100 characters (1002, address3) - Delivery city should be between 1 to 30 characters long (1002, city) - Delivery state should be between 1 to 30 characters long (1002, state) - Delivery zip code is not in correct format (1002, pinCode) |
Bank API
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Generate OTP | User not found | 400 | NOT_FOUND | - Supplied user id does not belong to any registered user (1002, null) |
| Verify OTP | OTP format error | 400 | BAD_REQUEST | - OTP should be between 4 and 6 characters long (5050, null) |
| Verify OTP | Invalid OTP | 400 | BAD_REQUEST | - Invalid OTP (6030, R05) |
| Minimum KYC | Invalid token | 400 | BAD_REQUEST | - Token size must be between 1 and 36 (5050, null) |
| Minimum KYC - PAN | Invalid PAN | 400 | BAD_REQUEST | - PAN is invalid (6030, R133) |
| Minimum KYC - AADHAAR | Invalid Aadhaar | 400 | BAD_REQUEST | - Pa (address) attributes of demographic data did not match (6030, R84) |
Card API
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Get Card Details | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Get Card Details | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Get Card Policy | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Get Card Policy | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Enable / Disable Card | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Enable / Disable Card | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Enable / Disable Channel | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Enable / Disable Channel | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Block Card | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Block Card | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
Card.Physical
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Add Physical Card | Invalid VPAN format | 400 | BAD_REQUEST | - VPAN should have 2 uppercase letters followed by 14 digits (1002, cardNumber) |
| Add Physical Card | VPAN already in use | 400 | BAD_REQUEST | - VPAN KE00000000000119 is already in use (2816, null) |
| Add Personalized Physical Card | Card already created | 400 | BAD_REQUEST | - User already has an active card (2804, null) |
| Add Personalized Physical Card | User not found on bank system | 400 | BAD_REQUEST | - User is not onboarded on bank (2607, null) |
| Add Personalized Physical Card | Insufficient KYC | 400 | FORBIDDEN | - User KYC not completed (6027, null) |
| Set Physical Card Pin | PIN policy violated | 400 | BAD_REQUEST | - PIN policy violated (6027, null) |
Card.Virtual
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Add Virtual Card | Card already created | 400 | BAD_REQUEST | - User already has an active card (2804, null) |
| Add Virtual Card | User not found on bank system | 400 | BAD_REQUEST | - User is not onboarded on bank (2607, null) |
| Add Virtual Card | Insufficient KYC | 403 | FORBIDDEN | - User KYC not completed (6027, null) |
| Get Virtual Card CVV | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Get Virtual Card CVV | Card is not virtual | 400 | BAD_REQUEST | - Card is not virtual (2808, null) |
| Get Virtual Card CVV | Card is disabled | 400 | BAD_REQUEST | - Card is disabled (2808, null) |
Funds API
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Add Funds | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Add Funds | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Add Funds | Amount Required | 400 | BAD_REQUEST | - Amount may not be null (5050, null) |
| Add Funds | Insufficient Balance | 400 | BAD_REQUEST | - Insufficient Balance (2825, null) |
Payment API
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Perform UPI Payment | Amount Required | 400 | BAD_REQUEST | - Amount may not be null (5050, null) |
| Perform UPI Payment | Invalid VPA | 400 | BAD_REQUEST | - VPA URL is invalid (4500, null) |
Report API
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Get User Transactions | Invalid date format | 400 | BAD_REQUEST | - Start Date is not in valid format (5050, null) - End Date is not in valid format (5050, null) |
| Get User Transactions | Invalid date range | 400 | BAD_REQUEST | - Start Date is greater than End Date (5050, null) |
| Get Card Transactions | Invalid card id format | 400 | BAD_REQUEST | - Card Id is not in valid format (1002, cardId) |
| Get Card Transactions | Card not found | 400 | BAD_REQUEST | - Card not found (2808, null) |
| Get Card Transactions | Invalid date format | 400 | BAD_REQUEST | - Start Date is not in valid format (5050, null) - End Date is not in valid format (5050, null) |
| Get Card Transactions | Invalid date range | 400 | BAD_REQUEST | - Start Date is greater than End Date (5050, null) |
Enterprise
| Endpoint | Scenario | HTTP Code | HTTP Message | Error Messages (code, field) |
|---|---|---|---|---|
| Get Enterprise Balance | Unsupported Bank | 400 | BAD_REQUEST | - Bank name is invalid (1002, bankName) |