POST v1/PaymentSession
Starts a payment session with configured payment provider(s)
URI template
v1/PaymentSessionRequest Information
URI Parameters
None.
Body Parameters
The details of the session request being made
InPaymentSessionRequestName | Description | Type | Additional information |
---|---|---|---|
SiteId |
The site id the consumer is ordering from. |
integer |
Required |
Amount |
The amount to send to the host |
decimal number |
None. |
ReturnUrl |
The return url |
string |
None. |
SessionDetails |
Information describing the Session Details |
ConnectedPaymentsSession | FreedomPaySession |
None. |
Request Formats
application/json, text/json
Sample:
{ "SiteId": 1, "Amount": 2.0, "ReturnUrl": "sample string 3", "SessionDetails": { "$id": "2", "PaymentProvider": 2, "SessionType": 0, "ReturnUrl": "sample string 4", "TokenDetails": { "$id": "3", "Token": "sample string 5", "CardExpirationMonth": 6, "CardExpirationYear": 7 }, "OrderDetails": { "$id": "4", "CurrencyCode": "sample string 8", "OrderNumber": "sample string 9", "OrderDescription": "sample string 10" }, "ConsumerAuthentication": { "$id": "5", "BillingAddress1": "sample string 11", "BillingCity": "sample string 12", "BillingCountryCode": "sample string 13", "BillingFirstName": "sample string 14", "BillingLastName": "sample string 15", "Email": "sample string 16", "MobilePhone": "sample string 17", "BillingPostalCode": "sample string 18", "BillingState": "sample string 19" }, "IsIntegratedButton": true, "Styles": "sample string 21", "Color": 22 } }
application/xml, text/xml
Sample:
<InPaymentSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound"> <Amount>2</Amount> <ReturnUrl>sample string 3</ReturnUrl> <SessionDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <d2p1:Color>22</d2p1:Color> <d2p1:ConsumerAuthentication> <d2p1:BillingAddress1>sample string 11</d2p1:BillingAddress1> <d2p1:BillingCity>sample string 12</d2p1:BillingCity> <d2p1:BillingCountryCode>sample string 13</d2p1:BillingCountryCode> <d2p1:BillingFirstName>sample string 14</d2p1:BillingFirstName> <d2p1:BillingLastName>sample string 15</d2p1:BillingLastName> <d2p1:BillingPostalCode>sample string 18</d2p1:BillingPostalCode> <d2p1:BillingState>sample string 19</d2p1:BillingState> <d2p1:Email>sample string 16</d2p1:Email> <d2p1:MobilePhone>sample string 17</d2p1:MobilePhone> </d2p1:ConsumerAuthentication> <d2p1:IsIntegratedButton>true</d2p1:IsIntegratedButton> <d2p1:OrderDetails> <d2p1:CurrencyCode>sample string 8</d2p1:CurrencyCode> <d2p1:OrderDescription>sample string 10</d2p1:OrderDescription> <d2p1:OrderNumber>sample string 9</d2p1:OrderNumber> </d2p1:OrderDetails> <d2p1:PaymentProvider>ConnectedPayments</d2p1:PaymentProvider> <d2p1:ReturnUrl>sample string 4</d2p1:ReturnUrl> <d2p1:SessionType>Verification</d2p1:SessionType> <d2p1:Styles>sample string 21</d2p1:Styles> <d2p1:TokenDetails> <d2p1:CardExpirationMonth>6</d2p1:CardExpirationMonth> <d2p1:CardExpirationYear>7</d2p1:CardExpirationYear> <d2p1:Token>sample string 5</d2p1:Token> </d2p1:TokenDetails> </SessionDetails> <SiteId>1</SiteId> </InPaymentSessionRequest>
Response Information
Resource Description
A <see cref="T:OnlineOrderingAPI.Models.v1.PaymentSessionResult" /> instance when successful, an error code and description when an error occurs.
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |