menu

Payment API

What's on this page

Online Payments / Developer Resources / Sequence Info

Sequence Info

This is applicable if you want to indicate this payment is part of a sequence. The information is optional for 3-D Secure 2 but might be required when creating a mandate.

Info


CCV Pay does not provide automated recurring or instalments. This is only meta information for 3-D Secure 2 and will be used for risk assessment by the issuer.

Sequence Information Object

Name Type Size Format Inclusion Description
type string Possible Values:
EXPRESS_CHECKOUT
RECURRING
INSTALMENT
UNSCHEDULED		 Required If the payment is part of a sequence of payments, indicate the type of sequence
instalmentMaxAuthorisations integer 3 Required if type is INSTALMENT and mode is INITIAL If the payment is part of an instalment, the maximum number of instalments allowed with this authentication
recurringExpiry string 8 Date formatted in YYYYMMDD Required if type is RECURRING and mode is INITIAL If the payment is part of a recurring payment, the date that the last recurring payment is executed
recurringFrequency integer 3 Required if type is RECURRING and mode is INITIAL If the payment is part of a recurring payment, the number of days between each recurring payment
mode string Possible Values:
INITIAL
SUBSEQUENT		 Required if type is RECURRING, INSTALMENT or UNSCHEDULED If the payment is part of an unscheduled sequence, indicate if the transaction is the initial or subsequent transaction
source string Possible Values:
CIT
MIT		 Required if type is RECURRING, INSTALMENT or UNSCHEDULED Indicate who the initiator is of the payment
initialTransactionId string Max 20 Required when using the vault with a vault access token. Not required when using a mandate. If the payment is part of a chain of transactions, the reference to the initial or last subsequent transaction of the chain
industryPractice string Possible Values:
INCREMENTAL
DELAYED_CHARGES
NO_SHOW
REAUTHORIZATION
RESUBMISSION
Optional If the payment is a change of an existing CIT, indicate what industry practice triggered the change

Instalment Example

{
    "sequenceInfo": {
      "type": "INSTALMENT",
      "mode": "INITIAL",
      "source": "CIT",
      "instalmentMaxAuthorisations": "12"
    }
}

Recurring Example

{
    "sequenceInfo": {
      "type": "RECURRING",
      "mode": "INITIAL",
      "source": "CIT",
      "recurringExpiry": "20211231",
      "recurringFrequency": "12"
    }
}