Skip to content

chore: update bank endpoints examples and descriptions #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damilola-paystack merged 1 commit into from
Oct 24, 2025
Merged

chore: update bank endpoints examples and descriptions #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 76 additions & 4 deletions dist/paystack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3710,7 +3710,7 @@
default:
description: Server error
/storefront:
post:

Check warning on line 3713 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Create Storefront
Expand All @@ -3730,7 +3730,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3733 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: List Storefronts
Expand Down Expand Up @@ -3767,7 +3767,7 @@
required: true
schema:
type: string
get:

Check warning on line 3770 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Fetch Storefront
Expand All @@ -3781,7 +3781,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3784 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Update Storefront
Expand All @@ -3803,7 +3803,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3806 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Delete Storefront
Expand All @@ -3824,7 +3824,7 @@
required: true
schema:
type: string
get:

Check warning on line 3827 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Verify Storefront Slug
Expand Down Expand Up @@ -3866,7 +3866,7 @@
required: true
schema:
type: string
post:

Check warning on line 3869 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Add Products to Storefront
Expand All @@ -3888,7 +3888,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
get:

Check warning on line 3891 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: List Products in Storefront
Expand All @@ -3909,7 +3909,7 @@
required: true
schema:
type: string
post:

Check warning on line 3912 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Publish Storefront
Expand All @@ -3930,7 +3930,7 @@
required: true
schema:
type: string
post:

Check warning on line 3933 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Duplicate Storefront
Expand All @@ -3945,7 +3945,7 @@
default:
description: Server error
/order:
post:

Check warning on line 3948 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Create Order
Expand All @@ -3965,7 +3965,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3968 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: List Orders
Expand Down Expand Up @@ -4009,7 +4009,7 @@
required: true
schema:
type: string
get:

Check warning on line 4012 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Fetch Order
Expand All @@ -4030,7 +4030,7 @@
required: true
schema:
type: string
get:

Check warning on line 4033 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Fetch Products Order
Expand All @@ -4051,7 +4051,7 @@
required: true
schema:
type: string
get:

Check warning on line 4054 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Validate pay for me order
Expand All @@ -4066,7 +4066,7 @@
default:
description: Server error
/page:
post:

Check warning on line 4069 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Create Page
Expand All @@ -4086,7 +4086,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4089 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: List Pages
Expand Down Expand Up @@ -4130,7 +4130,7 @@
required: true
schema:
type: string
get:

Check warning on line 4133 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Fetch Page
Expand All @@ -4144,7 +4144,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4147 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Update Page
Expand Down Expand Up @@ -4173,7 +4173,7 @@
required: true
schema:
type: string
get:

Check warning on line 4176 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Check Slug Availability
Expand All @@ -4194,7 +4194,7 @@
required: true
schema:
type: string
post:

Check warning on line 4197 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Add Products
Expand All @@ -4215,7 +4215,7 @@
default:
description: Server error
/settlement:
get:

Check warning on line 4218 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Settlement
summary: Fetch Settlements
Expand All @@ -4241,7 +4241,7 @@
default:
description: Server error
/settlement/{id}/transaction:
get:

Check warning on line 4244 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Settlement
summary: Settlement Transactions
Expand All @@ -4262,7 +4262,7 @@
default:
description: Server error
/integration/payment_session_timeout:
get:

Check warning on line 4265 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Integration
summary: Fetch Payment Session Timeout
Expand All @@ -4280,7 +4280,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4283 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Integration
summary: Update Payment Session Timeout
Expand All @@ -4304,7 +4304,7 @@
default:
description: Server error
/refund:
post:

Check warning on line 4307 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: Create Refund
Expand All @@ -4324,7 +4324,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4327 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: List Refunds
Expand Down Expand Up @@ -4362,7 +4362,7 @@
default:
description: Server error
/refund/{id}:
get:

Check warning on line 4365 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: Fetch Refund
Expand All @@ -4383,7 +4383,7 @@
default:
description: Server error
/dispute:
get:

Check warning on line 4386 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: List Disputes
Expand Down Expand Up @@ -4438,7 +4438,7 @@
required: true
schema:
type: string
get:

Check warning on line 4441 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Fetch Dispute
Expand All @@ -4452,7 +4452,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4455 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Update Dispute
Expand All @@ -4475,7 +4475,7 @@
default:
description: Server error
/dispute/{id}/upload_url:
get:

Check warning on line 4478 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Get Upload URL
Expand All @@ -4497,7 +4497,7 @@
default:
description: Server error
/dispute/export:
get:

Check warning on line 4500 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Export Disputes
Expand Down Expand Up @@ -4539,7 +4539,7 @@
default:
description: Server error
/dispute/transaction/{id}:
get:

Check warning on line 4542 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: List Transaction Disputes
Expand All @@ -4561,7 +4561,7 @@
default:
description: Server error
/dispute/{id}/resolve:
put:

Check warning on line 4564 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Resolve a Dispute
Expand Down Expand Up @@ -4591,7 +4591,7 @@
default:
description: Server error
/dispute/{id}/evidence:
post:

Check warning on line 4594 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Add Evidence
Expand Down Expand Up @@ -4623,43 +4623,103 @@
tags:
- Bank
summary: List Banks
description: List banks supported on Paystack
operationId: bank_list
parameters:
- in: query
name: country
description: |
The country from which to obtain the list of supported banks.
description: The country from which to obtain the list of supported banks
schema:
type: string
enum:
- ghana
- kenya
- nigeria
- south africa
example: nigeria
- in: query
name: pay_with_bank_transfer
name: currency
description: The country from which to obtain the list of supported banks
schema:
type: boolean
type: string
enum:
- GHS
- KES
- NGN
- ZAR
example: NGN
- in: query
name: use_cursor
description: A flag to indicate if cursor based pagination should be used
schema:
type: boolean
- in: query
name: perPage
description: The number of records to fetch per request
schema:
type: integer
- name: page
in: query
description: The offset to retrieve data from
schema:
type: integer
- in: query
name: next
description: |
An alphanumeric value returned for every cursor based retrieval, used to
retrieve the next set of data
schema:
type: string
- in: query
name: previous
description: |
An alphanumeric value returned for every cursor based retrieval, used to
retrieve the previous set of data
schema:
type: string
- in: query
name: pay_with_bank_transfer
description: A flag to filter for available banks a customer can make a transfer to complete a payment
schema:
type: boolean
- in: query
name: pay_with_bank
description: A flag to filter for banks a customer can pay directly from
schema:
type: boolean
- in: query
name: enabled_for_verification
description: |
A flag to filter the banks that are supported for account verification in South Africa.
You need to combine this with either the `currency` or `country` filter.
schema:
type: boolean
- in: query
name: gateway
description: The type of gateway for a Nigerian bank
schema:
type: string
enum:
- emandate
- digitalbankmandate
- in: query
name: type
description: Type of financial channel
schema:
type: string
enum:
- ghipps
- mobile_money
- nuban
- kepss
- basa
- in: query
name: include_nip_sort_code
description: |
A flag that returns Nigerian banks with their NIP institution code.
The returned value can be used in identifying institutions on NIP.
schema:
type: boolean
responses:
'200':
$ref: '#/components/responses/MiscellaneousListBanksSuccess'
Expand All @@ -4674,14 +4734,17 @@
tags:
- Bank
summary: Resolve Account Number
description: Resolve an account number to confirm the name associated with it
operationId: bank_resolveAccountNumber
parameters:
- name: account_number
description: The account number of interest
in: query
schema:
type: integer
example: 22728151
- name: bank_code
description: The bank code associated with the account number
in: query
schema:
type: integer
Expand All @@ -4700,6 +4763,7 @@
tags:
- Bank
summary: Validate Bank Account
description: Confirm the authenticity of a customer's account number before sending money
operationId: bank_validateAccountNumber
requestBody:
content:
Expand Down Expand Up @@ -17956,6 +18020,14 @@
document_number:
description: Customer’s mode of identity number
type: string
example:
account_name: Ann Bron
account_number: '0123456789'
account_type: personal
bank_code: '632005'
country_code: ZA
document_type: identityNumber
document_number: '1234567890123'
VerificationValidateAccountResponse:
type: object
properties:
Expand Down
8 changes: 8 additions & 0 deletions src/assets/openapi/components/schemas/BankValidateRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,11 @@ properties:
document_number:
description: Customer’s mode of identity number
type: string
example:
account_name: Ann Bron
account_number: '0123456789'
account_type: personal
bank_code: '632005'
country_code: ZA
document_type: identityNumber
document_number: '1234567890123'
68 changes: 64 additions & 4 deletions src/assets/openapi/paths/bank.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,103 @@ get:
tags:
- Bank
summary: List Banks
description: List banks supported on Paystack
operationId: bank_list
parameters:
- in: query
name: country
description: |
The country from which to obtain the list of supported banks.
description: The country from which to obtain the list of supported banks
schema:
type: string
enum:
- ghana
- kenya
- nigeria
- south africa
example: nigeria
- in: query
name: pay_with_bank_transfer
name: currency
description: The country from which to obtain the list of supported banks
schema:
type: boolean
type: string
enum:
- GHS
- KES
- NGN
- ZAR
example: NGN
- in: query
name: use_cursor
description: A flag to indicate if cursor based pagination should be used
schema:
type: boolean
- in: query
name: perPage
description: The number of records to fetch per request
schema:
type: integer
- name: page
in: query
description: The offset to retrieve data from
schema:
type: integer
- in: query
name: next
description: |
An alphanumeric value returned for every cursor based retrieval, used to
retrieve the next set of data
schema:
type: string
- in: query
name: previous
description: |
An alphanumeric value returned for every cursor based retrieval, used to
retrieve the previous set of data
schema:
type: string
- in: query
name: pay_with_bank_transfer
description: A flag to filter for available banks a customer can make a transfer to complete a payment
schema:
type: boolean
- in: query
name: pay_with_bank
description: A flag to filter for banks a customer can pay directly from
schema:
type: boolean
- in: query
name: enabled_for_verification
description: |
A flag to filter the banks that are supported for account verification in South Africa.
You need to combine this with either the `currency` or `country` filter.
schema:
type: boolean
- in: query
name: gateway
description: The type of gateway for a Nigerian bank
schema:
type: string
enum:
- emandate
- digitalbankmandate
- in: query
name: type
description: Type of financial channel
schema:
type: string
enum:
- ghipps
- mobile_money
- nuban
- kepss
- basa
- in: query
name: include_nip_sort_code
description: |
A flag that returns Nigerian banks with their NIP institution code.
The returned value can be used in identifying institutions on NIP.
schema:
type: boolean
responses:
'200':
$ref: ../components/responses/MiscellaneousListBanksSuccess.yaml
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/paths/bank_resolve.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@ get:
tags:
- Bank
summary: Resolve Account Number
description: Resolve an account number to confirm the name associated with it
operationId: bank_resolveAccountNumber
parameters:
- name: account_number
description: The account number of interest
in: query
schema:
type: integer
example: 22728151
- name: bank_code
description: The bank code associated with the account number
in: query
schema:
type: integer
Expand Down
1 change: 1 addition & 0 deletions src/assets/openapi/paths/bank_validate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Bank
summary: Validate Bank Account
description: Confirm the authenticity of a customer's account number before sending money
operationId: bank_validateAccountNumber
requestBody:
content:
Expand Down
Loading