POST api/mobile/v1/InitiatePayment

Request Information

URI Parameters

None.

Body Parameters

SolarInitiateCheckoutRequest
NameDescriptionTypeAdditional information
apiOperation

string

None.

interaction

Interaction

None.

order

Order

None.

customer

Customer

None.

billing

Billing

None.

transaction

Transaction

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "apiOperation": "sample string 1",
  "interaction": {
    "operation": "sample string 1",
    "returnUrl": "sample string 2",
    "merchant": {
      "name": "sample string 1",
      "email": "sample string 2",
      "phone": "sample string 3",
      "logo": "sample string 4",
      "url": "sample string 5",
      "address": {
        "line1": "sample string 1",
        "line2": "sample string 2"
      }
    },
    "locale": "sample string 3",
    "displayControl": {
      "billingAddress": "sample string 1",
      "customerEmail": "sample string 2",
      "shipping": "sample string 3"
    }
  },
  "order": {
    "id": "sample string 1",
    "amount": "sample string 2",
    "currency": "sample string 3",
    "description": "sample string 4",
    "reference": "sample string 5"
  },
  "customer": {
    "email": "sample string 1",
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "mobilePhone": "sample string 4",
    "phone": "sample string 5"
  },
  "billing": {
    "address": {
      "city": "sample string 1",
      "company": "sample string 2",
      "country": "sample string 3",
      "postcodeZip": "sample string 4",
      "stateProvince": "sample string 5",
      "stateProvinceCode": "sample string 6",
      "street": "sample string 7",
      "street2": "sample string 8"
    }
  },
  "transaction": {
    "reference": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<SenbokModel.SolarInitiateCheckoutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SenbokAPI.Models">
  <ApiOperation>sample string 1</ApiOperation>
  <Billing>
    <Address>
      <City>sample string 1</City>
      <Company>sample string 2</Company>
      <Country>sample string 3</Country>
      <PostcodeZip>sample string 4</PostcodeZip>
      <StateProvince>sample string 5</StateProvince>
      <StateProvinceCode>sample string 6</StateProvinceCode>
      <Street>sample string 7</Street>
      <Street2>sample string 8</Street2>
    </Address>
  </Billing>
  <Customer>
    <Email>sample string 1</Email>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <MobilePhone>sample string 4</MobilePhone>
    <Phone>sample string 5</Phone>
  </Customer>
  <Interaction>
    <DisplayControl>
      <BillingAddress>sample string 1</BillingAddress>
      <CustomerEmail>sample string 2</CustomerEmail>
      <Shipping>sample string 3</Shipping>
    </DisplayControl>
    <Locale>sample string 3</Locale>
    <Merchant>
      <Address>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
      </Address>
      <Email>sample string 2</Email>
      <Logo>sample string 4</Logo>
      <Name>sample string 1</Name>
      <Phone>sample string 3</Phone>
      <Url>sample string 5</Url>
    </Merchant>
    <Operation>sample string 1</Operation>
    <ReturnUrl>sample string 2</ReturnUrl>
  </Interaction>
  <Order>
    <Amount>sample string 2</Amount>
    <Currency>sample string 3</Currency>
    <Description>sample string 4</Description>
    <Id>sample string 1</Id>
    <Reference>sample string 5</Reference>
  </Order>
  <Transaction>
    <Reference>sample string 1</Reference>
  </Transaction>
</SenbokModel.SolarInitiateCheckoutRequest>

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.