Authorize recurring payment with verification

Request

Use our recurring authorize resources when you are initiating a payment using your customer's stored card details, verifying your customer's account first.

Security

BasicAuth

Path

linkDatastringrequired

Action link that's received in your request

Content-Typestringrequired

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

Acceptstring

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

Bodyapplication/vnd.worldpay.payments-v6+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.

instructionobjectrequired

An object that contains all information related to the payment.

Recurring 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
      }
    },
    "intent": "subscription"
  }
}

Responses

The recurring 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

Full 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

Recurring 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
      }
    ]
  }
}