**Last updated**: 11 November 2025 | [**Change log**](/products/card-payments/changelog/) # Take a card payment New API Version This documentation is for version 7 of the Card Payments API. If you're using [version 6](/products/card-payments/v6/authorize-a-payment), you can find information on how to upgrade in our [migration guide](/products/card-payments/v7-migration-guide). Take online card payments using our Card Payments API. ## Customer Initiated Transactions All payment requests where the cardholder actively participates in the flow are Customer Initiated Transactions (CITs). `POST` to our `customerInitiatedTransactions` endpoint to authorize a payment. Note Click the tabs below to see all the mandatory fields for the supported `paymentInstrument` parameters. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/cardPayments/customerInitiatedTransactions` ### Code examples Card { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } } } Token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/token", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}" } } } Network token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } Checkout { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/checkout", "tokenHref": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}", "cvcHref": "https://try.access.worldpay-bsh.securedataplatform.com/sessions/{}" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } Apple Pay { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/wallet+applepay", "walletToken": "{\"version\": \"EC_v1\",\"data\": \"kdHd..GQ==\",\"signature\": \"MIAGCSqGSIb3DQEH...AAA\",\"header\": {\"transactionId\": \"d3b28af..f8\",\"ephemeralPublicKey\": \"MFkwE..Q==\",\"publicKeyHash\": \"dxCK..6o=\" }}" } } } Google Pay { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/wallet+googlepay", "walletToken": "{\"protocolVersion\":\"ECv1\",\"signature\":\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\u003d\\u003d\",\"signedMessage\":\"{\\\"tag\\\":\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\u003d\\\",\\\"encryptedMessage\\\":\\\"mKOoXwi8OavZ\\\"}\"}" } } } Apple Pay decrypted { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken+applepay", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } Google Pay decrypted { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken+googlepay", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } ### Schema (parameters) For more information about the accepted payment instruments, see our dedicated guidance: * [Worldpay tokens](https://developer.worldpay-bsh.securedataplatform.com/products/tokens) * [Network tokens](#network-tokens) * [Checkout SDK](https://developer.worldpay-bsh.securedataplatform.com/products/checkout) * [Mobile wallets](https://developer.worldpay-bsh.securedataplatform.com/products/wallets) br ### Store a card If you are storing your customer's payment details for future use, you must indicate this using the `customerAgreement` object. Additionally, you can use our Tokens API to store your customer's card details via [Worldpay tokens](/products/tokens/create-a-token) or [network tokens](/products/tokens/create-a-network-token). Note **Important:** You must have consent from your customer to store their card details. You must also indicate when a card that you have stored previously is being used in a subsequent payment. **Example use cases:** - First card on file: a payment where the customer opts to store their card on your website for faster checkout on future purchases (i.e. express checkout). - Subsequent card on file: a payment where the customer selects a card that they have previously stored with you for an express checkout flow. - First payment in a subscription agreement. - First payment in an installment plan. Subsequent subscription or installment payments must be sent using our [merchant initiated transactions endpoint](/products/card-payments/repeat-payments), since these payments are not directly initiated by the cardholder. Note Strong Customer Authentication (SCA) is mandatory when storing payment details. You must include [3DS](#3ds) authentication or an [SCA Exemption](#sca-exemptions) when a stored card is being used for the first time. Example card on file requests: Card (first) { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 }, "cvc": "123" }, "customerAgreement":{ "type": "cardOnFile", "storedCardUsage": "first" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } Token (first) { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/token", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}", "cvc": "123" }, "customerAgreement":{ "type": "cardOnFile", "storedCardUsage": "first" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } Network token (first) { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement":{ "type": "cardOnFile", "storedCardUsage": "first" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" }, "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "06" } } } Card (subsequent) { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement":{ "type": "cardOnFile", "storedCardUsage": "subsequent" } } } Token (subsequent) { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/token", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}", "cvc": "123" }, "customerAgreement":{ "type": "cardOnFile", "storedCardUsage": "subsequent" } } } Network token (subsequent) { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement":{ "type": "cardOnFile", "storedCardUsage": "subsequent" } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } Example first subscription requests: Card { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 }, "cvc": "123" }, "customerAgreement":{ "type": "subscription", "storedCardUsage": "first" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } Token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/token", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}", "cvc": "123" }, "customerAgreement":{ "type": "subscription", "storedCardUsage": "first" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } Network token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement":{ "type": "subscription", "storedCardUsage": "first" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" }, "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } Apple Pay { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "customerAgreement": { "type": "subscription", "storedCardUsage": "first" }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/wallet+applepay", "walletToken": "{ \"version\": \"EC_v1\", \"data\": \"kdHd..GQ==\", \"signature\": \"MIAGCSqGSIb3DQEH...AAA\", \"header\": { \"transactionId\": \"d3b28af..f8\", \"ephemeralPublicKey\": \"MFkwE..Q==\", \"publicKeyHash\": \"dxCK..6o=\" } }" } } } Google Pay { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "customerAgreement": { "type": "subscription", "storedCardUsage": "first" }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/wallet+googlepay", "walletToken": "{\"protocolVersion\":\"ECv1\",\"signature\":\"MEQCIH6Q4OwQ0jAceFEkGF0JID6sJNXxOEi4r+mA7biRxqBQAiAondqoUpU/bdsrAOpZIsrHQS9nwiiNwOrr24RyPeHA0Q\\u003d\\u003d\",\"signedMessage\":\"{\\\"tag\\\":\\\"jpGz1F1Bcoi/fCNxI9n7Qrsw7i7KHrGtTf3NrRclt+U\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJatyFvFPPD21l8/uLP46Ta1hsKHndf8Z+tAgk+DEPQgYTkhHy19cF3h/bXs0tWTmZtnNm+vlVrKbRU9K8+7cZs\\\\u003d\\\",\\\"encryptedMessage\\\":\\\"mKOoXwi8OavZ\\\"}\"}" } } } Apple Pay decrypted { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken+applepay", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement":{ "type": "subscription", "storedCardUsage": "first" } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } Google Pay decrypted { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken+googlepay", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement":{ "type": "subscription", "storedCardUsage": "first" } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } | **Parameter** | **Required?** | **Description** | | --- | --- | --- | | `instruction.customerAgreement` | ❌ | An object containing details about processing agreements made with your customer, i.e.: An agreement to store the customer's paymentInstrument for future processing (e.g. set up a subscription plan or store a card on file)An agreement to set up an installment schedule (for Latin America payments) | | `customerAgreement.type` | ✅ | The processing arrangement agreed with your customer. Possible values:`cardOnFile` - for storing card details for future CITs`subscription` - for storing card details for a subscription agreement `installment` - for storing card details for an installment plan | | `customerAgreement.storedCardUsage` | Mandatory for types: `cardOnFile``subscription``installment` (where `installmentType` = `merchant` | Possible values:`first` - for storing a card for the first time`used` - for using a previously stored card | | `customerAgreement.installmentType` | Mandatory where `customerAgreement.type` = `installment` | Possible values:`merchant``latinAmerica` - for installment plans in Latin America | br ### Settlement #### Auto settlement You can request that payment authorizations are automatically sent for settlement (sometimes referred to as "capture") by setting `requestAutoSettlement.enabled` to `true` in your `/cardPayments/customerInitiatedTransactions` request. #### Manual settlement To manually request settlement at a time of your choosing, set `requestAutoSettlement.enabled` to `false`. You can then use the `cardPayments:settle` or `cardPayments:partialSettle` next action link returned in your response message to send the [full authorized amount](/products/card-payments/manage-payments#settle-an-authorization) or a [partial amount](/products/card-payments/manage-payments#partially-settle-an-authorization) for settlement. Note Payment Authorizations automatically expire after a set time period. The time period can be as little as three days, and depends on a number of parameters such as your region, Merchant Category Code (MCC), and the payment purpose. Please refer to card scheme documentation for the authorization expiry time periods for each scenario. br ### Network Tokens Network Tokens are format-preserving representations of a `cardNumber` (Primary Account Number, or PAN: the long card number, usually on the front of a card). This means that, like a `cardNumber`, network tokens are usually 16-digits in length. Some benefits of using network tokens: - Increased authorization rates - Reduced card scheme fees in some regions - Increased security given a new cryptogram must be provisioned for each customer initiated payment - Network tokens remain unaltered if the underlying card expires and is re-issued Note See our guidance on how to [Create a Network Token](https://developer.worldpay-bsh.securedataplatform.com/products/tokens/create-a-network-token). When using network tokens in Customer Initiated Transactions, you must include the `cryptogram`. This can be obtained from our [Tokens API](/products/tokens/querying-network-tokens-and-provisioning-cryptograms) or your Token provider. br Example network token requests: Network Token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "05" } } } 3DS2 Network Token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" }, "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "06" } } } | **Parameter** | **Required** | **Description** | | --- | --- | --- | | `authentication.networkToken` | ✅ | An object containing network token verification details. | | `authentication.networkToken.cryptogram` | ✅ | The single-use cryptogram provisioned for this payment. | | `authentication.networkToken.eci` | ❌ | Electronic Commerce Indicator (ECI).Indicates the outcome of the network token verification.02 or 05 - Fully Authenticated Transaction01 or 06 - Attempted Authentication Transaction00 or 07 - Not successfully authenticated**Mastercard** - 02, 01, 00**Visa** - 05, 06, 07**Amex** - 05, 06, 07**JCB** - 05, 06, 07**Diners** - 05, 06, 07 | br ### FraudSight Link your [FraudSight assessment](/products/fraudsight) with your payment using the `riskProfile`. This allows the fraud model to learn and improve the risk health of future payments. ``` "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC" ``` br ### SCA Exemptions #### Granted by Worldpay Apply your Worldpay granted exemption (from [Exemptions](/products/sca-exemptions/) or [FraudSight](/products/fraudsight/)) using the `riskProfile`. This allows the exemption to be applied to your payment authorization. ``` "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC" ``` br #### Granted by 3rd party TRA (external) To use exemptions granted by a 3rd party Transaction Risk Analysis (TRA) tool. This is not enabled by default, please contact your Implementation Manager. Do not send externally granted TRA exemptions without approval from us and confirmation that we have fully enabled it. ```JSON "exemption": { "type": "external", "request": { "placement": "authentication", "type": "lowRisk" } } ``` br #### 3DS authentication outage exemption This is not enabled by default, please contact your Implementation Manager. If 3DS suffers from a recognized downstream outage, you can apply an `authenticationOutage` exemption. Liability shift is not offered, but it increases the chance of an `authorized` outcome. ```JSON "exemption": { "type": "authenticationOutage" } ``` View the full exemption object schema ### 3DS Complete an [authentication request](/products/3ds/web/authentication) using our [3DS API](/products/3ds) to get the details required to prove that 3DS has taken place. 3DS2 Card { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } 3DS2 Card (Cartes Bancaires) Cartes Bancaires requires some additional 3DS authentication details { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/plain", "cardNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "threeDS": { "version": "2.1.0", "eci": "01", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAAA=", "transactionId": "c5b808e7-1de1-4069-a17b-f70d3b3b1645", "cryptogramAlgorithm": 2, "challengePreference": "challengeMandated", "authenticationFlow": "challenge", "statusReason": "11", "cancellationIndicator": "01", "networkScore": "00", "brand": "cartesBancaires" } } } 3DS2 Token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/token", "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}" } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" } } } 3DS2 Network Token { "transactionReference": "Memory265-13/08/1876", "channel": "ecom", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 250 }, "paymentInstrument": { "type": "card/networkToken", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } } }, "authentication": { "threeDS": { "eci": "05", "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAA3=", "transactionId": "a09b446d-5c0d-4003-9c99-21fb73d75999", "version": "2.2.0" }, "networkToken": { "cryptogram": "MAAAAAAAAAAAAAAAAAAAAAAAAAB=", "eci": "06" } } } Note 3DS data cannot be supplied for MOTO transactions. | **Parameter** | **Required** | **Description** | | --- | --- | --- | | `authentication.threeDS` | ✅ | An object containing the result of your customer's verification. For more details see [3DS verification](/products/3ds/web/challenge-verification#verification). | | `authentication.threeDS.version` | ✅ | The version of 3DS used to process the transaction. Possible values for 3DS2: `2.1.0``2.2.0` Required for Mastercard's Identity Check transactions in Authorization. | | `authentication.threeDS.eci` | ✅ | Electronic Commerce Indicator (ECI).Indicates the outcome of the [3DS verification](/products/3ds/web/challenge-verification#verification).02 or 05 - Fully Authenticated Transaction01 or 06 - Attempted Authentication Transaction00 or 07 - Non 3-D Secure Transaction**Mastercard** - 02, 01, 00**Visa** - 05, 06, 07**Amex** - 05, 06, 07**JCB** - 05, 06, 07**Diners** - 05, 06, 07 | | `authentication.threeDS.authenticationValue` | ✅ | Required, if `threeDS.eci` value is 01, 02, 05 or 06.A cryptographic value that provides evidence of the outcome of a 3DS verification.Visa - Cardholder Authentication Verification Value (CAVV)Mastercard - Universal Cardholder Authentication Field (UCAF)`threeDS.authenticationValue` must be 28 digits max and must be base64-encoded. | | `authentication.threeDS.transactionId` | ✅ | Required, if `threeDS.eci` value is 01, 02, 05 or 06.A unique authentication transaction identifier, generated by the issuer.For version 3DS2: `transactionId` follows RFC 4122 UUID standard and is 36 characters in length. | | `authentication.threeDS.cryptogramAlgorithm` | ❌ | Indicates the algorithm used to generate the cryptogram. For Cartes Bancaires authorizations only. | | `authentication.threeDS.challengePreference` | ❌ | Indicates the preferred challenge behavior.noPreferencenoChallengeRequestedchallengeRequestedchallengeMandatedFor Cartes Bancaires authorizations only. | | `authentication.threeDS.authenticationFlow` | ❌ | `challenge` - Your customer was redirected to their bank to complete authentication`frictionless` - Your customer completed authentication without needing to be redirected to their bankFor Cartes Bancaires authorizations only. | | `authentication.threeDS.statusReason` | ❌ | Provides further information relating to the outcome of the authentication. Returned for failed authentications only. For Cartes Bancaires authorizations only. | | `authentication.threeDS.cancellationIndicator` | ❌ | An indicator as to why the authentication was cancelled. - `01` - Cardholder selected cancel - `02` - Reserved for future use - `03` - Authentication timed out - `04` & `05` - Authentication timed out at ACS provider - `06` - Transaction error - `07` - Unknown - `08` - Transaction timed out at SDK For Cartes Bancaires authorizations only. | | `authentication.threeDS.networkScore` | ❌ | The global score calculated by the Cartes Bancaires scoring platform.For Cartes Bancaires authorizations only. | | `authentication.threeDS.brand` | ❌ | The card brand used in the authentication.For Cartes Bancaires authorizations only. | br ### Enable additional features Account Updater Reduce declines and improve your customer's experience by automatically retrieving updated card details in real time. Co-branded Cards Take payments from cards that carry multiple card brands. Financial Services (MCC 6012/6051) Supply additional mandatory data if you offer financial services, debt repayments, or consumer bill payments. Funding Transactions (AFT) Take Account Funding Transactions (AFTs) to pull funds from a card account to another destination. Airline data Supply detailed airline itinerary data to achieve several cost and efficiency benefits. Corporate Purchasing Data (Level 2 / 3) Submit additional order, tax, and line item data in your payment authorization and settlement requests where your customer is using a commercial or purchasing card. Latin America Payments Take payments in Latin America, including regional installment plan options, combo cards, and supplying customer document references. MOTO transactions Take Mail Order/ Telephone Order payments. Partial authorizations Accept authorizations for partial amounts. View all features ## Response Best practice Access Worldpay returns a `WP-CorrelationId` in the headers of service responses. We **highly recommend** you log this. The `WP-CorrelationId` is used by us to examine individual service requests. ### Successful payment You receive: * an HTTP code `201` * an `"outcome": "authorized"` or `"Sent for Settlement"` * a `paymentId` - a unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions * a `commandId` - a unique identifier generated by us for a single instance of an interaction (command) with our API * risk factors (only returned if issuer identifies conflict) * an [exemption result and reason](#exemptions) (only if you supplied a risk profile to request an [SCA exemption](/products/sca-exemptions)) * an issuer authorization code * links to either: * [settle](/products/card-payments/manage-payments#settle-an-authorization), [partially settle](/products/card-payments/manage-payments#partially-settle-an-authorization), [cancel](/products/card-payments/manage-payments#cancel-an-authorization), or [query a payment](/products/card-payments/query-a-payment) when `requestAutoSettlement` was set to `false` in the authorization request and the `outcome` is `"authorized"` * [refund](/products/card-payments/manage-payments#fully-refund-a-payment), [partially refund](/products/card-payments/manage-payments#partially-refund-a-payment), [reverse](/products/card-payments/manage-payments#reverse-a-payment) or [query a payment](/products/card-payments/query-a-payment) when `requestAutoSettlement` was set to `true` in the authorization request and the `outcome` is `"Sent for Settlement"` * a `paymentInstrument` object #### `paymentInstrument` We return the `"paymentInstrument"` object, if we are able to provide information related to the underlying card used in the authorization request. Note If we return the `paymentInstrument` object, there is no guarantee that each field listed below will be returned with every transaction. | Parameter | Description | | --- | --- | | `paymentInstrument.type` | The type of paymentInstrument. E.g.: `card/plain+masked``card/network+masked``card/network` | | `paymentInstrument.brand` | The card brand. Sometimes referred to as the network or scheme. E.g.: `visa``mastercard``amex` | | `paymentInstrument.cardBin` | The card bin. E.g.: `444433` this may contain the `*` character. | | `paymentInstrument.lastFour` | The last four digits of the card. E.g.: `1111` this may contain the `*` character, where the card number is less than 16 digits. | | `paymentInstrument.expiryDate.month` | The card expiry month. E.g.: `11` | | `paymentInstrument.expiryDate.year` | The card expiry year. E.g.: `2025` | | `paymentInstrument.fundingType` | How the card is funded. E.g.: `credit``debit``prepaid``deferredDebit``chargeCard` | | `paymentInstrument.category` | Whether the card is classed as a consumer card or a card for commercial use. E.g.: `consumer``commercial` | | `paymentInstrument.countryCode` | The alpha-2 ISO-3166 country code that the card was issued in. May return `"N/A"` where the country is unknown. E.g.: `GB` | | `paymentInstrument.issuerName` | The name of the card issuer. E.g.: `Some Issuer PLC.` | | `paymentInstrument.paymentAccountReference` | The payment account reference (PAR) is a non-financial reference that uniquely identifies the underlying cardholder account. This allows you to correlate payments made with differing instruments (e.g. "`card/plain"` and `"card/wallet+applepay"`), where the same account funds the transaction. A PAR cannot be used to initiate a payment. E.g.: `ABC123DEF456GHI789JKL123MNO45` | | `paymentInstrument.debitNetwork` | The debit network that the transaction was routed through. Returned optionally for subscribing merchants. See our [API reference](/products/card-payments/openapi/other/authorize#other/authorize/t=response&c=201&path=&d=0/paymentinstrument/debitnetwork) for all possible values. | Marketplaces If you follow a Marketplace flow, ensure you **now** split your payment through our [Split Payments API](/products/split-payments/), to guarantee an automated payout to the party. ### Refused payment You receive: * an HTTP code `201` * an `"outcome": "refused"` * a `paymentId` - a unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions * a `commandId` - a unique identifier generated by us for a single instance of an interaction (command) with our API * a `refusalCode` containing either our standard [refusal codes](/products/reference/refusal-response) or the [rawCode](/products/reference/refusal-response/scheme-codes) (if enabled) * a `refusalDescription` which gives additional context on the refusal * an [advice code](/products/reference/refusal-response#refusal-advice-codes) (only if returned by the card scheme and acquirer) * risk factors (only returned if issuer identifies conflict) * an [exemption result and reason](#exemptions) (only if you supplied a risk profile to request an [SCA exemption](/products/sca-exemptions)) * a `paymentInstrument` object ### Example response codeblock codeblockitem codeblockitem codeblockitem codeblockitem Card/Token { "outcome": "authorized", "paymentId": "pay-fh47sbnaKR28AuocN28x0", "commandId": "cmdfHx982Nbhsklg91hsvlrv0", "riskFactors": [ { "type": "cvc", "risk": "notSupplied" }, { "type": "avs", "risk": "notChecked", "detail": "address" }, { "type": "avs", "risk": "notChecked", "detail": "postcode" } ], "issuer": { "authorizationCode": "12345A" }, "scheme": { "reference": "060720116005060" }, "paymentInstrument": { "type": "card/plain+masked", "cardBin": "444433", "lastFour": "1111", "category": "consumer", "expiryDate": { "month": 5, "year": 2035 }, "cardBrand": "visa", "fundingType": "credit", "issuerName": "Some Issuer PLC", "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E" }, "_links": { "cardPayments:cancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiI=" }, "cardPayments:partialCancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/partials/eyJrIjoiazNhYjYzMiJ9" }, "cardPayments:settle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazNhYjYzMiI=" }, "cardPayments:partialSettle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiI=" }, "cardPayments:events": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/eyJrIjoiazNhYjYzMiI=" }, "curies": [ { "name": "cardPayments", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/cardPayments/{rel}", "templated": true } ] } } Network Token { "outcome": "authorized", "paymentId": "pay3N_87du2Sj-3HndV826xn0", "commandId": "cmdwZ5y_rSV1VmjD6CpgCuXG0", "riskFactors": [ { "type": "cvc", "risk": "notSupplied" }, { "type": "avs", "risk": "notMatched", "detail": "address" }, { "type": "avs", "risk": "notChecked", "detail": "postcode" } ], "issuer": { "authorizationCode": "12345A" }, "scheme": { "reference": "060720116005060" }, "paymentInstrument": { "type": "card/network", "cardBin": "444433", "expiryDate": { "month": 5, "year": 2035 }, "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E" }, "_links": { "cardPayments:cancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiI" }, "cardPayments:partialCancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/partials/eyJrIjoiazNhYjYzMiJ9" }, "cardPayments:settle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazNhYjYzMiI" }, "cardPayments:partialSettle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiI" }, "cardPayments:events": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/eyJrIjoiazNhYjYzMiI" }, "curies": [ { "name": "cardPayments", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/cardPayments/{rel}", "templated": true } ] } } Apple Pay/Google Pay { "outcome": "authorized", "paymentId": "paygN28d-s18ncZnsDL02n470", "commandId": "cmdWP_h29znMbajSr2-911U70", "riskFactors": [ { "risk": "notChecked", "detail": "postcode", "type": "avs" }, { "risk": "notChecked", "detail": "address", "type": "avs" } ], "scheme": { "reference": "schemeReference" }, "paymentInstrument": { "type": "card/network+masked", "cardBin": "444433", "lastFour": "1111", "tokenNumber": "444433******1111", "countryCode": "GB", "expiryDate": { "month": 2, "year": 2028 }, "cardBrand": "visa", "fundingType": "debit", "category": "consumer", "issuerName": "VALID_ISSUER", "paymentAccountReference": "somePAR" }, "_links": { "cardPayments:cancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/eyJrIjoiazUyOTVhMSIsImxpbmtWZXJzaW9uIjoiMy4wLjAifQ==.7uyuNo1ShOgM5rTwStg86LXzb0a2wdLW1lwX:DIQ2Ecrp4gw65VLnHmjsAVqzpa2NcwixaBb2p8R2x5NPXdRpybJ2ndKlbkNOc9gj+ruN20iaTdYqv2FNgB3ZAw3g+yyUMUlQDFD8DU++ZswXpUQe8YTBHmTP8zHQUXrSORn9IaI6kzJnMu2HWwEJOqKnWLvRCMy:fr4ptatJJrmRVON8WTjisJL:sd3TJ9uDcO:gD+q+Q01y++Mzop0k8y3bDcnNBpsG:8xf4uKGGYO3EcAWA==" }, "cardPayments:partialCancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/partials/eyJrIjoiazUyOTVhMSIsImxpbmtWZXJzaW9uIjoiMy4wLjAifQ==.7uyuNo1ShOgM5rTwStg86LXzb0a2wdLW1lwX:DIQ2Ecrp4gw65VLnHmjsAVqzpa2NcwixaBb2p8R2x5NPXdRpybJ2ndKlbkNOc9gj+ruN20iaTdYqv2FNgB3ZAw3g+yyUMUlQDFD8DU++ZswXpUQe8YTBHmTP8zHQUXrSORn9IaI6kzJnMu2HWwEJOqKnWLvRCMy:fr4ptatJJrmRVON8WTjisJL:sd3TJ9uDcO:gD+q+Q01y++Mzop0k8y3bDcnNBpsG:8xf4uKGGYO3EcAWA==" }, "cardPayments:settle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazUyOTVhMSIsImxpbmtWZXJzaW9uIjoiMy4wLjAifQ==.7uyuNo1ShOgM5rTwStg86LXzb0a2wdLW1lwX:DIQ2Ecrp4gw65VLnHmjsAVqzpa2NcwixaBb2p8R2x5NPXdRpybJ2ndKlbkNOc9gj+ruN20iaTdYqv2FNgB3ZAw3g+yyUMUlQDFD8DU++ZswXpUQe8YTBHmTP8zHQUXrSORn9IaI6kzJnMu2HWwEJOqKnWLvRCMy:fr4ptatJJrmRVON8WTjisJL:sd3TJ9uDcO:gD+q+Q01y++Mzop0k8y3bDcnNBpsG:8xf4uKGGYO3EcAWA==" }, "cardPayments:partialSettle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazUyOTVhMSIsImxpbmtWZXJzaW9uIjoiMy4wLjAifQ==.7uyuNo1ShOgM5rTwStg86LXzb0a2wdLW1lwX:DIQ2Ecrp4gw65VLnHmjsAVqzpa2NcwixaBb2p8R2x5NPXdRpybJ2ndKlbkNOc9gj+ruN20iaTdYqv2FNgB3ZAw3g+yyUMUlQDFD8DU++ZswXpUQe8YTBHmTP8zHQUXrSORn9IaI6kzJnMu2HWwEJOqKnWLvRCMy:fr4ptatJJrmRVON8WTjisJL:sd3TJ9uDcO:gD+q+Q01y++Mzop0k8y3bDcnNBpsG:8xf4uKGGYO3EcAWA==" }, "cardPayments:events": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/eyJrIjoiazUyOTVhMSIsImxpbmtWZXJzaW9uIjoiMy4wLjAifQ==.7uyuNo1ShOgM5rTwStg86LXzb0a2wdLW1lwX:DIQ2Ecrp4gw65VLnHmjsAVqzpa2NcwixaBb2p8R2x5NPXdRpybJ2ndKlbkNOc9gj+ruN20iaTdYqv2FNgB3ZAw3g+yyUMUlQDFD8DU++ZswXpUQe8YTBHmTP8zHQUXrSORn9IaI6kzJnMu2HWwEJOqKnWLvRCMy:fr4ptatJJrmRVON8WTjisJL:sd3TJ9uDcO:gD+q+Q01y++Mzop0k8y3bDcnNBpsG:8xf4uKGGYO3EcAWA==" }, "tokens:token": { "href": "https://access.worldpay-bsh.securedataplatform.com/tokens/linkData" }, "curies": [{ "name": "cardPayments", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payments/{rel}", "templated": true }] } } Refusal { "outcome": "refused", "paymentId": "pay29GnajUy2fBzC9552U_1b0", "commandId": "cmd9xmr5cSNtUulYlYW8kbY80", "refusalCode": "83", "refusalDescription": "Fraud/Security related reasons", "riskFactors": [ { "type": "riskProfile", "risk": "verificationFailed" }, { "type": "cvc", "risk": "notMatched" }, { "type": "avs", "risk": "notMatched", "detail": "address" }, { "type": "avs", "risk": "notChecked", "detail": "postcode" } ] } Apple Pay/Google Pay Refusal { "outcome": "refused", "paymentId": "pay38Ndh3N-cS18i023-hksO0", "commandId": "cmd93Ng8_KvnwI9sK7dJakl90", "description": "Do not honor", "refusalCode": "83", "refusalDescription": "Fraud/Security related reasons", "riskFactors": [ { "risk": "notChecked", "detail": "postcode", "type": "avs" }, { "risk": "notChecked", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/network+masked", "cardBin": "444433", "lastFour": "1111", "tokenNumber": "444433******1111", "countryCode": "GB", "expiryDate": { "month": 2, "year": 2028 }, "cardBrand": "visa", "fundingType": "debit", "category": "consumer", "issuerName": "VALID_ISSUER", "paymentAccountReference": "somePAR" } } Account Updater { "outcome": "authorized", "paymentId": "pay28NdG68sv-13_sDcu5Bwt0", "commandId": "cmd8hJcb20_sh2-sbRjx88wL0", "riskFactors": [ { "type": "cvc", "risk": "notSupplied" }, { "type": "avs", "risk": "notChecked", "detail": "address" }, { "type": "avs", "risk": "notChecked", "detail": "postcode" } ], "issuer": { "authorizationCode": "12345A" }, "scheme": { "reference": "060720116005060" }, "updatedPaymentInstrument": { "cardBin": "491183", "lastFour": "0000", "expiryDate": { "month": 9, "year": 2031 }, "cardBrand": "visa", "fundingType": "credit", "accountUpdaterMessage": "The account number was changed", "type": "card/plain+masked" }, "paymentInstrument": { "type": "card/plain+masked", "cardBin": "444433", "lastFour": "1111", "category": "consumer", "expiryDate": { "month": 5, "year": 2023 }, "cardBrand": "visa", "fundingType": "credit", "issuerName": "Some Issuer PLC", "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E" }, "_links": { "cardPayments:cancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiI=" }, "cardPayments:partialCancel": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/partials/eyJrIjoiazNhYjYzMiJ9" }, "cardPayments:settle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazNhYjYzMiI=" }, "cardPayments:partialSettle": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiI=" }, "cardPayments:events": { "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/eyJrIjoiazNhYjYzMiI=" }, "curies": [ { "name": "cardPayments", "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/cardPayments/{rel}", "templated": true } ] } } You can use the `payments:settle` action link to [settle the payment](/products/card-payments/manage-payments#settle-an-authorization) straight away. You only receive this, if you set `"requestAutoSettlement"` to `false` in your initial request. Alternatively you can cache the response and use the link to settle the payment later. Note In case of an error, you can get further information in our [error reference](/products/reference/worldpay-error-responses). #### `riskFactors` To reduce the probability of processing a fraudulent payment, supply your customer's billing address and cvc in your [authorization request](#complete-authorization-request-schema). We check this with your customer's issuing bank and include any conflicts in our response. The `riskFactors` array is returned **only if** there is a risk associated with the authorization request. The `riskFactors` array returns an object for `avs`, `cvc` or `riskProfile` **only if** this information was included in the authorization request **and** if any risk was identified. The table below describes the response parameters: | Parameter | Description | | --- | --- | | `riskFactors.type` | Returns `avs`, `cvc` or `riskProfile` | | `riskFactors.detail` | For `avs` only. Returns `postcode` or `address` | | `riskFactors.risk` | Returns `notChecked`, `notMatched`, `notSupplied` or `verificationFailed` | #### `exemptions` An [exemption](/products/sca-exemptions) result and reason if a [risk profile](/products/sca-exemptions/assessment#applying-the-exemption) was included in your authorization request. The table below describes the response parameters: | Parameter | Description | | --- | --- | | `exemption.result` | Returns `honored`, `outOfScope`, `rejected` or `unknown` | | `exemption.reason` | For `honored`, returns `issuerHonored` or `unknown`. For `outOfScope`, returns `merchantInitiatedTransaction`, `oneLegOut`, `moto`, `contactless` or `unknown`. For `rejected`, returns `issuerRejected`, `highRisk`, `invalid`, `unsupportedScheme`, `notSubscribed`, `unsupportedAcquirer` or `unknown` | ### Soft declines The issuer responds with a soft decline ([refusal code 65](/products/reference/refusal-response)), if no exemption has been applied to the payment. The next logical step for this is to proceed with [3DS authentication](/products/3ds/web/authentication). #### Next steps [Settle a payment](/products/card-payments/manage-payments#settle-an-authorization) [Refund a payment](/products/card-payments/manage-payments#fully-refund-an-authorization) [Cancel a payment](/products/card-payments/manage-payments#cancel-an-authorization) [Reverse a payment](/products/card-payments/manage-payments#reverse-an-authorization)