Subsequent recurring payment

Following an initial agreement, make subsequent recurring payments.

Main objects for this scenario:

  • customerAgreement - used to indicate this is a subsequent payment as part of an recurring payment.

    Collect the card details and send an API request with these details to the Payments resource.

    Request

    1. Plain card
    2. Token
    3. Recommended Key-values

    Basic example to illustrate the core values required

    {
        "transactionReference": "Memory265-13/08/1876",
        "merchant": {
            "entity": "default"
        },
        "instruction": {
            "customerAgreement": {
                "type": "subscription",
                "storedCardUsage":"subsequent"
            },
            "method": "card",
            "paymentInstrument": {
                "type": "plain",
                "cardNumber": "4000000000001091",
                    "expiryDate": {
                    "month": 5,
                    "year": 2035
                }
            },
            "narrative": {
                "line1": "trading name"
            },
            "value": {
                "currency": "GBP",
                "amount": 42
            }
        }
    }

Enable additional features

Fraud assessmentPrevent fraudulent transactions.
3DS authenticationShift Liability to the issuer / for EEA countries this is required as part of SCA compliance.
Not Applicable
SCA ExemptionsMeet SCA compliance without the added friction of 3DS.
Not Applicable
Auto SettlementRequest that payment authorizations are automatically sent for settlement (sometimes referred to as "capture").
Set instruction.settlement.auto to true in the payments request.

Response

For responses see the API reference.