Skip to content

chore: update transfer recipient examples and descriptions #54

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
Sep 11, 2025
Merged

chore: update transfer recipient examples and descriptions #54

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
32 changes: 25 additions & 7 deletions dist/paystack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2756,6 +2756,7 @@
tags:
- Transfer Recipient
summary: Create Transfer Recipient
description: Creates a new recipient. A duplicate account number will lead to the retrieval of the existing record.
operationId: transferrecipient_create
requestBody:
content:
Expand All @@ -2780,6 +2781,7 @@
tags:
- Transfer Recipient
summary: List Transfer Recipients
description: List transfer recipients available on your integration
operationId: transferrecipient_list
parameters:
- in: query
Expand Down Expand Up @@ -2827,6 +2829,8 @@
tags:
- Transfer Recipient
summary: Bulk Create Transfer Recipient
description: |
Create multiple transfer recipients in batches. A duplicate account number will lead to the retrieval of the existing record.
operationId: transferrecipient_bulk
requestBody:
content:
Expand All @@ -2838,7 +2842,7 @@
$ref: '#/components/schemas/TransferRecipientBulk'
responses:
'200':
description: ''
description: Sucessful response
content:
application/json:
schema:
Expand All @@ -2855,14 +2859,16 @@
required: true
schema:
type: string
example: RCP_5ap8rcimmcj8lbi
get:
tags:
- Transfer Recipient
summary: Fetch Transfer recipient
description: Fetch the details of a transfer recipient
operationId: transferrecipient_fetch
responses:
'200':
description: ''
description: Successful response
content:
application/json:
schema:
Expand All @@ -2876,7 +2882,8 @@
put:
tags:
- Transfer Recipient
summary: Update Transfer recipient
summary: Update Transfer Recipient
description: Update the details of a transfer recipient
operationId: transferrecipient_update
requestBody:
content:
Expand All @@ -2888,7 +2895,7 @@
$ref: '#/components/schemas/TransferRecipientUpdate'
responses:
'200':
description: ''
description: Successful response
content:
application/json:
schema:
Expand All @@ -2903,10 +2910,11 @@
tags:
- Transfer Recipient
summary: Delete Transfer Recipient
description: Delete a transfer recipient (sets the transfer recipient to inactive)
operationId: transferrecipient_delete
responses:
'200':
description: ''
description: Successful response
content:
application/json:
schema:
Expand All @@ -2918,7 +2926,7 @@
default:
description: Server error
/transfer:
post:

Check warning on line 2929 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:
- Transfer
summary: Initiate Transfer
Expand All @@ -2942,7 +2950,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 2953 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:
- Transfer
summary: List Transfers
Expand Down Expand Up @@ -3022,7 +3030,7 @@
default:
description: Server error
/transfer/finalize_transfer:
post:

Check warning on line 3033 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:
- Transfer
summary: Finalize Transfer
Expand All @@ -3043,7 +3051,7 @@
default:
description: Server error
/transfer/bulk:
post:

Check warning on line 3054 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:
- Transfer
summary: Initiate Bulk Transfer
Expand Down Expand Up @@ -3075,7 +3083,7 @@
required: true
schema:
type: string
get:

Check warning on line 3086 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:
- Transfer
summary: Fetch Transfer
Expand All @@ -3094,7 +3102,7 @@
default:
description: Server error
/transfer/verify/{reference}:
get:

Check warning on line 3105 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:
- Transfer
summary: Verify Transfer
Expand All @@ -3119,7 +3127,7 @@
default:
description: Server error
/transfer/export:
get:

Check warning on line 3130 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:
- Transfer
summary: Export Transfers
Expand Down Expand Up @@ -3168,7 +3176,7 @@
default:
description: Server error
/transfer/resend_otp:
post:

Check warning on line 3179 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:
- Transfer
summary: Resend OTP for Transfer
Expand All @@ -3193,7 +3201,7 @@
default:
description: Server error
/transfer/disable_otp:
post:

Check warning on line 3204 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:
- Transfer
summary: Disable OTP for Transfers
Expand All @@ -3210,7 +3218,7 @@
default:
description: Server error
/transfer/disable_otp_finalize:
post:

Check warning on line 3221 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:
- Transfer
summary: Finalize Disabling OTP for Transfers
Expand All @@ -3235,7 +3243,7 @@
default:
description: Server error
/transfer/enable_otp:
post:

Check warning on line 3246 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:
- Transfer
summary: Enable OTP requirement for Transfers
Expand All @@ -3252,7 +3260,7 @@
default:
description: Server error
/product:
post:

Check warning on line 3263 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:
- Product
summary: Create Product
Expand All @@ -3272,7 +3280,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3283 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:
- Product
summary: List Products
Expand Down Expand Up @@ -3318,7 +3326,7 @@
required: true
schema:
type: string
get:

Check warning on line 3329 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:
- Product
summary: Fetch Product
Expand All @@ -3332,7 +3340,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3343 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:
- Product
summary: Update product
Expand All @@ -3354,7 +3362,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3365 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:
- Product
summary: Delete Product
Expand All @@ -3369,7 +3377,7 @@
default:
description: Server error
/storefront:
post:

Check warning on line 3380 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 @@ -3389,7 +3397,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3400 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 @@ -3426,7 +3434,7 @@
required: true
schema:
type: string
get:

Check warning on line 3437 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 @@ -3440,7 +3448,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3451 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 @@ -3462,7 +3470,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3473 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 @@ -3483,7 +3491,7 @@
required: true
schema:
type: string
get:

Check warning on line 3494 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 @@ -3525,7 +3533,7 @@
required: true
schema:
type: string
post:

Check warning on line 3536 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 @@ -3547,7 +3555,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
get:

Check warning on line 3558 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 @@ -3568,7 +3576,7 @@
required: true
schema:
type: string
post:

Check warning on line 3579 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 @@ -3589,7 +3597,7 @@
required: true
schema:
type: string
post:

Check warning on line 3600 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 @@ -3604,7 +3612,7 @@
default:
description: Server error
/order:
post:

Check warning on line 3615 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 @@ -3624,7 +3632,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3635 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 @@ -3668,7 +3676,7 @@
required: true
schema:
type: string
get:

Check warning on line 3679 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 @@ -3689,7 +3697,7 @@
required: true
schema:
type: string
get:

Check warning on line 3700 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 @@ -3710,7 +3718,7 @@
required: true
schema:
type: string
get:

Check warning on line 3721 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 @@ -3725,7 +3733,7 @@
default:
description: Server error
/page:
post:

Check warning on line 3736 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 @@ -3745,7 +3753,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3756 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 @@ -3789,7 +3797,7 @@
required: true
schema:
type: string
get:

Check warning on line 3800 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 @@ -3803,7 +3811,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3814 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 @@ -3832,7 +3840,7 @@
required: true
schema:
type: string
get:

Check warning on line 3843 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 @@ -3853,7 +3861,7 @@
required: true
schema:
type: string
post:

Check warning on line 3864 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 @@ -3874,7 +3882,7 @@
default:
description: Server error
/paymentrequest:
post:

Check warning on line 3885 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:
- Payment Request
summary: Create Payment Request
Expand All @@ -3894,7 +3902,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3905 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:
- Payment Request
summary: List Payment Request
Expand Down Expand Up @@ -3953,7 +3961,7 @@
required: true
schema:
type: string
get:

Check warning on line 3964 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:
- Payment Request
summary: Fetch Payment Request
Expand All @@ -3967,7 +3975,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3978 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:
- Payment Request
summary: Update Payment Request
Expand Down Expand Up @@ -3996,7 +4004,7 @@
required: true
schema:
type: string
get:

Check warning on line 4007 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:
- Payment Request
summary: Verify Payment Request
Expand All @@ -4017,7 +4025,7 @@
required: true
schema:
type: string
post:

Check warning on line 4028 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:
- Payment Request
summary: Send Notification
Expand All @@ -4030,7 +4038,7 @@
default:
description: Server error
/paymentrequest/totals:
get:

Check warning on line 4041 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:
- Payment Request
summary: Payment Request Total
Expand All @@ -4051,7 +4059,7 @@
required: true
schema:
type: string
post:

Check warning on line 4062 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:
- Payment Request
summary: Finalize Payment Request
Expand All @@ -4070,7 +4078,7 @@
required: true
schema:
type: string
post:

Check warning on line 4081 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:
- Payment Request
summary: Archive Payment Request
Expand All @@ -4083,7 +4091,7 @@
default:
description: Server error
/settlement:
get:

Check warning on line 4094 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 @@ -4109,7 +4117,7 @@
default:
description: Server error
/settlement/{id}/transaction:
get:

Check warning on line 4120 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 Down Expand Up @@ -4150,7 +4158,7 @@
default:
description: Server error
/balance/ledger:
get:

Check warning on line 4161 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:
- Balance
summary: Balance Ledger
Expand Down Expand Up @@ -4192,7 +4200,7 @@
default:
description: Server error
/integration/payment_session_timeout:
get:

Check warning on line 4203 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 @@ -4210,7 +4218,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4221 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 @@ -4234,7 +4242,7 @@
default:
description: Server error
/refund:
post:

Check warning on line 4245 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 @@ -4254,7 +4262,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
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:
- Refund
summary: List Refunds
Expand Down Expand Up @@ -4292,7 +4300,7 @@
default:
description: Server error
/refund/{id}:
get:

Check warning on line 4303 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 @@ -4313,7 +4321,7 @@
default:
description: Server error
/dispute:
get:

Check warning on line 4324 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 @@ -4368,7 +4376,7 @@
required: true
schema:
type: string
get:

Check warning on line 4379 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 @@ -4382,7 +4390,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4393 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 @@ -4405,7 +4413,7 @@
default:
description: Server error
/dispute/{id}/upload_url:
get:

Check warning on line 4416 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 @@ -4427,7 +4435,7 @@
default:
description: Server error
/dispute/export:
get:

Check warning on line 4438 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 @@ -4469,7 +4477,7 @@
default:
description: Server error
/dispute/transaction/{id}:
get:

Check warning on line 4480 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 @@ -4491,7 +4499,7 @@
default:
description: Server error
/dispute/{id}/resolve:
put:

Check warning on line 4502 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 @@ -4521,7 +4529,7 @@
default:
description: Server error
/dispute/{id}/evidence:
post:

Check warning on line 4532 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 @@ -4549,7 +4557,7 @@
default:
description: Server error
/bank:
get:

Check warning on line 4560 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:
- Bank
summary: List Banks
Expand Down Expand Up @@ -4600,7 +4608,7 @@
default:
description: Server error
/bank/resolve:
get:

Check warning on line 4611 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:
- Bank
summary: Resolve Account Number
Expand All @@ -4626,7 +4634,7 @@
default:
description: Server error
/bank/validate:
post:

Check warning on line 4637 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:
- Bank
summary: Validate Bank Account
Expand All @@ -4647,7 +4655,7 @@
default:
description: Server error
/decision/bin/{bin}:
get:

Check warning on line 4658 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:
- Miscellaneous
summary: Resolve Card BIN
Expand All @@ -4668,7 +4676,7 @@
default:
description: Server error
/country:
get:

Check warning on line 4679 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:
- Miscellaneous
summary: List Countries
Expand Down Expand Up @@ -11526,10 +11534,15 @@
properties:
type:
description: Recipient Type
default: nuban
type: string
enum:
- nuban
- ghipss
- mobile_money
- basa
- authorization
name:
description: Recipient's name
description: The recipient's name according to their account registration.
type: string
account_number:
description: Recipient's bank account number
Expand All @@ -11549,6 +11562,11 @@
metadata:
description: JSON object of custom data
type: object
example:
type: nuban
name: Smith Taplo
account_number: '01000000010'
bank_code: '058'
TransferRecipientCreateResponse:
type: object
properties:
Expand Down
14 changes: 12 additions & 2 deletions src/assets/openapi/components/schemas/TransferRecipientCreate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ required:
properties:
type:
description: Recipient Type
default: nuban
type: string
enum:
- nuban
- ghipss
- mobile_money
- basa
- authorization
name:
description: Recipient's name
description: The recipient's name according to their account registration.
type: string
account_number:
description: Recipient's bank account number
Expand All @@ -32,3 +37,8 @@ properties:
metadata:
description: JSON object of custom data
type: object
example:
type: nuban
name: Smith Taplo
account_number: '01000000010'
bank_code: '058'
2 changes: 2 additions & 0 deletions src/assets/openapi/paths/transferrecipient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Transfer Recipient
summary: Create Transfer Recipient
description: Creates a new recipient. A duplicate account number will lead to the retrieval of the existing record.
operationId: transferrecipient_create
requestBody:
content:
Expand All @@ -26,6 +27,7 @@ get:
tags:
- Transfer Recipient
summary: List Transfer Recipients
description: List transfer recipients available on your integration
operationId: transferrecipient_list
parameters:
- in: query
Expand Down
4 changes: 3 additions & 1 deletion src/assets/openapi/paths/transferrecipient_bulk.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ post:
tags:
- Transfer Recipient
summary: Bulk Create Transfer Recipient
description: |
Create multiple transfer recipients in batches. A duplicate account number will lead to the retrieval of the existing record.
operationId: transferrecipient_bulk
requestBody:
content:
Expand All @@ -13,7 +15,7 @@ post:
$ref: ../components/schemas/TransferRecipientBulk.yaml
responses:
'200':
description: ''
description: 'Sucessful response'
content:
application/json:
schema:
Expand Down
12 changes: 8 additions & 4 deletions src/assets/openapi/paths/transferrecipient_{code}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ parameters:
required: true
schema:
type: string
example: RCP_5ap8rcimmcj8lbi
get:
tags:
- Transfer Recipient
summary: Fetch Transfer recipient
description: Fetch the details of a transfer recipient
operationId: transferrecipient_fetch
responses:
'200':
description: ''
description: 'Successful response'
content:
application/json:
schema:
Expand All @@ -26,7 +28,8 @@ get:
put:
tags:
- Transfer Recipient
summary: Update Transfer recipient
summary: Update Transfer Recipient
description: Update the details of a transfer recipient
operationId: transferrecipient_update
requestBody:
content:
Expand All @@ -38,7 +41,7 @@ put:
$ref: ../components/schemas/TransferRecipientUpdate.yaml
responses:
'200':
description: ''
description: 'Successful response'
content:
application/json:
schema:
Expand All @@ -53,10 +56,11 @@ delete:
tags:
- Transfer Recipient
summary: Delete Transfer Recipient
description: Delete a transfer recipient (sets the transfer recipient to inactive)
operationId: transferrecipient_delete
responses:
'200':
description: ''
description: 'Successful response'
content:
application/json:
schema:
Expand Down
Loading