POST fp/init
Request Information
URI Parameters
None.
Body Parameters
InitializeSessionRequestName | Description | Type | Additional information |
---|---|---|---|
initializationType | InitializationType |
None. |
|
tokenInformation | TokenInformation |
None. |
|
orderDetails | OrderDetails |
None. |
|
consumerAuthentication | ConsumerAuthentication |
None. |
|
button | Button |
None. |
|
buttonType | ButtonType |
None. |
|
buttonColor | ButtonColor |
None. |
|
styles | string |
None. |
|
hidePostalCode | boolean |
None. |
|
paymentFlow | string |
None. |
|
platform | string |
None. |
|
countryCode | string |
None. |
|
cultureCode | string |
None. |
|
esKey | string |
None. |
|
storeId | string |
None. |
|
terminalId | string |
None. |
|
apiEndPoint | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "initializationType": 1, "tokenInformation": { "token": "sample string 1", "accountNumber": "sample string 2", "cardExpirationMonth": 3, "cardExpirationYear": 4, "cardType": "sample string 5", "tokenExpiration": "2024-11-07T04:39:04.921322+00:00", "brand": "sample string 6", "posData": "sample string 7", "newToken": "sample string 8" }, "orderDetails": { "transactionTotal": 1.0, "currencyCode": "sample string 2", "orderNumber": "sample string 3", "orderDescription": "sample string 4" }, "consumerAuthentication": { "enabled": true, "autoMapToFreewayRequest": true, "Fields": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, "button": { "integrated": true }, "buttonType": 1, "buttonColor": 1, "styles": "sample string 1", "hidePostalCode": true, "paymentFlow": "sample string 3", "platform": "sample string 4", "countryCode": "sample string 5", "cultureCode": "sample string 6", "esKey": "sample string 7", "storeId": "sample string 8", "terminalId": "sample string 9", "apiEndPoint": "sample string 10" }
application/xml, text/xml
Sample:
<InitializeSessionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Models"> <apiEndPoint>sample string 10</apiEndPoint> <esKey>sample string 7</esKey> <storeId>sample string 8</storeId> <terminalId>sample string 9</terminalId> <button xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types"> <d2p1:integrated>true</d2p1:integrated> </button> <buttonColor>Black</buttonColor> <buttonType>Buy</buttonType> <consumerAuthentication xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types"> <d2p1:Fields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Fields> <d2p1:autoMapToFreewayRequest>true</d2p1:autoMapToFreewayRequest> <d2p1:enabled>true</d2p1:enabled> </consumerAuthentication> <countryCode>sample string 5</countryCode> <cultureCode>sample string 6</cultureCode> <hidePostalCode>true</hidePostalCode> <initializationType>Standard</initializationType> <orderDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types"> <d2p1:currencyCode>sample string 2</d2p1:currencyCode> <d2p1:orderDescription>sample string 4</d2p1:orderDescription> <d2p1:orderNumber>sample string 3</d2p1:orderNumber> <d2p1:transactionTotal>1</d2p1:transactionTotal> </orderDetails> <paymentFlow>sample string 3</paymentFlow> <platform>sample string 4</platform> <styles>sample string 1</styles> <tokenInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/NCR.FreedomPay.DTO.Types"> <d2p1:accountNumber>sample string 2</d2p1:accountNumber> <d2p1:brand>sample string 6</d2p1:brand> <d2p1:cardExpirationMonth>3</d2p1:cardExpirationMonth> <d2p1:cardExpirationYear>4</d2p1:cardExpirationYear> <d2p1:cardType>sample string 5</d2p1:cardType> <d2p1:newToken>sample string 8</d2p1:newToken> <d2p1:posData>sample string 7</d2p1:posData> <d2p1:token>sample string 1</d2p1:token> <d2p1:tokenExpiration>2024-11-07T04:39:04.921322+00:00</d2p1:tokenExpiration> </tokenInformation> </InitializeSessionRequest>
Response Information
Resource Description
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. |