authorize

HTTP method: POST

This step is required to process ApplePay data. By invoking this method we will decrypt data with Processing Key and Authorize it against selected acquirer.

Returned response is similar to callback xml.

Required parameters

Parameter	Description	Type
provider_data	The string value of `ApplePayPaymentAuthorizedEvent.payment.token` as produced by `JSON.stringify()`	string
terminal	The title of your terminal	string
shop_orderid	The id of the order in your webshop. This is what we will post back to you so you know which order a given payment is associated with	[a-zA-Z0-9-]{1,100}
amount	The amount of the payment in english notation (ex. 89.95)	float
currency	The currency of the payment in ISO-4217 format. Either the 3- digit numeric code, or the 3- letter character code	[0-9]{3} or [A-Z]{3}

Optional parameters

The optional parameters follow the same logic as with eCommerce/API/createPaymentRequest. The parameters are listed here for convenience. For details on usage, see the documentation for createPaymentRequest.

Parameter	Description	Type
customer_info	Customer info object	Customer info
orderLines	Order lines object	Order lines
language	Language	[a-z]{2}
transaction_info	Additional info about the payment	string array, max 50 entries, each entry of max 255 chars
type	This is the authorization type. For more information, see Payment request types: payment (default) paymentAndCapture verifyCard credit subscription subscriptionAndCharge subscriptionAndReserve It is not possible to create a payment request with type=payment. If the type is set to payment, it is automatically changed to paymentAndCapture.	string
sale_reconciliation_identifier	Sale reconciliation identifier	string{0,100}
sale_invoice_number	Sale invoice number	string{0,100}
sales_tax	Sales tax	float
cookie	Cookie	string
fraud_service	Fraud service provider	none maxmind red test
shipping_method	Shipping method type	LowCost DesignatedByCustomer Internatioal Military NextDay Other StorePickup TwoDayService ThreeDayService
customer_created_date	Customer created date	date (yyyy-mm-dd)

Return xml example


<?xml version="1.0"?>
<APIResponse version="20170228">
    <Header>
        <Date>2018-03-20T13:06:58+01:00</Date>
        <Path>API/cardWallet/authorize</Path>
        <ErrorCode>0</ErrorCode>
        <ErrorMessage/>
    </Header>
    <Body>
        <Result>Success</Result>
        <Transactions>
            <Transaction>
                <TransactionId>14</TransactionId>
                <PaymentId>e45bddb7-a4f4-4772-a073-222ef1231896</PaymentId>
                <AuthType>payment</AuthType>
                <CardStatus>Valid</CardStatus>
                <CreditCardExpiry>
                    <Year>2019</Year>
                    <Month>07</Month>
                </CreditCardExpiry>
                <CreditCardToken>
                    LA3TqyWKlfdm0LRvZ8vz26ltJr6TsrH23D/+Bwz8gnkGqLRtTnpTLXDTzS/RjxqXAdWwuYKkdsAzcZO/rv6SkQ==+1
                </CreditCardToken>
                <CreditCardMaskedPan>520424******1982</CreditCardMaskedPan>
                <IsTokenized>true</IsTokenized>
                <ThreeDSecureResult>Successful</ThreeDSecureResult>
                <LiableForChargeback>Issuer</LiableForChargeback>
                <CVVCheckResult>Not_Attempted</CVVCheckResult>
                <BlacklistToken>8c3c855e79f3cb888cdf5b8ab54686cba1770a08</BlacklistToken>
                <ShopOrderId>OrderIdString</ShopOrderId>
                <Shop>AltaPay Shop Integration</Shop>
                <Terminal>AltaPay ApplePay with Valitor Test Terminal</Terminal>
                <TransactionStatus>preauth</TransactionStatus>
                <ReasonCode>NONE</ReasonCode>
                <MerchantCurrency>208</MerchantCurrency>
                <MerchantCurrencyAlpha>DKK</MerchantCurrencyAlpha>
                <CardHolderCurrency>208</CardHolderCurrency>
                <CardHolderCurrencyAlpha>DKK</CardHolderCurrencyAlpha>
                <ReservedAmount>13.24</ReservedAmount>
                <CapturedAmount>0.00</CapturedAmount>
                <RefundedAmount>0.00</RefundedAmount>
                <CreditedAmount>0.00</CreditedAmount>
                <RecurringDefaultAmount>0.00</RecurringDefaultAmount>
                <SurchargeAmount>0.00</SurchargeAmount>
                <CreatedDate>2018-03-20 13:06:56</CreatedDate>
                <UpdatedDate>2018-03-20 13:06:58</UpdatedDate>
                <PaymentNature>CreditCardWallet</PaymentNature>
                <PaymentSource>eCommerce</PaymentSource>
                <PaymentSchemeName>MasterCard</PaymentSchemeName>
                <PaymentNatureService name="ValitorAcquirer">
                    <SupportsRefunds>true</SupportsRefunds>
                    <SupportsRelease>true</SupportsRelease>
                    <SupportsMultipleCaptures>true</SupportsMultipleCaptures>
                    <SupportsMultipleRefunds>true</SupportsMultipleRefunds>
                </PaymentNatureService>
                <ChargebackEvents/>
                <PaymentInfos>
                    <PaymentInfo name="displayName"><![CDATA[MasterCard 1504]]></PaymentInfo>
                    <PaymentInfo name="network"><![CDATA[MasterCard]]></PaymentInfo>
                    <PaymentInfo name="type"><![CDATA[credit]]></PaymentInfo>
                    <PaymentInfo name="transactionIdentifier">
                        <![CDATA[BB80C1440BDEE274AD273B70DCA3666AD92012D874950B2B391973EF31486A45]]>
                    </PaymentInfo>
                </PaymentInfos>
                <CustomerInfo>
                    <UserAgent/>
                    <IpAddress/>
                    <Email/>
                    <Username/>
                    <CustomerPhone/>
                    <OrganisationNumber/>
                    <CountryOfOrigin>
                        <Country/>
                        <Source>NotSet</Source>
                    </CountryOfOrigin>
                </CustomerInfo>
                <ReconciliationIdentifiers/>
            </Transaction>
        </Transactions>
    </Body>
</APIResponse>