Create an authorization

Request

Take online card payments using our Card Payments API.

Security

BasicAuth

Content-Typestringrequired

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

Acceptstring

Example:application/vnd.worldpay.payments-v6.hal+json

Bodyapplication/vnd.worldpay.payments-v6+json

instructionobjectrequired

An object that contains all information related to the payment.

merchantobjectrequired

An object that contains information about the merchant.

transactionReferencestringrequired

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

channelstring

The payment channel indicates the interaction of the cardholder with the merchant. 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

Value:"moto"

customerobject

An object that contains riskProfile and authentication of the customer.

Payment authorization for GBP 2.50

{
  "transactionReference": "transaction-ref",
  "merchant": {
    "entity": "an-entity"
  },
  "instruction": {
    "narrative": {
      "line1": "trading name"
    },
    "value": {
      "currency": "GBP",
      "amount": 250
    },
    "paymentInstrument": {
      "type": "card/plain",
      "cardNumber": "4444333322221111",
      "cardExpiryDate": {
        "month": 12,
        "year": 2024
      }
    }
  }
}

Responses

The payment authorization has been successfully created

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

outcomestringrequired

Outcome of the request.

Enum:"authorized""refused"

Discriminator

exemptionobject

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

issuerobject

An object containing information returned by the issuer.

paymentInstrumentobject

Details of the paymentInstrument used.

riskFactorsArray of objects

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

schemeobject

An object containing information returned by the scheme.

Response

Payment authorization for GBP 2.50 with a successful outcome

{
  "outcome": "authorized",
  "_links": {
    "payments:cancel": {
      "href": "/payments/authorizations/cancellations/linkData"
    },
    "payments:settle": {
      "href": "/payments/settlements/linkData"
    },
    "payments:partialSettle": {
      "href": "/payments/settlements/partials/linkData"
    },
    "payments:events": {
      "href": "/payments/events/linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}