Simulates an inbound Real Time Payments transfer to your account. Real Time Payments are a beta feature.
643 matches
100 actions
Increase
100 actions
- Action a Real-Time DecisionPOSTv1.0.0
- Approve a Check TransferPOSTv1.0.0
- Approve a Wire TransferPOSTv1.0.0
- Approve an Account TransferPOSTv1.0.0
- Approve an ACH TransferPOSTv1.0.0
- Cancel a pending ACH TransferPOSTv1.0.0
- Cancel a pending Check TransferPOSTv1.0.0
- Cancel a pending Wire TransferPOSTv1.0.0
- Cancel an Account TransferPOSTv1.0.0
- Close an AccountPOSTv1.0.0
- Complete a Sandbox Account TransferPOSTv1.0.0
- Create a CardPOSTv1.0.0
- Create a Card DisputePOSTv1.0.0
- Create a Card ProfilePOSTv1.0.0
- Create a Check DepositPOSTv1.0.0
- Create a Check TransferPOSTv1.0.0
- Create a FilePOSTv1.0.0
- Create a LimitPOSTv1.0.0
- Create a supplemental document for an EntityPOSTv1.0.0
- Create a Wire Drawdown RequestPOSTv1.0.0
- Create a Wire TransferPOSTv1.0.0
- Create an AccountPOSTv1.0.0
- Create an Account NumberPOSTv1.0.0
- Create an Account TransferPOSTv1.0.0
- Create an ACH PrenotificationPOSTv1.0.0
- Create an ACH ReturnPOSTv1.0.0
- Create an ACH TransferPOSTv1.0.0
- Create an EntityPOSTv1.0.0
- Create an Event SubscriptionPOSTv1.0.0
- Create an External AccountPOSTv1.0.0
- Deposit a Sandbox Check TransferPOSTv1.0.0
- List Account NumbersGETv1.0.0
- List Account StatementsGETv1.0.0
- List Account TransfersGETv1.0.0
- List AccountsGETv1.0.0
- List ACH PrenotificationsGETv1.0.0
- List ACH TransfersGETv1.0.0
- List Card DisputesGETv1.0.0
- List Card ProfilesGETv1.0.0
- List CardsGETv1.0.0
- List Check DepositsGETv1.0.0
- List Check TransfersGETv1.0.0
- List Declined TransactionsGETv1.0.0
- List DocumentsGETv1.0.0
- List EntitiesGETv1.0.0
- List Event SubscriptionsGETv1.0.0
- List EventsGETv1.0.0
- List External AccountsGETv1.0.0
- List FilesGETv1.0.0
- List Inbound ACH Transfer ReturnsGETv1.0.0
- List Inbound Wire Drawdown RequestsGETv1.0.0
- List LimitsGETv1.0.0
- List Pending TransactionsGETv1.0.0
- List Routing NumbersGETv1.0.0
- List TransactionsGETv1.0.0
- List Wire Drawdown RequestsGETv1.0.0
- List Wire TransfersGETv1.0.0
- Mail a Sandbox Check TransferPOSTv1.0.0
- Reject a Sandbox Check DepositPOSTv1.0.0
- Request a stop payment on a Check TransferPOSTv1.0.0
- Retrieve a CardGETv1.0.0
- Retrieve a Card DisputeGETv1.0.0
- Retrieve a Card ProfileGETv1.0.0
- Retrieve a Check DepositGETv1.0.0
- Retrieve a Check TransferGETv1.0.0
- Retrieve a Declined TransactionGETv1.0.0
- Retrieve a DocumentGETv1.0.0
- Retrieve a FileGETv1.0.0
- Retrieve a LimitGETv1.0.0
- Retrieve a Pending TransactionGETv1.0.0
- Retrieve a Real-Time DecisionGETv1.0.0
- Retrieve a TransactionGETv1.0.0
- Retrieve a Wire Drawdown RequestGETv1.0.0
- Retrieve a Wire TransferGETv1.0.0
- Retrieve an AccountGETv1.0.0
- Retrieve an Account NumberGETv1.0.0
- Retrieve an Account StatementGETv1.0.0
- Retrieve an Account TransferGETv1.0.0
- Retrieve an ACH PrenotificationGETv1.0.0
- Retrieve an ACH TransferGETv1.0.0
- Retrieve an EntityGETv1.0.0
- Retrieve an EventGETv1.0.0
- Retrieve an Event SubscriptionGETv1.0.0
- Retrieve an External AccountGETv1.0.0
- Retrieve an Inbound ACH Transfer ReturnGETv1.0.0
- Retrieve an Inbound Wire Drawdown RequestGETv1.0.0
- Retrieve Group detailsGETv1.0.0
- Retrieve sensitive details for a CardGETv1.0.0
- Return a Sandbox ACH TransferPOSTv1.0.0
- Return a Sandbox Check DepositPOSTv1.0.0
- Reverse a Sandbox Wire TransferPOSTv1.0.0
- Simulate a Real Time Payments Transfer to your accountPOSTv1.0.0
- Simulate a refund on a cardPOSTv1.0.0
- Simulate a tax document being createdPOSTv1.0.0
- Update a CardPATCHv1.0.0
- Update a LimitPATCHv1.0.0
- Update an AccountPATCHv1.0.0
- Update an Account NumberPATCHv1.0.0
- Update an Event SubscriptionPATCHv1.0.0
- Update an External AccountPATCHv1.0.0
Other/Increase
Simulate a Real Time Payments Transfer to your account
v1.0.0Input
- 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
{
"type": "object",
"required": [
"account_number_id",
"amount"
],
"properties": {
"account_number_id": {
"type": "string",
"description": "The identifier of the Account Number the inbound Real Time Payments Transfer is for."
},
"amount": {
"type": "integer",
"description": "The transfer amount in USD cents. Must be positive."
},
"debtor_account_number": {
"type": "string",
"description": "The account number of the account that sent the transfer."
},
"debtor_name": {
"type": "string",
"description": "The name provided by the sender of the transfer."
},
"debtor_routing_number": {
"type": "string",
"description": "The routing number of the account that sent the transfer."
},
"remittance_information": {
"type": "string",
"description": "Additional information included with the transfer."
},
"request_for_payment_id": {
"type": "string",
"description": "The identifier of a pending Request for Payment that this transfer will fulfill."
}
}
}Output
- 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
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 1007
- 1008
- 1009
- 1010
- 1011
- 1012
- 1013
- 1014
- 1015
- 1016
- 1017
- 1018
- 1019
- 1020
- 1021
- 1022
- 1023
- 1024
- 1025
- 1026
- 1027
- 1028
- 1029
- 1030
- 1031
- 1032
- 1033
- 1034
- 1035
- 1036
- 1037
- 1038
- 1039
- 1040
- 1041
- 1042
- 1043
- 1044
- 1045
- 1046
- 1047
- 1048
- 1049
- 1050
- 1051
- 1052
- 1053
- 1054
- 1055
- 1056
- 1057
- 1058
- 1059
- 1060
- 1061
- 1062
- 1063
- 1064
- 1065
- 1066
- 1067
- 1068
- 1069
- 1070
- 1071
- 1072
- 1073
- 1074
- 1075
- 1076
- 1077
- 1078
- 1079
- 1080
- 1081
- 1082
- 1083
- 1084
- 1085
- 1086
- 1087
- 1088
- 1089
- 1090
- 1091
- 1092
- 1093
- 1094
- 1095
- 1096
- 1097
- 1098
- 1099
- 1100
- 1101
- 1102
- 1103
- 1104
- 1105
- 1106
- 1107
- 1108
- 1109
- 1110
- 1111
- 1112
- 1113
- 1114
- 1115
- 1116
- 1117
- 1118
- 1119
- 1120
- 1121
- 1122
- 1123
- 1124
- 1125
- 1126
- 1127
- 1128
- 1129
- 1130
- 1131
- 1132
- 1133
- 1134
- 1135
- 1136
- 1137
- 1138
- 1139
- 1140
- 1141
- 1142
- 1143
- 1144
- 1145
- 1146
- 1147
- 1148
- 1149
- 1150
- 1151
- 1152
- 1153
- 1154
- 1155
- 1156
- 1157
- 1158
- 1159
- 1160
- 1161
- 1162
- 1163
- 1164
- 1165
- 1166
- 1167
- 1168
- 1169
- 1170
- 1171
- 1172
- 1173
- 1174
- 1175
- 1176
- 1177
- 1178
- 1179
- 1180
- 1181
- 1182
- 1183
- 1184
- 1185
- 1186
- 1187
- 1188
- 1189
- 1190
- 1191
- 1192
- 1193
- 1194
- 1195
- 1196
- 1197
- 1198
- 1199
- 1200
- 1201
- 1202
- 1203
- 1204
- 1205
- 1206
- 1207
- 1208
- 1209
- 1210
- 1211
- 1212
- 1213
- 1214
- 1215
- 1216
- 1217
- 1218
- 1219
- 1220
- 1221
- 1222
- 1223
- 1224
- 1225
- 1226
- 1227
- 1228
- 1229
- 1230
- 1231
- 1232
- 1233
- 1234
- 1235
- 1236
- 1237
- 1238
- 1239
- 1240
- 1241
- 1242
- 1243
- 1244
- 1245
- 1246
- 1247
- 1248
- 1249
- 1250
- 1251
- 1252
- 1253
- 1254
- 1255
- 1256
- 1257
- 1258
- 1259
- 1260
- 1261
- 1262
- 1263
- 1264
- 1265
- 1266
- 1267
- 1268
- 1269
- 1270
- 1271
- 1272
- 1273
- 1274
- 1275
- 1276
- 1277
- 1278
- 1279
- 1280
- 1281
- 1282
- 1283
- 1284
- 1285
- 1286
- 1287
- 1288
- 1289
- 1290
- 1291
- 1292
- 1293
- 1294
- 1295
- 1296
- 1297
- 1298
- 1299
- 1300
- 1301
- 1302
- 1303
- 1304
- 1305
- 1306
- 1307
- 1308
- 1309
- 1310
- 1311
- 1312
- 1313
- 1314
- 1315
- 1316
- 1317
- 1318
- 1319
- 1320
- 1321
- 1322
- 1323
- 1324
- 1325
- 1326
- 1327
- 1328
- 1329
- 1330
- 1331
- 1332
- 1333
- 1334
- 1335
- 1336
- 1337
- 1338
- 1339
- 1340
- 1341
- 1342
- 1343
- 1344
- 1345
- 1346
- 1347
- 1348
- 1349
- 1350
- 1351
- 1352
- 1353
- 1354
- 1355
- 1356
- 1357
- 1358
- 1359
- 1360
- 1361
- 1362
- 1363
- 1364
- 1365
- 1366
- 1367
- 1368
- 1369
- 1370
- 1371
- 1372
- 1373
- 1374
- 1375
- 1376
- 1377
- 1378
- 1379
- 1380
- 1381
- 1382
- 1383
- 1384
- 1385
- 1386
- 1387
- 1388
- 1389
- 1390
- 1391
- 1392
- 1393
- 1394
- 1395
- 1396
- 1397
- 1398
- 1399
- 1400
- 1401
- 1402
- 1403
- 1404
- 1405
- 1406
- 1407
- 1408
- 1409
- 1410
- 1411
- 1412
- 1413
- 1414
- 1415
- 1416
- 1417
- 1418
- 1419
- 1420
- 1421
- 1422
- 1423
- 1424
- 1425
- 1426
- 1427
- 1428
- 1429
- 1430
- 1431
- 1432
- 1433
- 1434
- 1435
- 1436
- 1437
- 1438
- 1439
- 1440
- 1441
- 1442
- 1443
- 1444
- 1445
- 1446
- 1447
- 1448
- 1449
- 1450
- 1451
- 1452
- 1453
- 1454
- 1455
- 1456
- 1457
- 1458
- 1459
- 1460
- 1461
- 1462
- 1463
- 1464
- 1465
- 1466
- 1467
- 1468
- 1469
- 1470
- 1471
- 1472
- 1473
- 1474
- 1475
- 1476
- 1477
- 1478
- 1479
- 1480
- 1481
- 1482
- 1483
- 1484
- 1485
- 1486
- 1487
- 1488
- 1489
- 1490
- 1491
- 1492
- 1493
- 1494
- 1495
- 1496
- 1497
- 1498
- 1499
- 1500
- 1501
- 1502
- 1503
- 1504
- 1505
- 1506
- 1507
- 1508
- 1509
- 1510
- 1511
- 1512
- 1513
- 1514
- 1515
- 1516
- 1517
- 1518
- 1519
- 1520
- 1521
- 1522
- 1523
- 1524
- 1525
- 1526
- 1527
- 1528
- 1529
- 1530
- 1531
- 1532
- 1533
- 1534
- 1535
- 1536
- 1537
- 1538
- 1539
- 1540
- 1541
- 1542
- 1543
- 1544
- 1545
- 1546
- 1547
- 1548
- 1549
- 1550
- 1551
- 1552
- 1553
- 1554
- 1555
- 1556
- 1557
- 1558
- 1559
- 1560
- 1561
- 1562
- 1563
- 1564
- 1565
- 1566
- 1567
- 1568
- 1569
- 1570
- 1571
- 1572
- 1573
- 1574
- 1575
- 1576
- 1577
- 1578
- 1579
- 1580
- 1581
- 1582
- 1583
- 1584
- 1585
- 1586
- 1587
- 1588
- 1589
- 1590
- 1591
- 1592
- 1593
- 1594
- 1595
- 1596
- 1597
- 1598
- 1599
- 1600
- 1601
- 1602
- 1603
- 1604
- 1605
- 1606
- 1607
- 1608
- 1609
- 1610
- 1611
- 1612
- 1613
- 1614
- 1615
- 1616
- 1617
- 1618
- 1619
- 1620
- 1621
- 1622
- 1623
- 1624
- 1625
- 1626
- 1627
- 1628
- 1629
- 1630
- 1631
- 1632
- 1633
- 1634
- 1635
- 1636
- 1637
- 1638
- 1639
- 1640
- 1641
- 1642
- 1643
- 1644
- 1645
- 1646
- 1647
- 1648
- 1649
- 1650
- 1651
- 1652
- 1653
- 1654
- 1655
- 1656
- 1657
- 1658
- 1659
- 1660
- 1661
- 1662
- 1663
- 1664
- 1665
- 1666
- 1667
- 1668
- 1669
- 1670
- 1671
- 1672
- 1673
- 1674
- 1675
- 1676
- 1677
- 1678
- 1679
- 1680
- 1681
- 1682
- 1683
- 1684
- 1685
- 1686
- 1687
- 1688
- 1689
- 1690
- 1691
- 1692
- 1693
- 1694
- 1695
- 1696
- 1697
- 1698
- 1699
- 1700
- 1701
- 1702
- 1703
- 1704
- 1705
- 1706
- 1707
- 1708
- 1709
- 1710
- 1711
- 1712
- 1713
- 1714
- 1715
- 1716
- 1717
- 1718
- 1719
- 1720
- 1721
- 1722
- 1723
- 1724
- 1725
- 1726
- 1727
- 1728
- 1729
- 1730
- 1731
- 1732
- 1733
- 1734
- 1735
- 1736
- 1737
- 1738
- 1739
- 1740
- 1741
- 1742
- 1743
- 1744
- 1745
- 1746
- 1747
- 1748
- 1749
- 1750
- 1751
- 1752
- 1753
- 1754
- 1755
- 1756
- 1757
- 1758
- 1759
- 1760
- 1761
- 1762
- 1763
- 1764
- 1765
- 1766
- 1767
- 1768
- 1769
- 1770
- 1771
- 1772
- 1773
- 1774
- 1775
- 1776
- 1777
- 1778
- 1779
- 1780
- 1781
- 1782
- 1783
- 1784
- 1785
- 1786
- 1787
- 1788
- 1789
- 1790
- 1791
- 1792
- 1793
- 1794
- 1795
- 1796
- 1797
- 1798
- 1799
- 1800
- 1801
- 1802
- 1803
- 1804
- 1805
- 1806
- 1807
- 1808
- 1809
- 1810
- 1811
- 1812
- 1813
- 1814
- 1815
- 1816
- 1817
- 1818
- 1819
- 1820
- 1821
- 1822
- 1823
- 1824
- 1825
- 1826
- 1827
- 1828
- 1829
- 1830
- 1831
- 1832
- 1833
- 1834
- 1835
- 1836
- 1837
- 1838
- 1839
- 1840
- 1841
- 1842
- 1843
- 1844
- 1845
- 1846
- 1847
- 1848
- 1849
- 1850
- 1851
- 1852
- 1853
- 1854
- 1855
- 1856
- 1857
- 1858
- 1859
- 1860
- 1861
- 1862
- 1863
- 1864
- 1865
- 1866
- 1867
- 1868
- 1869
- 1870
- 1871
- 1872
- 1873
- 1874
- 1875
- 1876
- 1877
- 1878
- 1879
- 1880
- 1881
- 1882
- 1883
- 1884
- 1885
- 1886
- 1887
- 1888
- 1889
- 1890
- 1891
- 1892
- 1893
- 1894
- 1895
- 1896
- 1897
- 1898
- 1899
- 1900
- 1901
- 1902
- 1903
- 1904
- 1905
- 1906
- 1907
- 1908
- 1909
- 1910
- 1911
- 1912
- 1913
- 1914
- 1915
- 1916
- 1917
- 1918
- 1919
- 1920
- 1921
- 1922
- 1923
- 1924
- 1925
- 1926
- 1927
- 1928
- 1929
- 1930
- 1931
- 1932
- 1933
- 1934
- 1935
- 1936
- 1937
- 1938
- 1939
- 1940
- 1941
- 1942
- 1943
- 1944
- 1945
- 1946
- 1947
- 1948
- 1949
- 1950
- 1951
- 1952
- 1953
- 1954
- 1955
- 1956
- 1957
- 1958
- 1959
- 1960
- 1961
- 1962
- 1963
- 1964
- 1965
- 1966
- 1967
- 1968
- 1969
- 1970
- 1971
- 1972
- 1973
- 1974
- 1975
- 1976
- 1977
- 1978
- 1979
- 1980
- 1981
- 1982
- 1983
- 1984
- 1985
- 1986
- 1987
- 1988
- 1989
- 1990
- 1991
- 1992
- 1993
- 1994
- 1995
- 1996
- 1997
- 1998
- 1999
- 2000
- 2001
- 2002
- 2003
- 2004
- 2005
- 2006
- 2007
- 2008
- 2009
- 2010
- 2011
- 2012
- 2013
- 2014
- 2015
- 2016
- 2017
- 2018
- 2019
- 2020
- 2021
- 2022
- 2023
- 2024
- 2025
- 2026
- 2027
- 2028
- 2029
- 2030
- 2031
- 2032
- 2033
- 2034
- 2035
- 2036
- 2037
- 2038
- 2039
- 2040
- 2041
- 2042
- 2043
- 2044
- 2045
- 2046
- 2047
- 2048
- 2049
- 2050
- 2051
- 2052
- 2053
- 2054
- 2055
- 2056
- 2057
- 2058
- 2059
- 2060
- 2061
- 2062
- 2063
- 2064
- 2065
- 2066
- 2067
- 2068
- 2069
- 2070
- 2071
- 2072
- 2073
- 2074
- 2075
- 2076
- 2077
- 2078
- 2079
- 2080
- 2081
- 2082
- 2083
- 2084
- 2085
- 2086
- 2087
- 2088
- 2089
- 2090
- 2091
- 2092
- 2093
- 2094
- 2095
- 2096
- 2097
- 2098
- 2099
- 2100
- 2101
- 2102
- 2103
- 2104
- 2105
- 2106
- 2107
- 2108
- 2109
- 2110
- 2111
- 2112
- 2113
- 2114
- 2115
- 2116
- 2117
- 2118
- 2119
- 2120
- 2121
- 2122
- 2123
- 2124
- 2125
- 2126
- 2127
- 2128
- 2129
- 2130
- 2131
- 2132
- 2133
- 2134
- 2135
- 2136
- 2137
- 2138
- 2139
- 2140
- 2141
- 2142
- 2143
- 2144
- 2145
- 2146
- 2147
- 2148
- 2149
- 2150
- 2151
- 2152
- 2153
- 2154
- 2155
- 2156
- 2157
- 2158
- 2159
- 2160
- 2161
- 2162
- 2163
- 2164
- 2165
- 2166
- 2167
- 2168
- 2169
- 2170
- 2171
- 2172
- 2173
- 2174
- 2175
- 2176
- 2177
- 2178
- 2179
- 2180
- 2181
- 2182
- 2183
- 2184
- 2185
- 2186
- 2187
- 2188
- 2189
- 2190
- 2191
- 2192
- 2193
- 2194
- 2195
- 2196
- 2197
- 2198
- 2199
- 2200
- 2201
- 2202
- 2203
- 2204
- 2205
- 2206
- 2207
- 2208
- 2209
- 2210
{
"type": "object",
"description": "The results of an inbound Real Time Payments Transfer simulation.",
"required": [
"declined_transaction",
"transaction",
"type"
],
"properties": {
"declined_transaction": {
"type": "object",
"description": "If the Real Time Payments Transfer attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: inbound_real_time_payments_transfer_decline`.",
"required": [
"account_id",
"amount",
"created_at",
"currency",
"description",
"id",
"route_id",
"route_type",
"source",
"type"
],
"properties": {
"account_id": {
"type": "string",
"description": "The identifier for the Account the Declined Transaction belongs to."
},
"amount": {
"type": "integer",
"description": "The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transcation's Account.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"description": {
"type": "string",
"description": "This is the description the vendor provides."
},
"id": {
"type": "string",
"description": "The Declined Transaction identifier."
},
"route_id": {
"type": "string",
"description": "The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details."
},
"route_type": {
"type": "string",
"description": "The type of the route this Declined Transaction came through."
},
"source": {
"type": "object",
"description": "This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.",
"required": [
"ach_decline",
"card_decline",
"card_route_decline",
"category",
"check_decline",
"inbound_real_time_payments_transfer_decline",
"international_ach_decline"
],
"properties": {
"ach_decline": {
"type": "object",
"description": "A ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.",
"required": [
"amount",
"originator_company_descriptive_date",
"originator_company_discretionary_data",
"originator_company_id",
"originator_company_name",
"reason",
"receiver_id_number",
"receiver_name",
"trace_number"
],
"properties": {
"amount": {
"type": "integer",
"description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"originator_company_descriptive_date": {
"type": "string"
},
"originator_company_discretionary_data": {
"type": "string"
},
"originator_company_id": {
"type": "string"
},
"originator_company_name": {
"type": "string"
},
"reason": {
"type": "string",
"description": "Why the ACH transfer was declined.",
"enum": [
"ach_route_canceled",
"ach_route_disabled",
"breaches_limit",
"credit_entry_refused_by_receiver",
"duplicate_return",
"entity_not_active",
"transaction_not_allowed",
"group_locked",
"insufficient_funds",
"no_ach_route",
"originator_request"
]
},
"receiver_id_number": {
"type": "string"
},
"receiver_name": {
"type": "string"
},
"trace_number": {
"type": "string"
}
}
},
"card_decline": {
"type": "object",
"description": "A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.",
"required": [
"amount",
"currency",
"digital_wallet_token_id",
"merchant_acceptor_id",
"merchant_category_code",
"merchant_city",
"merchant_country",
"merchant_descriptor",
"merchant_state",
"network",
"network_details",
"real_time_decision_id",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"digital_wallet_token_id": {
"type": "string",
"description": "If the authorization was attempted using a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used."
},
"merchant_acceptor_id": {
"type": "string",
"description": "The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with."
},
"merchant_category_code": {
"type": "string",
"description": "The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with."
},
"merchant_city": {
"type": "string",
"description": "The city the merchant resides in."
},
"merchant_country": {
"type": "string",
"description": "The country the merchant resides in."
},
"merchant_descriptor": {
"type": "string",
"description": "The merchant descriptor of the merchant the card is transacting with."
},
"merchant_state": {
"type": "string",
"description": "The state the merchant resides in."
},
"network": {
"type": "string",
"description": "The payment network used to process this card authorization",
"enum": [
"visa"
]
},
"network_details": {
"type": "object",
"description": "Fields specific to the `network`",
"required": [
"visa"
],
"properties": {
"visa": {
"type": "object",
"description": "Fields specific to the `visa` network",
"required": [
"electronic_commerce_indicator",
"point_of_service_entry_mode"
],
"properties": {
"electronic_commerce_indicator": {
"type": "string",
"description": "For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.",
"enum": [
"mail_phone_order",
"recurring",
"installment",
"unknown_mail_phone_order",
"secure_electronic_commerce",
"non_authenticated_security_transaction_at_3ds_capable_merchant",
"non_authenticated_security_transaction",
"non_secure_transaction"
]
},
"point_of_service_entry_mode": {
"type": "string",
"description": "The method used to enter the cardholder's primary account number and card expiration date",
"enum": [
"manual",
"magnetic_stripe_no_cvv",
"optical_code",
"integrated_circuit_card",
"contactless",
"credential_on_file",
"magnetic_stripe",
"contactless_magnetic_stripe",
"integrated_circuit_card_no_cvv"
]
}
}
}
}
},
"real_time_decision_id": {
"type": "string",
"description": "The identifier of the Real-Time Decision sent to approve or decline this transaction."
},
"reason": {
"type": "string",
"description": "Why the transaction was declined.",
"enum": [
"card_not_active",
"entity_not_active",
"group_locked",
"insufficient_funds",
"cvv2_mismatch",
"transaction_not_allowed",
"breaches_limit",
"webhook_declined",
"webhook_timed_out",
"declined_by_stand_in_processing"
]
}
}
},
"card_route_decline": {
"type": "object",
"description": "A Deprecated Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_route_decline`.",
"required": [
"amount",
"currency",
"merchant_acceptor_id",
"merchant_category_code",
"merchant_city",
"merchant_country",
"merchant_descriptor",
"merchant_state"
],
"properties": {
"amount": {
"type": "integer",
"description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"merchant_acceptor_id": {
"type": "string"
},
"merchant_category_code": {
"type": "string"
},
"merchant_city": {
"type": "string"
},
"merchant_country": {
"type": "string"
},
"merchant_descriptor": {
"type": "string"
},
"merchant_state": {
"type": "string"
}
}
},
"category": {
"type": "string",
"description": "The type of decline that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.",
"enum": [
"ach_decline",
"card_decline",
"check_decline",
"inbound_real_time_payments_transfer_decline",
"international_ach_decline",
"card_route_decline",
"other"
]
},
"check_decline": {
"type": "object",
"description": "A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.",
"required": [
"amount",
"auxiliary_on_us",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"auxiliary_on_us": {
"type": "string"
},
"reason": {
"type": "string",
"description": "Why the check was declined.",
"enum": [
"ach_route_canceled",
"ach_route_disabled",
"breaches_limit",
"entity_not_active",
"group_locked",
"insufficient_funds",
"unable_to_locate_account",
"unable_to_process",
"refer_to_image",
"stop_payment_requested",
"returned"
]
}
}
},
"inbound_real_time_payments_transfer_decline": {
"type": "object",
"description": "A Inbound Real Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.",
"required": [
"amount",
"creditor_name",
"currency",
"debtor_account_number",
"debtor_name",
"debtor_routing_number",
"reason",
"remittance_information",
"transaction_identification"
],
"properties": {
"amount": {
"type": "integer",
"description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"creditor_name": {
"type": "string",
"description": "The name the sender of the transfer specified as the recipient of the transfer."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be \"USD\" for a Real Time Payments transfer.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"debtor_account_number": {
"type": "string",
"description": "The account number of the account that sent the transfer."
},
"debtor_name": {
"type": "string",
"description": "The name provided by the sender of the transfer."
},
"debtor_routing_number": {
"type": "string",
"description": "The routing number of the account that sent the transfer."
},
"reason": {
"type": "string",
"description": "Why the transfer was declined.",
"enum": [
"account_number_canceled",
"account_number_disabled",
"group_locked",
"entity_not_active",
"real_time_payments_not_enabled"
]
},
"remittance_information": {
"type": "string",
"description": "Additional information included with the transfer."
},
"transaction_identification": {
"type": "string",
"description": "The Real Time Payments network identification of the declined transfer."
}
}
},
"international_ach_decline": {
"type": "object",
"description": "A International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.",
"required": [
"amount",
"destination_country_code",
"destination_currency_code",
"foreign_exchange_indicator",
"foreign_exchange_reference",
"foreign_exchange_reference_indicator",
"foreign_payment_amount",
"foreign_trace_number",
"international_transaction_type_code",
"originating_currency_code",
"originating_depository_financial_institution_branch_country",
"originating_depository_financial_institution_id",
"originating_depository_financial_institution_id_qualifier",
"originating_depository_financial_institution_name",
"originator_city",
"originator_company_entry_description",
"originator_country",
"originator_identification",
"originator_name",
"originator_postal_code",
"originator_state_or_province",
"originator_street_address",
"payment_related_information",
"payment_related_information2",
"receiver_city",
"receiver_country",
"receiver_identification_number",
"receiver_postal_code",
"receiver_state_or_province",
"receiver_street_address",
"receiving_company_or_individual_name",
"receiving_depository_financial_institution_country",
"receiving_depository_financial_institution_id",
"receiving_depository_financial_institution_id_qualifier",
"receiving_depository_financial_institution_name",
"trace_number"
],
"properties": {
"amount": {
"type": "integer",
"description": "The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"destination_country_code": {
"type": "string"
},
"destination_currency_code": {
"type": "string"
},
"foreign_exchange_indicator": {
"type": "string"
},
"foreign_exchange_reference": {
"type": "string"
},
"foreign_exchange_reference_indicator": {
"type": "string"
},
"foreign_payment_amount": {
"type": "integer"
},
"foreign_trace_number": {
"type": "string"
},
"international_transaction_type_code": {
"type": "string"
},
"originating_currency_code": {
"type": "string"
},
"originating_depository_financial_institution_branch_country": {
"type": "string"
},
"originating_depository_financial_institution_id": {
"type": "string"
},
"originating_depository_financial_institution_id_qualifier": {
"type": "string"
},
"originating_depository_financial_institution_name": {
"type": "string"
},
"originator_city": {
"type": "string"
},
"originator_company_entry_description": {
"type": "string"
},
"originator_country": {
"type": "string"
},
"originator_identification": {
"type": "string"
},
"originator_name": {
"type": "string"
},
"originator_postal_code": {
"type": "string"
},
"originator_state_or_province": {
"type": "string"
},
"originator_street_address": {
"type": "string"
},
"payment_related_information": {
"type": "string"
},
"payment_related_information2": {
"type": "string"
},
"receiver_city": {
"type": "string"
},
"receiver_country": {
"type": "string"
},
"receiver_identification_number": {
"type": "string"
},
"receiver_postal_code": {
"type": "string"
},
"receiver_state_or_province": {
"type": "string"
},
"receiver_street_address": {
"type": "string"
},
"receiving_company_or_individual_name": {
"type": "string"
},
"receiving_depository_financial_institution_country": {
"type": "string"
},
"receiving_depository_financial_institution_id": {
"type": "string"
},
"receiving_depository_financial_institution_id_qualifier": {
"type": "string"
},
"receiving_depository_financial_institution_name": {
"type": "string"
},
"trace_number": {
"type": "string"
}
}
}
}
},
"type": {
"type": "string",
"description": "A constant representing the object's type. For this resource it will always be `declined_transaction`.",
"enum": [
"declined_transaction"
]
}
}
},
"transaction": {
"type": "object",
"description": "If the Real Time Payments Transfer attempt succeeds, this will contain the resulting [Transaction](#transactions) object. The Transaction's `source` will be of `category: inbound_real_time_payments_transfer_confirmation`.",
"required": [
"account_id",
"amount",
"created_at",
"currency",
"description",
"id",
"route_id",
"route_type",
"source",
"type"
],
"properties": {
"account_id": {
"type": "string",
"description": "The identifier for the Account the Transaction belongs to."
},
"amount": {
"type": "integer",
"description": "The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"description": {
"type": "string",
"description": "For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides."
},
"id": {
"type": "string",
"description": "The Transaction identifier."
},
"route_id": {
"type": "string",
"description": "The identifier for the route this Transaction came through. Routes are things like cards and ACH details."
},
"route_type": {
"type": "string",
"description": "The type of the route this Transaction came through."
},
"source": {
"type": "object",
"description": "This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.",
"required": [
"account_transfer_intention",
"ach_check_conversion",
"ach_check_conversion_return",
"ach_transfer_intention",
"ach_transfer_rejection",
"ach_transfer_return",
"card_dispute_acceptance",
"card_refund",
"card_route_refund",
"card_route_settlement",
"card_settlement",
"category",
"check_deposit_acceptance",
"check_deposit_return",
"check_transfer_intention",
"check_transfer_rejection",
"check_transfer_return",
"check_transfer_stop_payment_request",
"dispute_resolution",
"empyreal_cash_deposit",
"inbound_ach_transfer",
"inbound_check",
"inbound_international_ach_transfer",
"inbound_real_time_payments_transfer_confirmation",
"inbound_wire_drawdown_payment",
"inbound_wire_drawdown_payment_reversal",
"inbound_wire_reversal",
"inbound_wire_transfer",
"interest_payment",
"internal_source",
"sample_funds",
"wire_drawdown_payment_intention",
"wire_drawdown_payment_rejection",
"wire_transfer_intention",
"wire_transfer_rejection"
],
"properties": {
"account_transfer_intention": {
"type": "object",
"description": "A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.",
"required": [
"amount",
"currency",
"description",
"destination_account_id",
"source_account_id",
"transfer_id"
],
"properties": {
"amount": {
"type": "integer",
"description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"description": {
"type": "string",
"description": "The description you chose to give the transfer."
},
"destination_account_id": {
"type": "string",
"description": "The identifier of the Account to where the Account Transfer was sent."
},
"source_account_id": {
"type": "string",
"description": "The identifier of the Account from where the Account Transfer was sent."
},
"transfer_id": {
"type": "string",
"description": "The identifier of the Account Transfer that led to this Pending Transaction."
}
}
},
"ach_check_conversion": {
"type": "object",
"description": "A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`.",
"required": [
"amount",
"file_id"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"file_id": {
"type": "string",
"description": "The identifier of the File containing an image of the returned check."
}
}
},
"ach_check_conversion_return": {
"type": "object",
"description": "A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`.",
"required": [
"amount",
"return_reason_code"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"return_reason_code": {
"type": "string",
"description": "Why the transfer was returned."
}
}
},
"ach_transfer_intention": {
"type": "object",
"description": "A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.",
"required": [
"account_number",
"amount",
"routing_number",
"statement_descriptor",
"transfer_id"
],
"properties": {
"account_number": {
"type": "string"
},
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"routing_number": {
"type": "string"
},
"statement_descriptor": {
"type": "string"
},
"transfer_id": {
"type": "string",
"description": "The identifier of the ACH Transfer that led to this Transaction."
}
}
},
"ach_transfer_rejection": {
"type": "object",
"description": "A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.",
"required": [
"transfer_id"
],
"properties": {
"transfer_id": {
"type": "string",
"description": "The identifier of the ACH Transfer that led to this Transaction."
}
}
},
"ach_transfer_return": {
"type": "object",
"description": "A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.",
"required": [
"created_at",
"return_reason_code",
"transaction_id",
"transfer_id"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created."
},
"return_reason_code": {
"type": "string",
"description": "Why the ACH Transfer was returned.",
"enum": [
"insufficient_fund",
"no_account",
"account_closed",
"invalid_account_number_structure",
"account_frozen_entry_returned_per_ofac_instruction",
"credit_entry_refused_by_receiver",
"unauthorized_debit_to_consumer_account_using_corporate_sec_code",
"corporate_customer_advised_not_authorized",
"payment_stopped",
"non_transaction_account",
"uncollected_funds",
"routing_number_check_digit_error",
"customer_advised_unauthorized_improper_ineligible_or_incomplete",
"amount_field_error",
"authorization_revoked_by_customer",
"invalid_ach_routing_number",
"file_record_edit_criteria",
"enr_invalid_individual_name",
"returned_per_odfi_request",
"addenda_error",
"limited_participation_dfi",
"incorrectly_coded_outbound_international_payment",
"other"
]
},
"transaction_id": {
"type": "string",
"description": "The identifier of the Tranasaction associated with this return."
},
"transfer_id": {
"type": "string",
"description": "The identifier of the ACH Transfer associated with this return."
}
}
},
"card_dispute_acceptance": {
"type": "object",
"description": "A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.",
"required": [
"accepted_at",
"card_dispute_id",
"transaction_id"
],
"properties": {
"accepted_at": {
"type": "string",
"format": "date-time",
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted."
},
"card_dispute_id": {
"type": "string",
"description": "The identifier of the Card Dispute that was accepted."
},
"transaction_id": {
"type": "string",
"description": "The identifier of the Transaction that was created to return the disputed funds to your account."
}
}
},
"card_refund": {
"type": "object",
"description": "A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.",
"required": [
"amount",
"card_settlement_transaction_id",
"currency",
"type"
],
"properties": {
"amount": {
"type": "integer",
"description": "The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"card_settlement_transaction_id": {
"type": "string",
"description": "The identifier for the Transaction this refunds, if any."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"type": {
"type": "string",
"description": "A constant representing the object's type. For this resource it will always be `card_refund`.",
"enum": [
"card_refund"
]
}
}
},
"card_route_refund": {
"type": "object",
"description": "A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`.",
"required": [
"amount",
"currency",
"merchant_acceptor_id",
"merchant_category_code",
"merchant_city",
"merchant_country",
"merchant_descriptor",
"merchant_state"
],
"properties": {
"amount": {
"type": "integer",
"description": "The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"merchant_acceptor_id": {
"type": "string"
},
"merchant_category_code": {
"type": "string"
},
"merchant_city": {
"type": "string"
},
"merchant_country": {
"type": "string"
},
"merchant_descriptor": {
"type": "string"
},
"merchant_state": {
"type": "string"
}
}
},
"card_route_settlement": {
"type": "object",
"description": "A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`.",
"required": [
"amount",
"currency",
"merchant_acceptor_id",
"merchant_category_code",
"merchant_city",
"merchant_country",
"merchant_descriptor",
"merchant_state"
],
"properties": {
"amount": {
"type": "integer",
"description": "The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"merchant_acceptor_id": {
"type": "string"
},
"merchant_category_code": {
"type": "string"
},
"merchant_city": {
"type": "string"
},
"merchant_country": {
"type": "string"
},
"merchant_descriptor": {
"type": "string"
},
"merchant_state": {
"type": "string"
}
}
},
"card_settlement": {
"type": "object",
"description": "A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.",
"required": [
"amount",
"currency",
"merchant_category_code",
"merchant_city",
"merchant_country",
"merchant_name",
"merchant_state",
"pending_transaction_id",
"presentment_amount",
"presentment_currency",
"type"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"merchant_category_code": {
"type": "string"
},
"merchant_city": {
"type": "string"
},
"merchant_country": {
"type": "string"
},
"merchant_name": {
"type": "string"
},
"merchant_state": {
"type": "string"
},
"pending_transaction_id": {
"type": "string",
"description": "The identifier of the Pending Transaction associated with this Transaction."
},
"presentment_amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's presentment currency."
},
"presentment_currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency."
},
"type": {
"type": "string",
"description": "A constant representing the object's type. For this resource it will always be `card_settlement`.",
"enum": [
"card_settlement"
]
}
}
},
"category": {
"type": "string",
"description": "The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.",
"enum": [
"account_transfer_intention",
"ach_check_conversion_return",
"ach_check_conversion",
"ach_transfer_intention",
"ach_transfer_rejection",
"ach_transfer_return",
"card_dispute_acceptance",
"card_refund",
"card_settlement",
"check_deposit_acceptance",
"check_deposit_return",
"check_transfer_intention",
"check_transfer_return",
"check_transfer_rejection",
"check_transfer_stop_payment_request",
"dispute_resolution",
"empyreal_cash_deposit",
"inbound_ach_transfer",
"inbound_ach_transfer_return_intention",
"inbound_check",
"inbound_international_ach_transfer",
"inbound_real_time_payments_transfer_confirmation",
"inbound_wire_drawdown_payment_reversal",
"inbound_wire_drawdown_payment",
"inbound_wire_reversal",
"inbound_wire_transfer",
"interest_payment",
"internal_general_ledger_transaction",
"internal_source",
"card_route_refund",
"card_route_settlement",
"real_time_payments_transfer_acknowledgement",
"sample_funds",
"wire_drawdown_payment_intention",
"wire_drawdown_payment_rejection",
"wire_transfer_intention",
"wire_transfer_rejection",
"other"
]
},
"check_deposit_acceptance": {
"type": "object",
"description": "A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.",
"required": [
"account_number",
"amount",
"auxiliary_on_us",
"check_deposit_id",
"currency",
"routing_number",
"serial_number"
],
"properties": {
"account_number": {
"type": "string",
"description": "The account number printed on the check."
},
"amount": {
"type": "integer",
"description": "The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"auxiliary_on_us": {
"type": "string",
"description": "An additional line of metadata printed on the check. This typically includes the check number for business checks."
},
"check_deposit_id": {
"type": "string",
"description": "The ID of the Check Deposit that was accepted."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"routing_number": {
"type": "string",
"description": "The routing number printed on the check."
},
"serial_number": {
"type": "string",
"description": "The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field."
}
}
},
"check_deposit_return": {
"type": "object",
"description": "A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.",
"required": [
"amount",
"check_deposit_id",
"currency",
"return_reason",
"returned_at",
"transaction_id"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"check_deposit_id": {
"type": "string",
"description": "The identifier of the Check Deposit that was returned."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"return_reason": {
"type": "string",
"enum": [
"ach_conversion_not_supported",
"closed_account",
"duplicate_submission",
"insufficient_funds",
"no_account",
"not_authorized",
"stale_dated",
"stop_payment",
"unknown_reason",
"unmatched_details",
"unreadable_image"
]
},
"returned_at": {
"type": "string",
"format": "date-time",
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned."
},
"transaction_id": {
"type": "string",
"description": "The identifier of the transaction that reversed the original check deposit transaction."
}
}
},
"check_transfer_intention": {
"type": "object",
"description": "A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.",
"required": [
"address_city",
"address_line1",
"address_line2",
"address_state",
"address_zip",
"amount",
"currency",
"recipient_name",
"transfer_id"
],
"properties": {
"address_city": {
"type": "string",
"description": "The city of the check's destination."
},
"address_line1": {
"type": "string",
"description": "The street address of the check's destination."
},
"address_line2": {
"type": "string",
"description": "The second line of the address of the check's destination."
},
"address_state": {
"type": "string",
"description": "The state of the check's destination."
},
"address_zip": {
"type": "string",
"description": "The postal code of the check's destination."
},
"amount": {
"type": "integer",
"description": "The transfer amount in USD cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"recipient_name": {
"type": "string",
"description": "The name that will be printed on the check."
},
"transfer_id": {
"type": "string",
"description": "The identifier of the Check Transfer with which this is associated."
}
}
},
"check_transfer_rejection": {
"type": "object",
"description": "A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`.",
"required": [
"transfer_id"
],
"properties": {
"transfer_id": {
"type": "string",
"description": "The identifier of the Check Transfer that led to this Transaction."
}
}
},
"check_transfer_return": {
"type": "object",
"description": "A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`.",
"required": [
"file_id",
"transfer_id"
],
"properties": {
"file_id": {
"type": "string",
"description": "If available, a document with additional information about the return."
},
"transfer_id": {
"type": "string",
"description": "The identifier of the returned Check Transfer."
}
}
},
"check_transfer_stop_payment_request": {
"type": "object",
"description": "A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.",
"required": [
"requested_at",
"transaction_id",
"transfer_id",
"type"
],
"properties": {
"requested_at": {
"type": "string",
"format": "date-time",
"description": "The time the stop-payment was requested."
},
"transaction_id": {
"type": "string",
"description": "The transaction ID of the corresponding credit transaction."
},
"transfer_id": {
"type": "string",
"description": "The ID of the check transfer that was stopped."
},
"type": {
"type": "string",
"description": "A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.",
"enum": [
"check_transfer_stop_payment_request"
]
}
}
},
"dispute_resolution": {
"type": "object",
"description": "A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`.",
"required": [
"amount",
"currency",
"disputed_transaction_id"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"disputed_transaction_id": {
"type": "string",
"description": "The identifier of the Transaction that was disputed."
}
}
},
"empyreal_cash_deposit": {
"type": "object",
"description": "A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`.",
"required": [
"amount",
"bag_id",
"deposit_date"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"bag_id": {
"type": "string"
},
"deposit_date": {
"type": "string",
"format": "date-time"
}
}
},
"inbound_ach_transfer": {
"type": "object",
"description": "A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.",
"required": [
"amount",
"originator_company_descriptive_date",
"originator_company_discretionary_data",
"originator_company_entry_description",
"originator_company_id",
"originator_company_name",
"receiver_id_number",
"receiver_name",
"trace_number"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"originator_company_descriptive_date": {
"type": "string"
},
"originator_company_discretionary_data": {
"type": "string"
},
"originator_company_entry_description": {
"type": "string"
},
"originator_company_id": {
"type": "string"
},
"originator_company_name": {
"type": "string"
},
"receiver_id_number": {
"type": "string"
},
"receiver_name": {
"type": "string"
},
"trace_number": {
"type": "string"
}
}
},
"inbound_check": {
"type": "object",
"description": "A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.",
"required": [
"amount",
"check_front_image_file_id",
"check_number",
"check_rear_image_file_id",
"currency"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"check_front_image_file_id": {
"type": "string"
},
"check_number": {
"type": "string"
},
"check_rear_image_file_id": {
"type": "string"
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
}
}
},
"inbound_international_ach_transfer": {
"type": "object",
"description": "A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.",
"required": [
"amount",
"destination_country_code",
"destination_currency_code",
"foreign_exchange_indicator",
"foreign_exchange_reference",
"foreign_exchange_reference_indicator",
"foreign_payment_amount",
"foreign_trace_number",
"international_transaction_type_code",
"originating_currency_code",
"originating_depository_financial_institution_branch_country",
"originating_depository_financial_institution_id",
"originating_depository_financial_institution_id_qualifier",
"originating_depository_financial_institution_name",
"originator_city",
"originator_company_entry_description",
"originator_country",
"originator_identification",
"originator_name",
"originator_postal_code",
"originator_state_or_province",
"originator_street_address",
"payment_related_information",
"payment_related_information2",
"receiver_city",
"receiver_country",
"receiver_identification_number",
"receiver_postal_code",
"receiver_state_or_province",
"receiver_street_address",
"receiving_company_or_individual_name",
"receiving_depository_financial_institution_country",
"receiving_depository_financial_institution_id",
"receiving_depository_financial_institution_id_qualifier",
"receiving_depository_financial_institution_name",
"trace_number"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
},
"destination_country_code": {
"type": "string"
},
"destination_currency_code": {
"type": "string"
},
"foreign_exchange_indicator": {
"type": "string"
},
"foreign_exchange_reference": {
"type": "string"
},
"foreign_exchange_reference_indicator": {
"type": "string"
},
"foreign_payment_amount": {
"type": "integer"
},
"foreign_trace_number": {
"type": "string"
},
"international_transaction_type_code": {
"type": "string"
},
"originating_currency_code": {
"type": "string"
},
"originating_depository_financial_institution_branch_country": {
"type": "string"
},
"originating_depository_financial_institution_id": {
"type": "string"
},
"originating_depository_financial_institution_id_qualifier": {
"type": "string"
},
"originating_depository_financial_institution_name": {
"type": "string"
},
"originator_city": {
"type": "string"
},
"originator_company_entry_description": {
"type": "string"
},
"originator_country": {
"type": "string"
},
"originator_identification": {
"type": "string"
},
"originator_name": {
"type": "string"
},
"originator_postal_code": {
"type": "string"
},
"originator_state_or_province": {
"type": "string"
},
"originator_street_address": {
"type": "string"
},
"payment_related_information": {
"type": "string"
},
"payment_related_information2": {
"type": "string"
},
"receiver_city": {
"type": "string"
},
"receiver_country": {
"type": "string"
},
"receiver_identification_number": {
"type": "string"
},
"receiver_postal_code": {
"type": "string"
},
"receiver_state_or_province": {
"type": "string"
},
"receiver_street_address": {
"type": "string"
},
"receiving_company_or_individual_name": {
"type": "string"
},
"receiving_depository_financial_institution_country": {
"type": "string"
},
"receiving_depository_financial_institution_id": {
"type": "string"
},
"receiving_depository_financial_institution_id_qualifier": {
"type": "string"
},
"receiving_depository_financial_institution_name": {
"type": "string"
},
"trace_number": {
"type": "string"
}
}
},
"inbound_real_time_payments_transfer_confirmation": {
"type": "object",
"description": "A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.",
"required": [
"amount",
"creditor_name",
"currency",
"debtor_account_number",
"debtor_name",
"debtor_routing_number",
"remittance_information",
"transaction_identification"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents."
},
"creditor_name": {
"type": "string",
"description": "The name the sender of the transfer specified as the recipient of the transfer."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be \"USD\" for a Real Time Payments transfer.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"debtor_account_number": {
"type": "string",
"description": "The account number of the account that sent the transfer."
},
"debtor_name": {
"type": "string",
"description": "The name provided by the sender of the transfer."
},
"debtor_routing_number": {
"type": "string",
"description": "The routing number of the account that sent the transfer."
},
"remittance_information": {
"type": "string",
"description": "Additional information included with the transfer."
},
"transaction_identification": {
"type": "string",
"description": "The Real Time Payments network identification of the transfer"
}
}
},
"inbound_wire_drawdown_payment": {
"type": "object",
"description": "A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.",
"required": [
"amount",
"beneficiary_address_line1",
"beneficiary_address_line2",
"beneficiary_address_line3",
"beneficiary_name",
"beneficiary_reference",
"description",
"input_message_accountability_data",
"originator_address_line1",
"originator_address_line2",
"originator_address_line3",
"originator_name",
"originator_to_beneficiary_information"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"beneficiary_address_line1": {
"type": "string"
},
"beneficiary_address_line2": {
"type": "string"
},
"beneficiary_address_line3": {
"type": "string"
},
"beneficiary_name": {
"type": "string"
},
"beneficiary_reference": {
"type": "string"
},
"description": {
"type": "string"
},
"input_message_accountability_data": {
"type": "string"
},
"originator_address_line1": {
"type": "string"
},
"originator_address_line2": {
"type": "string"
},
"originator_address_line3": {
"type": "string"
},
"originator_name": {
"type": "string"
},
"originator_to_beneficiary_information": {
"type": "string"
}
}
},
"inbound_wire_drawdown_payment_reversal": {
"type": "object",
"description": "A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.",
"required": [
"amount",
"description",
"input_cycle_date",
"input_message_accountability_data",
"input_sequence_number",
"input_source",
"previous_message_input_cycle_date",
"previous_message_input_message_accountability_data",
"previous_message_input_sequence_number",
"previous_message_input_source"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount that was reversed."
},
"description": {
"type": "string",
"description": "The description on the reversal message from Fedwire."
},
"input_cycle_date": {
"type": "string",
"format": "date",
"description": "The Fedwire cycle date for the wire reversal."
},
"input_message_accountability_data": {
"type": "string",
"description": "The Fedwire transaction identifier."
},
"input_sequence_number": {
"type": "string",
"description": "The Fedwire sequence number."
},
"input_source": {
"type": "string",
"description": "The Fedwire input source identifier."
},
"previous_message_input_cycle_date": {
"type": "string",
"format": "date",
"description": "The Fedwire cycle date for the wire transfer that was reversed."
},
"previous_message_input_message_accountability_data": {
"type": "string",
"description": "The Fedwire transaction identifier for the wire transfer that was reversed."
},
"previous_message_input_sequence_number": {
"type": "string",
"description": "The Fedwire sequence number for the wire transfer that was reversed."
},
"previous_message_input_source": {
"type": "string",
"description": "The Fedwire input source identifier for the wire transfer that was reversed."
}
}
},
"inbound_wire_reversal": {
"type": "object",
"description": "A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.",
"required": [
"amount",
"description",
"financial_institution_to_financial_institution_information",
"input_cycle_date",
"input_message_accountability_data",
"input_sequence_number",
"input_source",
"previous_message_input_cycle_date",
"previous_message_input_message_accountability_data",
"previous_message_input_sequence_number",
"previous_message_input_source",
"receiver_financial_institution_information"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount that was reversed."
},
"description": {
"type": "string",
"description": "The description on the reversal message from Fedwire."
},
"financial_institution_to_financial_institution_information": {
"type": "string",
"description": "Additional financial institution information included in the wire reversal."
},
"input_cycle_date": {
"type": "string",
"format": "date",
"description": "The Fedwire cycle date for the wire reversal."
},
"input_message_accountability_data": {
"type": "string",
"description": "The Fedwire transaction identifier."
},
"input_sequence_number": {
"type": "string",
"description": "The Fedwire sequence number."
},
"input_source": {
"type": "string",
"description": "The Fedwire input source identifier."
},
"previous_message_input_cycle_date": {
"type": "string",
"format": "date",
"description": "The Fedwire cycle date for the wire transfer that was reversed."
},
"previous_message_input_message_accountability_data": {
"type": "string",
"description": "The Fedwire transaction identifier for the wire transfer that was reversed."
},
"previous_message_input_sequence_number": {
"type": "string",
"description": "The Fedwire sequence number for the wire transfer that was reversed."
},
"previous_message_input_source": {
"type": "string",
"description": "The Fedwire input source identifier for the wire transfer that was reversed."
},
"receiver_financial_institution_information": {
"type": "string",
"description": "Information included in the wire reversal for the receiving financial institution."
}
}
},
"inbound_wire_transfer": {
"type": "object",
"description": "A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.",
"required": [
"amount",
"beneficiary_address_line1",
"beneficiary_address_line2",
"beneficiary_address_line3",
"beneficiary_name",
"beneficiary_reference",
"description",
"input_message_accountability_data",
"originator_address_line1",
"originator_address_line2",
"originator_address_line3",
"originator_name",
"originator_to_beneficiary_information",
"originator_to_beneficiary_information_line1",
"originator_to_beneficiary_information_line2",
"originator_to_beneficiary_information_line3",
"originator_to_beneficiary_information_line4"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"beneficiary_address_line1": {
"type": "string"
},
"beneficiary_address_line2": {
"type": "string"
},
"beneficiary_address_line3": {
"type": "string"
},
"beneficiary_name": {
"type": "string"
},
"beneficiary_reference": {
"type": "string"
},
"description": {
"type": "string"
},
"input_message_accountability_data": {
"type": "string"
},
"originator_address_line1": {
"type": "string"
},
"originator_address_line2": {
"type": "string"
},
"originator_address_line3": {
"type": "string"
},
"originator_name": {
"type": "string"
},
"originator_to_beneficiary_information": {
"type": "string"
},
"originator_to_beneficiary_information_line1": {
"type": "string"
},
"originator_to_beneficiary_information_line2": {
"type": "string"
},
"originator_to_beneficiary_information_line3": {
"type": "string"
},
"originator_to_beneficiary_information_line4": {
"type": "string"
}
}
},
"interest_payment": {
"type": "object",
"description": "A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.",
"required": [
"accrued_on_account_id",
"amount",
"currency",
"period_end",
"period_start"
],
"properties": {
"accrued_on_account_id": {
"type": "string",
"description": "The account on which the interest was accrued."
},
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"period_end": {
"type": "string",
"format": "date-time",
"description": "The end of the period for which this transaction paid interest."
},
"period_start": {
"type": "string",
"format": "date-time",
"description": "The start of the period for which this transaction paid interest."
}
}
},
"internal_source": {
"type": "object",
"description": "A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.",
"required": [
"amount",
"currency",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
},
"currency": {
"type": "string",
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.",
"enum": [
"CAD",
"CHF",
"EUR",
"GBP",
"JPY",
"USD"
]
},
"reason": {
"type": "string",
"enum": [
"bank_migration",
"cashback",
"empyreal_adjustment",
"error",
"error_correction",
"fees",
"interest",
"sample_funds",
"sample_funds_return"
]
}
}
},
"sample_funds": {
"type": "object",
"description": "A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.",
"required": [
"originator"
],
"properties": {
"originator": {
"type": "string",
"description": "Where the sample funds came from."
}
}
},
"wire_drawdown_payment_intention": {
"type": "object",
"description": "A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`.",
"required": [
"account_number",
"amount",
"message_to_recipient",
"routing_number",
"transfer_id"
],
"properties": {
"account_number": {
"type": "string"
},
"amount": {
"type": "integer",
"description": "The transfer amount in USD cents."
},
"message_to_recipient": {
"type": "string"
},
"routing_number": {
"type": "string"
},
"transfer_id": {
"type": "string"
}
}
},
"wire_drawdown_payment_rejection": {
"type": "object",
"description": "A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`.",
"required": [
"transfer_id"
],
"properties": {
"transfer_id": {
"type": "string"
}
}
},
"wire_transfer_intention": {
"type": "object",
"description": "A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.",
"required": [
"account_number",
"amount",
"message_to_recipient",
"routing_number",
"transfer_id"
],
"properties": {
"account_number": {
"type": "string",
"description": "The destination account number."
},
"amount": {
"type": "integer",
"description": "The transfer amount in USD cents."
},
"message_to_recipient": {
"type": "string",
"description": "The message that will show on the recipient's bank statement."
},
"routing_number": {
"type": "string",
"description": "The American Bankers' Association (ABA) Routing Transit Number (RTN)."
},
"transfer_id": {
"type": "string"
}
}
},
"wire_transfer_rejection": {
"type": "object",
"description": "A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.",
"required": [
"transfer_id"
],
"properties": {
"transfer_id": {
"type": "string"
}
}
}
}
},
"type": {
"type": "string",
"description": "A constant representing the object's type. For this resource it will always be `transaction`.",
"enum": [
"transaction"
]
}
}
},
"type": {
"type": "string",
"description": "A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer_simulation_result`.",
"enum": [
"inbound_real_time_payments_transfer_simulation_result"
]
}
}
}