-
Notifications
You must be signed in to change notification settings - Fork 1
/
Actions-2021-03-22.v1.yml
1411 lines (1411 loc) · 56.1 KB
/
Actions-2021-03-22.v1.yml
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
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Actions
description: Actions represent request and response messages sent to GP API.
contact:
name: API Integrations
url: 'https://developer.globalpay.com/?gp-api=true'
email: [email protected]
version: 2021 03 22
servers:
- url: 'https://apis.sandbox.globalpay.com/ucp'
description: Sandbox Environment
- url: 'https://apis.globalpay.com/ucp'
description: Production Environment
tags:
- name: Get a list of Actions
description: Get a list of Actions using criteria passed in the query string. Page through the result set to access all records.
- name: Get a Single Action
description: Get the details of a single action using its unique id.
paths:
/actions:
get:
operationId: getActionList
tags:
- Get a list of Actions
summary: Get a list of Actions using criteria passed in the query string. Page through the result set to access all records.
description: Get a list of Actions using criteria passed in the query string. Page through the result set to access all records.
parameters:
- name: Authorization
in: header
required: true
description: Bearer access token value used to access the API.
schema:
description: Bearer access token value used to access the API.
type: string
default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
- in: header
name: X-GP-Version
required: true
schema:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
- in: query
name: page
description: Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.
schema:
description: Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.
maximum: 1000
minimum: 1
type: number
default: 1
- in: query
name: page_size
description: The total number of objects to return in a single page for that list.
schema:
description: The total number of objects to return in a single page for that list.
maximum: 1000
minimum: 1
type: number
default: 5
- in: query
name: order
description: 'The direction of the ordering of the entire list, ASC or DESC'
schema:
description: 'The direction of the ordering of the entire list, ASC or DESC'
type: string
enum:
- ASC
- DESC
- in: query
name: order_by
description: 'The value to order the entire list by. '
schema:
description: 'The value to order the entire list by. '
type: string
enum:
- TIME_CREATED
- name: id
in: query
schema:
type: string
description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
minLength: 1
maxLength: 50
- name: type
in: query
schema:
type: string
description: The type of action executed.
example: PREAUTHORIZE
enum:
- AUTHORIZE
- PREAUTHORIZE
- name: resource
in: query
example: TRANSACTIONS
schema:
type: string
description: The type of resource the action relates to.
minLength: 1
maxLength: 50
- name: resource_status
in: query
schema:
type: string
description: The status of the resource after the action was executed.
example: REVERSED
minLength: 1
maxLength: 50
- name: resource_id
in: query
description: The Id of a specific resource linked to the action.
schema:
type: string
description: A unique identifier generated by Global Payments to identify the resource related to this action.
example: TRN_cf4e1008-c921-4096-bec9-2372cb9476d8
minLength: 1
maxLength: 50
- name: from_time_created
in: query
schema:
description: 'The start time to search for in a range, using the resource time_created value.'
type: string
format: date
example: '2021-10-01'
- name: to_time_created
in: query
schema:
description: 'The end time to search for in a range, using the resource time_created value.'
type: string
format: date
example: '2021-12-31'
- name: merchant_name
in: query
schema:
type: string
description: A meaningful label for the merchant set by Global Payments.
example: Sandbox_merchant_2
minLength: 1
maxLength: 50
- name: account_name
in: query
schema:
type: string
description: A meaningful label for the merchant account set by Global Payments.
example: Transaction_Processing
minLength: 1
maxLength: 50
- name: app_name
in: query
schema:
type: string
description: The name of the app the user gave to the application.
example: demo_app
minLength: 1
maxLength: 50
- name: version
in: query
schema:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
- name: response_code
in: query
schema:
type: string
description: The result of the action
minLength: 1
maxLength: 50
- name: http_code
in: query
schema:
type: string
description: The HTTP result of the action
minLength: 1
maxLength: 50
responses:
'200':
description: OK
headers:
Content-Type:
schema:
description: Indicates the format of the message.
type: string
default: application/json
Content-Encoding:
schema:
description: Indicates if the message is compressed and using what compression mechanism.
type: string
default: gzip
X-GP-Version:
schema:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
content:
application/json:
schema:
type: object
properties:
total_record_count:
type: number
description: 'The total number of records across all pages for the search filter. When searching for a collection of resoures, this is returned on the first page only and when the date range is a month or less.'
example: 3412
current_page_size:
type: number
description: The total number of records returned on the current page. If current_page_size is less than the page_size using in the querystring then this is the final page for that search.
example: 3412
merchant_id:
type: string
description: A unique identifier for the merchant set by Global Payments.
example: MER_c4c0df11039c48a9b63701adeaa296c3
minLength: 1
maxLength: 50
merchant_name:
type: string
description: A meaningful label for the merchant set by Global Payments.
example: Sandbox_merchant_2
minLength: 1
maxLength: 50
filter:
type: object
description: Indicates what fields and values used to filter the current list of resource objects in the current response.
paging:
type: object
description: The paging values used to generate this response.
properties:
page:
description: Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.
maximum: 1000
minimum: 1
type: number
default: 1
page_size:
description: The total number of objects to return in a single page for that list.
maximum: 1000
minimum: 1
type: number
default: 5
order_by:
description: 'The value to order the entire list by. '
type: string
enum:
- TIME_CREATED
order:
description: 'The direction of the ordering of the entire list, ASC or DESC'
type: string
enum:
- ASC
- DESC
actions:
type: array
description: A list of action records.
items:
type: object
properties:
id:
type: string
description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
minLength: 1
maxLength: 50
type:
type: string
description: The type of action executed.
example: PREAUTHORIZE
enum:
- AUTHORIZE
- PREAUTHORIZE
time_created:
type: string
format: date-time
description: Global Payments time indicating when the object was created in ISO-8601 format.
example: '2021-05-03T21:23:39.718Z'
resource:
type: string
description: The type of resource the action relates to.
minLength: 1
maxLength: 50
resource_id:
type: string
description: A unique identifier generated by Global Payments to identify the resource related to this action.
example: TRN_cf4e1008-c921-4096-bec9-2372cb9476d8
minLength: 1
maxLength: 50
resource_status:
type: string
description: The status of the resource after the action was executed.
example: REVERSED
minLength: 1
maxLength: 50
version:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
http_response_code:
type: string
description: The HTTP result of the action
minLength: 1
maxLength: 50
response_code:
type: string
description: The result of the action
minLength: 1
maxLength: 50
app_id:
type: string
description: The id of the app that was used to create the token.
example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
minLength: 1
maxLength: 50
app_name:
type: string
description: The name of the app the user gave to the application.
example: demo_app
minLength: 1
maxLength: 50
merchant_name:
type: string
description: A meaningful label for the merchant set by Global Payments.
example: Sandbox_merchant_2
minLength: 1
maxLength: 50
account_name:
type: string
description: A meaningful label for the merchant account set by Global Payments.
example: Transaction_Processing
minLength: 1
maxLength: 50
action:
type: object
description: Information about the Action executed.
properties:
id:
type: string
description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
minLength: 1
maxLength: 50
type:
type: string
description: Indicates the action taken.
time_created:
type: string
format: date-time
description: Global Payments time indicating when the object was created in ISO-8601 format.
example: '2021-05-03T21:23:39.718Z'
result_code:
type: string
description: The result of the action executed.
enum:
- SUCCESS
- DECLINE
minLength: 1
maxLength: 50
app_id:
type: string
description: The id of the app that was used to create the token.
example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
minLength: 1
maxLength: 50
app_name:
type: string
description: The name of the app the user gave to the application.
example: demo_app
minLength: 1
maxLength: 50
'400':
description: Bad Request
content:
application/json:
schema:
description: Bad Request
type: object
properties:
error_code:
type: string
description: This indicates an issue with the API request.
example: MANDATORY_DATA_MISSING
enum:
- DUPLICATE_TRANSACTION
- INVALID_BATCH_ACTION
- INVALID_REQUEST_DATA
- INVALID_TRANSACTION_ACTION
- MANDATORY_DATA_MISSING
- TRANSACTION_NOT_FOUND
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '40016'
enum:
- '40016'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Bad track data
'401':
description: Not Authenticated
content:
application/json:
schema:
description: Not Authenticated
type: object
properties:
error_code:
type: string
description: This action failed as token in the request is not valid.
example: NOT_AUTHENTICATED
enum:
- NOT_AUTHENTICATED
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '40001'
enum:
- '40001'
- '40002'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Invalid Access Token
'403':
description: Forbidden
content:
application/json:
schema:
description: Forbidden
type: object
properties:
error_code:
type: string
description: This action is not authorized with the credentials being used.
example: ACTION_NOT_AUTHORIZED
enum:
- ACTION_NOT_AUTHORIZED
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '40003'
enum:
- '40003'
- '40004'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Permission not enabled to execute action
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content:
application/json:
schema:
description: Internal Server Error
type: object
properties:
error_code:
type: string
description: This indicates an unexpected issue occurred on the Global Payments system.
example: SYSTEM_ERROR_DOWNSTREAM
enum:
- SYSTEM_ERROR_DOWNSTREAM
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50011'
enum:
- '50011'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Processor Configuration error
'501':
description: Not implemented
content:
application/json:
schema:
description: Not implemented
type: object
properties:
error_code:
type: string
description: This is an error not yet handled or mapped properly.
example: UNKNOWN_RESPONSE
enum:
- UNKNOWN_RESPONSE
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50012'
enum:
- '50012'
detailed_error_description:
type: string
description: 'Unique Text describing the specific error not yet handled. '
'502':
description: Bad Gateway
content:
application/json:
schema:
description: Bad Gateway
type: object
properties:
error_code:
type: string
description: This is an error indicating there was an issue connecting to a partner system..
example: UNAUTHORIZED_DOWNSTREAM
enum:
- UNAUTHORIZED_DOWNSTREAM
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50002'
enum:
- '50002'
detailed_error_description:
type: string
description: Authentication error—Verify and correct credentials.
'504':
description: Timeout
content:
application/json:
schema:
description: Timeout
type: object
properties:
error_code:
type: string
description: This is an error indicating there was a timeout issue to another system.
example: TIMEOUT_DOWNSTREAM
enum:
- TIMEOUT_DOWNSTREAM
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50008'
enum:
- '50008'
detailed_error_description:
type: string
description: No response from payment method provider.
'/actions/{id}':
get:
operationId: getActionSingle
tags:
- Get a Single Action
summary: Get the details of a single action using its unique id.
description: Get the details of a single action using its unique id.
parameters:
- name: Authorization
in: header
required: true
description: Bearer access token value used to access the API.
schema:
description: Bearer access token value used to access the API.
type: string
default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
- in: header
name: X-GP-Version
required: true
schema:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
- name: id
in: path
required: true
schema:
type: string
description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
minLength: 1
maxLength: 50
responses:
'200':
description: OK
headers:
Content-Type:
schema:
description: Indicates the format of the message.
type: string
default: application/json
Content-Encoding:
schema:
description: Indicates if the message is compressed and using what compression mechanism.
type: string
default: gzip
X-GP-Version:
schema:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
minLength: 1
maxLength: 50
type:
type: string
description: The type of action executed.
example: PREAUTHORIZE
enum:
- AUTHORIZE
- PREAUTHORIZE
time_created:
type: string
format: date-time
description: Global Payments time indicating when the object was created in ISO-8601 format.
example: '2021-05-03T21:23:39.718Z'
resource:
type: string
description: The type of resource the action relates to.
minLength: 1
maxLength: 50
resource_id:
type: string
description: A unique identifier generated by Global Payments to identify the resource related to this action.
example: TRN_cf4e1008-c921-4096-bec9-2372cb9476d8
minLength: 1
maxLength: 50
resource_parent_id:
type: string
description: A unique identifier used to identify the parent resource that the action relates to.
example: TRN_sdfklj43sf-c921-4096-bec9-2372cb949324a
minLength: 1
maxLength: 50
resource_status:
type: string
description: The status of the resource after the action was executed.
example: REVERSED
minLength: 1
maxLength: 50
resource_request_url:
type: string
description: The URL used to execute this action.
example: /transactions?from_time_created=2019-01-01&from_deposit_time_created=2019-01-01&page_size=1000&page=1&order=DESC
minLength: 1
maxLength: 1000
version:
description: Indicates the version of the GP-API for this message.
type: string
default: '2021-03-22'
minLength: 1
maxLength: 50
http_response_code:
type: string
description: The HTTP result of the action
minLength: 1
maxLength: 50
response_code:
type: string
description: The result of the action
minLength: 1
maxLength: 50
response_detailed_code:
type: string
description: The detailed result code of the action
minLength: 1
maxLength: 50
response_detailed_message:
type: string
description: The description of the detailed result code returned
minLength: 1
maxLength: 50
app_id:
type: string
description: The id of the app that was used to create the token.
example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
minLength: 1
maxLength: 50
app_name:
type: string
description: The name of the app the user gave to the application.
example: demo_app
minLength: 1
maxLength: 50
email:
type: string
description: 'Email registered with the application that was used to access this token. '
example: [email protected]
minLength: 1
maxLength: 50
merchant_id:
type: string
description: A unique identifier for the merchant set by Global Payments.
example: MER_c4c0df11039c48a9b63701adeaa296c3
minLength: 1
maxLength: 50
merchant_name:
type: string
description: A meaningful label for the merchant set by Global Payments.
example: Sandbox_merchant_2
minLength: 1
maxLength: 50
account_id:
type: string
description: A unique identifier for the merchant account set by Global Payments.
example: TRA_6716058969854a48b33347043ff8225f
minLength: 1
maxLength: 50
account_name:
type: string
description: A meaningful label for the merchant account set by Global Payments.
example: Transaction_Processing
minLength: 1
maxLength: 50
source_location:
type: string
description: Identifies where the action request came from
minLength: 1
maxLength: 50
destination_location:
type: string
description: Identifies where the action response is sent to
minLength: 1
maxLength: 50
message_received:
type: string
description: 'The sanitized HTTP,Header and body of the action request.'
minLength: 1
message_sent:
type: string
description: 'The sanitized HTTP,Header and body of the action response.'
minLength: 1
metrics:
type: string
description: A name value pair array of data points to assist with measuring the products usage.
minLength: 1
maxLength: 1000
total_time_milliseconds:
type: number
description: The time it took from the millisecond the action request hit this system to the response was sent back to the integrator.
minLength: 1
maxLength: 50
total_time_downstream_milliseconds:
type: number
description: The time it took from the millisecond the system passed the request onto a third party to the time that system responded.
minimum: 1
maximum: 100000
action:
type: object
description: Information about the Action executed.
properties:
id:
type: string
description: A unique identifier for the object created by Global Payments. The first 3 characters identifies the resource an id relates to.
minLength: 1
maxLength: 50
type:
type: string
description: Indicates the action taken.
time_created:
type: string
format: date-time
description: Global Payments time indicating when the object was created in ISO-8601 format.
example: '2021-05-03T21:23:39.718Z'
result_code:
type: string
description: The result of the action executed.
enum:
- SUCCESS
- DECLINE
minLength: 1
maxLength: 50
app_id:
type: string
description: The id of the app that was used to create the token.
example: U1lRHKomEn7DN907RCDPxVhyMfiMLcfy
minLength: 1
maxLength: 50
app_name:
type: string
description: The name of the app the user gave to the application.
example: demo_app
minLength: 1
maxLength: 50
'400':
description: Bad Request
content:
application/json:
schema:
description: Bad Request
type: object
properties:
error_code:
type: string
description: This indicates an issue with the API request.
example: MANDATORY_DATA_MISSING
enum:
- DUPLICATE_TRANSACTION
- INVALID_BATCH_ACTION
- INVALID_REQUEST_DATA
- INVALID_TRANSACTION_ACTION
- MANDATORY_DATA_MISSING
- TRANSACTION_NOT_FOUND
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '40016'
enum:
- '40016'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Bad track data
'401':
description: Not Authenticated
content:
application/json:
schema:
description: Not Authenticated
type: object
properties:
error_code:
type: string
description: This action failed as token in the request is not valid.
example: NOT_AUTHENTICATED
enum:
- NOT_AUTHENTICATED
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '40001'
enum:
- '40001'
- '40002'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Invalid Access Token
'403':
description: Forbidden
content:
application/json:
schema:
description: Forbidden
type: object
properties:
error_code:
type: string
description: This action is not authorized with the credentials being used.
example: ACTION_NOT_AUTHORIZED
enum:
- ACTION_NOT_AUTHORIZED
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '40003'
enum:
- '40003'
- '40004'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Permission not enabled to execute action
'404':
description: Resource Not Found
content: {}
'500':
description: Internal Server Error
content:
application/json:
schema:
description: Internal Server Error
type: object
properties:
error_code:
type: string
description: This indicates an unexpected issue occurred on the Global Payments system.
example: SYSTEM_ERROR_DOWNSTREAM
enum:
- SYSTEM_ERROR_DOWNSTREAM
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50011'
enum:
- '50011'
detailed_error_description:
type: string
description: Unique Text describing the specific error.
example: Processor Configuration error
'501':
description: Not implemented
content:
application/json:
schema:
description: Not implemented
type: object
properties:
error_code:
type: string
description: This is an error not yet handled or mapped properly.
example: UNKNOWN_RESPONSE
enum:
- UNKNOWN_RESPONSE
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50012'
enum:
- '50012'
detailed_error_description:
type: string
description: 'Unique Text describing the specific error not yet handled. '
'502':
description: Bad Gateway
content:
application/json:
schema:
description: Bad Gateway
type: object
properties:
error_code:
type: string
description: This is an error indicating there was an issue connecting to a partner system..
example: UNAUTHORIZED_DOWNSTREAM
enum:
- UNAUTHORIZED_DOWNSTREAM
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50002'
enum:
- '50002'
detailed_error_description:
type: string
description: Authentication error—Verify and correct credentials.
'504':
description: Timeout
content:
application/json:
schema:
description: Timeout
type: object
properties:
error_code:
type: string
description: This is an error indicating there was a timeout issue to another system.
example: TIMEOUT_DOWNSTREAM
enum:
- TIMEOUT_DOWNSTREAM
detailed_error_code:
type: string
description: Unique reference to identify the error.
example: '50008'
enum:
- '50008'
detailed_error_description:
type: string
description: No response from payment method provider.
components:
schemas:
actions_list:
type: object
properties:
total_record_count:
type: number
description: 'The total number of records across all pages for the search filter. When searching for a collection of resoures, this is returned on the first page only and when the date range is a month or less.'
example: 3412
current_page_size:
type: number
description: The total number of records returned on the current page. If current_page_size is less than the page_size using in the querystring then this is the final page for that search.
example: 3412
merchant_id:
type: string
description: A unique identifier for the merchant set by Global Payments.
example: MER_c4c0df11039c48a9b63701adeaa296c3
minLength: 1
maxLength: 50
merchant_name:
type: string
description: A meaningful label for the merchant set by Global Payments.
example: Sandbox_merchant_2
minLength: 1
maxLength: 50
filter:
type: object
description: Indicates what fields and values used to filter the current list of resource objects in the current response.
paging:
type: object
description: The paging values used to generate this response.