Skip to content

Commit c6801f0

Browse files
chore: update subaccount examples and descriptions
1 parent 86435f5 commit c6801f0

5 files changed

Lines changed: 36 additions & 6 deletions

File tree

dist/paystack.yaml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1914,6 +1914,7 @@ paths:
19141914
- Subaccount
19151915
summary: Create Subaccount
19161916
operationId: subaccount_create
1917+
description: Create a subacount for a partner
19171918
requestBody:
19181919
content:
19191920
application/json:
@@ -1938,22 +1939,25 @@ paths:
19381939
- Subaccount
19391940
summary: List Subaccounts
19401941
operationId: subaccount_list
1942+
description: List subaccounts available on your integration
19411943
parameters:
19421944
- in: query
19431945
name: perPage
1946+
description: Number of records to fetch per request
19441947
schema:
19451948
type: integer
1946-
description: Number of records to fetch per request
1949+
default: 50
19471950
- in: query
19481951
name: page
1952+
description: The offset to retrieve data from
19491953
schema:
19501954
type: integer
1951-
description: The offset to retrieve data from
1955+
default: 1
19521956
- in: query
19531957
name: active
1958+
description: Filter by the state of the subaccounts
19541959
schema:
19551960
type: boolean
1956-
description: Filter by active or inactive subaccounts
19571961
responses:
19581962
'200':
19591963
description: ''
@@ -1971,14 +1975,17 @@ paths:
19711975
parameters:
19721976
- name: code
19731977
in: path
1978+
description: The subaccount code you want to fetch
19741979
required: true
19751980
schema:
19761981
type: string
1982+
example: ACCT_6uujpqtzmnufzkw
19771983
get:
19781984
tags:
19791985
- Subaccount
19801986
summary: Fetch Subaccount
19811987
operationId: subaccount_fetch
1988+
description: Get details of a subaccount on your integration
19821989
responses:
19831990
'200':
19841991
description: ''
@@ -1997,6 +2004,7 @@ paths:
19972004
- Subaccount
19982005
summary: Update Subaccount
19992006
operationId: subaccount_update
2007+
description: Update a subaccount details on your integration
20002008
requestBody:
20012009
content:
20022010
application/json:
@@ -8846,6 +8854,11 @@ components:
88468854
metadata:
88478855
description: Stringified JSON object of custom data
88488856
type: string
8857+
example:
8858+
business_name: Oasis
8859+
account_number: '0123456047'
8860+
settlement_bank: '058'
8861+
percentage_charge: 30
88498862
SubaccountCreateResponse:
88508863
type: object
88518864
properties:
@@ -9054,6 +9067,8 @@ components:
90549067
metadata:
90559068
description: Stringified JSON object of custom data
90569069
type: string
9070+
example:
9071+
business_name: Sandalwood
90579072
SubaccountUpdateResponse:
90589073
type: object
90599074
properties:

src/assets/openapi/components/schemas/SubaccountCreate.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,8 @@ properties:
3535
metadata:
3636
description: Stringified JSON object of custom data
3737
type: string
38+
example:
39+
business_name: "Oasis"
40+
account_number: "0123456047"
41+
settlement_bank: "058"
42+
percentage_charge: 30

src/assets/openapi/components/schemas/SubaccountUpdate.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,5 @@ properties:
3333
metadata:
3434
description: Stringified JSON object of custom data
3535
type: string
36+
example:
37+
business_name: "Sandalwood"

src/assets/openapi/paths/subaccount.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ post:
33
- Subaccount
44
summary: Create Subaccount
55
operationId: subaccount_create
6+
description: Create a subacount for a partner
67
requestBody:
78
content:
89
application/json:
@@ -27,22 +28,25 @@ get:
2728
- Subaccount
2829
summary: List Subaccounts
2930
operationId: subaccount_list
31+
description: List subaccounts available on your integration
3032
parameters:
3133
- in: query
3234
name: perPage
35+
description: Number of records to fetch per request
3336
schema:
3437
type: integer
35-
description: Number of records to fetch per request
38+
default: 50
3639
- in: query
3740
name: page
41+
description: The offset to retrieve data from
3842
schema:
3943
type: integer
40-
description: The offset to retrieve data from
44+
default: 1
4145
- in: query
4246
name: active
47+
description: Filter by the state of the subaccounts
4348
schema:
4449
type: boolean
45-
description: Filter by active or inactive subaccounts
4650
responses:
4751
'200':
4852
description: ''

src/assets/openapi/paths/subaccount_{code}.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
parameters:
22
- name: code
33
in: path
4+
description: The subaccount code you want to fetch
45
required: true
56
schema:
67
type: string
8+
example: "ACCT_6uujpqtzmnufzkw"
79
get:
810
tags:
911
- Subaccount
1012
summary: Fetch Subaccount
1113
operationId: subaccount_fetch
14+
description: Get details of a subaccount on your integration
1215
responses:
1316
'200':
1417
description: ''
@@ -27,6 +30,7 @@ put:
2730
- Subaccount
2831
summary: Update Subaccount
2932
operationId: subaccount_update
33+
description: Update a subaccount details on your integration
3034
requestBody:
3135
content:
3236
application/json:

0 commit comments

Comments
 (0)