credentialOnFile | Computop Documents

Data Elements

Key

Format

CND

Description

type

object

Type of credential on file payment

initialPayment

boolean

Indicates whether a card on file transaction is the first one in a series of transactions (establishment) or a subsequent transaction

useCase

string

Type of use case that is intended

type

Key

Format

CND

Description

recurring

object

Recurring payments are a series of transactions processed persuant to an agreement between a cardholder and a merchant where the cardholder purchases goods or services over a period of time through a number of separate transactions. Please note that in the context of PSD2 and SCA requirements the European Banking Authority (EBA) describes recurring payments as a series of transactions with the same amount and with the same payee.

In conjunction with useCase (optional):

useCase (optional)

Description

absent

Standard subscription use case

fixed

Subscription is fixed amount, fixed duration/frequency

flexibleAmount

Subscription has flexible amount, fixed duration/frequency

flexibleFrequency

Subscription has fixed amount, flexible duration/frequency

unscheduled

string

Value indicating the party that initiates a credential on file transaction that does not occur on a fixed schedule.

unscheduled

Description

CIT

Customer Initiated Transaction

MIT

Merchant Initiated Transaction

In conjunction with useCase (optional):

useCase (optional)

Description

absent

Standard unscheduled use case

cof

Credential On File / One-Click

ucof

recurring

Key

Format

CND

Description

recurringFrequency

integer

Indicates the number of days between authorisations

recurringStartDate

string

Determines the date of the first authorization according to the recurring mandate

recurringExpiryDate

string

Date after which no further authorisations shall be performed

Schema

BASEURL= https://www.computop-paygate.com/schemas

1
{
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
  "$id": "https://www.computop-paygate.com/schemas/credentialOnFile.json",
4
  "title": "credentialOnFile",
5
  "description": "Credential-on-File Transactions",
6
  "type": "object",
7
  "examples": [
8
    {
9
      "type": {
10
        "recurring": {
11
          "recurringFrequency": 30,
12
          "recurringStartDate": "2019-09-14",
13
          "recurringExpiryDate": "2020-09-14"
14
        }
15
      },
16
      "initialPayment": true
17
    },
18
    {
19
      "type": {
20
        "recurring": {
21
          "recurringFrequency": 30,
22
          "recurringStartDate": "2021-09-14",
23
          "recurringExpiryDate": "9999-12-31",
24
          "total": 24,
25
          "curIdx": 5,
26
          "cumulativeAmount": 12000
27
        }
28
      },
29
      "initialPayment": false
30
    },
31
    {
32
      "type": {
33
        "unscheduled": "CIT"
34
      },
35
      "initialPayment": false
36
    },
37
    {
38
      "type": {
39
        "unscheduled": "CIT"
40
      },
41
      "initialPayment": true,
42
      "useCase":"cof"
43
    },
44
    {
45
      "type": {
46
        "installments": {
47
          "total": 8,
48
          "curIdx": 2,
49
          "purchaseAmount": 800000,
50
          "frequency": 30,
51
          "expiryDate": "2020-09-30"
52
        }
53
      },
54
      "initialPayment": false
55
    },
56
    {
57
      "type": {
58
        "installments": {
59
          "total": 8,
60
          "curIdx": 2,
61
          "purchaseAmount": 800000,
62
          "frequency": 30,
63
          "expiryDate": "2020-09-30"
64
        }
65
      },
66
      "initialPayment": false,
67
      "useCase":"fixed"
68
    }
69
  ],
70
  "properties": {
71
    "type": {
72
      "type": "object",
73
      "properties": {
74
        "recurring": {
75
          "type": "object",
76
          "properties": {
77
            "total": {
78
              "type": "integer",
79
              "minimum": 1,
80
              "maximum": 99,
81
              "description": "Total number of recurring payments."
82
            },
83
            "curIdx": {
84
              "type": "integer",
85
              "minimum": 1,
86
              "maximum": 99,
87
              "description": "Current sequence number of recurring payments of the same subscription agreement."
88
            },
89
            "purchaseAmount": {
90
              "type": "integer",
91
              "minimum": 1,
92
              "maximum": 9999999999,
93
              "description": "Total amount for the subscription agreement if known, single recurring/subscription payment in API-amount."
94
            },
95
            "cumulativeAmount": {
96
              "type": "integer",
97
              "minimum": 1,
98
              "maximum": 9999999999,
99
              "description": "Cumulative amount paid so far for this subscription agreement. Credits/refunds do not reduce this amount."
100
            },
101
            "recurringFrequency": {
102
              "type": "integer",
103
              "minimum": 1,
104
              "maximum": 9999,
105
              "description": "Indicates the minimum number of days between recurring authorizations."
106
            },
107
            "recurringStartDate": {
108
              "type": "string",
109
              "format": "full-date",
110
              "description": "YYYY-MM-DD"
111
            },
112
            "recurringExpiryDate": {
113
              "type": "string",
114
              "format": "full-date",
115
              "description": "Date of subscription expiry in format YYYY-MM-DD. Use 9999-12-31 if not specified."
116
            }
117
          },
118
          "required": [
119
            "recurringExpiryDate",
120
            "recurringFrequency"
121
          ],
122
          "additionalProperties": false
123
        },
124
        "installments": {
125
          "type": "object",
126
          "properties": {
127
            "total": {
128
              "type": "integer",
129
              "minimum": 1,
130
              "maximum": 99,
131
              "description": "Total number of installment payments."
132
            },
133
            "curIdx": {
134
              "type": "integer",
135
              "minimum": 1,
136
              "maximum": 99,
137
              "description": "Current sequence number of installment payments."
138
            },
139
            "purchaseAmount": {
140
              "type": "integer",
141
              "minimum": 1,
142
              "maximum": 9999999999,
143
              "description": "Total amount for installment payment; single installment payment in API-amount."
144
            },
145
            "cumulativeAmount": {
146
              "type": "integer",
147
              "minimum": 1,
148
              "maximum": 9999999999,
149
              "description": "Cumulative amount paid by installments so far. Credits/refunds do not reduce this amount."
150
            },
151
            "frequency": {
152
              "type": "integer",
153
              "minimum": 1,
154
              "maximum": 9999,
155
              "description": "Indicates the minimum number of days between installments authorizations."
156
            },
157
            "expiryDate": {
158
              "type": "string",
159
              "format": "full-date",
160
              "description": "YYYY-MM-DD"
161
            }
162
          },
163
          "required": [
164
            "total",
165
            "purchaseAmount"
166
          ],
167
          "additionalProperties": false
168
        },
169
        "unscheduled": {
170
          "type": "string",
171
          "enum": [
172
            "CIT",
173
            "MIT"
174
          ],
175
          "description": "CIT: Customer initiated transactions; MIT: Merchant initiated transactions."
176
        }
177
      },
178
      "oneOf": [
179
        {
180
          "required": [
181
            "recurring"
182
          ]
183
        },
184
        {
185
          "required": [
186
            "installments"
187
          ]
188
        },
189
        {
190
          "required": [
191
            "unscheduled"
192
          ]
193
        }
194
      ],
195
      "additionalProperties": false
196
    },
197
    "initialPayment": {
198
      "type": "boolean"
199
    },
200
    "useCase": {
201
        "type": "string",
202
        "enum" : ["cof", "ucof", "fixed", "flexibleAmount", "flexibleFrequency"],
203
        "description": "Type of useCase (unscheduled: cof, ucof // recurring: fixed, flexibleAmount, flexibleFrequency)"
204
   }
205
  },
206
  "required": [
207
    "type",
208
    "initialPayment"
209
  ],
210
  "additionalProperties": false
211
}

Sample Recurring

1
{
2
    "type": {
3
        "recurring": {
4
            "recurringFrequency": 30,
5
            "recurringStartDate": "2019-09-14",
6
            "recurringExpiryDate": "2020-09-14"
7
        }
8
    },
9
    "initialPayment": true
10
}

1
{
2
    "type": {
3
        "recurring": {
4
            "recurringFrequency": 30,
5
            "recurringStartDate": "2019-09-14",
6
            "recurringExpiryDate": "2020-09-14"
7
        }
8
    },
9
    "initialPayment": true,
10
     "useCase": "fixed" 
11
}

Sample Unscheduled CIT

1
{
2
    "type": {
3
        "unscheduled": "CIT"
4
    },
5
    "initialPayment": false
6
}

1
{
2
    "type": {
3
        "unscheduled": "CIT"
4
    },
5
    "initialPayment": false, 
6
    "useCase": "cof"
7
}