**Last updated**: 11 November 2025 | [**Change log**](/products/card-payments/changelog/)

# Take a payment

To take a payment, you must first create an [authorization request](#authorization-request). Your response contains links to your next available actions.

## Authorize a payment

If you want to reserve funds in your customer's account, send us an authorization request.

`POST` your authorization request to the `payments:authorize`action link received in your payments root resource response to authorize a payment.

### Authorization example request

`POST`  `https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations`

The requests below contain all the mandatory fields needed for a successful authorization request.

Note
Click the tabs below to see all the mandatory fields for all supported `paymentInstrument` parameters.

One-Time Authorization request body:

Card
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/plain",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    }
}
Token
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/token",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}"
        }
    }
}
Apple Pay
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "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",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "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\\\"}\"}"
        }
    }
}
Network Token
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/networkToken",
            "dpan": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    },
    "customer": {
        "authentication": {
            "type": "card/networkToken",
            "authenticationValue": "abc123==",
            "eci": "00"
        }
    }
}

Apple Pay decrypted
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/networkToken+applepay",
            "dpan": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    },
    "customer": {
        "authentication": {
            "type": "card/networkToken",
            "authenticationValue": "abc123=="
        }
    }
}

#### Parameter descriptions

| Parameter | Required | Description |
|  --- | --- | --- |
| `transactionReference` | ✅ | A unique reference generated by you that is used to identify a payment throughout its lifecycle. See [transaction reference format](/products/reference/formatting#transaction-reference-format), for more details and the best practices. |
| `merchant` | ✅ | An object that contains information about the merchant. |
| `merchant.entity` | ✅ | Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.Contact your Implementation Manager for more details. |
| `merchant.mcc` | ❌ | You can apply a merchant category code (`mcc`) to an individual request. You can only provide an `mcc` if we have enabled the dynamic mcc feature during [boarding](https://www.worldpay-bsh.securedataplatform.com/en-GB/merchant-support#still-need-help). If enabled but not provided, `merchant.mcc` defaults to a configured value. For more information contact your [Relationship Manager](https://www.worldpay-bsh.securedataplatform.com/en-GB/merchant-support#still-need-help). |
| `merchant.paymentFacilitator` | ❌ | An object containing Payment Facilitator information. This information is required for every authorization **only if you are a Payment Facilitator**:`pfId``isoId``subMerchant.merchantId``subMerchant.postalcode``subMerchant.street``subMerchant.city``subMerchant.countryCode``subMerchant.telephone` (mandatory for Amex)`subMerchant.email` (mandatory for Amex) You can find more formatting information [here](/products/reference/formatting#payment-facilitator-format). |
| `channel` | ❌ | The payment channel indicates the interaction of the cardholder with the merchant. Possible value : `moto`Supply a value of `moto` to process an authorization as a Mail Order or Telephone Order (MOTO) transaction. If channel is not provided, the authorization will be processed as ecommerce by default. 3DS `authentication` data cannot be supplied for MOTO payments. |
| `instruction` | ✅ | An object that contains all the information related to the payment. |
| `instruction.narrative` | ✅ | The text that appears on your customer's statement. Used to identify the merchant.See [narrative format](/products/reference/formatting#narrative-format) for more details and best practices. |
| `narrative.line1` | ✅ | The first line of the narrative which appears on your customer's statement (24 characters max. If character is not supported it is replaced with a space.).See [narrative `line1` format](/products/reference/formatting#narrative-line1) for more details. |
| `narrative.line2` | ❌ | Additional details about the payment e.g. order number, telephone number. |
| `instruction.value` | ✅ | An object that contains information about the value of the payment. |
| `instruction.debtRepayment` | ❌ | DRI is a flag which identifies a payment as being for the purpose of repaying a debt. Possible value : `true` (only supply if true)For more information contact your [Relationship Manager](https://www.worldpay-bsh.securedataplatform.com/en-GB/merchant-support#still-need-help). |
| `value.currency` | ✅ | The three digit currency code.See list of [supported currencies](/products/reference/useful-tables-v5-v6#currency-codes). |
| `instruction.value` | ✅ | An object that contains information about the value of the payment. |
| `value.amount` | ✅ | The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50. You can find the relevant exponent in our [currency table](/products/reference/useful-tables-v5-v6#currency-codes). |
| `instruction.paymentInstrument` | ✅ | An object that contains the payment type and details. To use "tokens" as a `paymentInstrument` you must first [create a token](/products/tokens/create-a-token). |
| `paymentInstrument.cardHolderName` | ❌ | An object that contains your customer's card name. This is not a mandatory field however it is recommended that you supply this to improve authorization rates. If not sent, the default value is "Not Supplied". |
| `paymentInstrument.cardExpiryDate` | ✅ | An object that contains your customer's card expiry date. Mandatory for all `"type": "card/plain"` requests. |
| `paymentInstrument.cardNumber` | ✅ | An object that contains your customer's card number. Mandatory for `"type": "card/plain"` requests. |
| `paymentInstrument.cvc` | ❌ | CVC is a unique set of 3 or 4 numbers on the back of the card.  Our API checks to see if the CVC supplied matches the CVC held by the issuing bank. |
| `paymentInstrument.billingAddress` | ❌ | An object containing the billing address information.  **If included you must send** at least:`address1``city``countryCode``postalCode` This is used for Address Verification Service (AVS) and can only be supplied with a `card/plain`,`card/wallet+applepay` or `card/wallet+googlepay` payment instrument. Our API checks the submitted AVS to see if it matches the address registered with the issuing bank. If the address supplied does not match the registered address it means that the payment carries additional risk. |
| `customer.riskProfile` | ❌ | Used to apply the [SCA exemption](/products/sca-exemptions) in the payment request and update the [FraudSight](/products/fraudsight) data model to benefit future payments. |


### 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.


```
"customer": {
    "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC"
  }
```

Full a full example request please see our [optional parameters](#optional-parameters) section.

### SCA Exemptions

Link your [Exemption assessment](/products/sca-exemptions) with your payment using the `riskProfile`. This allows the exemption to be applied to your payment authorization.


```
"customer": {
    "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC"
  }
```

For a full example request please see our [optional parameters](#optional-parameters) section.

### 3DS

#### 3DS authorization request parameter descriptions

To get the `customer` authentication object you must complete an [authentication request](/products/3ds/web/authentication) using our [3DS API](/products/3ds).

3DS2 Card
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "trading name"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/plain",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    },
    "customer": {
        "authentication": {
            "version": "2.1.0",
            "type": "3DS",
            "eci": "05",
            "authenticationValue": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
            "transactionId": "c5b808e7-1de1-4069-a17b-f70d3b3b1645"
        }
    }
}
3DS2 Token
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/token",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}"
        }
    },
    "customer": {
        "authentication": {
            "version": "2.1.0",
            "type": "3DS",
            "eci": "05",
            "authenticationValue": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
            "transactionId": "c5b808e7-1de1-4069-a17b-f70d3b3b1645"
        }
    }
}
Note
* 3DS1 is supported in certain regions only
* 3DS data cannot be supplied for MOTO transactions.


#### The descriptions of parameters from your 3DS authorization request

| Parameter | Required | Description |
|  --- | --- | --- |
| `customer` | ✅ | An object containing the result of your customer's verification. For more details see [3DS verification](/products/3ds/web/challenge-verification#verification). |
| `authentication.type` | ✅ | 3DS |
| `authentication.version` | ✅ | The version of 3DS used to process the transaction.For 3DS1 - `1.0.2`For 3DS2 - `2.1.0` or  `2.2.0`  Required for Mastercard's Identity Check transactions in Authorization. |
| `authentication.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 TransactionMastercard - 02, 01, 00Visa - 05, 06, 07Amex - 05, 06, 07JCB - 05, 06, 07Diners - 05, 06, 07 |
| `authentication.authenticationValue` | ✅ | Required, if `authentication.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)`authentication.authenticationValue` must be 28 digits max and must be base64-encoded. |
| `authentication.transactionId` | ✅ | Required, if `authentication.eci` value is 01, 02, 05 or 06.A unique authentication transaction identifier, generated by the issuer.For version 3DS1: `transactionId` is base64-encoded and  28 digits in length.For version 3DS2: `transactionId` follows RFC 4122 UUID standard and is 36 characters in length. |
| `authentication.cryptogramAlgorithm` | ❌ | Indicates the algorithm used to generate the cryptogram. For Cartes Bancaires authorizations only. |
| `authentication.challengePreference` | ❌ | Indicates the preferred challenge behavior.noPreferencenoChallengeRequestedchallengeRequestedchallengeMandatedFor Cartes Bancaires authorizations only. |
| `authentication.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.statusReason` | ❌ | Provides further information relating to the outcome of the authentication. Returned for failed authentications only. For Cartes Bancaires authorizations only. |
| `authentication.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.networkScore` | ❌ | The global score calculated by the Cartes Bancaires scoring platform.For Cartes Bancaires authorizations only. |
| `authentication.brand` | ❌ | The card brand used in the authentication.For Cartes Bancaires authorizations only. |


### Optional parameters

details
summary
Example One-Time Authorization request (all parameters)
The requests below contain all the mandatory and optional fields needed for a successful authorization request.

Full authorization request body:

Card All
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default",
        "mcc": "1234",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "channel": "moto",
    "instruction": {
        "debtRepayment": true,
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "cvc": "123",
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            },
            "type": "card/plain",
            "cardHolderName": "Sherlock Holmes",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    },
    "customer": {
        "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC"
    }
}

Token All
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default",
        "mcc": "1000",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "channel": "moto",
    "instruction": {
        "debtRepayment": true,
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/token",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}",
            "cvc": "898"
        }
    },
    "customer": {
        "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC"
    }
}

3DS2 Card All
{
    "transactionReference": "unique-transactionReference",
    "merchant": {
        "entity": "default",
        "mcc": "1234",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "instruction": {
        "debtRepayment": true,
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "cvc": "123",
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            },
            "type": "card/plain",
            "cardHolderName": "Sherlock Holmes",
            "cardNumber": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    },
    "customer": {
        "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC",
        "authentication": {
            "version": "2.1.0",
            "type": "3DS",
            "eci": "05",
            "authenticationValue": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
            "transactionId": "683001f5-3805-423a-b580-638e4b2093b"
        }
    }
}

3DS2 Token All
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default",
        "mcc": "1000",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "instruction": {
        "debtRepayment": true,
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/token",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}",
            "cvc": "898"

        }
    },
    "customer": {
        "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC",
        "authentication": {
            "version": "2.1.0",
            "type": "3DS",
            "eci": "05",
            "authenticationValue": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
            "transactionId": "c5b808e7-1de1-4069-a17b-f70d3b3b1645"
        }
    }
}

Apple Pay
{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
      "entity": "default"
  },
    "instruction": {
        "narrative": {
          "line1": "Mind Palace Ltd"
        },
        "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=\"
                }
              }",
              "billingAddress": {
                  "address1": "221B Baker Street",
                  "address2": "Marylebone",
                  "address3": "Westminster",
                  "postalCode": "NW1 6XE",
                  "city": "London",
                  "state": "Greater London",
                  "countryCode": "GB"
              }
        }
    }
}
Google Pay
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default"
        },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/wallet+googlepay",
            "walletToken": "{
                \"version\": \"EC_v1\",
                \"data\": \"kdHd..GQ==\",
                \"signature\": \"MIAGCSqGSIb3DQEH...AAA\",
                \"header\": {
                    \"transactionId\": \"d3b28af..f8\",
                    \"ephemeralPublicKey\": \"MFkwE..Q==\",
                    \"publicKeyHash\": \"dxCK..6o=\"
                }
            }",
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            }
        }
    }
}
Network Token
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default",
        "mcc": "1234",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/networkToken",
            "dpan": "4444333322221111",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            },
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            },
            "cardHolderName": "Sherlock Holmes"
        }
    },
    "customer": {
        "authentication": {
            "type": "card/networkToken",
            "authenticationValue": "abc123==",
            "eci": "00"
        }
    }
}

Apple Pay decrypted
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant": {
        "entity": "default",
        "mcc": "6432",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "instruction": {
        "narrative": {
            "line1": "Mind Palace Ltd"
        },
        "value": {
            "currency": "GBP",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/networkToken+applepay",
            "dpan": "4444333322221111",
            "billingAddress": {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            },
            "cardHolderName": "Sherlock Holmes",
            "cardExpiryDate": {
                "month": 12,
                "year": 2025
            }
        }
    },
    "customer": {
        "authentication": {
            "type": "card/networkToken",
            "authenticationValue": "abc123==",
            "eci": "00"
        }
    }
}

3DS2 Cartes Bancaires Card All
{
    "transactionReference": "unique-transactionReference",
    "merchant": {
        "entity": "default",
        "mcc": "1234",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "instruction": {
        "debtRepayment": true,
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "EUR",
            "amount": 250
        },
        "paymentInstrument": {
            "cvc": "123",
            "billingAddress": {
                "address1": "Quatrième étage",
                "address2": "8 Rue Crevaux",
                "address3": "Arrondissement 16",
                "postalCode": "75016",
                "city": "Paris",
                "state": "Île-de-France",
                "countryCode": "FR"
            },
            "type": "card/plain",
            "cardHolderName": "Arsène Lupin",
            "cardNumber": "6272441397849021",
            "cardExpiryDate": {
                "month": 5,
                "year": 2035
            }
        }
    },
    "customer": {
        "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC",
        "authentication": {
            "version": "2.1.0",
            "type": "3DS",
            "eci": "05",
            "authenticationValue": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
            "transactionId": "683001f5-3805-423a-b580-638e4b2093b",
            "cryptogramAlgorithm": 2,
            "challengePreference": "challengeMandated",
            "authenticationFlow": "challenge",
            "statusReason": "11",
            "cancellationIndicator": "01",
            "networkScore": "01",
            "brand": "cartesBancaires"
        }
    }
}
3DS2 Cartes Bancaires Token All
{
    "transactionReference": "unique-transactionReference",
    "merchant": {
        "entity": "default",
        "mcc": "1234",
        "paymentFacilitator": {
            "pfId": "12345",
            "isoId": "12345",
            "subMerchant": {
                "name": "John",
                "merchantId": "12345",
                "postalCode": "SW1 1AA",
                "street": "Regent Street",
                "city": "London",
                "state": "WSM",
                "countryCode": "826",
                "taxId": "ABC-123456789",
                "email": "test@email.com",
                "telephone": "+447987 654321"
            }
        }
    },
    "instruction": {
        "debtRepayment": true,
        "narrative": {
            "line1": "Mind Palace Ltd",
            "line2": "Memory265-13/08/1876"
        },
        "value": {
            "currency": "EUR",
            "amount": 250
        },
        "paymentInstrument": {
            "type": "card/token",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/tokens/{}",
            "cvc": "898"
            }
        },
    "customer": {
        "riskProfile": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/ewogICJ2IiA6IDEsC",
        "authentication": {
            "version": "2.1.0",
            "type": "3DS",
            "eci": "05",
            "authenticationValue": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
            "transactionId": "683001f5-3805-423a-b580-638e4b2093b",
            "cryptogramAlgorithm": 2,
            "challengePreference": "challengeMandated",
            "authenticationFlow": "challenge",
            "statusReason": "11",
            "cancellationIndicator": "01",
            "networkScore": "01",
            "brand": "cartesBancaires"
        }
    }
}
## 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"`
* 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
* a `paymentInstrument`
* links to [cancel](/products/card-payments/v6/manage-payments#cancel-an-authorization), [settle](/products/card-payments/v6/manage-payments#settle-an-authorization), [partially settle](/products/card-payments/v6/manage-payments#partially-settle-an-authorization) or [query your payment events](/products/card-payments/v6/query-a-payment)
* a `paymentInstrument` (only for mobile wallet payments)


#### `paymentInstrument`

The `"paymentInstrument"` object is returned if we are able to provide information related to the underlying card used in the authorization request.

Note
Note that if the `paymentInstrument` object is returned, there is no guarantee that each field listed below will be returned with every transaction.

| Parameter | Description |
|  --- | --- |
| `paymentInstrument.type` | The type of paymentInstrument. Eg: `card/plain+masked``card/network+masked``card/network` |
| `paymentInstrument.card.brand` | The card brand. Sometimes referred to as the network or scheme. Eg:  `"visa"``"mastercard"``"amex"` |
| `paymentInstrument.card.number.bin` | The card bin. Eg: `444433`   this may contain the `*` character. |
| `paymentInstrument.card.number.last4Digits` | The last four digits of the card. Eg:  `1111`   this may contain the `*` character, where the card number is less than 16 digits. |
| `paymentInstrument.card.expiryDate.month` | The card expiry month. Eg:  `11` |
| `paymentInstrument.card.expiryDate.year` | The card expiry year. Eg: `2025` |
| `paymentInstrument.card.fundingType` | How the card is funded. Eg:  `credit``debit``prepaid``deferredDebit``chargeCard` |
| `paymentInstrument.card.category` | Whether the card is classed as a consumer card or a card for commercial use. Eg:  `consumer``commercial` |
| `paymentInstrument.card.countryCode` | The alpha-2 ISO-3166 country code that the card was issued in. May return `"N/A"` where the country is unknown. Eg:  `GB` |
| `paymentInstrument.card.issuer.name` | The name of the card issuer. Eg:  `Some Issuer PLC.` |
| `paymentInstrument.card.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. Eg:  `ABC123DEF456GHI789JKL123MNO45` |


### Refused payment

You receive:

* an HTTP code `201`
* an `"outcome": "refused"`
* a [refusal code](/products/reference/refusal-response)
* a `description` which gives additional context on the refusal
* a [refusal 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`


#### Example response

Card/Token/3DS1/3DS2
{
    "outcome": "authorized",
    "riskFactors": [{
            "risk": "not_matched",
            "type": "cvc"
        },
        {
            "risk": "not_checked",
            "detail": "postcode",
            "type": "avs"
        },
        {
            "risk": "not_matched",
            "detail": "address",
            "type": "avs"
        }
    ],
    "exemption": {
        "result": "honored",
        "reason": "issuerHonored"
    },
    "issuer": {
        "authorizationCode": "12345A"
    },
    "paymentInstrument": {
        "type": "card/plain+masked",
        "card": {
            "brand": "visa",
            "number": {
                "bin": "444433",
                "last4Digits": "1111"
            },
            "expiryDate": {
                "month": 12,
                "year": 2025
            },
            "fundingType": "credit",
            "category": "consumer",
            "issuer": {
                "name": "Some Issuer PLC"
            },
            "paymentAccountReference": "ABC123DEF456GHI789JKL123M"
        }
    },
    "_links": {
        "payments:cancel": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:settle": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:partialSettle": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:events": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/eyJrIjoiazNhYjYzMiJ9"
        },
        "curies": [{
            "name": "payments",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payments/{rel}",
            "templated": true
        }]
    }
}
Apple Pay/Google Pay
{
    "outcome": "authorized",
    "riskFactors": [{
        "risk": "not_checked",
        "detail": "postcode",
        "type": "avs"
    },
    {
        "risk": "not_matched",
        "detail": "address",
        "type": "avs"
    }],
    "paymentInstrument": {
        "type": "card/network+masked",
        "card": {
            "number": {
                "bin": "444433",
                "last4Digits": "1111"
            },
            "countryCode": "GB",
            "expiryDate": {
                "month": 12,
                "year": 2025
            },
            "brand": "visa",
            "fundingType": "debit",
            "issuer": {
                "name": "Some Issuer PLC"
            },
            "paymentAccountReference": "ABC123DEF456GHI789JKL123M"
        }
    },
    "_links": {
        "payments:cancel": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:settle": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/full/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:partialSettle": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/partials/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:events": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/eyJrIjoiazNhYjYzMiJ9"
        },
        "curies": [{
            "name": "payments",
            "href": "https://try.access.worldpay-bsh.securedataplatform.com/rels/payments/{rel}",
            "templated": true
        }]
    }
}
Refusal
{
    "outcome": "refused",
    "description": "CARD EXPIRED",
    "code": "33",
    "refusalAdvice": {
        "code": "01"
    },
    "riskFactors": [{
            "risk": "not_supplied",
            "type": "cvc"
        },
        {
            "risk": "not_checked",
            "detail": "address",
            "type": "avs"
        },
        {
            "risk": "not_checked",
            "detail": "postcode",
            "type": "avs"
        },
        {
            "risk": "verificationFailed",
            "type": "riskProfile"
        }
    ]
}

Refusal Apple Pay/Google Pay
{
    "outcome": "refused",
    "description": "Do not honour",
    "code": "5",
    "refusalAdvice": {
        "code": "03"
    },
    "riskFactors": [{
        "risk": "not_checked",
        "detail": "postcode",
        "type": "avs"
    },
    {
        "risk": "not_matched",
        "detail": "address",
        "type": "avs"
    }],
    "paymentInstrument": {
        "type": "card/network+masked",
        "card": {
            "number": {
                "bin": "444433",
                "last4Digits": "1111"
            },
            "countryCode": "GB",
            "brand": "visa",
            "fundingType": "debit",
            "issuer": {
                "name": "VALID_ISSUER"
            },
            "paymentAccountReference": "somePAR"
        }
    }
}

You can use the `payments:settle` action link to [settle the payment](/products/card-payments/v6/manage-payments#settle-an-authorization) straight away. Alternatively you can cache the response and use the link to settle the payment later.

 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 `not_checked`, `not_matched`, `not_supplied` or `verificationFailed` |


#### `exemptions`

An [exemption](https://developer.worldpay-bsh.securedataplatform.com/products/sca-exemptions) result and reason if a [risk profile](https://developer.worldpay-bsh.securedataplatform.com/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 or cancel a payment](/products/card-payments/v6/manage-payments#cancel-an-authorization)