POST api/Vodafone/ChargeAPI

Request Information

URI Parameters

None.

Body Parameters

InitiateChargeRequest
NameDescriptionTypeAdditional information
amount

string

Required

msisdn

string

Required

APIKey

string

Required

description

string

Required

Request Formats

application/json, text/json

Sample:
{
  "amount": "sample string 1",
  "msisdn": "sample string 2",
  "APIKey": "sample string 3",
  "description": "sample string 4"
}

application/xml, text/xml

Sample:
<InitiateChargeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VodafoneDCB.Controllers">
  <APIKey>sample string 3</APIKey>
  <amount>sample string 1</amount>
  <description>sample string 4</description>
  <msisdn>sample string 2</msisdn>
</InitiateChargeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChargeAPIResponse
NameDescriptionTypeAdditional information
BillingResponse

ChargeResponse

None.

success

boolean

None.

code

string

None.

message

string

None.

errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "BillingResponse": {
    "Adjustment_amount": "sample string 1",
    "conversation_id": "sample string 2",
    "message": "sample string 3",
    "reason_code": "sample string 4",
    "currency": "sample string 5",
    "transaction_id": "sample string 6",
    "msisdn": "sample string 7"
  },
  "success": true,
  "code": "sample string 2",
  "message": "sample string 3",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<VodafoneController.ChargeAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VodafoneDCB.Controllers">
  <code>sample string 2</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message>sample string 3</message>
  <success>true</success>
  <BillingResponse>
    <Adjustment_amount>sample string 1</Adjustment_amount>
    <conversation_id>sample string 2</conversation_id>
    <currency>sample string 5</currency>
    <message>sample string 3</message>
    <msisdn>sample string 7</msisdn>
    <reason_code>sample string 4</reason_code>
    <transaction_id>sample string 6</transaction_id>
  </BillingResponse>
</VodafoneController.ChargeAPIResponse>