diff --git a/dist/betting.yaml b/dist/betting.yaml index 8d81ec1f..c47a99e3 100644 --- a/dist/betting.yaml +++ b/dist/betting.yaml @@ -57,6 +57,7 @@ paths: - Transaction summary: Charge Authorization operationId: transaction_chargeAuthorization + description: Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments requestBody: content: application/json: @@ -90,6 +91,7 @@ paths: required: true schema: type: string + example: re4lyvq3s3 responses: '200': description: '' @@ -108,14 +110,17 @@ paths: 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 @@ -134,6 +139,7 @@ paths: 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: @@ -158,6 +164,7 @@ paths: tags: - Transfer Recipient summary: List Transfer Recipients + description: List transfer recipients available on your integration operationId: transferrecipient_list parameters: - in: query @@ -205,6 +212,10 @@ paths: tags: - Transfer summary: Initiate Bulk Transfer + description: | + Batch multiple transfers in a single request. + + You need to disable the Transfers OTP requirement to use this endpoint. operationId: transfer_bulk requestBody: content: @@ -250,11 +261,19 @@ components: type: string share: description: The percentage or flat quota of the customer or partner - type: string + type: integer + example: + subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreate: type: object description: | Split configuration for transactions + required: + - name + - type + - subaccounts + - currency properties: name: description: Name of the transaction split @@ -289,11 +308,13 @@ components: bearer_subaccount: description: This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type type: string - required: - - name - - type - - subaccounts - - currency + example: + name: Halfsies + type: percentage + currency: NGN + subaccounts: + - subaccount: ACCT_6uujpqtzmnufzkw + share: 50 TransactionInitialize: description: Initialize a transaction type: object @@ -306,7 +327,7 @@ components: type: string amount: description: | - Amount should be in smallest denomination of the currency. For example if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR + Amount should be in smallest denomination of the currency. type: integer currency: $ref: '#/components/schemas/Currency' @@ -319,13 +340,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction @@ -1098,10 +1122,15 @@ components: 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 @@ -1121,6 +1150,11 @@ components: 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: @@ -1225,6 +1259,10 @@ components: reason: description: The reason or narration for the transfer. type: string + example: + amount: 120000 + recipient: RCP_gd9vgag7n5lr5ix + reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 TransferBulk: type: object required: @@ -1232,8 +1270,9 @@ components: - transfers properties: source: - description: Where should we transfer from? Only balance is allowed for now + description: The source of funds for the transfer. type: string + default: balance currency: description: Specify the currency of the transfer. type: string @@ -1248,6 +1287,12 @@ components: type: array items: $ref: '#/components/schemas/TransferBase' + example: + source: balance + transfers: + - amount: 120000 + recipient: RCP_gd9vgag7n5lr5ix + reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 TransferBulkResponseArray: type: object properties: diff --git a/dist/lending.yaml b/dist/lending.yaml index bb9d1db3..2634ed0d 100644 --- a/dist/lending.yaml +++ b/dist/lending.yaml @@ -58,6 +58,7 @@ paths: - Transaction summary: Charge Authorization operationId: transaction_chargeAuthorization + description: Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments requestBody: content: application/json: @@ -83,6 +84,7 @@ paths: - Transaction summary: Partial Debit operationId: transaction_partialDebit + description: Retrieve part of a payment from a customer requestBody: content: application/json: @@ -107,14 +109,17 @@ paths: 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 @@ -133,6 +138,7 @@ paths: 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: @@ -157,6 +163,7 @@ paths: tags: - Transfer Recipient summary: List Transfer Recipients + description: List transfer recipients available on your integration operationId: transferrecipient_list parameters: - in: query @@ -204,6 +211,7 @@ paths: tags: - Transfer summary: Initiate Transfer + description: Send money to your customers operationId: transfer_initiate requestBody: content: @@ -215,7 +223,7 @@ paths: $ref: '#/components/schemas/TransferInitiate' responses: '200': - description: '' + description: Successful operation content: application/json: schema: @@ -228,6 +236,7 @@ paths: tags: - Transfer summary: List Transfers + description: List the transfers made on your integration operationId: transfer_list parameters: - in: query @@ -235,6 +244,7 @@ paths: description: A flag to indicate if cursor based pagination should be used schema: type: boolean + example: true - in: query name: next description: | @@ -328,11 +338,19 @@ components: type: string share: description: The percentage or flat quota of the customer or partner - type: string + type: integer + example: + subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreate: type: object description: | Split configuration for transactions + required: + - name + - type + - subaccounts + - currency properties: name: description: Name of the transaction split @@ -367,11 +385,13 @@ components: bearer_subaccount: description: This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type type: string - required: - - name - - type - - subaccounts - - currency + example: + name: Halfsies + type: percentage + currency: NGN + subaccounts: + - subaccount: ACCT_6uujpqtzmnufzkw + share: 50 TransactionInitialize: description: Initialize a transaction type: object @@ -384,7 +404,7 @@ components: type: string amount: description: | - Amount should be in smallest denomination of the currency. For example if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR + Amount should be in smallest denomination of the currency. type: integer currency: $ref: '#/components/schemas/Currency' @@ -397,13 +417,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction @@ -1130,10 +1153,15 @@ components: 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 @@ -1153,6 +1181,11 @@ components: 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: @@ -1437,6 +1470,10 @@ components: reason: description: The reason or narration for the transfer. type: string + example: + amount: 120000 + recipient: RCP_gd9vgag7n5lr5ix + reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 TransferInitiate: description: Transfer initiation model allOf: @@ -1444,12 +1481,9 @@ components: - type: object required: - source - - amount - - recipient - - reference properties: source: - description: The origin of the funds to send from + description: The source of funds to send from type: string default: balance currency: @@ -1461,6 +1495,8 @@ components: - ZAR - KES - GHS + example: + source: balance TransferCreateResponse: type: object properties: diff --git a/dist/marketplace.yaml b/dist/marketplace.yaml index d9b9a1cb..d770f662 100644 --- a/dist/marketplace.yaml +++ b/dist/marketplace.yaml @@ -31,6 +31,7 @@ paths: - Subaccount summary: Create Subaccount operationId: subaccount_create + description: Create a subacount for a partner requestBody: content: application/json: @@ -55,22 +56,25 @@ paths: - Subaccount summary: List Subaccounts operationId: subaccount_list + description: List subaccounts available on your integration parameters: - in: query name: perPage + description: Number of records to fetch per request schema: type: integer - description: Number of records to fetch per request + default: 50 - in: query name: page + description: The offset to retrieve data from schema: type: integer - description: The offset to retrieve data from + default: 1 - in: query name: active + description: Filter by the state of the subaccounts schema: type: boolean - description: Filter by active or inactive subaccounts responses: '200': description: '' @@ -90,6 +94,7 @@ paths: - Split summary: Create Split operationId: split_create + description: Create a split configuration for transactions requestBody: content: application/json: @@ -114,7 +119,14 @@ paths: - Split summary: List Splits operationId: split_list + description: List the transaction splits available on your integration parameters: + - in: query + name: subaccount_code + description: Filter by subaccount code + schema: + type: string + example: ACCT_dskvlw3y3dMukmt - name: name description: The name of the split in: query @@ -147,12 +159,6 @@ paths: schema: type: string format: date-time - - in: query - name: subaccount_code - description: Filter by subaccount code - schema: - type: string - example: ACCT_dskvlw3y3dMukmt responses: '200': description: '' @@ -199,6 +205,7 @@ paths: tags: - Refund summary: Create Refund + description: Initiate a refund for a previously completed transaction operationId: refund_create requestBody: content: @@ -219,13 +226,16 @@ paths: tags: - Refund summary: List Refunds + description: List previously created refunds operationId: refund_list parameters: - in: query name: perPage schema: type: integer + default: 50 description: Number of records to fetch per page + example: 10 - in: query name: page schema: @@ -410,6 +420,11 @@ components: metadata: description: Stringified JSON object of custom data type: string + example: + business_name: Oasis + account_number: '0123456047' + settlement_bank: '058' + percentage_charge: 30 SubaccountCreateResponse: type: object properties: @@ -638,11 +653,19 @@ components: type: string share: description: The percentage or flat quota of the customer or partner - type: string + type: integer + example: + subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreate: type: object description: | Split configuration for transactions + required: + - name + - type + - subaccounts + - currency properties: name: description: Name of the transaction split @@ -677,11 +700,13 @@ components: bearer_subaccount: description: This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type type: string - required: - - name - - type - - subaccounts - - currency + example: + name: Halfsies + type: percentage + currency: NGN + subaccounts: + - subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreateResponse: type: object properties: @@ -765,7 +790,7 @@ components: type: string amount: description: | - Amount should be in smallest denomination of the currency. For example if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR + Amount should be in smallest denomination of the currency. type: integer currency: $ref: '#/components/schemas/Currency' @@ -778,13 +803,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction @@ -1040,22 +1068,28 @@ components: - transaction properties: transaction: - description: Transaction reference or id + description: The reference of a previosuly completed transaction type: string amount: - description: |- - Amount ( in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR ) to be refunded to the customer. - Amount cannot be more than the original transaction amount + description: Amount to be refunded to the customer. It cannot be more than the original transaction amount type: integer currency: - description: Three-letter ISO currency. Allowed values are NGN, GHS, ZAR or USD + description: Three-letter ISO currency type: string + enum: + - GHS + - KES + - NGN + - USD + - ZAR customer_note: description: Customer reason type: string merchant_note: description: Merchant reason type: string + example: + transaction: mpkr39h74k RefundCreateResponse: type: object properties: diff --git a/dist/membership.yaml b/dist/membership.yaml index 92ced421..8560ded6 100644 --- a/dist/membership.yaml +++ b/dist/membership.yaml @@ -34,6 +34,7 @@ paths: - Plan summary: Create Plan operationId: plan_create + description: Create a plan for recurring payments requestBody: content: application/json: @@ -54,22 +55,29 @@ paths: - Plan summary: List Plans operationId: plan_list + description: List all recurring payment plans parameters: - in: query name: perPage + description: Number of records to fetch per page schema: type: integer - description: Number of records to fetch per page - in: query name: page + description: The section to retrieve schema: type: integer - description: The section to retrieve - in: query name: interval + description: Specify interval of the plan schema: type: string - description: Specify interval of the plan + enum: + - daily + - weekly + - monthly + - biannually + - annually - in: query name: amount schema: @@ -101,6 +109,7 @@ paths: tags: - Subscription summary: Create Subscription + description: Create a subscription a customer operationId: subscription_create requestBody: content: @@ -121,6 +130,7 @@ paths: tags: - Subscription summary: List Subscriptions + description: List all subscriptions available on your integration operationId: subscription_list parameters: - in: query @@ -135,9 +145,10 @@ paths: description: The section to retrieve - in: query name: plan - schema: - type: string description: Plan ID + schema: + type: integer + example: 2697466 - in: query name: customer schema: @@ -198,6 +209,7 @@ paths: - Transaction summary: Charge Authorization operationId: transaction_chargeAuthorization + description: Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments requestBody: content: application/json: @@ -385,8 +397,14 @@ components: description: Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR type: integer interval: - description: Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually + description: Payment interval type: string + enum: + - daily + - weekly + - monthly + - biannually + - annually description: description: A description for this plan type: string @@ -404,6 +422,10 @@ components: Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing. type: integer + example: + name: Basic + amount: 150000 + interval: monthly PlanCreateResponse: type: object properties: @@ -709,6 +731,9 @@ components: description: Set the date for the first debit. (ISO 8601 format) e.g. 2017-05-16T00:30:13+01:00 type: string format: date-time + example: + customer: CUS_xnxdt6s1zg1f4nx + plan: PLN_gx2wn530m0i3w3m SubscriptionCreateResponse: type: object properties: @@ -811,11 +836,19 @@ components: type: string share: description: The percentage or flat quota of the customer or partner - type: string + type: integer + example: + subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreate: type: object description: | Split configuration for transactions + required: + - name + - type + - subaccounts + - currency properties: name: description: Name of the transaction split @@ -850,11 +883,13 @@ components: bearer_subaccount: description: This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type type: string - required: - - name - - type - - subaccounts - - currency + example: + name: Halfsies + type: percentage + currency: NGN + subaccounts: + - subaccount: ACCT_6uujpqtzmnufzkw + share: 50 TransactionInitialize: description: Initialize a transaction type: object @@ -867,7 +902,7 @@ components: type: string amount: description: | - Amount should be in smallest denomination of the currency. For example if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR + Amount should be in smallest denomination of the currency. type: integer currency: $ref: '#/components/schemas/Currency' @@ -880,13 +915,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction diff --git a/dist/paystack.yaml b/dist/paystack.yaml index a798e5c4..efa5c8d2 100644 --- a/dist/paystack.yaml +++ b/dist/paystack.yaml @@ -5068,13 +5068,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction diff --git a/dist/savings.yaml b/dist/savings.yaml index 7e5ec4d6..464b50be 100644 --- a/dist/savings.yaml +++ b/dist/savings.yaml @@ -57,6 +57,7 @@ paths: - Transaction summary: Charge Authorization operationId: transaction_chargeAuthorization + description: Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments requestBody: content: application/json: @@ -81,14 +82,17 @@ paths: 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 @@ -107,6 +111,7 @@ paths: 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: @@ -131,6 +136,7 @@ paths: tags: - Transfer Recipient summary: List Transfer Recipients + description: List transfer recipients available on your integration operationId: transferrecipient_list parameters: - in: query @@ -178,6 +184,7 @@ paths: tags: - Transfer summary: Initiate Transfer + description: Send money to your customers operationId: transfer_initiate requestBody: content: @@ -189,7 +196,7 @@ paths: $ref: '#/components/schemas/TransferInitiate' responses: '200': - description: '' + description: Successful operation content: application/json: schema: @@ -202,6 +209,7 @@ paths: tags: - Transfer summary: List Transfers + description: List the transfers made on your integration operationId: transfer_list parameters: - in: query @@ -209,6 +217,7 @@ paths: description: A flag to indicate if cursor based pagination should be used schema: type: boolean + example: true - in: query name: next description: | @@ -301,11 +310,19 @@ components: type: string share: description: The percentage or flat quota of the customer or partner - type: string + type: integer + example: + subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreate: type: object description: | Split configuration for transactions + required: + - name + - type + - subaccounts + - currency properties: name: description: Name of the transaction split @@ -340,11 +357,13 @@ components: bearer_subaccount: description: This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type type: string - required: - - name - - type - - subaccounts - - currency + example: + name: Halfsies + type: percentage + currency: NGN + subaccounts: + - subaccount: ACCT_6uujpqtzmnufzkw + share: 50 TransactionInitialize: description: Initialize a transaction type: object @@ -357,7 +376,7 @@ components: type: string amount: description: | - Amount should be in smallest denomination of the currency. For example if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR + Amount should be in smallest denomination of the currency. type: integer currency: $ref: '#/components/schemas/Currency' @@ -370,13 +389,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction @@ -887,10 +909,15 @@ components: 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 @@ -910,6 +937,11 @@ components: 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: @@ -1194,6 +1226,10 @@ components: reason: description: The reason or narration for the transfer. type: string + example: + amount: 120000 + recipient: RCP_gd9vgag7n5lr5ix + reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 TransferInitiate: description: Transfer initiation model allOf: @@ -1201,12 +1237,9 @@ components: - type: object required: - source - - amount - - recipient - - reference properties: source: - description: The origin of the funds to send from + description: The source of funds to send from type: string default: balance currency: @@ -1218,6 +1251,8 @@ components: - ZAR - KES - GHS + example: + source: balance TransferCreateResponse: type: object properties: diff --git a/dist/wallet.yaml b/dist/wallet.yaml index 1893856f..a92e4206 100644 --- a/dist/wallet.yaml +++ b/dist/wallet.yaml @@ -65,6 +65,7 @@ paths: - Transaction summary: Charge Authorization operationId: transaction_chargeAuthorization + description: Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments requestBody: content: application/json: @@ -90,6 +91,7 @@ paths: - Customer summary: Create Customer operationId: customer_create + description: Create a customer on your integration requestBody: content: application/json: @@ -173,8 +175,10 @@ paths: - name: code in: path required: true + description: The code for the customer gotten from the response of the customer creation schema: type: string + example: CUS_c6wqvwmvwopw4ms post: tags: - Customer @@ -206,6 +210,7 @@ paths: - Dedicated Virtual Account summary: Create Dedicated Account operationId: dedicatedAccount_create + description: Create a dedicated virtual account for an existing customer requestBody: content: application/json: @@ -230,39 +235,52 @@ paths: - Dedicated Virtual Account summary: List Dedicated Accounts operationId: dedicatedAccount_list + description: List dedicated virtual accounts available on your integration. parameters: - - name: account_number + - name: active in: query + description: Status of the dedicated virtual account schema: - type: string + type: boolean + example: true - name: customer in: query + description: The customer's ID schema: - type: string - - name: active - in: query - schema: - type: boolean + type: integer + example: 297346561 - name: currency in: query + description: The currency of the dedicated virtual account schema: type: string + enum: + - NGN + - GHS - name: provider_slug in: query + description: The bank's slug in lowercase, without spaces schema: type: string + example: titan-paystack - name: bank_id in: query + description: The bank's ID schema: type: string + example: '035' - name: perPage in: query + description: The number of records to fetch per request schema: - type: string + type: integer + default: 50 - name: page in: query + description: The offset to retrieve data from schema: - type: string + type: integer + default: 1 responses: '200': description: '' @@ -281,6 +299,7 @@ paths: 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: @@ -305,6 +324,7 @@ paths: tags: - Transfer Recipient summary: List Transfer Recipients + description: List transfer recipients available on your integration operationId: transferrecipient_list parameters: - in: query @@ -352,6 +372,7 @@ paths: tags: - Transfer summary: Initiate Transfer + description: Send money to your customers operationId: transfer_initiate requestBody: content: @@ -363,7 +384,7 @@ paths: $ref: '#/components/schemas/TransferInitiate' responses: '200': - description: '' + description: Successful operation content: application/json: schema: @@ -376,6 +397,7 @@ paths: tags: - Transfer summary: List Transfers + description: List the transfers made on your integration operationId: transfer_list parameters: - in: query @@ -383,6 +405,7 @@ paths: description: A flag to indicate if cursor based pagination should be used schema: type: boolean + example: true - in: query name: next description: | @@ -475,11 +498,19 @@ components: type: string share: description: The percentage or flat quota of the customer or partner - type: string + type: integer + example: + subaccount: ACCT_6uujpqtzmnufzkw + share: 50 SplitCreate: type: object description: | Split configuration for transactions + required: + - name + - type + - subaccounts + - currency properties: name: description: Name of the transaction split @@ -514,11 +545,13 @@ components: bearer_subaccount: description: This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type type: string - required: - - name - - type - - subaccounts - - currency + example: + name: Halfsies + type: percentage + currency: NGN + subaccounts: + - subaccount: ACCT_6uujpqtzmnufzkw + share: 50 TransactionInitialize: description: Initialize a transaction type: object @@ -531,7 +564,7 @@ components: type: string amount: description: | - Amount should be in smallest denomination of the currency. For example if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR + Amount should be in smallest denomination of the currency. type: integer currency: $ref: '#/components/schemas/Currency' @@ -544,13 +577,16 @@ components: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: | Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction @@ -1020,6 +1056,10 @@ components: metadata: description: Stringified JSON object of custom data type: string + example: + email: rock@sandy.com + first_name: Rock + last_name: Sandy CustomerCreateResponse: type: object properties: @@ -1131,6 +1171,14 @@ components: account_number: description: Customer's bank account number. type: string + example: + first_name: Jabal + last_name: Cedar + country: NG + type: bank_account + account_number: '0123456789' + bank_code: '007' + bvn: '20012345677' CustomerValidateResponse: type: object properties: @@ -1255,7 +1303,7 @@ components: - customer properties: customer: - description: Customer ID or code + description: The code for the previously created customer type: string preferred_bank: description: The bank slug for preferred bank. To get a list of available banks, use the List Providers endpoint @@ -1266,6 +1314,9 @@ components: split_code: description: Split code consisting of the lists of accounts you want to split the transaction with type: string + example: + customer: CUS_bo732eugpb2qrg6 + preferred_bank: titan-paystack DedicatedNubanCreateResponse: type: object properties: @@ -1500,10 +1551,15 @@ components: 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 @@ -1523,6 +1579,11 @@ components: 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: @@ -1807,6 +1868,10 @@ components: reason: description: The reason or narration for the transfer. type: string + example: + amount: 120000 + recipient: RCP_gd9vgag7n5lr5ix + reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 TransferInitiate: description: Transfer initiation model allOf: @@ -1814,12 +1879,9 @@ components: - type: object required: - source - - amount - - recipient - - reference properties: source: - description: The origin of the funds to send from + description: The source of funds to send from type: string default: balance currency: @@ -1831,6 +1893,8 @@ components: - ZAR - KES - GHS + example: + source: balance TransferCreateResponse: type: object properties: diff --git a/src/assets/openapi/components/schemas/TransactionInitialize.yaml b/src/assets/openapi/components/schemas/TransactionInitialize.yaml index 0ac53f6b..4f615d0b 100644 --- a/src/assets/openapi/components/schemas/TransactionInitialize.yaml +++ b/src/assets/openapi/components/schemas/TransactionInitialize.yaml @@ -26,13 +26,16 @@ properties: items: type: string enum: - - card + - apple_pay - bank - - ussd - - qr + - bank_transfer + - capitec_pay + - card - eft - mobile_money - - bank_transfer + - payattitude + - qr + - ussd callback_url: description: > Fully qualified url, e.g. https://example.com/ to redirect your customers