Endpoint
POST https://{baseUrl}/api/sp1403
Request Parameters
string
required
Business mode hava
B,C. B is enterprise. C is individual.string
required
bank country code (e.g.
US) ISO 3166-1 alpha-2.string
required
ISO 4217 3-letter currency code (e.g.
USD). Omit this field to retrieve balances for all currencies.string
required
paymentMode value is LOCAL or SWIFT.
string
payoutType value is
WALLET, BANK(Optional).string
required
payoutMethod value from List PayoutMethod API, when value SWIFT is
WIRE.Request Example
{
"bizMode": "B",
"countryCode": "IN",
"currency": "INR",
"paymentMode": "LOCAL",
"payoutType": "",
"payoutMethod": "IMPS"
}
{
"bizMode": "C",
"countryCode": "IN",
"currency": "INR",
"paymentMode": "LOCAL",
"payoutType": "",
"payoutMethod": "IMPS"
}
Response Body
object
field dict list information.
Show fieldDictList fields
Show fieldDictList fields
string
required
request field name.
fieldType
required
fieldType value is
select/input/file. select is use enum value.string
required
isRequired value is
M/O/C/S. M: Required, O:Optional, C: Conditional,S: Advisedstring
required
request field name desc.
string
required
request param value min length.
string
required
request param value max length.
string
required
sort order.
Response Example
{
"fieldDictList": [{
"isRequired": "M",
"fieldName": "registerCountry",
"minLength": 0,
"fieldDesc": "Company Registration Country",
"sort": 0,
"fieldType": "select",
"maxLength": 2
}, {
"isRequired": "O",
"fieldName": "businessLicenseImg",
"minLength": 0,
"fieldDesc": "Upload Business License",
"sort": 1,
"fieldType": "file",
"maxLength": 255
}, {
"isRequired": "O",
"fieldName": "registerCertImg",
"minLength": 0,
"fieldDesc": "Upload Business Registration Certificate (BR)",
"sort": 2,
"fieldType": "file",
"maxLength": 255
}, {
"isRequired": "O",
"fieldName": "incorporateCertImg",
"minLength": 0,
"fieldDesc": "Upload Company Registration Certificate (CI)",
"sort": 3,
"fieldType": "file",
"maxLength": 255
}, {
"isRequired": "M",
"fieldName": "addressCountry",
"minLength": 0,
"fieldDesc": "Country/Region",
"sort": 4,
"fieldType": "select",
"maxLength": 10
}, {
"isRequired": "M",
"fieldName": "addressProvince",
"minLength": 0,
"fieldDesc": "Province/State",
"sort": 5,
"fieldType": "input",
"maxLength": 64
}, {
"isRequired": "M",
"fieldName": "addressCity",
"minLength": 0,
"fieldDesc": "City",
"sort": 6,
"fieldType": "input",
"maxLength": 64
}, {
"isRequired": "O",
"fieldName": "phoneAreaCode",
"minLength": 0,
"fieldDesc": "Phone Area Code",
"sort": 7,
"fieldType": "select",
"maxLength": 16
}, {
"isRequired": "O",
"fieldName": "phoneNo",
"minLength": 0,
"fieldDesc": "Phone",
"sort": 8,
"fieldType": "input",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "postCode",
"minLength": 0,
"fieldDesc": "Postal Code",
"sort": 9,
"fieldType": "input",
"maxLength": 20
}, {
"isRequired": "M",
"fieldName": "addressLine",
"minLength": 0,
"fieldDesc": "Address",
"sort": 10,
"fieldType": "input",
"maxLength": 255
}, {
"isRequired": "M",
"fieldName": "accountNo",
"minLength": 0,
"fieldDesc": "Account Number",
"sort": 20,
"fieldType": "input",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "companyName",
"minLength": 0,
"fieldDesc": "Account Name",
"sort": 21,
"fieldType": "input",
"maxLength": 250
}, {
"isRequired": "M",
"fieldName": "bankCode",
"minLength": 0,
"fieldDesc": "Bank Code",
"sort": 25,
"fieldType": "select",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "ifscCode",
"minLength": 0,
"fieldDesc": "IFSC Code",
"sort": 26,
"fieldType": "input",
"maxLength": 11
}, {
"isRequired": "S",
"fieldName": "relationProof",
"minLength": 0,
"fieldDesc": "Supporting Materials",
"sort": 39,
"fieldType": "file",
"maxLength": 500
}]
}
{
"fieldDictList": [{
"isRequired": "M",
"fieldName": "accountNo",
"minLength": 0,
"fieldDesc": "Account Number",
"sort": 0,
"fieldType": "input",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "firstName",
"minLength": 0,
"fieldDesc": "First Name",
"sort": 5,
"fieldType": "input",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "lastName",
"minLength": 0,
"fieldDesc": "Last Name",
"sort": 6,
"fieldType": "input",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "addressCountry",
"minLength": 0,
"fieldDesc": "Country/Region",
"sort": 12,
"fieldType": "select",
"maxLength": 10
}, {
"isRequired": "M",
"fieldName": "addressProvince",
"minLength": 0,
"fieldDesc": "Province/State",
"sort": 13,
"fieldType": "input",
"maxLength": 64
}, {
"isRequired": "M",
"fieldName": "addressCity",
"minLength": 0,
"fieldDesc": "City",
"sort": 14,
"fieldType": "input",
"maxLength": 64
}, {
"isRequired": "S",
"fieldName": "phoneAreaCode",
"minLength": 0,
"fieldDesc": "Phone Area Code",
"sort": 15,
"fieldType": "select",
"maxLength": 16
}, {
"isRequired": "S",
"fieldName": "phoneNo",
"minLength": 0,
"fieldDesc": "Phone",
"sort": 16,
"fieldType": "input",
"maxLength": 50
}, {
"isRequired": "M",
"fieldName": "postCode",
"minLength": 0,
"fieldDesc": "Postal Code",
"sort": 17,
"fieldType": "input",
"maxLength": 20
}, {
"isRequired": "M",
"fieldName": "addressLine",
"minLength": 0,
"fieldDesc": "Address",
"sort": 18,
"fieldType": "input",
"maxLength": 255
}, {
"isRequired": "S",
"fieldName": "relationProof",
"minLength": 0,
"fieldDesc": "Supporting Materials",
"sort": 50,
"fieldType": "file",
"maxLength": 500
}]
}