curl --request POST \
--url {banking_api_base_url}/banking/payment/initiate-request \
--header 'Content-Type: application/json' \
--header 'x-client-id: <App ID>' \
--header 'x-client-secret: <Secret Key>' \
--header 'order-source: reset-api' \
--data-raw '{
"event_name": "fund_transfer",
"debit_account_number": "0003000006",
"transfer_type": "direct",
"beneficiary_mode": "onetimetransfer",
"mobile": "9896989698",
"email": "[email protected]",
"address": null,
"country_dialing_code": "91",
"country_iso_code": "IN",
"beneficiary_id": "null",
"debit_account_type": "current",
"transfer_mode": "NEFT",
"transfer_amount": "10.12",
"account_transfer": {
"account_owner_name": "beneficiary name",
"account_number": "6760654654",
"ifsc_code": "icici000143",
"is_validate": "false",
"payment_for": "salary payment"
},
"payout_order_id": "654894598459"
}'
{
"code": "200",
"status": "success",
"type": "fund_transfer[direct]",
"description": "api fund_transfer[direct] successfully performed",
"available_balance_before": "0",
"transfer_amount": "10.12",
"available_balance_after": "-10.12",
"tranfer_rrn_number": "null",
"unique_system_order_id": "payout_864c483a658b682",
"merchant_payout_order_id": "65489459c8459",
"txn_status": "pending",
"msg": "payout txn marked successfully, you will receive success and failed response from our side at your shared callback",
"transfer_time": "24-07-2023 03:11:37pm"
}
{
"error_code": "od_dup",
"status": "failed",
"error_description": "duplicate order id, kindly pass unique order id"
}
Body JSON Parameters | Type | Details | Example |
---|---|---|---|
event_name | string, required | Mode of fund transfer | fund_transfer |
debit_account_number | string, required | Fund debit account number | 9253000000000000 |
transfer_type | string, required | Select transfer type direct or beneficiary | direct |
beneficiary_mode | string, required | Mode of Beneficiary For Example - onetimetransfer for adhoc payout and non_onetimetransfer for saved Beneficiary | onetimetransfer |
mobile | string, required | Beneficiary mobile number | 9896989698 |
string, required | Beneficiary email id | [email protected] | |
address | string, required | Beneficiary address | DLF Cyber City Phase - II, Gurugram, Haryana - 122002 |
country_dialing_code | string, required | Beneficiary address country iso dialing code | 91 |
country_iso_code | string, required | Beneficiary address country iso code | IN |
beneficiary_id | string, optional | Beneficiary ID, if transfer_type is non_direct otherwise pass null | ben_dfdf6gv4df68gdf |
debit_account_type | string, required | payout current account type for India it is current | current |
transfer_amount | flot, required | payout amount value | 12.70 |
account_owner_name | string, required | Beneficiary name | John Deo |
account_number | string, required | Beneficiary account numbber | 00002335669849 |
ifsc_code | string, required | Beneficiary bank IFSC Code | KPNB0123456 |
is_validate | string, optional | Beneficiary account validation | true or false |
payment_for | string, required | reason to transfer this payment | salary payment |
payout_order_id | string, required | unique system order id (merchant software) | orderdvd8fvd8856 |
Error Code | Message |
---|---|
200 | API authentication successful! |
400 | Missing authentication parameters |
401 | Unauthorized - API authentication failed |
403 | Incoming IP address is not whitelisted |
405 | Unauthorized - Passed method not allowed |
409 | Request is not unique or correct |
422 | Missing required fields in body data or invalid JSON data |
500 | Server Error |