Customer initiated sale using card on file

Request

Use our card on file sale resource when your customer is initiating a payment using stored card details, and you want to instantly trigger the settlement process

Security

BasicAuth

Bodyapplication/vnd.worldpay.payments-v5+json

instructionobjectrequired

merchantobjectrequired

transactionReferencestringrequired

channelstring

Value:"moto"

customerobject

An example of a sale 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 sale for migrated Card On File 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 sale for GBP 2.50 with a successful outcome

{
  "outcome": "Sent For Settlement",
  "_links": {
    "payments:refund": {
      "href": "/payments/settlements/refunds/:linkData"
    },
    "payments:partialRefund": {
      "href": "/payments/settlements/refunds/partials/:linkData"
    },
    "payments:reversal": {
      "href": "/payments/sales/reversals/linkData"
    },
    "payments:events": {
      "href": "/payments/events/linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}