-
Notifications
You must be signed in to change notification settings - Fork 1
/
Installments-2021-03-22.v1.yaml
833 lines (830 loc) · 39.8 KB
/
Installments-2021-03-22.v1.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
openapi: 3.0.3
info:
version: 2021 03 22
title: Installments
description: 'Installments represent the installment payment programs that are available to your customers for a specific transaction. We support installment payment programs in both Asia Pacific and Mexico. These programs allow the cardholder to select the terms and the number of payments. The merchant''s transaction settles for the full amount, but the cardholder gets billed a flat amount for a set number of months.'
contact:
name: API Integrations
email: [email protected]
servers:
- url: 'https://apis.sandbox.globalpay.com/ucp'
description: Sandbox Environment
- url: 'https://apis.globalpay.com/ucp'
description: Production Environment
paths:
/installments:
post:
tags:
- Create an Installment
summary: Confirm installment plans available
description: Confirm which installments plans are available to the cardholder for a specific transaction.
operationId: create-installment
parameters:
- name: X-GP-Version
in: header
description: The version of the API to execute the request.
required: true
schema:
type: string
minLength: 1
maxLength: 50
default: '2021-03-22'
example: '2021-03-22'
- name: Authorization
in: header
description: Bearer access token value used to authorize and access the API. Must always begin with the string "Bearer".
required: true
schema:
type: string
default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
- name: Content-type
in: header
description: Format of the message body.
required: true
schema:
type: string
default: application/json
example: application/json
requestBody:
content:
application/json:
schema:
type: object
properties:
account_name:
type: string
title: account_name_INSTALLMENTS.account_name
description: A meaningful label that better identifies the account.
minLength: 1
maxLength: 50
example: transaction_processing
channel:
type: string
enum:
- CP
- CNP
description: |
Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario.
* `CP` - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk.
* `CNP` - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
minLength: 1
maxLength: 50
example: CP
amount:
type: string
description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency. and with no decimal point.
minLength: 1
maxLength: 50
example: '11099'
currency:
type: string
enum:
- USD
- EUR
- GBP
- CAD
- CHF
- etc.
description: The currency of the amount in ISO-4217(alpha-3).
minLength: 3
maxLength: 3
example: USD
country:
type: string
description: |
This is the countty the merchant is domiciled in. For example, If if the merchant is based in Canada it must be set to CA.If if the merchant is based in England it must be set to GB.If if the merchant is based in USA it must be set to US.The country in ISO-3166-1(alpha-2 code) format.
minLength: 2
maxLength: 2
example: US
reference:
type: string
description: Merchant defined field to reference the transaction.
minLength: 1
maxLength: 50
example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
program:
type: string
description: This field indicates the installment program the merchant is participating in.
example: SIP
payment_method:
type: object
properties:
entry_mode:
type: string
enum:
- MOTO
- ECOM
- IN_APP
- CHIP
- SWIPE
- MANUAL
- PHONE
- MAIL
- CONTACTLESS_CHIP
- CONTACTLESS_SWIPE
- PRESENT
- UNKNOWN
description: |
Indicates how the payment method information was obtained by the Merchant for this transaction.
* `MOTO` - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail.
* `ECOM` - A CNP channel entry mode where the payment method was obtained via a browser.
* `IN_APP` - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only.
* `CHIP` - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip.
* `SWIPE` - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information.
* `MANUAL` - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device.
* `CONTACTLESS_CHIP` - A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a card on or near a device to exchange card information.
* `CONTACTLESS_SWIPE` - A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information
* `PHONE` - A CNP channel entry mode where the payment method was obtained over the phone.
* `MAIL` - A CNP channel entry mode where the payment method was obtained via postal mail.
* `PRESENT`- The entry mode cannot be determined but it is a Customer Present transaction.
* `UNKNOWN` - The entry mode for this transaction cannot be determined.
minLength: 1
maxLength: 50
example: ECOM
card:
type: object
properties:
number:
type: string
description: The the card account number used to authorize the transaction. Also known as PAN.
minLength: 1
maxLength: 50
example: '4263970000005262'
expiry_month:
type: string
description: The 2 digit expiry date month of the card.
minLength: 1
maxLength: 50
example: '12'
expiry_year:
type: string
description: The 2 digit expiry date year of the card.
minLength: 1
maxLength: 50
example: '29'
examples:
SIP Example:
value:
account_name: Transaction_Processing
channel: CP
amount: '11099'
currency: USD
country: US
reference: becf9f3e-4d33-459c-8ed2-0c4affc9555e
program: SIP
payment_method:
entry_mode: ECOM
card:
number: '4263970000005262'
expiry_month: '12'
expiry_year: '29'
MIPP Example:
value:
account_name: Transaction_Processing
channel: CP
amount: '11099'
currency: USD
country: US
reference: becf9f3e-4d33-459c-8ed2-0c4affc9555e
program: MIPP
payment_method:
entry_mode: ECOM
card:
number: '4263970000005262'
expiry_month: '12'
expiry_year: '29'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific installment request. Begins with the three letters, INS.'
minLength: 1
maxLength: 50
example: INS_hAxxDJ3C4pWKh039jkGNqQ8xF1Oa4w
time_created:
type: string
description: Global Payments time indicating when the object was created in ISO-8601 format.
format: date-time
example: '2026-05-03T21:23:39.718Z'
type:
type: string
enum:
- INSTALLMENT_QUERY
description: The type of installment request.
example: INSTALLMENT_QUERY
status:
type: string
enum:
- AVAILABLE
- NOT_AVAILABLE
description: Indicates the status of the installment.
example: AVAILABLE
channel:
type: string
enum:
- CP
- CNP
description: |
Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario.
* `CP` - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk.
* `CNP` - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
minLength: 1
maxLength: 50
example: CP
amount:
type: string
description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency. and with no decimal point.
minLength: 1
maxLength: 50
example: '11099'
currency:
type: string
enum:
- USD
- EUR
- GBP
- CAD
- CHF
- etc.
description: The currency of the amount in ISO-4217(alpha-3).
minLength: 3
maxLength: 3
example: USD
country:
type: string
description: |
This is the countty the merchant is domiciled in. For example, If if the merchant is based in Canada it must be set to CA.If if the merchant is based in England it must be set to GB.If if the merchant is based in USA it must be set to US.The country in ISO-3166-1(alpha-2 code) format.
minLength: 2
maxLength: 2
example: US
merchant_id:
type: string
description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific merchant. Begins with the three letters, MER.'
minLength: 1
maxLength: 50
example: MER_A6A1EC44522F96630ABEA17A
merchant_name:
type: string
title: merchant_name_INSTALLMENTS.merchant_name
description: A meaningful label that better identifies the merchant.
minLength: 1
maxLength: 50
example: ABC INDUSTRIES
account_id:
type: string
description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific account. Begins with the three letters, TRA.'
minLength: 1
maxLength: 50
example: TRA_86920f927028745yt34d077d88beb29b
account_name:
type: string
title: account_name_INSTALLMENTS.account_name
description: A meaningful label that better identifies the account.
minLength: 1
maxLength: 50
example: transaction_processing
reference:
type: string
description: Merchant defined field to reference the transaction.
minLength: 1
maxLength: 50
example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
program:
type: string
description: This field indicates the installment program the merchant is participating in.
example: SIP
terms:
type: array
items:
type: object
properties:
id:
type: string
description: The reference to the installment option being offered. This field is applicable only if the installment.program is SIP.
example: '1'
time_unit:
type: string
description: 'This field indicates if installment.term.time_unit_number is days, months or years'
example: MONTH
time_unit_numbers:
type: array
description: This field indicates the total number of payments to be made over the course of the installment payment plan.
items:
type: string
example:
- '3'
- '6'
payment_method:
type: object
properties:
result:
type: string
description: The result code associated with the payment method used to process this transaction.
minLength: 1
maxLength: 50
example: '00'
message:
type: string
description: The result message that better explains the result code.
minLength: 1
maxLength: 50
example: APPROVAL
entry_mode:
type: string
enum:
- MOTO
- ECOM
- IN_APP
- CHIP
- SWIPE
- MANUAL
- PHONE
- MAIL
- CONTACTLESS_CHIP
- CONTACTLESS_SWIPE
- PRESENT
- UNKNOWN
description: |
Indicates how the payment method information was obtained by the Merchant for this transaction.
* `MOTO` - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail.
* `ECOM` - A CNP channel entry mode where the payment method was obtained via a browser.
* `IN_APP` - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only.
* `CHIP` - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip.
* `SWIPE` - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information.
* `MANUAL` - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device.
* `CONTACTLESS_CHIP` - A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a card on or near a device to exchange card information.
* `CONTACTLESS_SWIPE` - A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information
* `PHONE` - A CNP channel entry mode where the payment method was obtained over the phone.
* `MAIL` - A CNP channel entry mode where the payment method was obtained via postal mail.
* `PRESENT`- The entry mode cannot be determined but it is a Customer Present transaction.
* `UNKNOWN` - The entry mode for this transaction cannot be determined.
minLength: 1
maxLength: 50
example: ECOM
card:
type: object
properties:
brand:
type: string
enum:
- VISA
- MASTERCARD
- AMEX
- DINERS
- DISCOVER
- JCB
- CUP
description: Indicates the card brand that issued the card.
minLength: 1
maxLength: 50
example: VISA
masked_number_last4:
type: string
description: Masked card number with last 4 digits visible.
minLength: 1
maxLength: 50
example: xxxxxxxxxxxx5262
authcode:
type: string
description: Code generated by the card provider when the card is successfully authorized.
minLength: 1
maxLength: 50
brand_reference:
type: string
description: The unique reference created by the brands/schemes to uniquely identify the transaction.
minLength: 1
maxLength: 50
action:
type: object
properties:
id:
type: string
description: A unique identifier generated by Global Payments to identify an action.
minLength: 1
maxLength: 50
example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
type:
type: string
enum:
- INSTALLMENT_QUERY
description: Indicates the specific action taken.
minLength: 1
maxLength: 50
example: INSTALLMENT_QUERY
time_created:
type: string
description: Global Payments time indicating when the object was created in ISO-8601 format.
minLength: 1
maxLength: 50
example: '2026-05-03T21:23:39.718Z'
result_code:
type: string
enum:
- SUCCESS
- DECLINED
- PENDING
- ERROR
description: The result of the action executed.
minLength: 1
maxLength: 50
example: SUCCESS
app_id:
type: string
description: The id of the app that was used to create the token.
minLength: 1
maxLength: 50
example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
app_name:
type: string
description: The name of the app the user gave to the application.
minLength: 1
maxLength: 50
example: my_lovely_app
x-examples:
Example 1:
id: INS_ltYS39jFJO8HUvFRAbYzQgbZBu0Yzo
time_created: '2024-04-08T08:45:10.605Z'
type: INSTALLMENT_QUERY
status: AVAILABLE
channel: CP
amount: '0'
currency: USD
country: US
merchant_id: MER_5f74ce576da3417f9f7f3a03f59ee0a0
merchant_name: AP IPP SIP
account_id: TRA_065bd008015542efa80a6d8e34dd0098
account_name: SIP_Transaction_Processing
reference: TRANS-20180114123459878
program: SIP
terms:
- id: '01'
time_unit: MONTH
time_unit_numbers:
- 3
- 6
- 9
- 12
- 24
- 36
- id: '02'
time_unit: MONTH
time_unit_numbers:
- 12
- 24
- 36
- id: '03'
time_unit: MONTH
time_unit_numbers:
- 3
- 6
- 12
payment_method:
result: '00'
message: APPROVAL
entry_mode: ECOM
card:
brand: VISA
masked_number_last4: XXXXXXXXXXXX5512
authcode: ''
brand_reference: '409916002706'
action:
id: ACT_ltYS39jFJO8HUvFRAbYzQgbZBu0Yzo
type: INSTALLMENT_QUERY
time_created: '2024-04-08T08:45:10.605Z'
result_code: SUCCESS
app_id: GPuBZzGzNyywi2bk08i18L2FOgtHS3v3
app_name: gpqa_ap_sip
examples:
Example 1:
value:
id: INS_hAxxDJ3C4pWKh039jkGNqQ8xF1Oa4w
time_created: '2019-08-24T14:15:22Z'
type: INSTALLMENT_QUERY
status: AVAILABLE
channel: CP
amount: '11099'
currency: USD
country: US
merchant_id: MER_A6A1EC44522F96630ABEA17A
merchant_name: ABC INDUSTRIES
account_id: TRA_86920f927028745yt34d077d88beb29b
account_name: transaction_processing
reference: becf9f3e-4d33-459c-8ed2-0c4affc9555e
program: SIP
terms:
- id: '1'
time_unit: MONTH
time_unit_numbers:
- '3'
- '6'
payment_method:
result: string
message: string
entry_mode: ECOM
card:
brand: VISA
masked_number_last4: xxxxxxxxxxxx5262
authcode: string
brand_reference: string
action:
id: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
type: INSTALLMENT_QUERY
time_created: '2026-05-03T21:23:39.718Z'
result_code: SUCCESS
app_id: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
app_name: my_lovely_app
'404':
description: User Not Found
servers:
- url: 'https://apis.sandbox.globalpay.com/ucp'
description: Sandbox Environment
- url: 'https://apis.globalpay.com/ucp'
description: Production Environment
components:
parameters:
X-GP-Version:
name: X-GP-Version
in: header
description: The version of the API to execute the request.
required: true
schema:
type: string
minLength: 1
maxLength: 50
default: '2021-03-22'
example: '2021-03-22'
Authorization:
name: Authorization
in: header
description: Bearer access token value used to authorize and access the API. Must always begin with the string "Bearer".
required: true
schema:
type: string
default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
Content-type:
name: Content-type
in: header
description: Format of the message body.
required: true
schema:
type: string
default: application/json
example: application/json
schemas:
account_name_INSTALLMENTS.account_name:
type: string
title: account_name_INSTALLMENTS.account_name
description: A meaningful label that better identifies the account.
minLength: 1
maxLength: 50
example: transaction_processing
channel_INSTALLMENTS.channel:
type: string
enum:
- CP
- CNP
description: |
Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario.
* `CP` - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk.
* `CNP` - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone
minLength: 1
maxLength: 50
example: CP
amount_INSTALLMENTS.amount:
type: string
description: The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency. and with no decimal point.
minLength: 1
maxLength: 50
example: '11099'
currency_INSTALLMENTS.currency:
type: string
enum:
- USD
- EUR
- GBP
- CAD
- CHF
- etc.
description: The currency of the amount in ISO-4217(alpha-3).
minLength: 3
maxLength: 3
example: USD
country_INSTALLMENTS.country:
type: string
description: |
This is the countty the merchant is domiciled in. For example, If if the merchant is based in Canada it must be set to CA.If if the merchant is based in England it must be set to GB.If if the merchant is based in USA it must be set to US.The country in ISO-3166-1(alpha-2 code) format.
minLength: 2
maxLength: 2
example: US
reference_INSTALLMENTS.reference:
type: string
description: Merchant defined field to reference the transaction.
minLength: 1
maxLength: 50
example: becf9f3e-4d33-459c-8ed2-0c4affc9555e
program_INSTALLMENTS.program:
type: string
description: This field indicates the installment program the merchant is participating in.
example: SIP
entry_mode_INSTALLMENTS.payment_method.entry_mode:
type: string
enum:
- MOTO
- ECOM
- IN_APP
- CHIP
- SWIPE
- MANUAL
- PHONE
- MAIL
- CONTACTLESS_CHIP
- CONTACTLESS_SWIPE
- PRESENT
- UNKNOWN
description: |
Indicates how the payment method information was obtained by the Merchant for this transaction.
* `MOTO` - A CNP channel entry mode where the payment method information was obtained over the phone or via postal mail.
* `ECOM` - A CNP channel entry mode where the payment method was obtained via a browser.
* `IN_APP` - A CNP channel entry mode where the payment method was obtained via an application and applies to digital wallets only.
* `CHIP` - A CP channel entry mode where the payment method information was obtained from a chip. E.g. card is inserted into a device to read the chip.
* `SWIPE` - A CP channel entry mode where the payment method information was obtained from swiping a magnetic strip. E.g. card's magnetic strip is swiped through a device to read the card information.
* `MANUAL` - A CP channel entry mode where the payment method information was obtained by manually keying the payment method information into the device.
* `CONTACTLESS_CHIP` - A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device. E.g. tap a card on or near a device to exchange card information.
* `CONTACTLESS_SWIPE` - A CP channel entry mode where the payment method information was obtained by bringing the payment method to close proximity of a device and also swiping the card. E.g. tap a card on or near a device and swipe it through device to exchange card information
* `PHONE` - A CNP channel entry mode where the payment method was obtained over the phone.
* `MAIL` - A CNP channel entry mode where the payment method was obtained via postal mail.
* `PRESENT`- The entry mode cannot be determined but it is a Customer Present transaction.
* `UNKNOWN` - The entry mode for this transaction cannot be determined.
minLength: 1
maxLength: 50
example: ECOM
number_INSTALLMENTS.payment_method.card.number:
type: string
description: The the card account number used to authorize the transaction. Also known as PAN.
minLength: 1
maxLength: 50
example: '4263970000005262'
expiry_month_INSTALLMENTS.payment_method.card.expiry_month:
type: string
description: The 2 digit expiry date month of the card.
minLength: 1
maxLength: 50
example: '12'
expiry_year_INSTALLMENTS.payment_method.card.expiry_year:
type: string
description: The 2 digit expiry date year of the card.
minLength: 1
maxLength: 50
example: '29'
id_INSTALLMENTS.id:
type: string
description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific installment request. Begins with the three letters, INS.'
minLength: 1
maxLength: 50
example: INS_hAxxDJ3C4pWKh039jkGNqQ8xF1Oa4w
time_created_INSTALLMENTS.time_created:
type: string
description: Global Payments time indicating when the object was created in ISO-8601 format.
format: date-time
example: '2026-05-03T21:23:39.718Z'
type_INSTALLMENTS.type:
type: string
enum:
- INSTALLMENT_QUERY
description: The type of installment request.
example: INSTALLMENT_QUERY
status_INSTALLMENTS.status:
type: string
enum:
- AVAILABLE
- NOT_AVAILABLE
description: Indicates the status of the installment.
example: AVAILABLE
merchant_id_INSTALLMENTS.merchant_id:
type: string
description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific merchant. Begins with the three letters, MER.'
minLength: 1
maxLength: 50
example: MER_A6A1EC44522F96630ABEA17A
merchant_name_INSTALLMENTS.merchant_name:
type: string
title: merchant_name_INSTALLMENTS.merchant_name
description: A meaningful label that better identifies the merchant.
minLength: 1
maxLength: 50
example: ABC INDUSTRIES
account_id_INSTALLMENTS.account_id:
type: string
description: 'A unique identifier that is used to identify and reference an instance of this resource. This id is used when actioning or referencing a specific account. Begins with the three letters, TRA.'
minLength: 1
maxLength: 50
example: TRA_86920f927028745yt34d077d88beb29b
id_INSTALLMENTS.terms.id:
type: string
description: The reference to the installment option being offered. This field is applicable only if the installment.program is SIP.
example: '1'
time_unit_INSTALLMENTS.terms.time_unit:
type: string
description: 'This field indicates if installment.term.time_unit_number is days, months or years'
example: MONTH
time_unit_numbers_INSTALLMENTS.terms.time_unit_numbers:
type: array
description: This field indicates the total number of payments to be made over the course of the installment payment plan.
items:
type: string
example:
- '3'
- '6'
result_INSTALLMENTS.payment_method.result:
type: string
description: The result code associated with the payment method used to process this transaction.
minLength: 1
maxLength: 50
example: '00'
message_INSTALLMENTS.payment_method.message:
type: string
description: The result message that better explains the result code.
minLength: 1
maxLength: 50
example: APPROVAL
brand_INSTALLMENTS.payment_method.card.brand:
type: string
enum:
- VISA
- MASTERCARD
- AMEX
- DINERS
- DISCOVER
- JCB
- CUP
description: Indicates the card brand that issued the card.
minLength: 1
maxLength: 50
example: VISA
masked_number_last4_INSTALLMENTS.payment_method.card.masked_number_last4:
type: string
description: Masked card number with last 4 digits visible.
minLength: 1
maxLength: 50
example: xxxxxxxxxxxx5262
authcode_INSTALLMENTS.payment_method.card.authcode:
type: string
description: Code generated by the card provider when the card is successfully authorized.
minLength: 1
maxLength: 50
brand_reference_INSTALLMENTS.payment_method.card.brand_reference:
type: string
description: The unique reference created by the brands/schemes to uniquely identify the transaction.
minLength: 1
maxLength: 50
id_INSTALLMENTS.action.id:
type: string
description: A unique identifier generated by Global Payments to identify an action.
minLength: 1
maxLength: 50
example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
type_INSTALLMENTS.action.type:
type: string
enum:
- INSTALLMENT_QUERY
description: Indicates the specific action taken.
minLength: 1
maxLength: 50
example: INSTALLMENT_QUERY
time_created_INSTALLMENTS.action.time_created:
type: string
description: Global Payments time indicating when the object was created in ISO-8601 format.
minLength: 1
maxLength: 50
example: '2026-05-03T21:23:39.718Z'
result_code_INSTALLMENTS.action.result_code:
type: string
enum:
- SUCCESS
- DECLINED
- PENDING
- ERROR
description: The result of the action executed.
minLength: 1
maxLength: 50
example: SUCCESS
app_id_INSTALLMENTS.action.app_id:
type: string
description: The id of the app that was used to create the token.
minLength: 1
maxLength: 50
example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
app_name_INSTALLMENTS.action.app_name:
type: string
description: The name of the app the user gave to the application.
minLength: 1
maxLength: 50
example: my_lovely_app