Skip to main content

Payouts to India

Payout parameters

NameTypeMandatoryDescription
payment_methodPaymentMethod+Payout data
 typestring+Value: bank_account
 bank_accountBankAccountPaymentMethod+Bank account
  system_typestring+Value: global
  globalBankAccountGlobal+Bank account details
   descriptionstring+Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
   bank_account_numberstring+Bank account number for the payout
   ifs_codestring+IFS code (an alphanumeric value of 11 characters: ABCD (bank name) 1 (reserved symbol for future use) 234567 (branch))
participant_detailsParticipantDetails+Information on payout participants
 recipientParticipant+Recipient details
  bank_namestring+Bank name
  currencystring+Recipient's currency in ISO 4217 format. Case insensitive
  first_namestring+Recipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  last_namestring+Recipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout
  country_iso3string+Recipient's country code (ISO-3166-1 alpha-3)
 senderParticipant+Sender details
  company_namestring+Sender company name. Limited to 100 characters, cannot contain digits only
  registration_numberstring+Sender company registration number
  country_iso3string+Sender’s country code (ISO-3166-1 alpha-3)
  address_linestring+Always: Unit A, 11/F, Arthur Commercial Building, 33 Arthur Street, Yau Ma Tei, Kowloon
  codestring+Sender company registration number
amount_detailsAmountDetails+Payout amount details
 amountint+Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
 currencystring+ISO 4217 currency code. Case insensitive

Example

curl -X POST \
https://demo.smart-glocal.com/api/v1/session/start/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d'{
"session_id": "ps_1053680",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "global",
"global": {
"bank_account_number": "NUMBER_VALUE",
"ifs_code": "1234567ABCD",
"description": "purpose of remittance"
}
}
},
"participant_details": {
"recipient": {
"bank_name": "All Banks / Payment System: Default",
"currency": "inr",
"first_name": "John",
"last_name": "Johnson",
"country_iso3": "IND"
}
},
"sender": {
"company_name": "Company name",
"registration_number": "1234567890",
"country_iso3": "USA",
"address_line": "Wall street",
"code": "1234567890"
},
"amount_details": {
"amount": 1000,
"currency": "usd"
}
}
CountryCurrencyBank
IndiaINRAll Banks / Payment System: Default