**Last updated**: 30 March 2026 | [**Change log**](/products/card-payments/changelog/) # Take repeat card payments 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 repeat card payments using our Card Payments API. ## Merchant Initiated Transactions You can take payments without the active participation of the customer according to an agreement previously made with the cardholder. These are known as Merchant Initiated Transactions (MITs). `POST` to our `merchantInitiatedTransactions` endpoint to authorize a payment. The requests below contain all the **mandatory** fields needed for a successful authorization request. `POST` `https://try.access.worldpay-bsh.securedataplatform.com/cardPayments/merchantInitiatedTransactions` Note Click the tabs below to see all the mandatory fields for all supported `paymentInstrument` parameters. Merchant Initiated Transaction request body: Card ```json { "transactionReference": "Memory265-13/08/1876", "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": "subscription", "schemeReference": "000000000000020005060720116005061" } } } ``` Token ```json { "transactionReference": "Memory265-13/08/1876", "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/{}" }, "customerAgreement": { "type": "subscription", "schemeReference": "000000000000020005060720116005061" } } } ``` Network token ```json { "transactionReference": "Memory265-13/08/1876", "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", "schemeReference": "000000000000020005060720116005061" } } } ``` Apple Pay decrypted ```json { "transactionReference": "Memory265-13/08/1876", "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", "schemeReference": "000000000000020005060720116005061" } } } ``` Google Pay decrypted ```json { "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "requestAutoSettlement": { "enabled": false }, "narrative": { "line1": "Mind Palace" }, "value": { "currency": "GBP", "amount": 650 }, "paymentInstrument": { "type": "card/networkToken+googlepay", "tokenNumber": "4444333322221111", "expiryDate": { "month": 5, "year": 2035 } }, "customerAgreement": { "type": "subscription", "schemeReference": "123456789" } } } ``` Important Before taking a Merchant Initiated Transaction, you must obtain prior agreement with the cardholder to [store a card](/products/card-payments/authorize-a-payment#store-a-card). Note You can use mobile wallets to process Merchant Initiated Transactions either: * by decrypting them yourself, or * by using the wallet payload that was converted into a Worldpay Token during the initial Customer Initiated Transaction ### Schema (parameters) ```json { "$ref": "#/components/schemas/merchantInitiatedTransaction", "components": { "schemas": { "transactionReference": { "maxLength": 64, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "A unique reference generated by you that is used to identify a payment throughout its lifecycle." }, "orderReference": { "type": "string", "description": "A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:\n- the total amount for a single order is split across multiple payments\n- you use a single reference for each payment in a recurring agreement or split shipment scenario ", "maxLength": 64, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~/+]*$", "example": "order-12345" }, "entity": { "maxLength": 32, "minLength": 1, "pattern": "^([A-Za-z0-9]+[A-Za-z0-9 ]*)?$", "example": "default", "type": "string", "description": "Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries." }, "mcc": { "pattern": "^\\d{4}$", "type": "string", "description": "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. If enabled but not provided, `merchant.mcc` defaults to a configured value.", "maxLength": 4, "minLength": 4 }, "paymentFacilitator": { "required": [ "schemeId", "subMerchant" ], "type": "object", "description": "An object containing Payment Facilitator information. This information is required for every authorization **only if you are a Payment Facilitator**.", "properties": { "schemeId": { "maxLength": 11, "minLength": 1, "pattern": "[0-9]*$", "type": "string", "description": "Your payment facilitator ID received from Visa, Mastercard, or Amex." }, "independentSalesOrganizationId": { "maxLength": 11, "minLength": 1, "pattern": "[0-9]*$", "type": "string" }, "subMerchant": { "required": [ "reference", "name", "address" ], "type": "object", "properties": { "name": { "maxLength": 25, "minLength": 1, "pattern": "^(?!\\s*$)[A-Za-z0-9 ]*$", "type": "string" }, "reference": { "type": "string", "minLength": 1, "maxLength": 15, "pattern": "^[A-Za-z0-9]*$" }, "address": { "type": "object", "required": [ "postalCode", "street", "city", "countryCode" ], "properties": { "postalCode": { "maxLength": 10, "minLength": 1, "pattern": "^(?!\\s*$)[a-zA-Z0-9\\s]*$", "type": "string", "example": "SW1 1AA" }, "street": { "maxLength": 50, "minLength": 1, "pattern": "^(?!\\s*$)[A-Za-z0-9\\s]*$", "type": "string", "example": "221B Baker Street" }, "city": { "maxLength": 13, "minLength": 1, "pattern": "^(?!\\s*$)[A-Za-z\\s-]*$", "type": "string", "example": "London" }, "state": { "maxLength": 3, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "The state code of the subMerchant in ISO-3166-2 format." }, "countryCode": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]*$", "type": "string", "description": "Country code of the subMerchant in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." } } }, "phoneNumber": { "maxLength": 20, "minLength": 4, "pattern": "^(?!\\s*$)[0-9\\s()+-/.x]*$", "type": "string" }, "taxReference": { "maxLength": 20, "minLength": 1, "pattern": "^(?!\\s*$)[a-zA-Z0-9\\s-]*$", "type": "string" }, "email": { "maxLength": 40, "minLength": 1, "type": "string", "pattern": "^.+@.+$" }, "url": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9@!£*#$)(+-_=.,/;:]*$", "type": "string" } } } } }, "taxReference": { "maxLength": 20, "minLength": 1, "pattern": "^(?!\\s*$)[a-zA-Z0-9\\s-]*$", "type": "string", "description": "Merchant's tax reference." }, "value": { "required": [ "amount", "currency" ], "type": "object", "description": "An object that contains information about the value of the payment.", "properties": { "amount": { "type": "integer", "description": "The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50.", "example": 250 }, "currency": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]$", "description": " The three character currency code. See list of [supported currencies](/products/reference/supported-countries-currencies#iso-currency-codes).", "example": "USD" } } }, "narrative": { "required": [ "line1" ], "type": "object", "description": "The text that appears on your customer's statement. Used to identify the merchant.", "properties": { "line1": { "type": "string", "minLength": 1, "maxLength": 24, "pattern": "^[a-zA-Z0-9 _!@#$%()*=.:;?[]{}~/+-,`^&]*$", "description": "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)." }, "line2": { "type": "string", "minLength": 1, "maxLength": 24, "pattern": "^[a-zA-Z0-9 _!@#$%()*=.:;?[]{}~/+-,`^&]*$", "description": "Additional details about the payment e.g. order number, telephone number." } } }, "cardNumber": { "type": "string", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]+$", "description": "Your customer's card number. Sometimes referred to as Primary Account Number (PAN)." }, "cardHolderName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The cardholder's name as it appears on their card." }, "expiryDateCard": { "required": [ "month", "year" ], "type": "object", "description": "Contains your customer's card expiry date.", "properties": { "month": { "type": "integer", "pattern": "^([1-9]|1[0-2])$", "example": 7 }, "year": { "type": "integer", "pattern": "^([1-9]{1}[0-9]{3})$", "example": 2050 } } }, "billingAddress": { "required": [ "postalCode", "countryCode" ], "type": "object", "description": "Contains the billing address information.", "properties": { "address1": { "type": "string", "description": "First line of the address. Required if `city` is provided." }, "address2": { "type": "string", "description": "Second line of the address." }, "address3": { "type": "string", "description": "Third line of the address." }, "city": { "type": "string", "description": "City. Required if `address1` is provided." }, "postalCode": { "type": "string", "description": "Post code. Required, but an empty value can be provided for specific countries (e.g., `IE`)." }, "state": { "type": "string", "description": "State/province in max 3 characters." }, "countryCode": { "type": "string", "description": "Must be provided in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." }, "phoneNumber": { "type": "string", "description": "Phone number.", "minLength": 3, "maxLength": 20, "pattern": "^[0-9()+-/.x ]+$" } } }, "card_plain_mit": { "required": [ "type", "cardNumber", "expiryDate" ], "type": "object", "properties": { "type": { "enum": [ "card/plain" ], "type": "string", "description": "An identifier for the `paymentInstrument` being used." }, "cardNumber": { "$ref": "#/components/schemas/cardNumber" }, "cardHolderName": { "$ref": "#/components/schemas/cardHolderName" }, "expiryDate": { "$ref": "#/components/schemas/expiryDateCard" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" } } }, "card_token_mit": { "required": [ "type", "href" ], "type": "object", "properties": { "type": { "enum": [ "card/token" ], "type": "string", "description": "An identifier for the `paymentInstrument` being used." }, "href": { "type": "string", "description": "An `http` address that contains your link to an Access Token." } } }, "tokenNumber": { "type": "string", "maxLength": 19, "minLength": 12, "pattern": "^[0-9]+$", "description": "The network token number." }, "expiryDateToken": { "required": [ "month", "year" ], "type": "object", "description": "Contains your customer's token expiry date.", "properties": { "month": { "type": "integer", "pattern": "^([1-9]|1[0-2])$", "example": 7 }, "year": { "type": "integer", "pattern": "^([1-9]{1}[0-9]{3})$", "example": 2050 } } }, "card_networkToken": { "required": [ "type", "tokenNumber", "expiryDate" ], "type": "object", "properties": { "type": { "enum": [ "card/networkToken" ], "type": "string", "description": "An identifier for the `paymentInstrument` being used." }, "tokenNumber": { "$ref": "#/components/schemas/tokenNumber" }, "expiryDate": { "$ref": "#/components/schemas/expiryDateToken" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "cardHolderName": { "$ref": "#/components/schemas/cardHolderName" } } }, "card_networkToken_applepay": { "required": [ "type", "tokenNumber", "expiryDate" ], "type": "object", "properties": { "type": { "enum": [ "card/networkToken+applepay" ], "type": "string" }, "tokenNumber": { "$ref": "#/components/schemas/tokenNumber" }, "expiryDate": { "$ref": "#/components/schemas/expiryDateToken" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "cardHolderName": { "$ref": "#/components/schemas/cardHolderName" } } }, "card_networkToken_googlepay": { "required": [ "type", "tokenNumber", "expiryDate" ], "type": "object", "properties": { "type": { "enum": [ "card/networkToken+googlepay" ], "type": "string" }, "tokenNumber": { "$ref": "#/components/schemas/tokenNumber" }, "expiryDate": { "$ref": "#/components/schemas/expiryDateToken" }, "billingAddress": { "$ref": "#/components/schemas/billingAddress" }, "cardHolderName": { "$ref": "#/components/schemas/cardHolderName" } } }, "mit_subscription": { "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer. A subscription plan occurs at fixed time intervals." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " } } }, "mit_installment": { "required": [ "type", "installmentType" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " }, "installmentType": { "type": "string", "description": "Defines the type of installments service.", "enum": [ "merchant" ] } } }, "mit_unscheduled": { "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " } } }, "mit_reauthorization": { "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " }, "storedCardUsage": { "type": "string", "description": "Set to `subsequent` if the transaction is using a stored card.", "enum": [ "subsequent" ] } } }, "mit_resubmission": { "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " }, "storedCardUsage": { "type": "string", "description": "Set to `subsequent` if the transaction is using a stored card.", "enum": [ "subsequent" ] } } }, "mit_noShow": { "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " }, "storedCardUsage": { "type": "string", "description": "Set to `subsequent` if the transaction is using a stored card.", "enum": [ "subsequent" ] } } }, "mit_delayedCharge": { "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The processing arrangement agreed with your customer." }, "schemeReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Used by card schemes to link merchant initiated transactions (MITs) to the original customer initiated transaction (CIT). Supply the value returned by the card scheme in the original CIT.", "example": "MCCNDUVST1002 " }, "storedCardUsage": { "type": "string", "description": "Set to `subsequent` if the transaction is using a stored card.", "enum": [ "subsequent" ] } } }, "consumerBillPayment": { "type": "boolean", "description": "Consumer Bill Payment is a flag which identifies a bill payment paid by providers on behalf of consumers." }, "requestAccountUpdater": { "type": "boolean", "description": "Allows you to request a real-time account update when using a previously stored card. You can only use this with `customerAgreement` transactions with a `storedCardUsage` value of `subsequent`. If the stored card details that you provided for the transaction are no longer valid and new credentials are available, the authorization will be processed with the new card and its details will be returned in the `updatedPaymentInstrument` object in the response." }, "debtRepayment": { "type": "boolean", "description": "Debt Repayment Indicator is a flag which identifies a payment with the purpose of repaying a debt." }, "fundsTransfer_bankAccount": { "type": "object", "properties": { "type": { "enum": [ "bankAccount" ], "type": "string" }, "identifierType": { "type": "string", "enum": [ "iban", "swift", "routingNumber", "accountNumber" ] }, "iban": { "maxLength": 34, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "The International Bank Account Number (IBAN) of the recipient. Required if `identifierType` is `iban`.", "example": "IE12BOFI90000112345678" }, "accountNumber": { "maxLength": 39, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "The account number of the recipient. Required if `identifierType` is `routingNumber`, `swift` or `accountNumber`. Visa requires the value to be a maximum of 34 characters. ", "example": "01234567" }, "swiftBic": { "maxLength": 11, "minLength": 8, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "The SWIFT Bank Identification Code (BIC) of the recipient. Required if `identifierType` is `swift`. Must be either 8 or 11 alphanumeric characters.", "example": "BEASUS33xxx" }, "routingNumber": { "maxLength": 9, "minLength": 9, "pattern": "^[0-9]*$", "type": "string", "description": "The ABA (American Bankers Association) Routing Transit Number (RTN). Identifies the Financial Insititution of the recipient's account. Required if `identifierType` is `routingNumber`. Must be 9 numeric characters.", "example": "111000025" } }, "required": [ "type", "identifierType" ] }, "fundsTransfer_card": { "type": "object", "properties": { "type": { "enum": [ "card" ], "type": "string" }, "cardNumber": { "maxLength": 19, "minLength": 12, "pattern": "^[0-9]*$", "type": "string", "description": "Recipient's card number." } }, "required": [ "type", "cardNumber" ] }, "fundsTransfer_wallet": { "type": "object", "properties": { "type": { "enum": [ "wallet" ], "type": "string" }, "walletReference": { "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9@!£$*#)(+\\-_=.,/:;\"]*$", "type": "string", "description": "A reference identifying the destination wallet. Visa requires the value to be a maximum of 34 characters." } }, "required": [ "type", "walletReference" ] }, "fundsTransfer_storedValueWallet": { "type": "object", "properties": { "type": { "enum": [ "storedValueWallet" ], "type": "string" }, "walletReference": { "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "A reference identifying the destination wallet. Visa requires the value to be a maximum of 34 characters." } }, "required": [ "type", "walletReference" ] }, "fundsTransfer_stagedDigitalWallet": { "type": "object", "properties": { "type": { "enum": [ "stagedDigitalWallet" ], "type": "string" }, "walletReference": { "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "A reference identifying the destination wallet. Visa requires the value to be a maximum of 34 characters." } }, "required": [ "type", "walletReference" ] }, "fundsTransfer_merchantWallet": { "type": "object", "properties": { "type": { "enum": [ "merchantWallet" ], "type": "string" }, "walletReference": { "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "A reference identifying the destination wallet. Visa requires the value to be a maximum of 34 characters." } }, "required": [ "type", "walletReference" ] }, "fundsTransfer_email": { "type": "object", "properties": { "type": { "enum": [ "email" ], "type": "string" }, "emailAddress": { "maxLength": 40, "minLength": 1, "type": "string", "description": "Recipient's email address. Visa requires the value to be a maximum of 34 characters." } }, "required": [ "type", "emailAddress" ] }, "fundsTransfer_phone": { "type": "object", "properties": { "type": { "enum": [ "phone" ], "type": "string" }, "phoneNumber": { "maxLength": 20, "minLength": 3, "type": "string", "description": "Recipient's phone number.", "pattern": "^[0-9 ()+\\-/.x]+$" } }, "required": [ "type", "phoneNumber" ] }, "fundsTransfer_socialNetwork": { "type": "object", "properties": { "type": { "enum": [ "socialNetwork" ], "type": "string" }, "socialNetworkReference": { "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "A reference identifying recipient's social network account. Visa requires the value to be a maximum of 34 characters." } }, "required": [ "type", "socialNetworkReference" ] }, "fundsTransfer": { "type": "object", "description": "Contains details of the funds transfer request, which is a money movement for a reason other than the purchase of goods or services (also known as Account Funding Transaction (AFT)).", "required": [ "type" ], "properties": { "type": { "description": "Specifies the type of the funds transfer. {% admonition type=\"warning\" name=\"Note\" %} You may only submit the `fundsTransfer.type` values that relate to the use cases that you have been approved for by the schemes.{% /admonition %}", "enum": [ "accountToAccount", "cash", "disbursement", "personToPerson", "purchase", "topUp", "walletLoad" ], "type": "string", "x-enumDescriptions": { "accountToAccount": "Move funds to another financial institution account owned by the same person", "cash": "A card is used to fund a transfer where funds are given to the recipient in cash", "disbursement": "A card is used as the source of funds for a disbursement", "personToPerson": "Move funds to an account owned by another person (eg gifts)", "purchase": "For the initial purchase of a reloadable account (such as prepaid or gift card), or direct crypto & liquid asset purchases without an intermediary wallet load", "topUp": "Top up a pre-paid or debit card", "walletLoad": "Move funds to a digital wallet owned by the same person" } }, "purpose": { "description": "Specifies the purpose of the funds transfer. Required for some regions and use cases (eg crypto).", "enum": [ "businessToBusiness", "creditCardRepayment", "crypto", "crowdLending", "debitCard", "education", "emergency", "familySupport", "gift", "giftCard", "gaming", "highRiskSecurities", "liquidAssets", "medical", "payroll", "prepaidCard", "salary", "savings", "travel", "other" ], "type": "string" }, "recipient": { "type": "object", "description": "An object containing details about the recipient of funds, including name and address information, as well as recipient account details. In many use cases, the recipient is the same person as the sender (for example if your customer uses their card to load funds into their own crypto exchange or investment account). __Although an optional object in the API schema, `recipient` is required for some regions and use cases.__", "properties": { "account": { "type": "object", "description": "An object for the account details of the recipient.", "oneOf": [ { "$ref": "#/components/schemas/fundsTransfer_bankAccount" }, { "$ref": "#/components/schemas/fundsTransfer_card" }, { "$ref": "#/components/schemas/fundsTransfer_wallet" }, { "$ref": "#/components/schemas/fundsTransfer_storedValueWallet" }, { "$ref": "#/components/schemas/fundsTransfer_stagedDigitalWallet" }, { "$ref": "#/components/schemas/fundsTransfer_merchantWallet" }, { "$ref": "#/components/schemas/fundsTransfer_email" }, { "$ref": "#/components/schemas/fundsTransfer_phone" }, { "$ref": "#/components/schemas/fundsTransfer_socialNetwork" } ], "discriminator": { "propertyName": "type", "mapping": { "bankAccount": "#/components/schemas/fundsTransfer_bankAccount", "card": "#/components/schemas/fundsTransfer_card", "wallet": "#/components/schemas/fundsTransfer_wallet", "storedValueWallet": "#/components/schemas/fundsTransfer_storedValueWallet", "stagedDigitalWallet": "#/components/schemas/fundsTransfer_stagedDigitalWallet", "merchantWallet": "#/components/schemas/fundsTransfer_merchantWallet", "email": "#/components/schemas/fundsTransfer_email", "phone": "#/components/schemas/fundsTransfer_phone", "socialNetwork": "#/components/schemas/fundsTransfer_socialNetwork" } } }, "firstName": { "maxLength": 35, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "Recipient's first name. Must be supplied if `lastName` or `middleName` are provided." }, "middleName": { "maxLength": 35, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "Recipient's middle name." }, "lastName": { "maxLength": 35, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "Recipient's last name. Must be supplied if `firstName` or `middleName` are provided." }, "address": { "type": "object", "description": "The recipient's address.", "properties": { "address1": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string", "description": "Must be supplied if `city` is provided." }, "address2": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string" }, "city": { "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string", "description": "Must be supplied if `address1` is provided." }, "postalCode": { "maxLength": 10, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string" }, "state": { "maxLength": 3, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "1-3 alphanumeric characters and spaces." }, "countryCode": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]*$", "type": "string", "description": "Country code in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." } }, "required": [ "countryCode" ] }, "dateOfBirth": { "type": "object", "description": "Recipient's date of birth.", "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ] }, "phoneNumber": { "type": "string", "description": "Recipient's phone number.", "maxLength": 20, "minLength": 3, "pattern": "^[0-9 ()+\\-/.x]*$" }, "documentReference": { "maxLength": 25, "minLength": 1, "type": "string", "description": "Recipient's document reference (e.g. Tax ID).", "pattern": "^[A-Za-z0-9\\-\\/+.()]*$" } } }, "sender": { "type": "object", "description": "An object containing details about the sender of funds, including name and address information. The sender account is always the card account declared within `instruction.paymentInstrument`. __Although an optional object in the API schema, `sender` is required for some regions and use cases.__", "properties": { "firstName": { "maxLength": 35, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "Sender's first name. Must be supplied if `lastName` or `middleName` are provided." }, "middleName": { "maxLength": 35, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "Sender's middle name." }, "lastName": { "maxLength": 35, "minLength": 1, "pattern": "^[-A-Za-z0-9_!@#$%()*=.:;?\\[\\]{}~`/+]*$", "type": "string", "description": "Sender's last name. Must be supplied if `firstName` or `middleName` are provided." }, "address": { "type": "object", "description": "The sender's address.", "properties": { "address1": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string", "description": "Must be supplied if `city` is provided." }, "address2": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string" }, "city": { "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string", "description": "Must be supplied if `address1` is provided." }, "postalCode": { "maxLength": 10, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string" }, "state": { "maxLength": 3, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "1-3 alphanumeric characters and spaces." }, "countryCode": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]*$", "type": "string", "description": "Country code in [ISO 3166-1 Alpha-2 format](/products/reference/supported-countries-currencies#iso-country-codes)." } }, "required": [ "countryCode" ] }, "dateOfBirth": { "type": "object", "description": "Sender's date of birth.", "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ] }, "documentReference": { "maxLength": 25, "minLength": 1, "type": "string", "description": "Sender's document reference (e.g. Tax ID)." } } } } }, "routing": { "type": "object", "description": "An object containing specific routing preferences.", "properties": { "fundingType": { "type": "string", "description": "Specifies the credit or debit functionality of a combo card.", "enum": [ "credit", "debit" ] }, "preferredCardBrand": { "type": "string", "enum": [ "visa", "mastercard", "maestro", "amex", "cartesBancaires", "diners", "dankort", "jcb", "discover", "elo", "eftposAU", "unionPay" ], "description": "Specifies your customer's preferred card brand to be used for the transaction using a co-badged card." } } }, "recipient": { "type": "object", "description": "Additional transaction recipient data.", "properties": { "accountReference": { "maxLength": 10, "minLength": 1, "pattern": "^[a-zA-Z0-9]*$", "type": "string", "description": "Partial account reference of the primary recipient. Either partial card number (first 6 and last 4, no spaces), or a bank account number", "example": "4444331111" }, "lastName": { "maxLength": 60, "minLength": 1, "pattern": "^[a-zA-Z@!£*#$)(+-_=.,/;:'\" ]*$", "type": "string", "description": "The last name of the recipient. If for a business, then use the company name.", "example": "Smith" }, "address": { "type": "object", "description": "Address of the recipient.", "required": [ "postalCode" ], "properties": { "postalCode": { "maxLength": 7, "minLength": 5, "pattern": "^[A-Z0-9 ]*$", "type": "string", "description": "The postal code of the recipient (UK only)" } } }, "dateOfBirth": { "type": "object", "description": "Birth date of the recipient.", "required": [ "day", "month", "year" ], "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } } } } }, "shipping": { "type": "object", "description": "An object containing shipping details.", "properties": { "sender": { "type": "object", "properties": { "address": { "type": "object", "description": "An object containing sender's (shipped from) address.", "properties": { "postalCode": { "maxLength": 10, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string" } } } } }, "recipient": { "type": "object", "properties": { "address": { "type": "object", "description": "An object containing recipient's shipping address.", "properties": { "countryCode": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]*$", "type": "string" }, "postalCode": { "maxLength": 10, "minLength": 1, "pattern": "^[a-zA-Z0-9 ]*$", "type": "string" } } } } } } }, "order": { "type": "object", "description": "An object containing details about the order.", "properties": { "taxExempt": { "type": "boolean", "description": "A flag to indicate whether the purchase is exempt from tax. Must be set to `true` if `order.salesTax` is 0." }, "orderDate": { "type": "object", "description": "Date of the order.", "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ] }, "items": { "description": "Array of order items. You can send up to 99 individual order objects within this array.", "items": { "type": "object", "required": [ "name" ], "properties": { "commodityCode": { "maxLength": 12, "minLength": 1, "type": "string", "description": "Commodity code as defined by the National Institute of Governmental Purchasing.", "pattern": "^[A-Za-z0-9@!£*#$)(-+_=.,/;:'\"]{1,12}$", "example": "ABC123@#" }, "totalTaxAmount": { "type": "integer", "description": "Total tax amount for the item(s)." }, "unitCost": { "type": "integer", "description": "The price of one unit of the item purchased." }, "totalAmount": { "type": "integer", "description": "Total cost of the item(s) including tax." }, "totalAmountNoTax": { "type": "integer", "description": "Total cost of the item(s) excluding tax." }, "unitOfMeasure": { "maxLength": 8, "minLength": 1, "type": "string", "description": "The unit of measure of the purchased item. Explains how to interpret `items.quantity` field, e.g. quantity = 15, unitOfMeasure = kg.", "pattern": "^[A-Za-z0-9@!£*#$)(+_=.,/;:'\"-]{1,8}$" }, "name": { "maxLength": 26, "minLength": 1, "type": "string", "description": "Name of the item(s).", "pattern": "^[A-Za-z0-9 @!£*#$)(+_=.,/;:'\"-]{1,26}$" }, "quantity": { "type": "integer", "description": "Number of items purchased." }, "productCode": { "maxLength": 12, "minLength": 1, "type": "string", "description": "Merchant defined product code.", "pattern": "^[A-Za-z0-9@!£*#\\$)(+_=.,/;:'\"-]{1,12}$" }, "totalDiscountAmount": { "type": "integer", "description": "Total discount amount for the item(s)." } } }, "type": "array" }, "dutyAmount": { "type": "integer", "description": "Total amount of duty costs for the order." }, "salesTax": { "type": "integer", "description": "Total amount of sales tax for the order. Must be provided if `merchant.taxReference` is supplied." }, "shippingAmount": { "type": "integer", "description": "Total amount of shipping costs for the order." }, "invoiceReference": { "maxLength": 15, "minLength": 1, "type": "string", "description": "Invoice reference for the order.", "pattern": "^[A-Za-z0-9 @!£*#\\$)\\(+_=.,/;:'\"-]{1,15}$" }, "discountAmount": { "type": "integer", "description": "Total amount of discounts for the order." } } }, "industryData": { "type": "object", "description": "An object containing industry specific order data.", "properties": { "type": { "enum": [ "airline" ], "type": "string" }, "airlineName": { "type": "string", "description": "The name of the airline (displayed as it would be on a bill).", "example": "Cobb Air", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z0-9 @!£*#\\$()\\+\\-_=.,\\/;:'\"]+$" }, "ticket": { "type": "object", "description": "An object containing ticket details.", "properties": { "number": { "type": "string", "description": "The ticket number.", "example": "123", "minLength": 1, "maxLength": 16, "pattern": "^[A-Za-z0-9]+$" }, "issuerAddress": { "type": "object", "description": "An object containing the ticket issuer's address.", "properties": { "address1": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[A-Za-z0-9 ]+$" }, "city": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9 ]+$" }, "countryCode": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[A-Z]{2}$" }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 10, "pattern": "^[A-Za-z0-9 ]+$" } }, "required": [ "address1", "city", "countryCode", "postalCode" ] }, "flightDetails": { "description": "An array with objects containing flight details. Each object represents one leg of a flight and you can submit up to four flight legs within this array.", "items": { "type": "object", "properties": { "fareClassCode": { "type": "string", "description": "The code used by airlines to identity a fare type.", "minLength": 1, "maxLength": 15, "pattern": "^[A-Za-z0-9]+$" }, "departureAirport": { "type": "string", "description": "The three letter IATA Airport Code for the departure airport.", "example": "LHR", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" }, "arrivalAirport": { "type": "string", "description": "The three letter IATA Airport Code for the destination airport.", "example": "SYD", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" }, "carrierCode": { "type": "string", "description": "Same as `industryData.airlineCode`, the code represents the airline for the specific flight leg.", "example": "M1", "minLength": 2, "maxLength": 2, "pattern": "^[A-Z]{2}$" }, "fareBasisCode": { "type": "string", "description": "An optional extension to the `fareClassCode` for custom codes.", "example": "TMYA", "minLength": 1, "maxLength": 15, "pattern": "^[A-Za-z0-9]+$" }, "flightCode": { "type": "string", "description": "The flight code.", "example": "501", "minLength": 1, "maxLength": 5, "pattern": "^[0-9]+$" }, "departureDate": { "type": "object", "description": "An object containing the date of the departure.", "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ] }, "stopOver": { "type": "boolean", "description": "Set to `true` if this flight leg is a stopover, connecting different destinations." }, "taxAmount": { "type": "integer", "description": "The tax amount for this specific flight leg.", "example": 3500 } }, "required": [ "carrierCode", "flightCode", "departureAirport", "arrivalAirport", "departureDate", "fareClassCode", "taxAmount" ] }, "type": "array" }, "restricted": { "type": "boolean", "description": "Typically, restricted airfares require approval and e-ticket processing within 24 hours of making the reservation, are not transferable if cancelled, and can have specific requirements on when or whether a cancelled ticket can be rebooked. You must define if the ticket is restricted, but this does not affect the payment flows." }, "issueDate": { "type": "object", "description": "An object containing the ticket's issue date.", "properties": { "day": { "type": "integer" }, "month": { "type": "integer" }, "year": { "type": "integer" } }, "required": [ "day", "month", "year" ] } }, "required": [ "number", "restricted", "issuerAddress" ] }, "agentName": { "type": "string", "description": "The name of the travel agent.", "example": "J Small and Co", "minLength": 1, "maxLength": 26, "pattern": "^[A-Za-z0-9 @!£*#\\$()\\+\\-_=.,\\/;:'\"]+$" }, "agentCode": { "type": "string", "description": "The IATA travel agency code.", "example": "12345678", "minLength": 1, "maxLength": 8, "pattern": "^[0-9]+$" }, "invoiceReference": { "type": "string", "description": "Billing Settlement Plan invoice reference.", "minLength": 1, "maxLength": 14, "pattern": "^[A-Za-z0-9]+$" }, "airlineCode": { "type": "string", "description": "The two character IATA airline code.", "example": "CA", "minLength": 2, "maxLength": 2, "pattern": "^[A-Z]{2}$" }, "passenger": { "type": "object", "description": "An object containing passenger details.", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 15, "pattern": "^[A-Za-z0-9]+$" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[A-Za-z @!£*#\\$()\\+\\-_=.,\\/;:'\"]+$" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[A-Za-z @!£*#\\$()\\+\\-_=.,\\/;:'\"]+$" } }, "required": [ "code", "firstName", "lastName" ] } }, "required": [ "type", "ticket", "airlineName", "airlineCode", "agentCode", "passenger" ] }, "merchantInitiatedTransaction": { "required": [ "transactionReference", "merchant", "instruction" ], "type": "object", "properties": { "transactionReference": { "$ref": "#/components/schemas/transactionReference" }, "orderReference": { "$ref": "#/components/schemas/orderReference" }, "merchant": { "required": [ "entity" ], "type": "object", "description": "An object that contains information about the merchant.", "properties": { "entity": { "$ref": "#/components/schemas/entity" }, "mcc": { "$ref": "#/components/schemas/mcc" }, "paymentFacilitator": { "$ref": "#/components/schemas/paymentFacilitator" }, "taxReference": { "$ref": "#/components/schemas/taxReference" } } }, "instruction": { "required": [ "value", "narrative", "paymentInstrument", "requestAutoSettlement", "customerAgreement" ], "type": "object", "description": "An object that contains all information related to the payment.", "properties": { "requestAutoSettlement": { "type": "object", "description": "Indicates whether the transaction should be sent for settlement now `true` or later `false`, at a time of your choosing.", "properties": { "enabled": { "type": "boolean" } } }, "value": { "allOf": [ { "$ref": "#/components/schemas/value" }, { "type": "object", "properties": { "acceptPartialAmount": { "type": "boolean", "description": "Set to `true` to accept partial authorization amount. The remainder of the amount can be charged using a different payment credential via a new authorization request. {% admonition type=\"info\" name=\"Note\" %} `requestAutoSettlement` must be `false` for partial authorizations.{% /admonition %}" }, "surchargeAmount": { "type": "integer", "description": "The charging amount representing processing and service fees. Ensure that the `surchargeAmount` complies with local regulations and card network rules before applying. {% admonition type=\"info\" name=\"Note\" %} The `surchargeAmount` is included in the total transaction amount, e.g. if the `value.surchargeAmount` is $20 and the `value.amount` is $100, then the actual cost of goods/services is $80. {% /admonition %}" }, "convenienceAmount": { "type": "integer", "description": "The charging amount representing the offer of a convenient payment method or channel (such as online booking fee). Ensure that the `convenienceAmount` complies with local regulations and card network rules before applying. {% admonition type=\"info\" name=\"Note\" %} The convenience fee is included in the total transaction amount, e.g. if the `value.convenienceAmount` is $20 and the `value.amount` is $100, then the actual cost of goods/services is $80. {% /admonition %}" } } } ] }, "narrative": { "$ref": "#/components/schemas/narrative" }, "paymentInstrument": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/card_plain_mit" }, { "$ref": "#/components/schemas/card_token_mit" }, { "$ref": "#/components/schemas/card_networkToken" }, { "$ref": "#/components/schemas/card_networkToken_applepay" }, { "$ref": "#/components/schemas/card_networkToken_googlepay" } ], "discriminator": { "mapping": { "card/plain": "#/components/schemas/card_plain_mit", "card/token": "#/components/schemas/card_token_mit", "card/networkToken": "#/components/schemas/card_networkToken", "card/networkToken+applepay": "#/components/schemas/card_networkToken_applepay", "card/networkToken+googlepay": "#/components/schemas/card_networkToken_googlepay" }, "propertyName": "type" } }, "customerAgreement": { "type": "object", "description": "Contains specific customer agreements for the transaction.", "oneOf": [ { "$ref": "#/components/schemas/mit_subscription" }, { "$ref": "#/components/schemas/mit_installment" }, { "$ref": "#/components/schemas/mit_unscheduled" }, { "$ref": "#/components/schemas/mit_reauthorization" }, { "$ref": "#/components/schemas/mit_resubmission" }, { "$ref": "#/components/schemas/mit_noShow" }, { "$ref": "#/components/schemas/mit_delayedCharge" } ], "discriminator": { "propertyName": "type", "mapping": { "subscription": "#/components/schemas/mit_subscription", "installment": "#/components/schemas/mit_installment", "unscheduled": "#/components/schemas/mit_unscheduled", "reauthorization": "#/components/schemas/mit_reauthorization", "resubmission": "#/components/schemas/mit_resubmission", "noShow": "#/components/schemas/mit_noShow", "delayedCharge": "#/components/schemas/mit_delayedCharge" } } }, "consumerBillPayment": { "$ref": "#/components/schemas/consumerBillPayment" }, "requestAccountUpdater": { "$ref": "#/components/schemas/requestAccountUpdater" }, "debtRepayment": { "$ref": "#/components/schemas/debtRepayment" }, "fundsTransfer": { "$ref": "#/components/schemas/fundsTransfer" }, "routing": { "$ref": "#/components/schemas/routing" } } }, "recipient": { "$ref": "#/components/schemas/recipient" }, "shipping": { "$ref": "#/components/schemas/shipping" }, "order": { "$ref": "#/components/schemas/order" }, "customer": { "type": "object", "description": "Additional customer data.", "properties": { "documentReference": { "type": "string", "description": "Required for domestic processing in some Latin American countries.", "minLength": 1, "maxLength": 50 }, "reference": { "type": "string", "description": "Merchant-generated customer reference.", "minLength": 1, "maxLength": 17 }, "emailAddress": { "type": "string", "description": "Customer's email address. If enabled by your configuration, your customer will receive the transaction outcome at this email address.", "minLength": 1, "maxLength": 128 } } }, "industryData": { "$ref": "#/components/schemas/industryData" }, "riskProfile": { "type": "string", "description": "Used to update the FraudSight data model to benefit future payments.", "example": "https://try.access.worldpay-bsh.securedataplatform.com/riskProfile/{linkData}" } } } } } } ``` ### Enable additional features Account Updater Reduce declines and improve your customer's experience by automatically retrieving updated card details in real time. Airline data Supply detailed airline itinerary data to achieve several cost and efficiency benefits. Co-branded cards Take payments from cards that carry multiple card brands. 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. 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. Latin America payments Take payments in Latin America, including regional installment plan options, combo cards, and supplying customer document references. 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 [cancel](/products/card-payments/manage-payments#cancel-an-authorization), [settle](/products/card-payments/manage-payments#settle-an-authorization), [partially settle](/products/card-payments/manage-payments#partially-settle-an-authorization) or [query your payment](/products/card-payments/query-a-payment) * a `paymentInstrument` #### `paymentInstrument` The `"paymentInstrument"` object is returned if we are able to provide information related to the underlying card used in the authorization request. 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. 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. | ### 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) * a `paymentInstrument` #### Example response Card/Token ```json { "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 ```json { "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 } ] } } ``` Refusal ```json { "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" } ] } ``` Account Updater ```json { "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. 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` | **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)