Create a Private Limited Company application
api-version
The requested API version
3.0
ApiKey
Standard Authorization header using the ApiKey scheme.
Content-Type
Only application/json is supported.
company
The company details for the Private Limited Company application.
persons
Array of objects. List of persons of interest.
stores
Array of objects. List of stores
bankAccount
The merchant's bank account details.
fees
The fee structure applied to the merchant.
additionalAttachments
Attachment to be uploaded.
success
Indicates whether the request was successful.
statusCode
The HTTP status code of the response.
message
Created.
data
An object containing the created merchant's details.
success
Indicates whether the request was successful.
statusCode
The HTTP status code of the response.
message
Bad request.
data
success
Indicates whether the request was successful.
statusCode
The HTTP status code of the response.
message
Api Key was not provided.
data
null
success
Indicates whether the request was successful.
statusCode
The HTTP status code of the response.
message
Not Found.
data
null
success
Indicates whether the request was successful.
statusCode
The HTTP status code of the response.
message
Unexpected error occurred. Please contact support.
data
null
/isoapi/privatelimitedcompany
201 Created
curl -X POST https://boarding.valitor.com/isoapi/privatelimitedcompany -H 'ApiKey: my-ApiKey' -H 'Content-Type: application/json' -d '{ "company": { "name": "Valitor hf", "number": "FC036722", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "email": "string", "phone": "string", "invoiceStatementOnMerchantLevel": false, "tax_id": "12345678901234" }, "persons": [ { "firstName": "John", "middleName": "Thor", "lastName": "Johnson", "ssn": "010101-2340", "title": "Mr.", "position": "CEO, Head of HR, CFO", "email": "string", "phone": "string", "dateOfBirth": "1978-10-07", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "roles": [ "PrimaryContact" ], "share": 0.1, "identificationAttachment": { "file": "string", "fileName": "string" } } ], "stores": [ { "name": "My Awesome Store", "merchantCategoryCode": 1234, "acceptedCardTypes": [ "VISA" ], "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "transactionInformation": { "expectedAverageTransactionAmount": 10000, "expectedMaximumTransactionAmount": 10000, "averageTimeBetweenPurchaseAndDeliveryInDays": 1, "averageMonthlyVolume": 1000 }, "acceptedTransactionTypes": [ "ECommerce" ], "eCommerceSolutions": { "eCommerceType": "WebPaymentPage", "websiteURL": "www.example.com", "webPaymentPageInformation": { "sellerEmail": "johndoe@domain.com", "sellerPhone": "+123/4567890", "logoAttachment": { "file": "string", "fileName": "string" } } }, "recurring": false, "descriptionOfProductsAndServices": "string" } ], "bankAccount": { "bankName": "Nombre de Banco", "accountNumber": "123241234", "bankAddress": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "iban": "NWBK60161331926819", "ownerNationalIdNumber": "2501992323", "swiftNumber": "CITIDE55", "sortCode": "12-34-56", "bankAccountConfirmationAttachment": { "file": "string", "fileName": "string" }, "bankAccountConfirmed": true }, "fees": { "merchantServiceChargeFees": [ { "name": "VisaCredit", "fixedValue": 0.1, "percentageValue": 0.1 } ] }, "additionalAttachments": [ { "file": "string", "fileName": "string" } ] } '{ "success": true, "statusCode": 201, "message": "Created", "data": { "merchantName": "House of goods", "merchantId": 1000, "stores": [ { "storeName": "Store name", "agreementId": 1, "terminalId": 1 } ] } }
400 Bad Request
curl -X POST https://boarding.valitor.com/isoapi/privatelimitedcompany -H 'ApiKey: my-ApiKey' -H 'Content-Type: application/json' -d '{ "company": { "name": "Valitor hf", "number": "FC036722", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "email": "string", "phone": "string", "invoiceStatementOnMerchantLevel": false, "tax_id": "12345678901234" }, "persons": [ { "firstName": "John", "middleName": "Thor", "lastName": "Johnson", "ssn": "010101-2340", "title": "Mr.", "position": "CEO, Head of HR, CFO", "email": "string", "phone": "string", "dateOfBirth": "1978-10-07", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "roles": [ "PrimaryContact" ], "share": 0.1, "identificationAttachment": { "file": "string", "fileName": "string" } } ], "stores": [ { "name": "My Awesome Store", "merchantCategoryCode": 1234, "acceptedCardTypes": [ "VISA" ], "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "transactionInformation": { "expectedAverageTransactionAmount": 10000, "expectedMaximumTransactionAmount": 10000, "averageTimeBetweenPurchaseAndDeliveryInDays": 1, "averageMonthlyVolume": 1000 }, "acceptedTransactionTypes": [ "ECommerce" ], "eCommerceSolutions": { "eCommerceType": "WebPaymentPage", "websiteURL": "www.example.com", "webPaymentPageInformation": { "sellerEmail": "johndoe@domain.com", "sellerPhone": "+123/4567890", "logoAttachment": { "file": "string", "fileName": "string" } } }, "recurring": false, "descriptionOfProductsAndServices": "string" } ], "bankAccount": { "bankName": "Nombre de Banco", "accountNumber": "123241234", "bankAddress": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "iban": "NWBK60161331926819", "ownerNationalIdNumber": "2501992323", "swiftNumber": "CITIDE55", "sortCode": "12-34-56", "bankAccountConfirmationAttachment": { "file": "string", "fileName": "string" }, "bankAccountConfirmed": true }, "fees": { "merchantServiceChargeFees": [ { "name": "VisaCredit", "fixedValue": 0.1, "percentageValue": 0.1 } ] }, "additionalAttachments": [ { "file": "string", "fileName": "string" } ] } '{ "success": false, "statusCode": 400, "message": "Bad request", "data": { "property": "error message" } }
401 Unauthorized
curl -X POST https://boarding.valitor.com/isoapi/privatelimitedcompany -H 'ApiKey: my-ApiKey' -H 'Content-Type: application/json' -d '{ "company": { "name": "Valitor hf", "number": "FC036722", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "email": "string", "phone": "string", "invoiceStatementOnMerchantLevel": false, "tax_id": "12345678901234" }, "persons": [ { "firstName": "John", "middleName": "Thor", "lastName": "Johnson", "ssn": "010101-2340", "title": "Mr.", "position": "CEO, Head of HR, CFO", "email": "string", "phone": "string", "dateOfBirth": "1978-10-07", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "roles": [ "PrimaryContact" ], "share": 0.1, "identificationAttachment": { "file": "string", "fileName": "string" } } ], "stores": [ { "name": "My Awesome Store", "merchantCategoryCode": 1234, "acceptedCardTypes": [ "VISA" ], "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "transactionInformation": { "expectedAverageTransactionAmount": 10000, "expectedMaximumTransactionAmount": 10000, "averageTimeBetweenPurchaseAndDeliveryInDays": 1, "averageMonthlyVolume": 1000 }, "acceptedTransactionTypes": [ "ECommerce" ], "eCommerceSolutions": { "eCommerceType": "WebPaymentPage", "websiteURL": "www.example.com", "webPaymentPageInformation": { "sellerEmail": "johndoe@domain.com", "sellerPhone": "+123/4567890", "logoAttachment": { "file": "string", "fileName": "string" } } }, "recurring": false, "descriptionOfProductsAndServices": "string" } ], "bankAccount": { "bankName": "Nombre de Banco", "accountNumber": "123241234", "bankAddress": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "iban": "NWBK60161331926819", "ownerNationalIdNumber": "2501992323", "swiftNumber": "CITIDE55", "sortCode": "12-34-56", "bankAccountConfirmationAttachment": { "file": "string", "fileName": "string" }, "bankAccountConfirmed": true }, "fees": { "merchantServiceChargeFees": [ { "name": "VisaCredit", "fixedValue": 0.1, "percentageValue": 0.1 } ] }, "additionalAttachments": [ { "file": "string", "fileName": "string" } ] } '{ "success": false, "statusCode": 401, "message": "Api Key was not provided", "data": null }
404 Not Found
curl -X POST https://boarding.valitor.com/isoapi/privatelimitedcompany -H 'ApiKey: my-ApiKey' -H 'Content-Type: application/json' -d '{ "company": { "name": "Valitor hf", "number": "FC036722", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "email": "string", "phone": "string", "invoiceStatementOnMerchantLevel": false, "tax_id": "12345678901234" }, "persons": [ { "firstName": "John", "middleName": "Thor", "lastName": "Johnson", "ssn": "010101-2340", "title": "Mr.", "position": "CEO, Head of HR, CFO", "email": "string", "phone": "string", "dateOfBirth": "1978-10-07", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "roles": [ "PrimaryContact" ], "share": 0.1, "identificationAttachment": { "file": "string", "fileName": "string" } } ], "stores": [ { "name": "My Awesome Store", "merchantCategoryCode": 1234, "acceptedCardTypes": [ "VISA" ], "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "transactionInformation": { "expectedAverageTransactionAmount": 10000, "expectedMaximumTransactionAmount": 10000, "averageTimeBetweenPurchaseAndDeliveryInDays": 1, "averageMonthlyVolume": 1000 }, "acceptedTransactionTypes": [ "ECommerce" ], "eCommerceSolutions": { "eCommerceType": "WebPaymentPage", "websiteURL": "www.example.com", "webPaymentPageInformation": { "sellerEmail": "johndoe@domain.com", "sellerPhone": "+123/4567890", "logoAttachment": { "file": "string", "fileName": "string" } } }, "recurring": false, "descriptionOfProductsAndServices": "string" } ], "bankAccount": { "bankName": "Nombre de Banco", "accountNumber": "123241234", "bankAddress": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "iban": "NWBK60161331926819", "ownerNationalIdNumber": "2501992323", "swiftNumber": "CITIDE55", "sortCode": "12-34-56", "bankAccountConfirmationAttachment": { "file": "string", "fileName": "string" }, "bankAccountConfirmed": true }, "fees": { "merchantServiceChargeFees": [ { "name": "VisaCredit", "fixedValue": 0.1, "percentageValue": 0.1 } ] }, "additionalAttachments": [ { "file": "string", "fileName": "string" } ] } '{ "success": false, "statusCode": 404, "message": "Not Found", "data": null }
500 Internal Server Error
curl -X POST https://boarding.valitor.com/isoapi/privatelimitedcompany -H 'ApiKey: my-ApiKey' -H 'Content-Type: application/json' -d '{ "company": { "name": "Valitor hf", "number": "FC036722", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "email": "string", "phone": "string", "invoiceStatementOnMerchantLevel": false, "tax_id": "12345678901234" }, "persons": [ { "firstName": "John", "middleName": "Thor", "lastName": "Johnson", "ssn": "010101-2340", "title": "Mr.", "position": "CEO, Head of HR, CFO", "email": "string", "phone": "string", "dateOfBirth": "1978-10-07", "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "roles": [ "PrimaryContact" ], "share": 0.1, "identificationAttachment": { "file": "string", "fileName": "string" } } ], "stores": [ { "name": "My Awesome Store", "merchantCategoryCode": 1234, "acceptedCardTypes": [ "VISA" ], "address": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "transactionInformation": { "expectedAverageTransactionAmount": 10000, "expectedMaximumTransactionAmount": 10000, "averageTimeBetweenPurchaseAndDeliveryInDays": 1, "averageMonthlyVolume": 1000 }, "acceptedTransactionTypes": [ "ECommerce" ], "eCommerceSolutions": { "eCommerceType": "WebPaymentPage", "websiteURL": "www.example.com", "webPaymentPageInformation": { "sellerEmail": "johndoe@domain.com", "sellerPhone": "+123/4567890", "logoAttachment": { "file": "string", "fileName": "string" } } }, "recurring": false, "descriptionOfProductsAndServices": "string" } ], "bankAccount": { "bankName": "Nombre de Banco", "accountNumber": "123241234", "bankAddress": { "street": "Oxfordstreet 12", "postalCode": "HFJ220", "city": "London", "countryCode": "is" }, "iban": "NWBK60161331926819", "ownerNationalIdNumber": "2501992323", "swiftNumber": "CITIDE55", "sortCode": "12-34-56", "bankAccountConfirmationAttachment": { "file": "string", "fileName": "string" }, "bankAccountConfirmed": true }, "fees": { "merchantServiceChargeFees": [ { "name": "VisaCredit", "fixedValue": 0.1, "percentageValue": 0.1 } ] }, "additionalAttachments": [ { "file": "string", "fileName": "string" } ] } '{ "success": false, "statusCode": 500, "message": "Unexpected error occurred. Please contact support.", "data": null }