Needio.Services

<back to all web services

MakePaymentPreControlRequest

Requires Authentication
MakePaymentPreControlRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdquerystringNo
PaidPricequerydecimalNo
Installmentqueryint?No
PaymentCardqueryPaymentCardDTONo
InvoiceAddressIdqueryintNo
DeliveryTypequeryDeliveryTypesNo
ShippingAddressIdqueryintNo
RefIdqueryintNo
ShippingCodequerystringNo
LocationqueryGeoLocationNo
levelquerybyteNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
MakePaymentPreControlResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<string>No
WarningsformList<string>No
InfosformList<string>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
PaymentCardDTO Parameters:
NameParameterData TypeRequiredDescription
CardHolderNameformstringNo
CardNumberformstringNo
ExpireYearformstringNo
ExpireMonthformstringNo
CvcformstringNo
RegisterCardformboolNo
CardAliasformstringNo
CardTokenformstringNo
CardUserKeyformstringNo
DeliveryTypes Enum:
NameValue
None0
DeliveryToAddress1
DeliveryInStore2
DeliveryByCargo4
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
MakePaymentPreControlResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsformList<string>No
WarningsformList<string>No
InfosformList<string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/MakePaymentPreControlRequest HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MakePaymentPreControlRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <DeliveryType>None</DeliveryType>
  <Installment>0</Installment>
  <InvoiceAddressId>0</InvoiceAddressId>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:GeoAddress>String</d2p1:GeoAddress>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:Lat>String</d2p1:Lat>
    <d2p1:Lon>String</d2p1:Lon>
  </Location>
  <PaidPrice>0</PaidPrice>
  <PaymentCard xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:CardAlias>String</d2p1:CardAlias>
    <d2p1:CardHolderName>String</d2p1:CardHolderName>
    <d2p1:CardNumber>String</d2p1:CardNumber>
    <d2p1:CardToken>String</d2p1:CardToken>
    <d2p1:CardUserKey>String</d2p1:CardUserKey>
    <d2p1:Cvc>String</d2p1:Cvc>
    <d2p1:ExpireMonth>String</d2p1:ExpireMonth>
    <d2p1:ExpireYear>String</d2p1:ExpireYear>
    <d2p1:RegisterCard>false</d2p1:RegisterCard>
  </PaymentCard>
  <RefId>0</RefId>
  <SessionId>String</SessionId>
  <ShippingAddressId>0</ShippingAddressId>
  <ShippingCode>String</ShippingCode>
  <level>0</level>
</MakePaymentPreControlRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MakePaymentPreControlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Errors>
  <Infos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Infos>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Warnings>
</MakePaymentPreControlResponse>