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-v5+json

Acceptstring

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

Bodyapplication/vnd.worldpay.payments-v5+json

transactionReferencestringrequired

merchantobjectrequired

instructionobjectrequired

An example of a recurring payment authorization for GBP 2.50 with a successful outcome

{
  "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
      },
      "cardHolderName": "John Appleseed"
    }
  }
}

Responses

The recurring payment authorization has been successfully created

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

outcomestringrequired

issuerobject

paymentInstrumentobject

riskFactorsArray of objects

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

schemeobject

Response

An example of a 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
      }
    ]
  }
}