POST api/OmniPay/SyncOmniPayOrderForReports

Request Information

URI Parameters

None.

Body Parameters

SyncOmniPayOrderForReports
NameDescriptionTypeAdditional information
event

string

None.

data

OmniPayOrderData

None.

Request Formats

application/json, text/json

Sample:
{
  "event": "sample string 1",
  "data": {
    "customerRef": "sample string 1",
    "userRef": "sample string 2",
    "amount": 3.0,
    "walletBalance": 4.0,
    "walletPayment": 5.0,
    "paylaterPayment": 6.0,
    "promoPayment": 7.0,
    "orderValue": 8.0,
    "orderId": "sample string 9",
    "loanId": "sample string 10",
    "loanAmount": 11.0,
    "amountRepaid": 12.0,
    "amountPending": 13.0,
    "interestPaid": 14.0,
    "purchaseType": "sample string 15",
    "promoId": "sample string 16",
    "referenceId": "sample string 17",
    "createdAt": "2024-09-19T18:16:56.935816+01:00",
    "senderUserRef": "sample string 19",
    "receiverUserRef": "sample string 20",
    "senderCustomerRef": "sample string 21",
    "receiverCustomerRef": "sample string 22",
    "senderAccountName": "sample string 23",
    "senderBankName": "sample string 24",
    "senderAccountNumber": "sample string 25",
    "fees": 26.0,
    "commission": 27.0,
    "shipmentId": "sample string 28",
    "walletId": "sample string 29",
    "virtualAccounts": [
      {
        "AccountName": "sample string 1",
        "AccountNumber": "sample string 2",
        "BankName": "sample string 3"
      },
      {
        "AccountName": "sample string 1",
        "AccountNumber": "sample string 2",
        "BankName": "sample string 3"
      }
    ],
    "phoneNumber": "sample string 30"
  }
}

application/xml, text/xml

Sample:
<SyncOmniPayOrderForReports xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <data>
    <amount>3</amount>
    <amountPending>13</amountPending>
    <amountRepaid>12</amountRepaid>
    <commission>27</commission>
    <createdAt>2024-09-19T18:16:56.935816+01:00</createdAt>
    <customerRef>sample string 1</customerRef>
    <fees>26</fees>
    <interestPaid>14</interestPaid>
    <loanAmount>11</loanAmount>
    <loanId>sample string 10</loanId>
    <orderId>sample string 9</orderId>
    <orderValue>8</orderValue>
    <paylaterPayment>6</paylaterPayment>
    <phoneNumber>sample string 30</phoneNumber>
    <promoId>sample string 16</promoId>
    <promoPayment>7</promoPayment>
    <purchaseType>sample string 15</purchaseType>
    <receiverCustomerRef>sample string 22</receiverCustomerRef>
    <receiverUserRef>sample string 20</receiverUserRef>
    <referenceId>sample string 17</referenceId>
    <senderAccountName>sample string 23</senderAccountName>
    <senderAccountNumber>sample string 25</senderAccountNumber>
    <senderBankName>sample string 24</senderBankName>
    <senderCustomerRef>sample string 21</senderCustomerRef>
    <senderUserRef>sample string 19</senderUserRef>
    <shipmentId>sample string 28</shipmentId>
    <userRef>sample string 2</userRef>
    <virtualAccounts>
      <OmniPayVirtualAccounts>
        <AccountName>sample string 1</AccountName>
        <AccountNumber>sample string 2</AccountNumber>
        <BankName>sample string 3</BankName>
      </OmniPayVirtualAccounts>
      <OmniPayVirtualAccounts>
        <AccountName>sample string 1</AccountName>
        <AccountNumber>sample string 2</AccountNumber>
        <BankName>sample string 3</BankName>
      </OmniPayVirtualAccounts>
    </virtualAccounts>
    <walletBalance>4</walletBalance>
    <walletId>sample string 29</walletId>
    <walletPayment>5</walletPayment>
  </data>
  <event>sample string 1</event>
</SyncOmniPayOrderForReports>

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 'SyncOmniPayOrderForReports'.

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional 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": "2024/09/19 18:16:56",
  "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>