POST api/orders/paymentform

Retrieves an HTML payment form to be injected in the user's order submission page.

Request Information

URI Parameters

None.

Body Parameters

An object containing information about the request. Note that the PaymentId field is optional.

Name	Type	Additional information
PaymentId	integer	None.
Amount	decimal number	None.
Language	string	None.
Description	string	None.
SavePaymentInformation	boolean	None.
AcceptUrl	string	None.
DeclineUrl	string	None.
ExceptionUrl	string	None.
CancelUrl	string	None.
PaymentFormUrl	string	None.
AmountPrepaidPurchase	decimal number	None.
AmountPrepaidInitialBalance	decimal number	None.
RecurringAuth	integer	None.
CustomerId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PaymentId": 1,
  "Amount": 2.0,
  "Language": "sample string 3",
  "Description": "sample string 4",
  "SavePaymentInformation": true,
  "AcceptUrl": "sample string 6",
  "DeclineUrl": "sample string 7",
  "ExceptionUrl": "sample string 8",
  "CancelUrl": "sample string 9",
  "PaymentFormUrl": "sample string 10",
  "AmountPrepaidPurchase": 11.0,
  "AmountPrepaidInitialBalance": 12.0,
  "RecurringAuth": 13,
  "CustomerId": 14
}

text/html

Sample:

{"PaymentId":1,"Amount":2.0,"Language":"sample string 3","Description":"sample string 4","SavePaymentInformation":true,"AcceptUrl":"sample string 6","DeclineUrl":"sample string 7","ExceptionUrl":"sample string 8","CancelUrl":"sample string 9","PaymentFormUrl":"sample string 10","AmountPrepaidPurchase":11.0,"AmountPrepaidInitialBalance":12.0,"RecurringAuth":13,"CustomerId":14}

application/xml, text/xml

Sample:

<OrdersController.PaymentFormRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LimitlessMobile.WebAPI.Controllers">
  <AcceptUrl>sample string 6</AcceptUrl>
  <Amount>2</Amount>
  <AmountPrepaidInitialBalance>12</AmountPrepaidInitialBalance>
  <AmountPrepaidPurchase>11</AmountPrepaidPurchase>
  <CancelUrl>sample string 9</CancelUrl>
  <CustomerId>14</CustomerId>
  <DeclineUrl>sample string 7</DeclineUrl>
  <Description>sample string 4</Description>
  <ExceptionUrl>sample string 8</ExceptionUrl>
  <Language>sample string 3</Language>
  <PaymentFormUrl>sample string 10</PaymentFormUrl>
  <PaymentId>1</PaymentId>
  <RecurringAuth>13</RecurringAuth>
  <SavePaymentInformation>true</SavePaymentInformation>
</OrdersController.PaymentFormRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An object containing the paymentId and an HTML string.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.