API References

General Enumerations

Falcon API is built across data and often requires fixed values throughout the endpoints. Details of some of the commonly used enums are as follows. Most of these enums are used either in POST or PATCH methods. However, the GET endpoints also provide these enums in responses so developers should be able to map the enums to their actual business meaning.

Banks

Bank NameStackAPI Enum
IndusInd Bank Non-JITINDUSIND
IndusInd Bank JITINDUSIND_JIT
Yes Bank JIT / Non-JITYES_BANK

📘

JIT / Non-JIT

Just-in-Time (JIT) Funding is a method of automatically funding an account in real-time during the transaction process. Refer to Just-In-Time Funding for more details.

Gender

  • MALE
  • FEMALE

Married Status

  • SINGLE
  • MARRIED

KYC Status

  • NONE
  • MINIMUM
  • FULL
  • EXPIRED

Cards Type

  • PHYSICAL
  • VIRTUAL

Card KYC Status

  • KYC_PENDING - Awaiting KYC
  • ACTIVE - Active (Ready to use)
  • INACTIVE - Permanently blocked

Card Usage Status

  • ENABLED - Enabled (ready for use)
  • DISABLED - Temporarily blocked
  • LOCKED - Permanently blocked

ATM Status

  • ENABLED
  • DISABLED

Payment Channel Status

  • ENABLED
  • DISABLED

Card Block Reason

  • LOST
  • STOLEN
  • DAMAGED

Payment Status

  • SUCCESS
  • FAILED
  • PENDING