POST api/OmniPay/CreateOmniPayDepotWallet

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FirstName	string	None.
LastName	string	None.
EmailAddress	string	None.
BVN	string	None.
Password	string	Min length: 8
PhoneNumber	string	None.
RoleId	OmniPayUserEnum	None.
RoleName	string	None.
IdempotencyKey	string	None.
CreatedBy	integer	None.
UserId	integer	None.
StockPointId	integer	None.
IsSfa	boolean	None.
BusinessId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "EmailAddress": "sample string 3",
  "BVN": "sample string 4",
  "Password": "sample string 5",
  "PhoneNumber": "sample string 6",
  "RoleId": 1,
  "RoleName": "sample string 7",
  "IdempotencyKey": "sample string 8",
  "CreatedBy": 9,
  "UserId": 10,
  "StockPointId": 11,
  "IsSfa": true,
  "BusinessId": 13
}

application/xml, text/xml

Sample:

<CreateOmniPayUserWalletApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BVN>sample string 4</BVN>
  <BusinessId>13</BusinessId>
  <CreatedBy>9</CreatedBy>
  <EmailAddress>sample string 3</EmailAddress>
  <FirstName>sample string 1</FirstName>
  <IdempotencyKey>sample string 8</IdempotencyKey>
  <IsSfa>true</IsSfa>
  <LastName>sample string 2</LastName>
  <Password>sample string 5</Password>
  <PhoneNumber>sample string 6</PhoneNumber>
  <RoleId>Admin</RoleId>
  <RoleName>sample string 7</RoleName>
  <StockPointId>11</StockPointId>
  <UserId>10</UserId>
</CreateOmniPayUserWalletApiModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

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/11/03 16:03:42",
  "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>