Card Payments

Card Payments (7)

Card Payments root resource, returns links to available payments actions.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

testing (try)

https://try.access.worldpay.com/

live

https://access.worldpay.com/

Take a card payment

Request

Take online card payments using our Card Payments API.

Headers

Content-Typestringrequired

Example: application/vnd.worldpay.payments-v7+json

Acceptstringrequired

Example: application/vnd.worldpay.payments-v7+json

Bodyapplication/vnd.worldpay.payments-v7+json

transactionReferencestringrequired

A unique reference generated by you that is used to identify a payment throughout its lifecycle.

merchantobjectrequired

An object that contains information about the merchant.

entitystringrequired

Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.

mccstring

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.

paymentFacilitatorobject

An object containing Payment Facilitator information. This information is required for every authorization only if you are a Payment Facilitator.

taxReferencestring

Merchant's tax reference.

instructionobjectrequired

An object that contains all information related to the payment.

requestAutoSettlementobjectrequired

Indicates whether the transaction should be sent for settlement now true or later false at a time of your choosing.

valueobjectrequired

An object that contains information about the value of the payment.

narrativeobjectrequired

The text that appears on your customer's statement. Used to identify the merchant.

paymentInstrumentobjectrequired

customerAgreementobject

Contains specific customer agreements for the transaction.

consumerBillPaymentboolean

Consumer Bill Payment is a flag which identifies a bill payment paid by providers on behalf of consumers.

requestAccountUpdaterboolean

Allows you to request a real-time account update (Visa cards only) when using a previously stored card. You can only use this on subsequest card requests.

debtRepaymentboolean

Debt Repayment Indicator is a flag which identifies a payment with the purpose of repaying a debt.

fundsTransferobject

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

routingobject

An object containing specific routing preferences.

channelstringrequired

Interaction between the cardholder and you. Supply a value of ecom to process an eCommerce authorization. Supply a value of moto to process an authorization as a Mail Order or Telephone Order transaction. Note: 3DS authentication cannot be supplied for MOTO payments.

Enum"ecom""moto"

shippingobject

An object containing shipping details.

senderobject

recipientobject

orderobject

An object containing details about the order.

taxExemptboolean

A flag to indicate whether the purchase is exempt from tax. Must be set to true if order.salesTax is 0

orderDateobject

Date of the order.

itemsArray of objects

Array of order items. You can send up to 99 individual order objects within this array.

dutyAmountinteger

Total amount of duty costs for the order.

salesTaxinteger

Total amount of sales tax for the order. Must be provided if merchant.taxReference is supplied.

shippingAmountinteger

Total amount of shipping costs for the order.

invoiceReferencestring

Invoice reference for the order.

discountAmountinteger

Total amount of discounts for the order.

riskProfilestring

Used to apply the SCA exemption in the payment request and update the FraudSight data model to benefit future payments.

authenticationobject

An object containing 3DS, Network Token or both authentications of the customer.

threeDSobject

networkTokenobject

Network Token authentication. Only allowed for card/networkToken transactions.

recipientobject

Additional transaction recipient data.

accountReferencestring

Partial account number of the recipient.

lastNamestring

Last name of the recipient

addressobject

Address of the recipient

dateOfBirthobject

Birth date of the recipient

customerobject

Additional customer data.

documentReferencestring

Required for domestic processing in some Latin American countries.

referencestring

Merchant-generated customer reference.

industryDataobject

An object containing industry specific order data.

typestringrequired

Value"airline"

airlineNamestringrequired

The name of the airline (displayed as it would be on a bill).

ticketobjectrequired

An object containing ticket details.

agentNamestring

The name of the travel agent.

agentCodestringrequired

The IATA travel agency code.

invoiceReferencestring

Billing Settlement Plan invoice reference.

airlineCodestringrequired

The two character IATA airline code.

passengerobjectrequired

An object containing passenger details.

application/vnd.worldpay.payments-v7+json

Payment authorization for GBP 2.50

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "requestAutoSettlement": {
      "enabled": false
    },
    "narrative": {
      "line1": "MindPalace"
    },
    "value": {
      "currency": "GBP",
      "amount": 250
    },
    "paymentInstrument": {
      "type": "card/plain",
      "cardNumber": "4444333322221111",
      "expiryDate": {
        "month": 5,
        "year": 2035
      }
    }
  },
  "channel": "ecom"
}

Responses

The payment authorization has been successfully created

Bodyapplication/vnd.worldpay.payments-v7.hal+json

outcomestringrequired

Outcome of the request.

Discriminator

exemptionobject

An exemption result and reason if a risk profile was included in your authorization request.

resultstringrequired

reasonstringrequired

issuerobject

An object containing information returned by the issuer.

authorizationCodestringrequired

paymentInstrumentobject

Details of the paymentInstrument used.

typestring

cardBinstring

lastFourstring

categorystring

issuerNamestring

fundingTypestring

cardBrandstring

paymentAccountReferencestring

expiryDateobject

riskFactorsArray of objects

Any risk factors which have been identified for the authorization. This section will not appear if no risks are identified.

typestringrequired

Enum"avs""cvc""riskProfile"

riskstringrequired

Enum"notChecked""notMatched""notSupplied""verificationFailed"

detailstring

Enum"address""postcode"

schemeobject

An object containing information returned by the card scheme.

referencestringrequired

The reference returned by the scheme for this particular payment authorization. The scheme reference returned in a customer initiated transaction should be provided in all subsequent merchant initiated transactions.

Response

application/vnd.worldpay.payments-v7.hal+json

Payment authorization for GBP 2.50 with a successful outcome

{
  "outcome": "authorized",
  "riskFactors": [
    {
      "type": "cvc",
      "risk": "notSupplied"
    },
    {
      "type": "avs",
      "risk": "notChecked",
      "detail": "address"
    },
    {
      "type": "avs",
      "risk": "notChecked",
      "detail": "postcode"
    }
  ],
  "issuer": {
    "authorizationCode": "675725"
  },
  "scheme": {
    "reference": "MCCOLXT1C0104  "
  },
  "paymentInstrument": {
    "type": "card/plain+masked",
    "cardBin": "555555",
    "lastFour": "4444",
    "category": "consumer",
    "countryCode": "GB",
    "expiryDate": {
      "month": 9,
      "year": 2029
    },
    "cardBrand": "mastercard",
    "fundingType": "credit",
    "issuerName": "AN ISSUING BANK LTD",
    "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E"
  },
  "_links": {
    "cardPayments:cancel": {
      "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/"
    },
    "cardPayments:settle": {
      "href": "https://try.access.worldpay.com/payments/settlements/full/"
    },
    "cardPayments:partialSettle": {
      "href": "https://try.access.worldpay.com/payments/settlements/partials/"
    },
    "cardPayments:events": {
      "href": "https://try.access.worldpay.com/payments/events/"
    },
    "curies": [
      {
        "name": "cardPayments",
        "href": "https://try.access.worldpay.com/rels/cardPayments/{rel}",
        "templated": true
      }
    ]
  }
}

Take a repeat card payment

Request

Take online payments using our Card Payments API.

Headers

Content-Typestringrequired

Example: application/vnd.worldpay.payments-v7+json

Acceptstringrequired

Example: application/vnd.worldpay.payments-v7+json

Bodyapplication/vnd.worldpay.payments-v7+json

transactionReferencestringrequired

A unique reference generated by you that is used to identify a payment throughout its lifecycle.

merchantobjectrequired

An object that contains information about the merchant.

entitystringrequired

Direct your payment to assist with billing, reporting and reconciliation. This is mandatory for authentication and queries.

mccstring

paymentFacilitatorobject

An object containing Payment Facilitator information. This information is required for every authorization only if you are a Payment Facilitator.

taxReferencestring

Merchant's tax reference.

instructionobjectrequired

An object that contains all information related to the payment.

requestAutoSettlementobjectrequired

Indicates whether the transaction should be sent for settlement now true or later false at a time of your choosing.

valueobjectrequired

An object that contains information about the value of the payment.

narrativeobjectrequired

The text that appears on your customer's statement. Used to identify the merchant.

paymentInstrumentobjectrequired

customerAgreementobjectrequired

Contains specific customer agreements for the transaction.

consumerBillPaymentboolean

Consumer Bill Payment is a flag which identifies a bill payment paid by providers on behalf of consumers.

requestAccountUpdaterboolean

Allows you to request a real-time account update (Visa cards only) when using a previously stored card. You can only use this on subsequest card requests.

debtRepaymentboolean

Debt Repayment Indicator is a flag which identifies a payment with the purpose of repaying a debt.

fundsTransferobject

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

routingobject

An object containing specific routing preferences.

recipientobject

Additional transaction recipient data.

accountReferencestring

Partial account number for the recipient.

lastNamestring

Last name of the recipient.

addressobject

Address of the recipient.

dateOfBirthobject

Birth date of the recipient.

shippingobject

An object containing shipping details.

senderobject

recipientobject

orderobject

An object containing details about the order.

taxExemptboolean

A flag to indicate whether the purchase is exempt from tax. Must be set to true if order.salesTax is 0

orderDateobject

Date of the order.

itemsArray of objects

Array of order items. You can send up to 99 individual order objects within this array.

dutyAmountinteger

Total amount of duty costs for the order.

salesTaxinteger

Total amount of sales tax for the order. Must be provided if merchant.taxReference is supplied.

shippingAmountinteger

Total amount of shipping costs for the order.

invoiceReferencestring

Invoice reference for the order.

discountAmountinteger

Total amount of discounts for the order.

customerobject

Additional customer data.

documentReferencestring

Required for domestic processing in some Latin American countries.

referencestring

Merchant-generated customer reference.

industryDataobject

An object containing industry specific order data.

typestringrequired

Value"airline"

airlineNamestringrequired

The name of the airline (displayed as it would be on a bill).

ticketobjectrequired

An object containing ticket details.

agentNamestring

The name of the travel agent.

agentCodestringrequired

The IATA travel agency code.

invoiceReferencestring

Billing Settlement Plan invoice reference.

airlineCodestringrequired

The two character IATA airline code.

passengerobjectrequired

An object containing passenger details.

application/vnd.worldpay.payments-v7+json

MIT authorization for subscriptions

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "requestAutoSettlement": {
      "enabled": false
    },
    "narrative": {
      "line1": "MindPalace"
    },
    "value": {
      "currency": "GBP",
      "amount": 250
    },
    "paymentInstrument": {
      "type": "card/plain",
      "cardNumber": "4444333322221111",
      "expiryDate": {
        "month": 5,
        "year": 2035
      }
    },
    "customerAgreement": {
      "type": "subscription",
      "schemeReference": "MCCOLXT1C0104  "
    }
  }
}

Responses

The payment authorization has been successfully created

Bodyapplication/vnd.worldpay.payments-v7.hal+json

outcomestringrequired

Outcome of the request.

Discriminator

exemptionobject

An exemption result and reason if a risk profile was included in your authorization request.

resultstringrequired

reasonstringrequired

issuerobject

An object containing information returned by the issuer.

authorizationCodestringrequired

paymentInstrumentobject

Details of the paymentInstrument used.

typestring

cardBinstring

lastFourstring

categorystring

issuerNamestring

fundingTypestring

cardBrandstring

paymentAccountReferencestring

expiryDateobject

riskFactorsArray of objects

Any risk factors which have been identified for the authorization. This section will not appear if no risks are identified.

typestringrequired

Enum"avs""cvc""riskProfile"

riskstringrequired

Enum"notChecked""notMatched""notSupplied""verificationFailed"

detailstring

Enum"address""postcode"

schemeobject

An object containing information returned by the card scheme.

referencestringrequired

Response

application/vnd.worldpay.payments-v7.hal+json

Payment authorization for GBP 2.50 with a successful outcome

{
  "outcome": "authorized",
  "riskFactors": [
    {
      "type": "cvc",
      "risk": "notSupplied"
    },
    {
      "type": "avs",
      "risk": "notChecked",
      "detail": "address"
    },
    {
      "type": "avs",
      "risk": "notChecked",
      "detail": "postcode"
    }
  ],
  "issuer": {
    "authorizationCode": "675725"
  },
  "scheme": {
    "reference": "MCCOLXT1C0104  "
  },
  "paymentInstrument": {
    "type": "card/plain+masked",
    "cardBin": "555555",
    "lastFour": "4444",
    "category": "consumer",
    "countryCode": "GB",
    "expiryDate": {
      "month": 9,
      "year": 2029
    },
    "cardBrand": "mastercard",
    "fundingType": "credit",
    "issuerName": "AN ISSUING BANK LTD",
    "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E"
  },
  "_links": {
    "cardPayments:cancel": {
      "href": "https://try.access.worldpay.com/payments/authorizations/cancellations/"
    },
    "cardPayments:settle": {
      "href": "https://try.access.worldpay.com/payments/settlements/full/"
    },
    "cardPayments:partialSettle": {
      "href": "https://try.access.worldpay.com/payments/settlements/partials/"
    },
    "cardPayments:events": {
      "href": "https://try.access.worldpay.com/payments/events/"
    },
    "curies": [
      {
        "name": "cardPayments",
        "href": "https://try.access.worldpay.com/rels/cardPayments/{rel}",
        "templated": true
      }
    ]
  }
}

Manage Payments

Operations

Query a Payment

Operations

Card Payments (7)

Take a card payment

Request

Responses

Do you like our page?

Take a repeat card payment

Request

Responses

Do you like our page?

Manage Payments

Query a Payment