Create Company
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-companyRequest Body
Section titled “Request Body”| Parameter | Type Value | Description | Value Like |
|---|---|---|---|
| companyname required | Varchar | Need to pass the name of the company (length 1-50) | newcompanynew |
| companydomain required | Varchar | Need to pass the company domain (length 1-50) | ak |
| companycode required | Varchar | Need to pass the unique company code (length 1-7) | 4351 |
| companyaddress required | Varchar | Need to pass the company address (length 1-250) | kochi |
| companyemail required | Varchar | Need to pass the email of the company (length 1-50) | newcompany@xyz.com |
| invoiceexpirehours optional | Numeric | Can pass the expiry hours for the invoices of the respective company (length 1-5) | 168 |
| merchantid required | Numeric | Need to pass the airpay merchant id (length 1-11) | 1088 |
| username required | Varchar | Need to pass the airpay username (length 1-50) | 1234567 |
| secretkey required | Varchar | Need to pass the airpay secret key (length 1-100) | 91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps |
| password required | Varchar | Need to pass the airpay password (length 1-50) | PaSSA7ab |
| returnformat optional | Varchar | Can pass the format for response (length 1-20) json or xml or urlencoded | json |
| emailcc optional | Varchar | Can pass the multiple emails to keep in cc of notifications sent to customer (length 1-255) | xyz@gmail.com |
| charges optional | Varchar | Can pass the charges on the modes on the different modes of transaction (length 1-255) “pgdc”:“1.10” (debitcard surcharge amount) “pgcc”:“1.15”(creditcard surcharge amount) “nb”:“1.50”(netbank surcharge amount) | pgdc:1.10 |
| returncompanytoken optional | Numeric | Can pass to get company secret token in response (length 1) Eg. 1 for yes | 1 |
Success 200
Section titled “Success 200”| Parameter | Type Value | Description | Value Like |
|---|---|---|---|
| success required | Numeric | Success 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) | 200 |
| message required | Varchar | Success message with data. |
Request Example
Section titled “Request Example”{ "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" }}Success Response
Section titled “Success Response”HTTP/1.1 200 OK{ "success": "200", "message": { "data": { "companytoken": "91f5evhk72f56432ec678sdfes685h42sd2t21k430912508233b7r37562g2hps", "COMPANY_ID": "124", "comCreation": "company successfully created" } }}Error Response
Section titled “Error Response”HTTP/1.1 502 Not Found { "status": 502, "message": [] }