worldline Direct
Sign up

To honour the COF guidelines and to instruct our platform to process transactions accordingly, the DirectAPI implements a set of properties. Each JSON in our collection representing the use cases contain the respective properties and its correct value.

Property Description
cardPaymentMethodSpecificInput.tokenize

Indicates that you want to tokenise the card used in this transaction. Fixed value "true".

For every successful transaction, our platform returns a cardPaymentMethodSpecificInput.token
you can use for CIT subsequent payments (sample C). Make sure not to send tokenize when using the token.

cardPaymentMethodSpecificInput.isRecurring

Indicates that this payment is part of a series of recurring payments (sample A). Your customers have authorised you to charge fixed amounts (MITs) on a recurring basis (i.e. for subscriptions) as a standing instruction (sample E).

Fixed value "true".

cardPaymentMethodSpecificInput.recurring.
recurringPaymentSequenceIndicator

Indicates that this payment is the first of a series of recurring payments (sample A). Your customers have authorised you to charge fixed amounts (MITs) on a recurring basis (i.e. for subscriptions) as a standing instruction (sample E).

Fixed value "first".

cardPaymentMethodSpecificInput.unscheduledCardOnFileRequestor

Indicates the requestor of this transaction:

  • "cardholderInitiated": Your customer initiates this transaction (samples B/C). This also marks the transaction as unscheduled.
  • "merchantInitiated": You initiate the transaction on behalf of your customer. Reserved for advanced use cases not described here. We strongly recommend processing MITs via samples D / E / F / G / H / J for which this property is irrelevant.
cardPaymentMethodSpecificInput.
unscheduledCardOnFileSequenceIndicator
Indicates that this payment is part of a series of unscheduled recurring payments:
  • "first": The first payment of this series (sample B).
  • "subsequent": A subsequent payment of this series (use case C)
cardPaymentMethodSpecificInput.threeDSecure.
challengeIndicator

Manage 3-D Secure for initial/subsequent payments.

Indicate the preferred 3-D Secure flow for this transaction.
Fixed value "challenge-required" to ensure 3-D Secure is rolled out when initiating a new payment series (samples A/B).
To smooth out your customers’ payment experience for subsequent CITs (sample C), we recommend value "no-challenge-requested". Learn more about this property and its use in our dedicated guide.

cardPaymentMethodSpecificInput.token

hostedCheckoutSpecificInput.tokens

The card profile(s) stored on our platform for CIT subsequent payments (sample C).

subsequentCardPaymentMethodSpecificInput.
subsequentType

Describes the fair use of card data for MITs without a token (samples D through J). Depending on the use case, different values apply:

  • "Installment": For scheduled instalments over a certain period of time. Both the amount and intervals are fixed as a standing instruction (sample D).
  • "Recurring": For recurring services (i.e. a subscription) for an extended period. The amount is fixed as a standing instruction (sample E).
  • "Unscheduled": For recurring services (i.e. for Pay-per-use services) for an extended period. Both the amount and the intervals may vary between the payments as a standing instruction (sample F).

The following values describe established industry practices, allowing you to process transactions without your customers' explicit consent:

  • "Resubmission": You have already provided the goods/services to your customer, but you were unable to collect the funds at the time of the order (sample G).
  • "PartialShipment": Collect the funds for a partially paid order. Also applicable for hospitality and car rentals for extended stays/rentals (sample H).
  • "DelayedCharge": Apply a supplemental charge after delivering the original goods/services (sample I).
  • "NoShow": Apply penalty fees for goods/services reserved by your customers but not picked up (i.e. hotel rooms). Also applicable for scenarios in which your customers agreed to a purchase but did not meet the terms of agreement (sample J). 
{payment.id}

The payment.id of the previous transaction from a payment series (samples D through J).

Add it as a path parameter to the SubsequentPayment endpoint Url.

Was this page helpful?

Do you have any comments?

Thank you for your response.