POST api/OmniPay/CreateOmniPayCompany

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CompanyName	string	None.
EmailAddress	string	None.
PersonOfContactFirstName	string	None.
PersonOfContactLastName	string	None.
PersonOfContactEmail	string	None.
PersonOfContactPhone	string	None.
PersonOfContactBVN	string	None.
IdempotencyKey	string	None.
CreatedBy	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "EmailAddress": "sample string 2",
  "PersonOfContactFirstName": "sample string 3",
  "PersonOfContactLastName": "sample string 4",
  "PersonOfContactEmail": "sample string 5",
  "PersonOfContactPhone": "sample string 6",
  "PersonOfContactBVN": "sample string 7",
  "IdempotencyKey": "sample string 8",
  "CreatedBy": 9
}

application/xml, text/xml

Sample:

<CreateOmniPayCompanyApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <CompanyName>sample string 1</CompanyName>
  <CreatedBy>9</CreatedBy>
  <EmailAddress>sample string 2</EmailAddress>
  <IdempotencyKey>sample string 8</IdempotencyKey>
  <PersonOfContactBVN>sample string 7</PersonOfContactBVN>
  <PersonOfContactEmail>sample string 5</PersonOfContactEmail>
  <PersonOfContactFirstName>sample string 3</PersonOfContactFirstName>
  <PersonOfContactLastName>sample string 4</PersonOfContactLastName>
  <PersonOfContactPhone>sample string 6</PersonOfContactPhone>
</CreateOmniPayCompanyApiModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateOmniPayCompanyApiModel'.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/04 07:17:51",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>