Skip to content

Commit ce17410

Browse files
YegorZhYegorZh
committed
fix: minor simulation, cash deposit and payment fixes
1 parent b9046e9 commit ce17410

File tree

9 files changed

+133
-59
lines changed

9 files changed

+133
-59
lines changed

‎openapi.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,15 @@
110110
"/payments/{paymentId}/cancel": {
111111
"$ref": "./schemas/payment/paymentsPaths.json#/cancelPayment"
112112
},
113+
"/store-locations": {
114+
"$ref": "./schemas/cash-deposit/cashDepositPaths.json#/listCashDepositStoreLocations"
115+
},
116+
"/cash-deposits/barcodes": {
117+
"$ref": "./schemas/cash-deposit/cashDepositPaths.json#/generateBarcode"
118+
},
119+
"/cash-deposits/barcodes/{barcodeNumber}/image": {
120+
"$ref": "./schemas/cash-deposit/cashDepositPaths.json#/getBarcodeImage"
121+
},
113122
"/received-payments": {
114123
"$ref": "./schemas/payment/paymentsPaths.json#/listReceivedPayments"
115124
},
@@ -346,6 +355,9 @@
346355
},
347356
"/sandbox/received-payments": {
348357
"$ref": "./schemas/simulation/simulationPaths.json#/receivedPaymentTransaction"
358+
},
359+
"/sandbox/received-ach-payment": {
360+
"$ref": "./schemas/simulation/simulationPaths.json#/createIncomingAchPayment"
349361
}
350362
},
351363
"components": {

‎schemas/cash-deposit/cashDepositBarcode.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"additionalProperties": false
4545
},
4646
"relationships": {
47-
"$ref": "#/components/schemas/FeeRelationships"
47+
"$ref": "#/components/schemas/CashDepositBarcodeRelationships"
4848
}
4949
},
5050
"required": ["type", "attributes", "relationships"]

‎schemas/cash-deposit/cashDepositPaths.json‎

Lines changed: 10 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"data": {
88
"type": "array",
99
"items": {
10-
"$ref": "./storeLocation.json#/schemas/components/StoreLocation"
10+
"$ref": "./storeLocation.json#/components/schemas/StoreLocation"
1111
}
1212
},
1313
"meta": {
@@ -20,7 +20,7 @@
2020
"generateBarcode": {
2121
"post": {
2222
"tags": ["unit"],
23-
"operationId": "createFee",
23+
"operationId": "generateBarcode",
2424
"summary": "Generate Cash Deposit Barcode",
2525
"description": "Generate Cash Deposit Barcode via API ",
2626
"requestBody": {
@@ -54,57 +54,13 @@
5454
}
5555
}
5656
},
57-
"listByCoordinates": {
57+
"listCashDepositStoreLocations": {
5858
"get": {
5959
"tags": ["unit"],
60-
"operationId": "getCashDepositStoreLocationsListByCoordinates",
60+
"operationId": "getCashDepositStoreLocationsList",
6161

6262
"summary": "Get Cash Deposit Store Locations List By Coordinates",
6363
"description": "Get Cash Deposit Store Locations List By Coordinates from API ",
64-
"parameters": [
65-
{
66-
"$ref": "../types.json#/components/schemas/PageQuery"
67-
},
68-
{
69-
"name": "filter",
70-
"in": "query",
71-
"style": "deepObject",
72-
"allowReserved": true,
73-
"schema": {
74-
"type": "object",
75-
"properties": {
76-
"coordinates": {
77-
"$ref": "../types.json#/components/schemas/Coordinates"
78-
},
79-
"serviceType": {
80-
"type": "string",
81-
"enum": ["Swipe", "Barcode"]
82-
}
83-
}
84-
}
85-
}
86-
],
87-
"responses": {
88-
"200": {
89-
"description": "Successful Response",
90-
"content": {
91-
"application/vnd.api+json; charset=utf-8": {
92-
"schema": {
93-
"$ref": "#/components/schemas/UnitStoreLocationsListResponse"
94-
}
95-
}
96-
}
97-
}
98-
}
99-
}
100-
},
101-
"listByPostalCode": {
102-
"get": {
103-
"tags": ["unit"],
104-
"operationId": "getCashDepositStoreLocationsListByPostalCode",
105-
106-
"summary": "Get Cash Deposit Store Locations List By Postal Code",
107-
"description": "Get Cash Deposit Store Locations List By Postal Code from API ",
10864
"parameters": [
10965
{
11066
"$ref": "../types.json#/components/schemas/PageQuery"
@@ -120,11 +76,15 @@
12076
"postalCode": {
12177
"type": "string"
12278
},
79+
"coordinates": {
80+
"$ref": "../types.json#/components/schemas/Coordinates"
81+
},
12382
"serviceType": {
12483
"type": "string",
12584
"enum": ["Swipe", "Barcode"]
12685
}
127-
}
86+
},
87+
"required": ["serviceType"]
12888
}
12989
}
13090
],
@@ -150,12 +110,9 @@
150110
"summary": "Get Barcode Image By Barcode Number",
151111
"description": "Get Barcode Image By Barcode Number from API ",
152112
"parameters": [
153-
{
154-
"$ref": "../types.json#/components/schemas/PageQuery"
155-
},
156113
{
157114
"name": "barcodeNumber",
158-
"in": "query",
115+
"in": "path",
159116
"required": true,
160117
"schema": {
161118
"type": "string"

‎schemas/cash-deposit/generateBarcode.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"type": "object",
3131
"properties": {
3232
"storeId": {
33-
"type": "integer"
33+
"type": "string"
3434
}
3535
},
3636
"required": ["storeId"]

‎schemas/cash-deposit/storeLocation.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"type": "string"
2121
},
2222
"phone": {
23-
"$ref": "../types.json#/components/schemas/Phone"
23+
"type": "string"
2424
},
2525
"address": {
2626
"$ref": "../types.json#/components/schemas/Address"

‎schemas/payment/receivedPayment.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@
5050
"enum": [
5151
"Pending",
5252
"Advanced",
53-
"Completed",
54-
"Returned"
53+
"PendingReview",
54+
"MarkedForReturn",
55+
"Returned",
56+
"Completed"
5557
]
5658
},
5759
"amount": {

‎schemas/simulation/payment/createACHReceivedPaymentTransaction.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
"type": "integer"
3131
},
3232
"completionDate": {
33-
"type": "date"
33+
"type": "string",
34+
"format": "date"
3435
},
3536
"description": {
3637
"type": "string",

‎schemas/simulation/payment/createIncomingAchPayment.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"components": {
3+
"schemas": {
4+
"CreateIncomingAchPaymentTransactionRelationships": {
5+
"allOf": [
6+
{
7+
"title": "Create ACH Received Payment Transaction Relationships",
8+
"required": ["account"]
9+
},
10+
{
11+
"$ref": "../../relationships.json#/components/schemas/AccountRelationship"
12+
}
13+
]
14+
},
15+
"CreateIncomingAchPaymentRequest": {
16+
"type": "object",
17+
"properties": {
18+
"data": {
19+
"type": "object",
20+
"properties": {
21+
"type": {
22+
"type": "string",
23+
"enum": ["achReceivedPayment"],
24+
"default": "achReceivedPayment"
25+
},
26+
"attributes": {
27+
"type": "object",
28+
"properties": {
29+
"amount": {
30+
"type": "integer"
31+
},
32+
"settlementDate": {
33+
"type": "string",
34+
"format": "date"
35+
},
36+
"companyName": {
37+
"type": "string",
38+
"maxLength": 16
39+
},
40+
"receivingEntityName": {
41+
"type": "string",
42+
"maxLength": 16
43+
},
44+
"secCode": {
45+
"type": "string",
46+
"maxLength": 3
47+
},
48+
"direction": {
49+
"type": "string",
50+
"enum": ["Debit", "Credit"]
51+
}
52+
},
53+
"required": [
54+
"amount",
55+
"settlementDate",
56+
"companyName"
57+
]
58+
},
59+
"relationships": {
60+
"$ref": "#/components/schemas/CreateIncomingAchPaymentTransactionRelationships"
61+
}
62+
},
63+
"required": ["type", "attributes", "relationships"]
64+
}
65+
},
66+
"required": ["data"]
67+
}
68+
}
69+
}
70+
}

‎schemas/simulation/simulationPaths.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,37 @@
8686
}
8787
}
8888
}
89+
},
90+
"createIncomingAchPayment": {
91+
"post": {
92+
"tags": ["unit"],
93+
"operationId": "createIncomingAchPaymentSimulation",
94+
95+
"summary": "Create Incoming ACH Payment Simulation",
96+
"description": "Create Incoming ACH Payment Simulation via API ",
97+
"requestBody": {
98+
"description": "Create Incoming ACH Payment Simulation Request",
99+
"required": true,
100+
"content": {
101+
"application/vnd.api+json": {
102+
"schema": {
103+
"$ref": "./payment/createIncomingAchPayment.json#/components/schemas/CreateIncomingAchPaymentRequest"
104+
}
105+
}
106+
}
107+
},
108+
"responses": {
109+
"201": {
110+
"description": "Successful Response",
111+
"content": {
112+
"application/vnd.api+json": {
113+
"schema": {
114+
"$ref": "../payment/paymentsPaths.json#/components/schemas/UnitReceivedPaymentResponse"
115+
}
116+
}
117+
}
118+
}
119+
}
120+
}
89121
}
90122
}

0 commit comments

Comments
 (0)