Create Disbursement

The Create Disbursement API allows merchants to initiate a disbursement request. This process involves generating a disbursement ID that can be used to query the disbursement. Upon validation of request body information, the create disbursement request will be confirmed.

Endpoint

Request URL: https://apihit.net/api/disbursement/create

Request Headers

Header Name	Value
Content-Type	application/json
Accept	application/json
X-Signature	The HMAC signature used for verification.

Request Parameters

Property	Presence	Type	Description
mid	Mandatory	String	Provided by creedo during onboarding.
disbursement_method	Mandatory	String	This parameter indicates the method of disbursement. For IMPS, the value of this parameter should be "IMPS".
merchant_disbursement_id	Mandatory	String	Unique invoice number used on the merchant side for this specific disbursement. Max length is 25 characters. Special characters "<", ">" and "&" are not allowed.
disbursement_amount	Mandatory	Integer	Amount of the disbursement to be made.
disbursement_currency	Mandatory	String	Currency of the mentioned amount. For IMPS, the value of this parameter should be "INR".
account_details	Mandatory.	Object	Contains beneficiary bank account details required for IMPS transfer.
account_details.account_number	Mandatory	String	Beneficiary bank account number where Creedo will send the disbursement amount.
account_details.ifsc_code	Mandatory	String	IFSC code of the beneficiary bank branch (e.g., SBIN0001234).
account_details.bank_code	Mandatory	String	Bank code from the Supported Banks list (e.g., state-bank-of-india).
ipn_url	Mandatory	String	URL where creedo sends Instant Disbursement Notification. It must accept POST request from creedo.
customer_id	Mandatory	String	Unique user ID on the merchant's side.
customer_name	Mandatory	String	Full name of the user on the merchant's side.
customer_phone_number	Mandatory	String	Registered phone number of the user on the merchant's side.
customer_email	Mandatory	String	Registered email address of the user on the merchant's side.
customer_ip	Mandatory	String	Current IP address of the user.
customer_type	Optional	String	Type of the user. Possible values: Trusted, FTD, MTD, YTD, Others.
btag	Optional	String	Btag identifier of the customer.
additional_info_1	Optional	String	Additional information.
additional_info_2	Optional	String	Additional information.

Success Response Parameters

Property	Type	Description
gateway_status	String	"accepted"
creedo_disbursement_id	String	Creedo-generated disbursement ID for this disbursement creation request. This disbursement ID can be used later to track the disbursement and in other disbursement-related APIs.

Error Response Parameters

Property	Type	Description
gateway_status	String	"rejected"
message	String	Error message here.

Signature Generation

The signature (X-Signature) is generated using HMAC with SHA-256. It uses the secret_key and a secret_string as inputs. All inputs should be in string format:

secret_string = mid:merchant_disbursement_id:disbursement_method:disbursement_currency:disbursement_amount

Request Body

POST /api/disbursement/create HTTP/1.1
Host: https://apihit.net
Content-Type: application/json
Accept: application/json
X-Signature: <hash_str>

{
  "mid": "CREEDO12345",
  "disbursement_method": "IMPS",
  "merchant_disbursement_id": "INV123456789",
  "disbursement_amount": 5000,
  "disbursement_currency": "INR",
  "account_details": {
      "account_number": "91801008xxxxxxx",
      "ifsc_code": "SBIN0001234",
      "bank_code": "state-bank-of-india" //Bank code
  },
  "ipn_url": "https://example.com/ipn-handler",
  "customer_id": "USER12345",
  "customer_name": "John Doe",
  "customer_phone_number": "+9198XXXXXXXX",
  "customer_email": "johndoe@example.com",
  "customer_ip": "192.168.1.1",
  "customer_type": "Trusted",  // Optional
  "btag": "BTAG001",  // Optional
  "additional_info_1": "Loyal customer",  // Optional
  "additional_info_2": ""  // Optional
}

Success Response

A successful response will return a JSON object containing:

{
  "gateway_status": "accepted",
  "creedo_disbursement_id": "3C8HL0MHX9"
}

Error Response

In case of an error, the API will return a JSON object with error details:

{
    "gateway_status": "rejected",
    "message": "Unknown error occurred."
}

Notes

• The merchant_disbursement_id must be unique for each transaction to prevent duplication.

Supported Banks

The value sent in account_details.bank_code must be one of the Bank Code values listed below.

Bank Code	Bank Name
abhyudaya-cooperative-bank	Abhyudaya Co-operative Bank Limited
abn-amro-bank	ABN AMRO Bank N.V.
abu-dhabi-commercial-bank	Abu Dhabi Commercial Bank
aditya-birla-payments-bank	Aditya Birla Payments Bank
ahmedabad-mercantile-cooperative-bank	Ahmedabad Mercantile Co-operative Bank
airtel-payments-bank	Airtel Payments Bank
allahabad-bank	Allahabad Bank
andhra-bank	Andhra Bank
andhra-pradesh-grameena-vikas-bank	Andhra Pradesh Grameena Vikas Bank
andhra-pragathi-grameena-bank	Andhra Pragathi Grameena Bank
arunachal-pradesh-rural-bank	Arunachal Pradesh Rural Bank
aryavart-bank	Aryavart Bank
assam-gramin-vikash-bank	Assam Gramin Vikash Bank
au-small-finance-bank	AU Small Finance Bank
axis-bank	Axis Bank Limited
bandhan-bank	Bandhan Bank
bangiya-gramin-vikash-bank	Bangiya Gramin Vikash Bank
bank-of-america	Bank of America
bank-of-bahrain-and-kuwait	Bank of Bahrain and Kuwait
bank-of-baroda	Bank of Baroda
bank-of-india	Bank of India
bank-of-maharashtra	Bank of Maharashtra
bank-of-nova-scotia	Bank of Nova Scotia
bank-of-rajasthan	Bank of Rajasthan
barclays-bank	Barclays Bank PLC
baroda-gujarat-gramin-bank	Baroda Gujarat Gramin Bank
baroda-rajasthan-kshetriya-gramin-bank	Baroda Rajasthan Kshetriya Gramin Bank
baroda-uttar-pradesh-gramin-bank	Baroda Uttar Pradesh Gramin Bank
bassein-catholic-cooperative-bank	Bassein Catholic Co-operative Bank
bharat-cooperative-bank-mumbai	Bharat Co-operative Bank (Mumbai)
bharatpe	BharatPe
bnp-paribas-india	BNP Paribas India
canara-bank	Canara Bank
capital-small-finance-bank	Capital Small Finance Bank
central-bank-of-india	Central Bank of India
chaitanya-godavari-grameena-bank	Chaitanya Godavari Grameena Bank
chhattisgarh-rajya-gramin-bank	Chhattisgarh Rajya Gramin Bank
citibank-india	Citibank India
citizencredit-cooperative-bank	CitizenCredit Co-operative Bank
city-union-bank	City Union Bank Limited
coastal-bank	COASTAL BANK
corporation-bank	Corporation Bank
cosmos-cooperative-bank	Cosmos Co-operative Bank
csb-bank	CSB Bank (Catholic Syrian Bank)
dakshin-bihar-gramin-bank	Dakshin Bihar Gramin Bank
dbs-bank-india	DBS Bank India
dcb-bank	DCB Bank
dena-bank	Dena Bank
deposit-insurance-and-credit-guarantee-corporation	Deposit Insurance and Credit Guarantee Corporation
deutsche-bank	Deutsche Bank
dhanalakshmi-bank	Dhanalakshmi Bank
ellaquai-dehati-bank	Ellaquai Dehati Bank
equitas-bank	Equitas Bank
esaf-small-finance-bank	ESAF Small Finance Bank
exim-bank	Exim Bank
federal-bank	Federal Bank Limited
fincare-small-finance-bank	Fincare Small Finance Bank
fino-payments-bank	Fino Payments Bank
greater-bombay-cooperative-bank	Greater Bombay Co-operative Bank
hdfc-bank	HDFC Bank Limited
himachal-pradesh-gramin-bank	Himachal Pradesh Gramin Bank
hsbc-india	HSBC India
icici-bank	ICICI Bank Limited
idbi-bank	IDBI Bank Limited
idfc-first-bank	IDFC First Bank
india-post-payments-bank	India Post Payments Bank
indian-bank	Indian Bank
indian-overseas-bank	Indian Overseas Bank
indusind-bank	IndusInd Bank
ing-vysya-bank	ING Vysya Bank
jammu-and-kashmir-bank	Jammu and Kashmir Bank
jana-small-finance-bank	Jana Small Finance Bank
janakalyan-sahakari-bank	Janakalyan Sahakari Bank
janata-sahakari-bank-pune	JANATA SAHAKARI BANK PUNE
jharkhand-rajya-gramin-bank	Jharkhand Rajya Gramin Bank
jio-payments-bank	Jio Payments Bank
jk-grameen-bank	J&K Grameen Bank
jpmorgan-chase-bank	JPMorgan Chase Bank
kalupur-commercial-cooperative-bank	Kalupur Commercial Co-operative Bank
kalyan-janata-sahakari-bank	Kalyan Janata Sahakari Bank
karnataka-bank	Karnataka Bank Limited
karnataka-gramin-bank	Karnataka Gramin Bank
karnataka-state-apex-cooperative-bank	Karnataka State Apex Co-operative Bank
karnataka-vikas-grameena-bank	Karnataka Vikas Grameena Bank
karur-vysya-bank	Karur Vysya Bank Limited
kashi-gomti-samyut-gramin-bank	Kashi Gomti Samyut Gramin Bank
kerala-gramin-bank	Kerala Gramin Bank
kotak-mahindra-bank	Kotak Mahindra Bank Limited
lakshmi-vilas-bank	Lakshmi Vilas Bank Limited
madhya-bihar-gramin-bank	Madhya Bihar Gramin Bank
madhyanchal-gramin-bank	Madhyanchal Gramin Bank
mahanagar-cooperative-bank	Mahanagar Co-operative Bank
maharashtra-gramin-bank	Maharashtra Gramin Bank
maharashtra-state-cooperative-bank	Maharashtra State Co-operative Bank
manipur-rural-bank	Manipur Rural Bank
mashreqbank	Mashreqbank PSC
meghalaya-rural-bank	Meghalaya Rural Bank
mehsana-urban-cooperative-bank	Mehsana Urban Co-operative Bank
mizoram-rural-bank	Mizoram Rural Bank
mizuho-bank-india	Mizuho Bank India
nainital-bank	Nainital Bank Limited
new-india-cooperative-bank	New India Co-operative Bank
nkgsb-cooperative-bank	NKGSB Co-operative Bank
north-east-small-finance-bank	North East Small Finance Bank
nutan-nagarik-sahakari-bank	Nutan Nagarik Sahakari Bank
oman-international-bank	Oman International Bank SAOG
oriental-bank-of-commerce	Oriental Bank of Commerce
parsik-janata-sahakari-bank	Parsik Janata Sahakari Bank
paytm-payments-bank	Paytm Payments Bank
punjab-and-maharashtra-cooperative-bank	Punjab and Maharashtra Co-operative Bank
punjab-and-sind-bank	Punjab and Sind Bank
punjab-national-bank	Punjab National Bank
ratnakar-bank	Ratnakar Bank Limited
reserve-bank-of-india	Reserve Bank of India
royal-bank-of-scotland	Royal Bank of Scotland
saraswat-cooperative-bank	Saraswat Co-operative Bank
saraswat-vithal-cooperative-bank	Saraswat Vithal Co-operative Bank
shinhan-bank-india	Shinhan Bank India
small-industries-development-bank-of-india	Small Industries Development Bank of India
smart-pay	Smart Pay
societe-generale	Société Générale
south-indian-bank	South Indian Bank Limited
standard-chartered-bank-india	Standard Chartered Bank India
state-bank-of-bikaner-and-jaipur	State Bank of Bikaner and Jaipur
state-bank-of-hyderabad	State Bank of Hyderabad
state-bank-of-india	State Bank of India
state-bank-of-mauritius	State Bank of Mauritius
state-bank-of-mysore	State Bank of Mysore
state-bank-of-patiala	State Bank of Patiala
state-bank-of-travancore	State Bank of Travancore
surat-peoples-cooperative-bank	Surat Peoples Co-operative Bank
suryoday-bank	SuryodayBank
syndicate-bank	Syndicate Bank
tamilnad-mercantile-bank	Tamilnad Mercantile Bank Limited
tamilnadu-state-apex-cooperative-bank	Tamilnadu State Apex Co-operative Bank
thane-janata-sahakari-bank	Thane Janata Sahakari Bank
uco-bank	UCO Bank
ujjivan-small-finance-bank	Ujjivan Small Finance Bank
union-bank-of-india	Union Bank of India
united-bank-of-india	United Bank of India
utkarsh-small-finance-bank	Utkarsh Small Finance Bank
uttar-banga-kshetriya-gramin-bank	Uttar Banga Kshetriya Gramin Bank
vijaya-bank	Vijaya Bank
yes-bank	Yes Bank Limited