-
Notifications
You must be signed in to change notification settings - Fork 1
/
Deposits-2021-03-22.v1.yaml
2648 lines (2636 loc) · 100 KB
/
Deposits-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
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
x-stoplight:
id: cu3v1805t5fz0
info:
title: Deposits
description: 'Deposits represent the initiation of a Debit or a Credit to a Merchant''s Bank Account that relates to Transactions and Disputes processed, or fees charged to the Merchant.'
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 Deposit information
description: Get information about the amounts Global Payments affected to merchant's bank account(s).
externalDocs:
url: 'https://developer.globalpay.com/settlement-reporting/step-by-step-guide'
- name: Get a Single Deposit
description: Get information about a single amount Global Payments affected to merchant's bank account.
externalDocs:
url: 'https://developer.globalpay.com/settlement-reporting/step-by-step-guide'
paths:
/settlement/deposits:
get:
operationId: getDepositList
tags:
- Get a list of Deposit information
summary: Get a list of Deposits using criteria passed in the query string. Page through the result set to access all records.
description: Get a list of Deposits using criteria passed in the query string. Page through the result set to access all records.
parameters:
- name: Authorization
in: header
schema:
type: string
example: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
default: Bearer G3FA4TuYGCBiCWs4YpzrALGCYXZJ
description: Bearer access token value used to authorize and access the API. Must always begin with the string "Bearer".
required: true
- name: X-GP-Version
in: header
required: true
schema:
type: string
default: '2021-03-22'
example: '2021-03-22'
minLength: 1
maxLength: 50
description: The version of the API to execute the request.
- name: page
in: query
schema:
type: number
x-stoplight:
id: f3yalmtk1ht36
description: 'Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.1 means the first page, 2 the second and so on.'
minLength: 1
maxLength: 1000
default: 1
example: 1
- name: page_size
in: query
schema:
type: number
x-stoplight:
id: c4xjzukdboxq1
description: The total number of records to return in a single page for a list.
example: 5
minLength: 1
maxLength: 1000
default: 5
- name: order
in: query
schema:
type: string
x-stoplight:
id: pp5vl4k2xa2fq
description: 'The direction of the ordering of the entire list, ASC or DESC'
example: ASC
enum:
- ASC
- DESC
- name: order_by
in: query
schema:
type: string
x-stoplight:
id: ovazxjcolt61j
description: The field to order the list by.
example: TIME_CREATED
default: TIME_CREATED
- name: account_name
in: query
required: true
example: Settlement Reporting
schema:
type: string
x-stoplight:
id: hx5u9826qul64
description: A meaningful label for the merchant account set by Global Payments.
example: Settlement Reporting
minLength: 1
maxLength: 50
- name: from_time_created
in: query
schema:
type: string
x-stoplight:
id: g3jamr1p7cqs4
example: '2022-05-01'
format: date-time
description: |
The start time to search for in a range, using the resource time_created value.
- name: to_time_created
in: query
schema:
type: string
x-stoplight:
id: 461e0zku4tbpa
example: '2023-05-01'
format: date-time
description: |
The end time to search for in a range, using the resource time_created value.
- name: id
in: query
schema:
type: string
x-stoplight:
id: r4rf3zxw9xsgu
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: status
in: query
schema:
type: string
x-stoplight:
id: byvfuvk51rqdj
description: |
Indicates where a resource object is in it's lifecycle. *`FUNDED` - Deposit Funded to bank account
*`IRREG` - Deposit not funded by Global Payments
*`RESERVED `- Deposit on reserve.
*`DELAYED` - Deposit delayed for funding.
*`RELEASED` - Deposit released by Global Payments from a status of DELAYED
example: FUNDED
- name: amount
in: query
schema:
type: string
x-stoplight:
id: nvdzu64quo04u
description: The amount that should be credited or debited. It is always represented in the lowest denomiation of the related currency.
example: '500'
- name: masked_account_number_last4
in: query
schema:
type: string
x-stoplight:
id: cizqdxzq2rw0s
description: Data relating to a bank transfer directly to or from the Payer's bank account.
minLength: 1
maxLength: 50
- name: system.mid
in: query
schema:
type: string
x-stoplight:
id: ycm7wq504kyoj
description: Merchant Identifier from Global Payments system for some features.
minLength: 1
maxLength: 50
- name: system.hierarchy
in: query
schema:
type: string
x-stoplight:
id: z6m96ycdeitn2
description: Identifies the location of a merchant within the merchant's corporate hierarchical structure.
minLength: 1
maxLength: 50
responses:
'200':
description: OK
headers:
Content-Type:
schema:
description: Indicates the format of the message.
type: string
default: application/json
x-stoplight:
id: qdoiuafa6zsf8
Content-Encoding:
schema:
description: Indicates if the message is compressed and using what compression mechanism.
type: string
default: gzip
x-stoplight:
id: rgi0h47svaey8
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
x-stoplight:
id: r6rjivm6gr5z6
content:
application/json:
schema:
type: object
x-stoplight:
id: 012ol5w7jxpo8
properties:
total_record_count:
type: number
x-stoplight:
id: q703a2i7gvk06
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: 1000
current_page_size:
type: number
x-stoplight:
id: ztcr1dqx08z8l
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: 564
merchant_id:
type: string
x-stoplight:
id: iqbq2s2ryxqxn
description: A unique identifier for the merchant set by Global Payments.
example: MER_c4c0df11039c48a9b63701adeaa296c3
minLength: 1
maxLength: 50
merchant_name:
type: string
x-stoplight:
id: 7z1itlxnfrtjm
description: A meaningful label for the merchant set by Global Payments.
example: Sandbox_merchant_2
minLength: 1
maxLength: 50
account_id:
type: string
x-stoplight:
id: wacihrt8unw7p
description: A unique identifier for the merchant account set by Global Payments.
example: TRA_86920f927028745yt34d077d88beb29b
minLength: 1
maxLength: 50
account_name:
type: string
x-stoplight:
id: hx5u9826qul64
description: A meaningful label for the merchant account set by Global Payments.
example: Settlement Reporting
minLength: 1
maxLength: 50
filter:
type: object
properties:
from_time_created:
type: string
x-stoplight:
id: g3jamr1p7cqs4
example: '2022-05-01'
format: date-time
description: |
The start time to search for in a range, using the resource time_created value.
to_time_created:
type: string
x-stoplight:
id: 461e0zku4tbpa
example: '2023-05-01'
format: date-time
description: |
The end time to search for in a range, using the resource time_created value.
paging:
type: object
properties:
page:
type: number
x-stoplight:
id: f3yalmtk1ht36
description: 'Indicates the page sequence to return in the response. The number of records presented on each page is determined by page_size field.1 means the first page, 2 the second and so on.'
minLength: 1
maxLength: 1000
default: 1
example: 1
page_size:
type: number
x-stoplight:
id: c4xjzukdboxq1
description: The total number of records to return in a single page for a list.
example: 5
minLength: 1
maxLength: 1000
default: 5
order_by:
type: string
x-stoplight:
id: ovazxjcolt61j
description: The field to order the list by.
example: TIME_CREATED
default: TIME_CREATED
order:
type: string
x-stoplight:
id: pp5vl4k2xa2fq
description: 'The direction of the ordering of the entire list, ASC or DESC'
example: ASC
enum:
- ASC
- DESC
deposits:
type: array
description: A list of Deposit records.
items:
type: object
properties:
id:
type: string
x-stoplight:
id: r4rf3zxw9xsgu
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
time_created:
type: string
x-stoplight:
id: 5npnx6z8kv5fg
description: Global Payments time indicating when the object was created in ISO-8601 format..
example: '2021-05-03'
status:
type: string
x-stoplight:
id: byvfuvk51rqdj
description: |
Indicates where a resource object is in it's lifecycle. *`FUNDED` - Deposit Funded to bank account
*`IRREG` - Deposit not funded by Global Payments
*`RESERVED `- Deposit on reserve.
*`DELAYED` - Deposit delayed for funding.
*`RELEASED` - Deposit released by Global Payments from a status of DELAYED
example: FUNDED
funding_type:
type: string
x-stoplight:
id: zxvfx7v8waqje
description: Indicates if the amount relates to a Debit or Credit to the merchant's bank account.
example: DEBIT
amount:
type: string
x-stoplight:
id: nvdzu64quo04u
description: The amount that should be credited or debited. It is always represented in the lowest denomiation of the related currency.
example: '500'
currency:
type: string
x-stoplight:
id: f19fb6yiv2p4f
description: The currency of the amount in ISO-4217(alpha-3)
example: USD
minLength: 3
maxLength: 3
aggregation_model:
type: string
x-stoplight:
id: a99gccfmr6n4k
description: 'Indicates how a merchant''s payment processing activity across Sales, Refunds, Disputes and Fees is structured for a Deposit. Activity can be aggregated into one daily amount or all activity separately funded via different deposits.'
example: 4-No Summary
bank_transfer:
type: object
x-stoplight:
id: tn0w8bqiqkjuj
properties:
masked_account_number_last4:
type: string
x-stoplight:
id: cizqdxzq2rw0s
description: Data relating to a bank transfer directly to or from the Payer's bank account.
minLength: 1
maxLength: 50
bank:
type: object
x-stoplight:
id: 8skzpysebmgiz
properties:
code:
type: string
x-stoplight:
id: bygy1aeip7vht
description: The local identifier code for the bank.
example: 124002971
maxLength: 50
system:
type: object
x-stoplight:
id: tdt30xpfms43e
properties:
mid:
type: string
x-stoplight:
id: ycm7wq504kyoj
description: Merchant Identifier from Global Payments system for some features.
minLength: 1
maxLength: 50
hierarchy:
type: string
x-stoplight:
id: z6m96ycdeitn2
description: Identifies the location of a merchant within the merchant's corporate hierarchical structure.
minLength: 1
maxLength: 50
name:
type: string
x-stoplight:
id: 52tyn7fg9clv9
description: The merchant name that is associated with the merchant.
example: MERCHANT ABC INC.
minLength: 1
maxLength: 100
dba:
type: string
x-stoplight:
id: afay0ofmacpjb
description: The alternate name the merchant may be known as.
example: MERCHANT XYZ INC
minLength: 1
maxLength: 100
sales:
type: object
x-stoplight:
id: mc1f95ci98o1x
properties:
count:
type: number
x-stoplight:
id: m5jk5u1fbpzei
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: gb2wfwmxvm3xc
description: The total amount across one or more items
example: '120'
refunds:
type: object
x-stoplight:
id: x4ntbuphy7hzj
properties:
count:
type: number
x-stoplight:
id: b9lwonymvurb5
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: n18gon3tsi09z
description: The total amount across one or more items.
example: '120'
disputes:
type: object
x-stoplight:
id: 1jsz93vk0rsnf
properties:
chargebacks:
type: object
x-stoplight:
id: m2sk2vj2cpsfs
properties:
count:
type: number
x-stoplight:
id: ziqcphyj9y62c
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: gek6fvdbn41z0
description: The total amount across one or more items.
example: '120'
reversals:
type: object
x-stoplight:
id: rdvdiqqsmd3pf
properties:
count:
type: number
x-stoplight:
id: 26kaukbql35ht
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: a3x431bih246f
description: The total amount across one or more items.
example: '120'
discounts:
type: object
x-stoplight:
id: zlxvaov21egm1
properties:
count:
type: number
x-stoplight:
id: do9q4psmhop0x
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: qyhsiecihza7e
description: The total amount across one or more items.
example: '120'
fees:
type: object
x-stoplight:
id: ku3gfg22k7zde
properties:
amount:
type: string
x-stoplight:
id: zgd619uvkedhe
description: The total amount across one or more items.
example: '120'
action:
type: object
properties:
id:
type: string
x-stoplight:
id: 6003668svw7pp
description: A unique identifier generated by Global Payments to identify an action.
example: ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
type:
type: string
x-stoplight:
id: z099h2chk03kh
description: Indicates the specific action taken.
example: DEPOSIT_SINGLE
enum:
- DEPOSIT_SINGLE
- DEPOSIT_LIST
time_created:
type: string
x-stoplight:
id: yiwv1vnf6h0co
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
x-stoplight:
id: lt982m1ujjdb1
description: The result of the action executed.
example: SUCCESS
enum:
- SUCCESS
minLength: 1
maxLength: 50
app_id:
type: string
x-stoplight:
id: srf0ut49rngwn
description: The id of the app that was used to create the token.
example: uzFr7t4VOqxdLDI44hHmXIjHtOOE8d
minLength: 1
maxLength: 50
app_name:
type: string
x-stoplight:
id: qdwr0elfm1kod
description: The name of the app the user gave to the application.
example: my_lovely_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
x-stoplight:
id: 4bq8e4zmuh5ef
'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
x-stoplight:
id: xz7ijn9g6wuhp
'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
x-stoplight:
id: klomm831n3xe4
'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
x-stoplight:
id: 9h5t2qirsa09t
'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. '
x-stoplight:
id: bbg3lue873fk0
'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.
x-stoplight:
id: af8ttv0haa7zk
'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.
x-stoplight:
id: urr7utebg8ys7
'/settlement/deposits/{id}':
get:
operationId: getDepositSingle
tags:
- Get a Single Deposit
summary: Get the details of a single Deposit using its unique id.
description: Get the details of a single Deposit 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
x-stoplight:
id: stor96sg67n8f
- 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
x-stoplight:
id: r6rjivm6gr5z6
description: The version of the API to execute the request.
- name: id
in: path
description: This is the deposit id created to uniquely identify it in the Global Payments system.
required: true
schema:
type: string
x-stoplight:
id: r4rf3zxw9xsgu
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
x-stoplight:
id: qdoiuafa6zsf8
Content-Encoding:
schema:
description: Indicates if the message is compressed and using what compression mechanism.
type: string
default: gzip
x-stoplight:
id: rgi0h47svaey8
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
x-stoplight:
id: r6rjivm6gr5z6
content:
application/json:
schema:
type: object
x-stoplight:
id: lrvs5knsc55fs
properties:
id:
type: string
x-stoplight:
id: r4rf3zxw9xsgu
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
time_created:
type: string
x-stoplight:
id: 5npnx6z8kv5fg
description: Global Payments time indicating when the object was created in ISO-8601 format..
example: '2021-05-03'
status:
type: string
x-stoplight:
id: byvfuvk51rqdj
description: |
Indicates where a resource object is in it's lifecycle. *`FUNDED` - Deposit Funded to bank account
*`IRREG` - Deposit not funded by Global Payments
*`RESERVED `- Deposit on reserve.
*`DELAYED` - Deposit delayed for funding.
*`RELEASED` - Deposit released by Global Payments from a status of DELAYED
example: FUNDED
funding_type:
type: string
x-stoplight:
id: zxvfx7v8waqje
description: Indicates if the amount relates to a Debit or Credit to the merchant's bank account.
example: DEBIT
amount:
type: string
x-stoplight:
id: nvdzu64quo04u
description: The amount that should be credited or debited. It is always represented in the lowest denomiation of the related currency.
example: '500'
currency:
type: string
x-stoplight:
id: f19fb6yiv2p4f
description: The currency of the amount in ISO-4217(alpha-3)
example: USD
minLength: 3
maxLength: 3
aggregation_model:
type: string
x-stoplight:
id: a99gccfmr6n4k
description: 'Indicates how a merchant''s payment processing activity across Sales, Refunds, Disputes and Fees is structured for a Deposit. Activity can be aggregated into one daily amount or all activity separately funded via different deposits.'
example: 4-No Summary
bank_transfer:
type: object
properties:
masked_account_number_last4:
type: string
x-stoplight:
id: cizqdxzq2rw0s
description: Data relating to a bank transfer directly to or from the Payer's bank account.
minLength: 1
maxLength: 50
bank:
type: object
x-stoplight:
id: o8tcveqh7zxw6
properties:
code:
type: string
x-stoplight:
id: bygy1aeip7vht
description: The local identifier code for the bank.
example: 124002971
maxLength: 50
system:
type: object
properties:
mid:
type: string
x-stoplight:
id: ycm7wq504kyoj
description: Merchant Identifier from Global Payments system for some features.
minLength: 1
maxLength: 50
hierarchy:
type: string
x-stoplight:
id: z6m96ycdeitn2
description: Identifies the location of a merchant within the merchant's corporate hierarchical structure.
minLength: 1
maxLength: 50
name:
type: string
x-stoplight:
id: 52tyn7fg9clv9
description: The merchant name that is associated with the merchant.
example: MERCHANT ABC INC.
minLength: 1
maxLength: 100
dba:
type: string
x-stoplight:
id: afay0ofmacpjb
description: The alternate name the merchant may be known as.
example: MERCHANT XYZ INC
minLength: 1
maxLength: 100
sales:
type: object
properties:
count:
type: number
x-stoplight:
id: m5jk5u1fbpzei
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: gb2wfwmxvm3xc
description: The total amount across one or more items
example: '120'
refunds:
type: object
properties:
count:
type: number
x-stoplight:
id: b9lwonymvurb5
description: The total number of items.
example: 123
amount:
type: string
x-stoplight:
id: n18gon3tsi09z
description: The total amount across one or more items.
example: '120'
disputes:
type: object
description: Data relating to the dispute totals across chargebacks and chargeback reversals.
properties:
chargebacks:
type: object
properties:
count:
type: number
x-stoplight:
id: ziqcphyj9y62c