POST api/v1/airtime/buy-airtime

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BillerId	integer	None.
CustomerAccountNumber	string	Required Matching regular expression pattern: (^[0-9]+$)
CustomerMsisdn	string	Required Matching regular expression pattern: (^[ A-Za-z0-9.+-]+$)
Provider	string	None.
ReferenceNumber	string	None.
BeneficiaryMobileNumber	string	None.
Amount	decimal number	None.
AdditionalFees	Collection of AdditionalFee	None.
RequestId	string	Required Matching regular expression pattern: (^[ A-Za-z0-9.\|/-]+$)
CountryId	string	Required

Request Formats

application/json, text/json

Sample:

{
  "BillerId": 1,
  "CustomerAccountNumber": "sample string 2",
  "CustomerMsisdn": "sample string 3",
  "Provider": "sample string 4",
  "ReferenceNumber": "sample string 5",
  "BeneficiaryMobileNumber": "sample string 6",
  "Amount": 7.0,
  "AdditionalFees": [
    {
      "AccountNumber": "sample string 1",
      "IsPercentage": "sample string 2",
      "FeeAmount": 3.0
    },
    {
      "AccountNumber": "sample string 1",
      "IsPercentage": "sample string 2",
      "FeeAmount": 3.0
    }
  ],
  "RequestId": "sample string 8",
  "CountryId": "sample string 9"
}

application/xml, text/xml

Sample:

<PurchaseAirtimeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FirstBank.SingleBiller.CoreObject.DataTransferObjects">
  <CountryId>sample string 9</CountryId>
  <RequestId>sample string 8</RequestId>
  <AdditionalFees>
    <AdditionalFee>
      <AccountNumber>sample string 1</AccountNumber>
      <FeeAmount>3</FeeAmount>
      <IsPercentage>sample string 2</IsPercentage>
    </AdditionalFee>
    <AdditionalFee>
      <AccountNumber>sample string 1</AccountNumber>
      <FeeAmount>3</FeeAmount>
      <IsPercentage>sample string 2</IsPercentage>
    </AdditionalFee>
  </AdditionalFees>
  <Amount>7</Amount>
  <BeneficiaryMobileNumber>sample string 6</BeneficiaryMobileNumber>
  <BillerId>1</BillerId>
  <CustomerAccountNumber>sample string 2</CustomerAccountNumber>
  <CustomerMsisdn>sample string 3</CustomerMsisdn>
  <Provider>sample string 4</Provider>
  <ReferenceNumber>sample string 5</ReferenceNumber>
</PurchaseAirtimeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.