authorize

HTTP method: POST

This step finalizes the Card Wallet payment by authorizing the previously registered payment.

By invoking this method, the gateway decrypts provided session data using the Processing Key and authorizes the transaction against the selected acquirer.

Returned response is similar to callback xml. If a redirect is required (e.g. for 3-D Secure processing), the response will contain a RedirectResponse.

Parameter Description Type
provider_data The wallet payment token passed as a stringified JSON object for deciphering by the gateway:
  • Apple Pay: The string value of ApplePayPaymentAuthorizedEvent.payment.token as produced by JSON.stringify().
  • GooglePay: The payment token string retrieved from the Google Pay API response (e.g. paymentData.paymentMethodData.tokenizationData.token or the stringified payload), passed exactly as provided by Google for the deciphering step.
 string
payment_id The identifier of the payment registered in the previous step string

*Legacy - only when related terminal is marked with the legacy flag in the gateway configuration.

  • If enabled, all payment information must be provided during the authorising request instead of payment_id attribute. See all required and optional parameters of createPaymentRequest.
  • If disabled, no additional tasks are required.
Parameter Description Type
transaction_info Additional info about the payment string array, max 50 entries, each entry of max 255 chars

Example of a successful authorization:


<APIResponse version="20251105">
    <Header>
        <Date>2025-12-12T10:24:26+00:00</Date>
        <Path>API/cardWallet/authorize</Path>
        <ErrorCode>0</ErrorCode>
        <ErrorMessage/>
    </Header>
    <Body>
        <Result>Success</Result>
        <Transactions>
            <Transaction>
                <TransactionId>81</TransactionId>
                <PaymentId>dec922c6-735f-4930-bee0-e1a73a0220ad</PaymentId>
                <AuthType>payment</AuthType>
                <CardStatus>Valid</CardStatus>
                <CreditCardExpiry>
                    <Year>2028</Year>
                    <Month>12</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>3c5106017fb41edd0e87b788c2abf62f80074f54</BlacklistToken>
                <ShopOrderId>12-5-7270388</ShopOrderId>
                <Shop>AltaPay Checkout Test Shop</Shop>
                <Terminal>ApplePay Checkout Test Terminal</Terminal>
                <TransactionStatus>preauth</TransactionStatus>
                <ReasonCode>NONE</ReasonCode>
                <MerchantCurrency>978</MerchantCurrency>
                <MerchantCurrencyAlpha>EUR</MerchantCurrencyAlpha>
                <CardHolderCurrency>978</CardHolderCurrency>
                <CardHolderCurrencyAlpha>EUR</CardHolderCurrencyAlpha>
                <ReservedAmount>36.18</ReservedAmount>
                <CapturedAmount>0.00</CapturedAmount>
                <RefundedAmount>0.00</RefundedAmount>
                <CreditedAmount>0.00</CreditedAmount>
                <RecurringDefaultAmount>0.00</RecurringDefaultAmount>
                <SurchargeAmount>0.00</SurchargeAmount>
                <CreatedDate>2025-12-12 10:24:25</CreatedDate>
                <UpdatedDate>2025-12-12 10:24:26</UpdatedDate>
                <PaymentNature>CreditCardWallet</PaymentNature>
                <PaymentSource>eCommerce</PaymentSource>
                <PaymentSchemeName>MASTERCARD</PaymentSchemeName>
                <AuthorisationExpiryDate/>
                <AuthorisationCode>123456</AuthorisationCode>
                <PaymentNatureService name="SoapTestAcquirer">
                    <SupportsRefunds>true</SupportsRefunds>
                    <SupportsRelease>true</SupportsRelease>
                    <SupportsMultipleCaptures>true</SupportsMultipleCaptures>
                    <SupportsMultipleRefunds>true</SupportsMultipleRefunds>
                </PaymentNatureService>
                <AddressVerification>G</AddressVerification>
                <AddressVerificationDescription>Address information is unavailable; international transaction; non-AVS participant</AddressVerificationDescription>
                <ChargebackEvents/>
                <PaymentInfos>
                    <PaymentInfo name="checkout_authorisation_id">
                        <![CDATA[K7wDL4iRHNKZvnYzrGF5p0ACMH2NsQ7pBaFz1HgZhwcyXrHDlOTJ5s5Cg0c/GSvl1DbVjfRE3YJckBI0bTkTFjUJ6228wabMDxhdNTm9/lA=]]>
                    </PaymentInfo>
                    <PaymentInfo name="checkout_payment_id">
                        <![CDATA[49175dbf-1f5b-4f1e-a90d-f78abd193919]]>
                    </PaymentInfo>
                    <PaymentInfo name="checkout_session_id">
                        <![CDATA[50715ad4-b1b8-4a85-b63e-c3f4d6acc01c]]>
                    </PaymentInfo>
                </PaymentInfos>
                <CustomerInfo>
                    <UserAgent/>
                    <IpAddress/>
                    <Email>
                        <![CDATA[test@example.com]]>
                    </Email>
                    <Username>
                        <![CDATA[]]>
                    </Username>
                    <AccountIdentifier>
                        <![CDATA[]]>
                    </AccountIdentifier>
                    <Firstname>
                        <![CDATA[John]]>
                    </Firstname>
                    <Lastname>
                        <![CDATA[Doe]]>
                    </Lastname>
                    <CardHolderName/>
                    <CustomerPhone>+4584758830</CustomerPhone>
                    <OrganisationNumber/>
                    <CountryOfOrigin>
                        <Country>DK</Country>
                        <Source>BillingAddress</Source>
                    </CountryOfOrigin>
                    <BillingAddress>
                        <Firstname>
                            <![CDATA[John]]>
                        </Firstname>
                        <Lastname>
                            <![CDATA[Doe]]>
                        </Lastname>
                        <Address>
                            <![CDATA[Gyngemose Parkvej 50]]>
                        </Address>
                        <City>
                            <![CDATA[Soeborg]]>
                        </City>
                        <Region>
                            <![CDATA[REG]]>
                        </Region>
                        <Country>
                            <![CDATA[DK]]>
                        </Country>
                        <PostalCode>
                            <![CDATA[2860]]>
                        </PostalCode>
                    </BillingAddress>
                </CustomerInfo>
                <RecipientInfo/>
                <ReconciliationIdentifiers/>
            </Transaction>
        </Transactions>
    </Body>
</APIResponse>

Example of a redirect response (e.g. for 3-D Secure processing):


<APIResponse version="20260521">
    <Header>
        <Date>2026-06-17T15:47:05+00:00</Date>
        <Path>API/cardWallet/authorize</Path>
        <ErrorCode>0</ErrorCode>
        <ErrorMessage/>
    </Header>
    <Body>
        <Result>Redirect</Result>
        <RedirectResponse>
            <Url>https://testgateway.altapaysecure.com/eCommerce/API/emvcoThreeDSecure/authenticate/3bf811ee-b6d3-4ee3-9807-026429f64bed</Url>
            <Method>POST</Method>
            <Data/>
            <FlowType>3DSecureV2</FlowType>
        </RedirectResponse>
        <Transactions>
            <Transaction>
                <TransactionId>36</TransactionId>
                <PaymentId>3bf811ee-b6d3-4ee3-9807-026429f64bed</PaymentId>
                <AuthType>payment</AuthType>
            </Transaction>
        </Transactions>
    </Body>
</APIResponse>