Skip to content

Commit 70e837d

Browse files
damilola-paystackdamilola-paystack
authored
Merge pull request #59 from PaystackOSS/patch-bank
chore: update bank endpoints examples and descriptions
2 parents 4415dd2 + c97bd34 commit 70e837d

5 files changed

Lines changed: 152 additions & 8 deletions

File tree

‎dist/paystack.yaml‎

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4623,43 +4623,103 @@ paths:
46234623
tags:
46244624
- Bank
46254625
summary: List Banks
4626+
description: List banks supported on Paystack
46264627
operationId: bank_list
46274628
parameters:
46284629
- in: query
46294630
name: country
4630-
description: |
4631-
The country from which to obtain the list of supported banks.
4631+
description: The country from which to obtain the list of supported banks
46324632
schema:
46334633
type: string
46344634
enum:
46354635
- ghana
46364636
- kenya
46374637
- nigeria
46384638
- south africa
4639+
example: nigeria
46394640
- in: query
4640-
name: pay_with_bank_transfer
4641+
name: currency
4642+
description: The country from which to obtain the list of supported banks
46414643
schema:
4642-
type: boolean
4644+
type: string
4645+
enum:
4646+
- GHS
4647+
- KES
4648+
- NGN
4649+
- ZAR
4650+
example: NGN
46434651
- in: query
46444652
name: use_cursor
4653+
description: A flag to indicate if cursor based pagination should be used
46454654
schema:
46464655
type: boolean
46474656
- in: query
46484657
name: perPage
4658+
description: The number of records to fetch per request
4659+
schema:
4660+
type: integer
4661+
- name: page
4662+
in: query
4663+
description: The offset to retrieve data from
46494664
schema:
46504665
type: integer
46514666
- in: query
46524667
name: next
4668+
description: |
4669+
An alphanumeric value returned for every cursor based retrieval, used to
4670+
retrieve the next set of data
46534671
schema:
46544672
type: string
46554673
- in: query
46564674
name: previous
4675+
description: |
4676+
An alphanumeric value returned for every cursor based retrieval, used to
4677+
retrieve the previous set of data
46574678
schema:
46584679
type: string
4680+
- in: query
4681+
name: pay_with_bank_transfer
4682+
description: A flag to filter for available banks a customer can make a transfer to complete a payment
4683+
schema:
4684+
type: boolean
4685+
- in: query
4686+
name: pay_with_bank
4687+
description: A flag to filter for banks a customer can pay directly from
4688+
schema:
4689+
type: boolean
4690+
- in: query
4691+
name: enabled_for_verification
4692+
description: |
4693+
A flag to filter the banks that are supported for account verification in South Africa.
4694+
You need to combine this with either the `currency` or `country` filter.
4695+
schema:
4696+
type: boolean
46594697
- in: query
46604698
name: gateway
4699+
description: The type of gateway for a Nigerian bank
4700+
schema:
4701+
type: string
4702+
enum:
4703+
- emandate
4704+
- digitalbankmandate
4705+
- in: query
4706+
name: type
4707+
description: Type of financial channel
46614708
schema:
46624709
type: string
4710+
enum:
4711+
- ghipps
4712+
- mobile_money
4713+
- nuban
4714+
- kepss
4715+
- basa
4716+
- in: query
4717+
name: include_nip_sort_code
4718+
description: |
4719+
A flag that returns Nigerian banks with their NIP institution code.
4720+
The returned value can be used in identifying institutions on NIP.
4721+
schema:
4722+
type: boolean
46634723
responses:
46644724
'200':
46654725
$ref: '#/components/responses/MiscellaneousListBanksSuccess'
@@ -4674,14 +4734,17 @@ paths:
46744734
tags:
46754735
- Bank
46764736
summary: Resolve Account Number
4737+
description: Resolve an account number to confirm the name associated with it
46774738
operationId: bank_resolveAccountNumber
46784739
parameters:
46794740
- name: account_number
4741+
description: The account number of interest
46804742
in: query
46814743
schema:
46824744
type: integer
46834745
example: 22728151
46844746
- name: bank_code
4747+
description: The bank code associated with the account number
46854748
in: query
46864749
schema:
46874750
type: integer
@@ -4700,6 +4763,7 @@ paths:
47004763
tags:
47014764
- Bank
47024765
summary: Validate Bank Account
4766+
description: Confirm the authenticity of a customer's account number before sending money
47034767
operationId: bank_validateAccountNumber
47044768
requestBody:
47054769
content:
@@ -17956,6 +18020,14 @@ components:
1795618020
document_number:
1795718021
description: Customer’s mode of identity number
1795818022
type: string
18023+
example:
18024+
account_name: Ann Bron
18025+
account_number: '0123456789'
18026+
account_type: personal
18027+
bank_code: '632005'
18028+
country_code: ZA
18029+
document_type: identityNumber
18030+
document_number: '1234567890123'
1795918031
VerificationValidateAccountResponse:
1796018032
type: object
1796118033
properties:

‎src/assets/openapi/components/schemas/BankValidateRequest.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,11 @@ properties:
3737
document_number:
3838
description: Customer’s mode of identity number
3939
type: string
40+
example:
41+
account_name: Ann Bron
42+
account_number: '0123456789'
43+
account_type: personal
44+
bank_code: '632005'
45+
country_code: ZA
46+
document_type: identityNumber
47+
document_number: '1234567890123'

‎src/assets/openapi/paths/bank.yaml‎

Lines changed: 64 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,103 @@ get:
22
tags:
33
- Bank
44
summary: List Banks
5+
description: List banks supported on Paystack
56
operationId: bank_list
67
parameters:
78
- in: query
89
name: country
9-
description: |
10-
The country from which to obtain the list of supported banks.
10+
description: The country from which to obtain the list of supported banks
1111
schema:
1212
type: string
1313
enum:
1414
- ghana
1515
- kenya
1616
- nigeria
1717
- south africa
18+
example: nigeria
1819
- in: query
19-
name: pay_with_bank_transfer
20+
name: currency
21+
description: The country from which to obtain the list of supported banks
2022
schema:
21-
type: boolean
23+
type: string
24+
enum:
25+
- GHS
26+
- KES
27+
- NGN
28+
- ZAR
29+
example: NGN
2230
- in: query
2331
name: use_cursor
32+
description: A flag to indicate if cursor based pagination should be used
2433
schema:
2534
type: boolean
2635
- in: query
2736
name: perPage
37+
description: The number of records to fetch per request
38+
schema:
39+
type: integer
40+
- name: page
41+
in: query
42+
description: The offset to retrieve data from
2843
schema:
2944
type: integer
3045
- in: query
3146
name: next
47+
description: |
48+
An alphanumeric value returned for every cursor based retrieval, used to
49+
retrieve the next set of data
3250
schema:
3351
type: string
3452
- in: query
3553
name: previous
54+
description: |
55+
An alphanumeric value returned for every cursor based retrieval, used to
56+
retrieve the previous set of data
3657
schema:
3758
type: string
59+
- in: query
60+
name: pay_with_bank_transfer
61+
description: A flag to filter for available banks a customer can make a transfer to complete a payment
62+
schema:
63+
type: boolean
64+
- in: query
65+
name: pay_with_bank
66+
description: A flag to filter for banks a customer can pay directly from
67+
schema:
68+
type: boolean
69+
- in: query
70+
name: enabled_for_verification
71+
description: |
72+
A flag to filter the banks that are supported for account verification in South Africa.
73+
You need to combine this with either the `currency` or `country` filter.
74+
schema:
75+
type: boolean
3876
- in: query
3977
name: gateway
78+
description: The type of gateway for a Nigerian bank
79+
schema:
80+
type: string
81+
enum:
82+
- emandate
83+
- digitalbankmandate
84+
- in: query
85+
name: type
86+
description: Type of financial channel
4087
schema:
4188
type: string
89+
enum:
90+
- ghipps
91+
- mobile_money
92+
- nuban
93+
- kepss
94+
- basa
95+
- in: query
96+
name: include_nip_sort_code
97+
description: |
98+
A flag that returns Nigerian banks with their NIP institution code.
99+
The returned value can be used in identifying institutions on NIP.
100+
schema:
101+
type: boolean
42102
responses:
43103
'200':
44104
$ref: ../components/responses/MiscellaneousListBanksSuccess.yaml

‎src/assets/openapi/paths/bank_resolve.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@ get:
22
tags:
33
- Bank
44
summary: Resolve Account Number
5+
description: Resolve an account number to confirm the name associated with it
56
operationId: bank_resolveAccountNumber
67
parameters:
78
- name: account_number
9+
description: The account number of interest
810
in: query
911
schema:
1012
type: integer
1113
example: 22728151
1214
- name: bank_code
15+
description: The bank code associated with the account number
1316
in: query
1417
schema:
1518
type: integer

‎src/assets/openapi/paths/bank_validate.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ post:
22
tags:
33
- Bank
44
summary: Validate Bank Account
5+
description: Confirm the authenticity of a customer's account number before sending money
56
operationId: bank_validateAccountNumber
67
requestBody:
78
content:

0 commit comments

Comments
 (0)