Skip to content

Create Company

| View as Markdown

This API will register the company for creating invoice for accepting payments. We must pass company name, company domain, company code, company address, company email, invoice expire hours, airpay merchant id, username, password, secret key, return format, emailcc and company token in request. If the request has valid details, we will get company token, company id and message “company successfully created”.

https://kraken.airpay.co.in/airpay/ms/invoicepay/api/create-company
FieldTypeRequiredDescription
companynameVarcharYesName of the company (length 50)
companydomainVarcharYesCompany domain (length 50)
companycodeVarcharYesUnique company code (length 7)
companyaddressVarcharYesCompany address (length 250)
companyemailVarcharYesEmail of the company (length 50)
invoiceexpirehoursNumericNoExpiry hours for the invoices of the respective company (length 5)
merchantidNumericYesAirpay Merchant ID (length 11)
usernameVarcharYesAirpay Username (length 50)
secretkeyVarcharYesAirpay Secret Key (length 100)
passwordVarcharYesAirpay Password (length 50)
returnformatVarcharNoResponse format (length 20)
Supported values: json, xml, urlencoded
emailccVarcharNoMultiple email IDs to keep in CC for notifications sent to customer (length 255)
chargesVarcharNoCharges on different transaction modes (length 255)
"pgdc":"1.10" - Debit card surcharge amount
"pgcc":"1.15" - Credit card surcharge amount
"nb":"1.50" - Net banking surcharge amount
returncompanytokenNumericNoReturn company secret token in response (length 1)
Example: 1 for yes
{
"companyname": "newcompanynew",
"companydomain": "ak",
"companycode": "4351",
"companyaddress": "kochi",
"companyemail": "newcompany@xyz.com",
"invoiceexpirehours": "168",
"merchantid": "1088",
"username": "1234567",
"secretkey": " 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps",
"password": " PaSSA7ab",
"returnformat": "json",
"emailcc": "xyz@gmail.com",
"charges": {
"pgdc": "1.10",
"pgcc": "1.15",
"nb": "1.50"
}
}
FieldTypeDescription
successNumericSuccess code
Success - 200 (The transaction is success)
Transaction in Process - 211 (The transaction is processing)
Failed - 400 (The transaction is failed)
Dropped - 401 (The transaction will not register properly)
Cancel - 402 (payment that has not yet been processed)
Incomplete - 403 (Not recieved any call back from bank)
Bounced - 405 (The transaction has bounced)
No Records - 503 (There are no records found)
messageVarcharSuccess message with data.
HTTP/1.1 200 OK
{
"success": "200",
"message": {
"data": {
"companytoken": "91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps",
"COMPANY_ID": "124",
"comCreation": "company successfully created"
}
}
}
HTTP/1.1 502 Not Found
{
"status": 502,
"message": []
}