Needio.Services

<back to all web services

StartThreeDsRequest

Requires Authentication
Required role:Guest
The following routes are available for this service:
All Verbs/Payment/StartThreeDs/
StartThreeDsRequest Parameters:
NameParameterData TypeRequiredDescription
PaymentCardqueryPaymentCardDTONo
Installmentqueryint?No
isMobilequeryboolNo
PayWith3dsqueryboolNo
RefreshTokenqueryboolNo
IdentityNumberquerystringNo
HashqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
StartThreeDsReponse Parameters:
NameParameterData TypeRequiredDescription
PaymentTokenformstringNo
BasketHeaderIdformintNo
TransactionIdformint?No
RedirectToBasketformboolNo
ThreeDsContentformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
PaymentCardDTO Parameters:
NameParameterData TypeRequiredDescription
CardHolderNameformstringNo
CardNumberformstringNo
ExpireYearformstringNo
ExpireMonthformstringNo
CvcformstringNo
RegisterCardformboolNo
CardAliasformstringNo
CardTokenformstringNo
CardUserKeyformstringNo
StartThreeDsReponse Parameters:
NameParameterData TypeRequiredDescription
PaymentTokenformstringNo
BasketHeaderIdformintNo
TransactionIdformint?No
RedirectToBasketformboolNo
ThreeDsContentformstringNo

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 /Payment/StartThreeDs/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StartThreeDsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <Hash>0</Hash>
  <IdentityNumber>String</IdentityNumber>
  <Installment>0</Installment>
  <PayWith3ds>false</PayWith3ds>
  <PaymentCard xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.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>
  <RefreshToken>false</RefreshToken>
  <isMobile>false</isMobile>
</StartThreeDsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StartThreeDsReponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <BasketHeaderId>0</BasketHeaderId>
  <PaymentToken>String</PaymentToken>
  <RedirectToBasket>false</RedirectToBasket>
  <ThreeDsContent>String</ThreeDsContent>
  <TransactionId>0</TransactionId>
</StartThreeDsReponse>