├── .gitignore ├── .spectral.yaml ├── vacuum.conf.yaml ├── .vscode └── extensions.json ├── src ├── assets │ └── openapi │ │ ├── components │ │ ├── responses │ │ │ ├── Ok.yaml │ │ │ ├── PageListSuccess.yaml │ │ │ ├── PlanListSuccess.yaml │ │ │ ├── OrderListSuccess.yaml │ │ │ ├── PageFetchSuccess.yaml │ │ │ ├── PlanFetchSuccess.yaml │ │ │ ├── SplitListSuccess.yaml │ │ │ ├── DisputeListSuccess.yaml │ │ │ ├── OrderCreateSuccess.yaml │ │ │ ├── OrderFetchSuccess.yaml │ │ │ ├── PageCreateSuccess.yaml │ │ │ ├── PageUpdateSuccess.yaml │ │ │ ├── PlanCreateSuccess.yaml │ │ │ ├── PlanUpdateSuccess.yaml │ │ │ ├── RefundFetchSuccess.yaml │ │ │ ├── RefundListSuccess.yaml │ │ │ ├── RefundRetrySuccess.yaml │ │ │ ├── SplitCreateSuccess.yaml │ │ │ ├── SplitFetchSuccess.yaml │ │ │ ├── SplitUpdateSuccess.yaml │ │ │ ├── TerminalGetSuccess.yaml │ │ │ ├── BalanceCheckSuccess.yaml │ │ │ ├── ChargeCreateSuccess.yaml │ │ │ ├── CustomerFetchSuccess.yaml │ │ │ ├── CustomerListSuccess.yaml │ │ │ ├── DisputeExportSuccess.yaml │ │ │ ├── DisputeFetchSuccess.yaml │ │ │ ├── DisputeUpdateSuccess.yaml │ │ │ ├── OrderValidateSuccess.yaml │ │ │ ├── ProductCreateSuccess.yaml │ │ │ ├── ProductDeleteSuccess.yaml │ │ │ ├── ProductFetchSuccess.yaml │ │ │ ├── ProductListsSuccess.yaml │ │ │ ├── ProductUpdateSuccess.yaml │ │ │ ├── RefundCreateSuccess.yaml │ │ │ ├── TerminalListsSuccess.yaml │ │ │ ├── TransferBulkSuccess.yaml │ │ │ ├── TransferFetchSuccess.yaml │ │ │ ├── TransferListSuccess.yaml │ │ │ ├── BulkChargeListSuccess.yaml │ │ │ ├── CustomerCreateSuccess.yaml │ │ │ ├── CustomerUpdateSuccess.yaml │ │ │ ├── DisputeResolveSuccess.yaml │ │ │ ├── StorefrontListSuccess.yaml │ │ │ ├── SubaccountListSuccess.yaml │ │ │ ├── TerminalUpdateSuccess.yaml │ │ │ ├── TransferCreateSuccess.yaml │ │ │ ├── TransferVerifySuccess.yaml │ │ │ ├── BulkChargeFetchSuccess.yaml │ │ │ ├── BulkChargePauseSuccess.yaml │ │ │ ├── BulkChargeResumeSuccess.yaml │ │ │ ├── ChargeSubmitOtpSuccess.yaml │ │ │ ├── ChargeSubmitPinSuccess.yaml │ │ │ ├── CustomerValidateSuccess.yaml │ │ │ ├── DisputeUploadURLSuccess.yaml │ │ │ ├── PageAddProductsSuccess.yaml │ │ │ ├── StorefrontCreateSuccess.yaml │ │ │ ├── StorefrontDeleteSuccess.yaml │ │ │ ├── StorefrontFetchSuccess.yaml │ │ │ ├── StorefrontUpdateSuccess.yaml │ │ │ ├── SubaccountCreateSuccess.yaml │ │ │ ├── SubaccountFetchSuccess.yaml │ │ │ ├── SubaccountUpdateSuccess.yaml │ │ │ ├── SubscriptionListSuccess.yaml │ │ │ ├── ChargeSubmitPhoneSuccess.yaml │ │ │ ├── OrderFetchProductSuccess.yaml │ │ │ ├── SubscriptionCreateSuccess.yaml │ │ │ ├── SubscriptionFetchSuccess.yaml │ │ │ ├── TerminalGetStatusSuccess.yaml │ │ │ ├── BalanceFetchLedgerSuccess.yaml │ │ │ ├── BulkChargeInitiateSuccess.yaml │ │ │ ├── ChargeCheckPendingSuccess.yaml │ │ │ ├── DedicatedNubanFetchSuccess.yaml │ │ │ ├── DisputeAddEvidenceSuccess.yaml │ │ │ ├── PaymentRequestListSuccess.yaml │ │ │ ├── PaymentRequestTotalSuccess.yaml │ │ │ ├── SubscriptionDisableSuccess.yaml │ │ │ ├── TransferDisablesOtpSuccess.yaml │ │ │ ├── TransferEnablesOtpSuccess.yaml │ │ │ ├── TransferResendsOtpSuccess.yaml │ │ │ ├── VirtualTerminalListSuccess.yaml │ │ │ ├── ApplePayOkResponse.yaml │ │ │ ├── ChargeSubmitBirthdaySuccess.yaml │ │ │ ├── DedicatedNubanCreateSuccess.yaml │ │ │ ├── PaymentRequestArchiveSuccess.yaml │ │ │ ├── PaymentRequestCreateSuccess.yaml │ │ │ ├── PaymentRequestUpdateSuccess.yaml │ │ │ ├── PaymentRequestVerifySuccess.yaml │ │ │ ├── SplitRemoveSubaccountSuccess.yaml │ │ │ ├── TransferRecipientListSuccess.yaml │ │ │ ├── VirtualTerminalCreateSuccess.yaml │ │ │ ├── VirtualTerminalFetchSuccess.yaml │ │ │ ├── VirtualTerminalUpdateSuccess.yaml │ │ │ ├── DisputeListTransactionSuccess.yaml │ │ │ ├── MiscellaneousListBanksSuccess.yaml │ │ │ ├── PaymentRequestFinalizeSuccess.yaml │ │ │ ├── TransferRecipientFetchSuccess.yaml │ │ │ ├── CustomerWhitelistBlacklistSuccess.yaml │ │ │ ├── DedicatedNubanDeactivateSuccess.yaml │ │ │ ├── MiscellaneousListStatesSuccess.yaml │ │ │ ├── SplitAddUpdateSubaccountSuccess.yaml │ │ │ ├── TerminalCommissionDeviceSuccess.yaml │ │ │ ├── TransferRecipientCreateSuccess.yaml │ │ │ ├── TransferRecipientDeleteSuccess.yaml │ │ │ ├── TransferRecipientUpdateSuccess.yaml │ │ │ ├── MiscellaneousListCountriesSuccess.yaml │ │ │ ├── PageCheckSlugAvailabilitySuccess.yaml │ │ │ ├── TerminalDecommissionDeviceSuccess.yaml │ │ │ ├── VirtualTerminalDeactivateSuccess.yaml │ │ │ ├── CustomerAuthorizationVerifySuccess.yaml │ │ │ ├── DirectDebitActivationChargeSuccess.yaml │ │ │ ├── NotFound.yaml │ │ │ ├── TransferFinalizeDisablesOtpSuccess.yaml │ │ │ ├── TransferRecipientBulkCreateSuccess.yaml │ │ │ ├── VerificationResolveCardBINSuccess.yaml │ │ │ ├── VerificationValidateAccountSuccess.yaml │ │ │ ├── VirtualTerminalAddSplitCodeSuccess.yaml │ │ │ ├── CustomerInitializeDirectDebitSuccess.yaml │ │ │ ├── Unauthorized.yaml │ │ │ ├── VirtualTerminalDeleteSplitCodeSuccess.yaml │ │ │ ├── CustomerAuthorizationInitializeSuccess.yaml │ │ │ ├── CustomerDeactivateAuthorizationSuccess.yaml │ │ │ ├── PaymentRequestSendNotificationSuccess.yaml │ │ │ ├── VirtualTerminalDestinationAssignSuccess.yaml │ │ │ ├── VirtualTerminalDestinationUnassignSuccess.yaml │ │ │ ├── BulkChargeFetchBulkBatchChargesSuccess.yaml │ │ │ ├── VerificationResolveAccountNumberSuccess.yaml │ │ │ ├── CustomerFetchMandateAuthorizationsSuccess.yaml │ │ │ ├── TransactionInitializeBadRequestResponse.yaml │ │ │ └── CustomerDirectDebitActivationChargeSuccess.yaml │ │ └── schemas │ │ │ ├── Response.yaml │ │ │ ├── EFT.yaml │ │ │ ├── RefundRetry.yaml │ │ │ ├── Currency.yaml │ │ │ ├── OrderCancelResponse.yaml │ │ │ ├── OrderDeliverResponse.yaml │ │ │ ├── OrderRefundResponse.yaml │ │ │ ├── PaymentRequestTaxArray.yaml │ │ │ ├── PlanUpdateResponse.yaml │ │ │ ├── BulkChargePauseResponse.yaml │ │ │ ├── BulkChargeResumeResponse.yaml │ │ │ ├── CustomerValidateResponse.yaml │ │ │ ├── ProductDeleteResponse.yaml │ │ │ ├── StorefrontDeleteResponse.yaml │ │ │ ├── StorefrontUpdateResponse.yaml │ │ │ ├── TerminalUpdateResponse.yaml │ │ │ ├── BalanceCheckResponseArray.yaml │ │ │ ├── PaymentRequestArchiveResponse.yaml │ │ │ ├── PaymentRequestPendingArray.yaml │ │ │ ├── PaymentRequestTotalArray.yaml │ │ │ ├── SplitRemoveSubaccountResponse.yaml │ │ │ ├── SubscriptionDisableResponse.yaml │ │ │ ├── TransferDisablesOtpResponse.yaml │ │ │ ├── TransferEnablesOtpResponse.yaml │ │ │ ├── TransferResendsOtpResponse.yaml │ │ │ ├── PageCheckSlugAvailabilityResponse.yaml │ │ │ ├── PaymentRequestNotificationsArray.yaml │ │ │ ├── PaymentRequestSuccessfulArray.yaml │ │ │ ├── TerminalCommissionDeviceResponse.yaml │ │ │ ├── TerminalDecommissionDeviceResponse.yaml │ │ │ ├── TransferFinalizeDisablesOtpResponse.yaml │ │ │ ├── TransferRecipientDeleteResponse.yaml │ │ │ ├── TransferRecipientUpdateResponse.yaml │ │ │ ├── VirtualTerminalDeactivateResponse.yaml │ │ │ ├── CustomerDeactivateAuthorizationResponse.yaml │ │ │ ├── PaymentRequestSendNotificationResponse.yaml │ │ │ ├── TransactionTotalVolumeByCurrencyArray.yaml │ │ │ ├── VirtualTerminalDeleteSplitCodeResponse.yaml │ │ │ ├── TransactionPendingTransfersByCurrencyArray.yaml │ │ │ ├── VirtualTerminalDestinationUnassignResponse.yaml │ │ │ ├── ErrorMeta.yaml │ │ │ ├── PaymentSession.yaml │ │ │ ├── TransferRecipientUpdate.yaml │ │ │ ├── VirtualTerminalUpdate.yaml │ │ │ ├── DisputeHistoryArray.yaml │ │ │ ├── TransferFinalizeDisableOTP.yaml │ │ │ ├── DisputeMessagesArray.yaml │ │ │ ├── ApplePayParam.yaml │ │ │ ├── PaymentRequestLineItemsArray.yaml │ │ │ ├── TransactionTimelineResponse.yaml │ │ │ ├── TransferFeesBreakdownArray.yaml │ │ │ ├── TransferRecipientBulk.yaml │ │ │ ├── MiscellaneousListStatesResponseArray.yaml │ │ │ ├── TransferRecipientErrorsArray.yaml │ │ │ ├── DedicatedVirtualAccountRemoveSplit.yaml │ │ │ ├── MetadataCustomFieldsArray.yaml │ │ │ ├── CustomerAuthorizationVerifyResponseCustomer.yaml │ │ │ ├── CustomerDeactivateAuthorization.yaml │ │ │ ├── DirectDebitActivationChargeResponse.yaml │ │ │ ├── CustomerDirectDebitActivationChargeRequest.yaml │ │ │ ├── VirtualTerminalAddSplitCode.yaml │ │ │ ├── VirtualTerminalDeleteSplitCode.yaml │ │ │ ├── Bank.yaml │ │ │ ├── CustomerDirectDebitActivationChargeResponse.yaml │ │ │ ├── CustomerInitializeDirectDebitRequest.yaml │ │ │ ├── USSD.yaml │ │ │ ├── StorefrontAddProducts.yaml │ │ │ ├── StorefrontContactsArray.yaml │ │ │ ├── BalanceCheckResponse.yaml │ │ │ ├── PageProduct.yaml │ │ │ ├── TransferBulkResponse.yaml │ │ │ ├── TerminalUpate.yaml │ │ │ ├── MiscellaneousListBanksResponse.yaml │ │ │ ├── ApplePayCreateOkModel.yaml │ │ │ ├── MiscellaneousListStatesResponse.yaml │ │ │ ├── SubscriptionToggle.yaml │ │ │ ├── TerminalActivationToggle.yaml │ │ │ ├── MiscellaneousListCountriesResponse.yaml │ │ │ ├── MiscellaneousListProvidersResponse.yaml │ │ │ ├── DirectDebitActivationChargeRequest.yaml │ │ │ ├── VerifyCodeSupportedBanksArray.yaml │ │ │ ├── VirtualTerminalDestinationUnassign.yaml │ │ │ ├── VerifyAccessCodeSupportedBanksArray.yaml │ │ │ ├── SplitSubaccounts.yaml │ │ │ ├── CustomerInitializeDirectDebitResponse.yaml │ │ │ ├── ChargeSubmitPhone.yaml │ │ │ ├── CustomerAuthorizationInitializeResponse.yaml │ │ │ ├── CustomerAuthorizationVerifyResponse.yaml │ │ │ ├── ChargeSubmitOTP.yaml │ │ │ ├── ChargeSubmitPin.yaml │ │ │ ├── CustomerInitializeDirectDebitAccount.yaml │ │ │ ├── MobileMoney.yaml │ │ │ ├── CustomerAuthorizationInitializeAccount.yaml │ │ │ ├── DirectDebitMandateAuthorizationMeta.yaml │ │ │ ├── TransferFinalize.yaml │ │ │ ├── ChannelOptionMobileMoneyArray.yaml │ │ │ ├── DisputeUpdate.yaml │ │ │ ├── ControlPanelFetchPaymentSessionTimeoutResponse.yaml │ │ │ ├── ControlPanelUpdatePaymentSessionTimeoutResponse.yaml │ │ │ ├── TerminalCountsResponse.yaml │ │ │ ├── CustomerFetchMandateAuthorizationsResponseMeta.yaml │ │ │ ├── DisputeExportResponse.yaml │ │ │ ├── CustomerInitializeDirectDebitResponseData.yaml │ │ │ ├── TransactionExportResponse.yaml │ │ │ ├── DisputeUploadURLResponse.yaml │ │ │ ├── TerminalGetStatusResponse.yaml │ │ │ ├── ChargeSubmitBirthdayResponse.yaml │ │ │ ├── PreAuthorizationReleaseResponse.yaml │ │ │ ├── ShareSubaccountsArray.yaml │ │ │ ├── TransactionCheckAuthorizationResponse.yaml │ │ │ ├── TransferBulkResponseArray.yaml │ │ │ ├── ChargeSubmitBirthday.yaml │ │ │ ├── CustomerAuthorizationInitializeResponseData.yaml │ │ │ ├── CustomerInitializeDirectDebitAddress.yaml │ │ │ ├── CustomerAuthorizationInitializeAddress.yaml │ │ │ ├── CustomerUpdate.yaml │ │ │ ├── TerminalSendEventData.yaml │ │ │ ├── ErrorRecordsArray.yaml │ │ │ ├── PageUpdate.yaml │ │ │ ├── FormulaSubaccountsArray.yaml │ │ │ ├── PaymentChannelCreateEFTChargeResponse.yaml │ │ │ ├── DirectDebitMandateAuthorizationListResponse.yaml │ │ │ ├── PaymentChannelCreateBankChargeResponse.yaml │ │ │ ├── PreAuthorizationReserveWithSelfCheckoutResponse.yaml │ │ │ ├── StorefrontUpdate.yaml │ │ │ ├── InitializeAuthorizationCardResponse.yaml │ │ │ ├── InitializeAuthorizationDirectdebitResponse.yaml │ │ │ ├── TransactionInitializeResponse.yaml │ │ │ ├── TransferRecipientBulkCreateResponse.yaml │ │ │ ├── VerificationResolveAccountNumberResponse.yaml │ │ │ ├── CustomerFetchMandateAuthorizationsResponse.yaml │ │ │ ├── CustomerRiskAction.yaml │ │ │ ├── PreAuthorizationInitializeResponse.yaml │ │ │ ├── DirectDebitMandateAuthorizationCustomer.yaml │ │ │ ├── TransferResendOTP.yaml │ │ │ ├── CustomerAuthorizationVerifyResponseData.yaml │ │ │ ├── PaymentChannelCreateQRChargeResponse.yaml │ │ │ ├── PaymentChannelCreateUSSDChargeResponse.yaml │ │ │ ├── VirtualTerminalListResponse.yaml │ │ │ ├── DedicatedVirtualAccountSplit.yaml │ │ │ ├── BulkChargeListResponseArray.yaml │ │ │ ├── CustomerCreate.yaml │ │ │ ├── VirtualTerminalListResponseArray.yaml │ │ │ ├── TransferInitiate.yaml │ │ │ ├── OrderItems.yaml │ │ │ ├── Error.yaml │ │ │ ├── TerminalListsResponse.yaml │ │ │ ├── TerminalListsResponseArray.yaml │ │ │ ├── PaymentRequestTotalResponse.yaml │ │ │ ├── ChargeSubmitAddress.yaml │ │ │ ├── TerminalSendEvent.yaml │ │ │ ├── VerifyAuthorizationCardResponse.yaml │ │ │ ├── BalanceFetchLedgerResponseArray.yaml │ │ │ ├── RefundRetryAccountDetails.yaml │ │ │ ├── TransferBulk.yaml │ │ │ ├── PageListResponse.yaml │ │ │ ├── PlanListResponse.yaml │ │ │ ├── SplitListResponse.yaml │ │ │ ├── SplitUpdate.yaml │ │ │ ├── DisputeListResponse.yaml │ │ │ ├── ProductListsResponse.yaml │ │ │ ├── TransferListResponse.yaml │ │ │ ├── RefundCreate.yaml │ │ │ ├── StorefrontListResponse.yaml │ │ │ ├── SubaccountListResponse.yaml │ │ │ ├── SubscriptionListResponse.yaml │ │ │ ├── BalanceFetchLedgerResponse.yaml │ │ │ ├── DedicatedNubanListResponse.yaml │ │ │ ├── PreAuthorizationListResponse.yaml │ │ │ ├── StorefrontListResponseArray.yaml │ │ │ ├── TransferRecipientListResponse.yaml │ │ │ ├── CustomerAuthorizationInitializeRequest.yaml │ │ │ ├── DedicatedVirtualAccountCreate.yaml │ │ │ ├── PreAuthorizationVerifyResponse.yaml │ │ │ ├── BulkChargeFetchBulkBatchChargesResponse.yaml │ │ │ ├── CustomerListResponse.yaml │ │ │ ├── StorefrontCreate.yaml │ │ │ ├── BulkChargeListResponse.yaml │ │ │ ├── OrderListResponse.yaml │ │ │ ├── StorefrontShippingResponse.yaml │ │ │ ├── VirtualTerminalDestinationAssign.yaml │ │ │ ├── PaymentRequestListResponse.yaml │ │ │ ├── RefundListResponse.yaml │ │ │ ├── VirtualTerminalDestinationAssignResponse.yaml │ │ │ ├── OrderFetchProductResponse.yaml │ │ │ ├── CustomerListResponseArray.yaml │ │ │ ├── EftDebitOrderLogMandateResponse.yaml │ │ │ ├── EftDebitOrderListMandateResponse.yaml │ │ │ ├── DisputeResolve.yaml │ │ │ ├── SubscriptionCreate.yaml │ │ │ ├── TransactionListResponse.yaml │ │ │ ├── TransferBase.yaml │ │ │ ├── ChargeMobileMoneyResponse.yaml │ │ │ ├── TransactionPartialDebit.yaml │ │ │ ├── VerificationResolveCardBINResponse.yaml │ │ │ ├── OrderShipping.yaml │ │ │ ├── TransactionTotalsResponse.yaml │ │ │ └── DisputeEvidence.yaml │ │ └── paths │ │ ├── country.yaml │ │ ├── paymentrequest_totals.yaml │ │ ├── dedicated_account_available_providers.yaml │ │ ├── balance.yaml │ │ ├── storefront_{id}_order.yaml │ │ ├── subscription_{code}_manage_link.yaml │ │ ├── order_{id}.yaml │ │ ├── refund_{id}.yaml │ │ ├── directdebit_activation-charge.yaml │ │ ├── subscription_{code}_manage_email.yaml │ │ ├── transfer_finalize_transfer.yaml │ │ ├── virtual_terminal_{code}_deactivate.yaml │ │ ├── storefront_{id}_publish.yaml │ │ ├── order_product_{id}.yaml │ │ ├── storefront_{id}_duplicate.yaml │ │ ├── order_{code}_validate.yaml │ │ ├── paymentrequest_finalize_{id}.yaml │ │ ├── subscription_enable.yaml │ │ ├── charge_submit_address.yaml │ │ ├── dispute_{id}_upload_url.yaml │ │ ├── storefront_verify_{slug}.yaml │ │ ├── transfer_enable_otp.yaml │ │ ├── decision_bin_{bin}.yaml │ │ ├── paymentrequest_notify_{id}.yaml │ │ ├── transfer_disable_otp.yaml │ │ ├── subscription_disable.yaml │ │ ├── dispute_transaction_{id}.yaml │ │ ├── subscription_{code}.yaml │ │ ├── customer_{id}_directdebit-mandate-authorizations.yaml │ │ ├── page_check_slug_availability_{slug}.yaml │ │ ├── terminal_decommission_device.yaml │ │ ├── bank_validate.yaml │ │ ├── settlement_{id}_transactions.yaml │ │ ├── terminal_commission_device.yaml │ │ ├── address_verification_states.yaml │ │ ├── paymentrequest_verify_{id}.yaml │ │ ├── charge_submit_otp.yaml │ │ ├── charge_submit_pin.yaml │ │ ├── terminal_{terminal_id}_presence.yaml │ │ ├── charge_submit_phone.yaml │ │ ├── transfer_{code}.yaml │ │ ├── customer_authorization_verify_{reference}.yaml │ │ ├── dedicated_account_assign.yaml │ │ ├── charge_submit_birthday.yaml │ │ ├── paymentrequest_archive_{id}.yaml │ │ ├── settlement.yaml │ │ ├── transaction_{id}.yaml │ │ ├── transaction_partial_debit.yaml │ │ ├── transaction_verify_{reference}.yaml │ │ ├── transfer_verify_{reference}.yaml │ │ ├── bulkcharge_pause_{code}.yaml │ │ ├── customer_set_risk_action.yaml │ │ ├── transfer_resend_otp.yaml │ │ ├── bulkcharge_resume_{code}.yaml │ │ ├── customer_authorization_initialize.yaml │ │ ├── transfer_bulk.yaml │ │ ├── customer_authorization_deactivate.yaml │ │ ├── page_{id}_product.yaml │ │ ├── dispute_{id}_evidence.yaml │ │ ├── transaction_timeline_{id}.yaml │ │ └── transfer_disable_otp_finalize.yaml ├── views │ └── index.html └── index.js └── .github ├── workflows └── lint-spec.yml ├── pull_request_template.md └── ISSUE_TEMPLATE └── feature_request.md /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .DS_Store -------------------------------------------------------------------------------- /.spectral.yaml: -------------------------------------------------------------------------------- 1 | extends: spectral:oas -------------------------------------------------------------------------------- /vacuum.conf.yaml: -------------------------------------------------------------------------------- 1 | ruleset: "./ruleset-recommended.yaml" -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "42Crunch.vscode-openapi", 4 | "pb33f.vacuum" 5 | ] 6 | } -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/Ok.yaml: -------------------------------------------------------------------------------- 1 | description: Request successful 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/Response.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/Response.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PageListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Page List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PageListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PlanListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Plan List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PlanListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/OrderListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Order List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/OrderListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PageFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Page Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PageFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PlanFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Plan Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PlanFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SplitListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Split List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SplitListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/EFT.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: Details of the EFT provider 3 | properties: 4 | provider: 5 | description: The EFT provider 6 | type: string 7 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/OrderCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Order Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/OrderCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/OrderFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Order Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/OrderFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PageCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Page Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PageCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PageUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Page Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PageUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PlanCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Plan Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PlanCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PlanUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Plan Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PlanUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/RefundFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Refund Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/RefundFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/RefundListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Refund List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/RefundListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/RefundRetrySuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Refund Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/RefundRetryResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SplitCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Split Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SplitCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SplitFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Split Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SplitFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SplitUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Split Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SplitUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TerminalGetSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Terminal Get response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TerminalGetResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/RefundRetry.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - refund_account_details 4 | properties: 5 | refund_account_details: 6 | $ref: './RefundRetryAccountDetails.yaml' -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BalanceCheckSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Balance Check response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BalanceCheckResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ChargeCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Charge Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ChargeCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeExportSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute Export response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeExportResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/OrderValidateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Order Validate response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/OrderValidateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ProductCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Product Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ProductCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ProductDeleteSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Product Delete response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ProductDeleteResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ProductFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Product Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ProductFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ProductListsSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Product Lists response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ProductListsResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ProductUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Product Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ProductUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/RefundCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Refund Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/RefundCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TerminalListsSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Terminal Lists response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TerminalListsResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferBulkSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Bulk response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferBulkResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/Currency.yaml: -------------------------------------------------------------------------------- 1 | description: List of all support currencies 2 | type: string 3 | enum: 4 | - GHS 5 | - KES 6 | - NGN 7 | - ZAR 8 | - USD 9 | example: GHS 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BulkChargeListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Bulk Charge List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BulkChargeListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeResolveSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute Resolve response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeResolveResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/StorefrontListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Storefront List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/StorefrontListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubaccountListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subaccount List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubaccountListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TerminalUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Terminal Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TerminalUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferVerifySuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Verify response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferVerifyResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BulkChargeFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Bulk Charge Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BulkChargeFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BulkChargePauseSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Bulk Charge Pause response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BulkChargePauseResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BulkChargeResumeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Bulk Charge Resume response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BulkChargeResumeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ChargeSubmitOtpSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Charge Submit Otp response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ChargeSubmitOtpResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ChargeSubmitPinSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Charge Submit Pin response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ChargeSubmitPinResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerValidateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Validate response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerValidateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeUploadURLSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute Upload URL response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeUploadURLResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PageAddProductsSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Page Add Products response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PageAddProductsResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/StorefrontCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Storefront Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/StorefrontCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/StorefrontDeleteSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Storefront Delete response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/StorefrontDeleteResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/StorefrontFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Storefront Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/StorefrontFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/StorefrontUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Storefront Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/StorefrontUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubaccountCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subaccount Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubaccountCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubaccountFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subaccount Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubaccountFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubaccountUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subaccount Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubaccountUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubscriptionListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subscription List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubscriptionListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderCancelResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderDeliverResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderRefundResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestTaxArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | amount: 6 | type: integer 7 | required: 8 | - name 9 | - amount 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PlanUpdateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ChargeSubmitPhoneSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Charge Submit Phone response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ChargeSubmitPhoneResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/OrderFetchProductSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Order Fetch Product response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/OrderFetchProductResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubscriptionCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subscription Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubscriptionCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubscriptionFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subscription Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubscriptionFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TerminalGetStatusSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Terminal Get Status response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TerminalGetStatusResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BulkChargePauseResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BulkChargeResumeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerValidateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ProductDeleteResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontDeleteResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontUpdateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalUpdateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BalanceFetchLedgerSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Balance Fetch Ledger response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BalanceFetchLedgerResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BulkChargeInitiateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Bulk Charge Initiate response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BulkChargeInitiateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ChargeCheckPendingSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Charge Check Pending response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ChargeCheckPendingResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DedicatedNubanFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dedicated Nuban Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DedicatedNubanFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeAddEvidenceSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute Add Evidence response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeAddEvidenceResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestTotalSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Total response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestTotalResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SubscriptionDisableSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Subscription Disable response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SubscriptionDisableResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferDisablesOtpSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Disables Otp response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferDisablesOtpResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferEnablesOtpSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Enables Otp response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferEnablesOtpResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferResendsOtpSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Resends Otp response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferResendsOtpResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Lists response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BalanceCheckResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currency: 4 | type: string 5 | balance: 6 | type: integer 7 | required: 8 | - currency 9 | - balance 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestArchiveResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestPendingArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currency: 4 | type: string 5 | amount: 6 | type: integer 7 | required: 8 | - currency 9 | - amount 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestTotalArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currency: 4 | type: string 5 | amount: 6 | type: integer 7 | required: 8 | - currency 9 | - amount 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SplitRemoveSubaccountResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SubscriptionDisableResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferDisablesOtpResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferEnablesOtpResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferResendsOtpResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ApplePayOkResponse.yaml: -------------------------------------------------------------------------------- 1 | description: Responses from the Transaction Initialize endpoint 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ApplePayCreateOkModel.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/ChargeSubmitBirthdaySuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Charge Submit Birthday response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/ChargeSubmitBirthdayResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DedicatedNubanCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dedicated Nuban Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DedicatedNubanCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestArchiveSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Archive response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestArchiveResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestVerifySuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Verify response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestVerifyResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SplitRemoveSubaccountSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Split Remove Subaccount response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SplitRemoveSubaccountResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferRecipientListSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Recipient List response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferRecipientListResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PageCheckSlugAvailabilityResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestNotificationsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | sent_at: 4 | type: string 5 | channel: 6 | type: string 7 | required: 8 | - sent_at 9 | - channel 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestSuccessfulArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currency: 4 | type: string 5 | amount: 6 | type: integer 7 | required: 8 | - currency 9 | - amount 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalCommissionDeviceResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalDecommissionDeviceResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferFinalizeDisablesOtpResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientDeleteResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientUpdateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDeactivateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DisputeListTransactionSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dispute List Transaction response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DisputeListTransactionResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/MiscellaneousListBanksSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Miscellaneous List Banks response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/MiscellaneousListBanksResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestFinalizeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Finalize response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestFinalizeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferRecipientFetchSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Recipient Fetch response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferRecipientFetchResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerDeactivateAuthorizationResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestSendNotificationResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionTotalVolumeByCurrencyArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currency: 4 | type: string 5 | amount: 6 | type: integer 7 | required: 8 | - currency 9 | - amount 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDeleteSplitCodeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerWhitelistBlacklistSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Whitelist Blacklist response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerRiskActionResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DedicatedNubanDeactivateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Dedicated Nuban Deactivate response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DedicatedNubanDeactivateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/MiscellaneousListStatesSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Miscellaneous List States response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/MiscellaneousListStatesResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/SplitAddUpdateSubaccountSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Split Add Update Subaccount response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/SplitAddUpdateSubaccountResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TerminalCommissionDeviceSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Terminal Commission Device response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TerminalCommissionDeviceResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferRecipientCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Recipient Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferRecipientCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferRecipientDeleteSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Recipient Delete response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferRecipientDeleteResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferRecipientUpdateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Recipient Update response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferRecipientUpdateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionPendingTransfersByCurrencyArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | currency: 4 | type: string 5 | amount: 6 | type: integer 7 | required: 8 | - currency 9 | - amount 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDestinationUnassignResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | required: 8 | - status 9 | - message 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/MiscellaneousListCountriesSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Miscellaneous List Countries response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/MiscellaneousListCountriesResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PageCheckSlugAvailabilitySuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Page Check Slug Availability response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PageCheckSlugAvailabilityResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TerminalDecommissionDeviceSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Terminal Decommission Device response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TerminalDecommissionDeviceResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalDeactivateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Deactivate response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalDeactivateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ErrorMeta.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: Extra details to help with a resolution of the error 3 | properties: 4 | nextStep: 5 | type: string 6 | description: A summarised solution for the error 7 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentSession.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - timeout 4 | properties: 5 | timeout: 6 | description: Time in seconds before a transaction becomes invalid 7 | type: integer 8 | example: 30 9 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | description: Recipient's name 5 | type: string 6 | email: 7 | description: Recipient's email address 8 | type: string 9 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - name 4 | properties: 5 | name: 6 | description: Name of the virtual terminal 7 | type: string 8 | example: 9 | name: "Lagos_Mainland_Zone_1" -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerAuthorizationVerifySuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Authorization Verify response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerAuthorizationVerifyResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/DirectDebitActivationChargeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Direct Debit Activation Charge response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/DirectDebitActivationChargeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/NotFound.yaml: -------------------------------------------------------------------------------- 1 | description: Entity not found 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/Error.yaml 6 | example: 7 | status: false 8 | message: Entity not found 9 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferFinalizeDisablesOtpSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Finalize Disables Otp response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferFinalizeDisablesOtpResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransferRecipientBulkCreateSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer Recipient Bulk Create response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransferRecipientBulkCreateResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VerificationResolveCardBINSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Verification Resolve Card B I N response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VerificationResolveCardBINResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VerificationValidateAccountSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Verification Validate Account response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VerificationValidateAccountResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalAddSplitCodeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Split Assign response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalAddSplitCodeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerInitializeDirectDebitSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Initialize Direct Debit response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerInitializeDirectDebitResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/Unauthorized.yaml: -------------------------------------------------------------------------------- 1 | description: Unauthorized operation 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/Error.yaml 6 | example: 7 | status: false 8 | message: Invalid key 9 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalDeleteSplitCodeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Split Remove response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalDeleteSplitCodeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerAuthorizationInitializeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Authorization Initialize response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerAuthorizationInitializeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerDeactivateAuthorizationSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Deactivate Authorization response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerDeactivateAuthorizationResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/PaymentRequestSendNotificationSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Payment Request Send Notification response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/PaymentRequestSendNotificationResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalDestinationAssignSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal Deactivate response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalDestinationAssignResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VirtualTerminalDestinationUnassignSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Virtual Terminal unassign response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VirtualTerminalDestinationUnassignResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/BulkChargeFetchBulkBatchChargesSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Bulk Charge Fetch Bulk Batch Charges response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/BulkChargeFetchBulkBatchChargesResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/VerificationResolveAccountNumberSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Verification Resolve Account Number response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/VerificationResolveAccountNumberResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeHistoryArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: string 5 | by: 6 | type: string 7 | createdAt: 8 | type: string 9 | required: 10 | - status 11 | - by 12 | - createdAt 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferFinalizeDisableOTP.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - otp 4 | properties: 5 | otp: 6 | description: OTP sent to business phone to verify disabling OTP requirement 7 | type: string 8 | example: 9 | otp: "928783" -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerFetchMandateAuthorizationsSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Fetch Mandate Authorizations response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerFetchMandateAuthorizationsResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/TransactionInitializeBadRequestResponse.yaml: -------------------------------------------------------------------------------- 1 | description: Responses from the Transaction Initialize endpoint 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/TransactionInitializeBadRequestModel.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeMessagesArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | sender: 4 | type: string 5 | body: 6 | type: string 7 | createdAt: 8 | type: string 9 | required: 10 | - sender 11 | - body 12 | - createdAt 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/responses/CustomerDirectDebitActivationChargeSuccess.yaml: -------------------------------------------------------------------------------- 1 | description: Customer Direct Debit Activation Charge response 2 | content: 3 | application/json: 4 | schema: 5 | $ref: ../schemas/CustomerDirectDebitActivationChargeResponse.yaml 6 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ApplePayParam.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - domainName 4 | properties: 5 | domainName: 6 | description: The domain or subdomain for your application 7 | type: string 8 | example: 9 | domainName: example.com 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestLineItemsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | amount: 6 | type: integer 7 | quantity: 8 | type: integer 9 | required: 10 | - name 11 | - amount 12 | - quantity 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionTimelineResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | required: 10 | - status 11 | - message 12 | - data 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferFeesBreakdownArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | amount: 4 | type: string 5 | formula: 6 | nullable: true 7 | type: 8 | type: string 9 | required: 10 | - amount 11 | - formula 12 | - type 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientBulk.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - batch 4 | properties: 5 | batch: 6 | description: A list of transfer recipient object. 7 | type: array 8 | items: 9 | $ref: ./TransferRecipientCreate.yaml 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MiscellaneousListStatesResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | type: string 5 | slug: 6 | type: string 7 | abbreviation: 8 | type: string 9 | required: 10 | - name 11 | - slug 12 | - abbreviation 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientErrorsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | message: 4 | type: string 5 | records: 6 | type: array 7 | items: 8 | $ref: ./ErrorRecordsArray.yaml 9 | required: 10 | - message 11 | - records 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DedicatedVirtualAccountRemoveSplit.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - account_number 4 | properties: 5 | account_number: 6 | description: Valid Dedicated virtual account 7 | type: string 8 | example: 9 | account_number: "0033322211" 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MetadataCustomFieldsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | value: 4 | type: string 5 | display_name: 6 | type: string 7 | variable_name: 8 | type: string 9 | required: 10 | - value 11 | - display_name 12 | - variable_name 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationVerifyResponseCustomer.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | code: 4 | type: string 5 | example: CUS_24lze1c8i2zl76y 6 | email: 7 | type: string 8 | example: ravi@demo.com 9 | required: 10 | - code 11 | - email 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerDeactivateAuthorization.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - authorization_code 4 | properties: 5 | authorization_code: 6 | description: Authorization code to be deactivated 7 | type: string 8 | example: 9 | authorization_code: "AUTH_xxxIjkZVj5" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DirectDebitActivationChargeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Mandate is queued for retry 9 | required: 10 | - status 11 | - message 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerDirectDebitActivationChargeRequest.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - authorization_id 4 | properties: 5 | authorization_id: 6 | type: integer 7 | description: The authorization ID gotten from the initiation response 8 | example: 1069309917 9 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalAddSplitCode.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - split_code 4 | properties: 5 | split_code: 6 | description: The split code to assign to the virtual terminal 7 | type: string 8 | example: 9 | split_code: "SPL_1234567890abcdef" 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDeleteSplitCode.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - split_code 4 | properties: 5 | split_code: 6 | description: The split code to assign to the virtual terminal 7 | type: string 8 | example: 9 | split_code: "SPL_1234567890abcdef" 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/Bank.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: The bank object if charging a bank account 3 | properties: 4 | code: 5 | description: Customer's bank code 6 | type: string 7 | account_number: 8 | description: Customer's account number 9 | type: string 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerDirectDebitActivationChargeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Mandate is queued for retry 9 | required: 10 | - status 11 | - message 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerInitializeDirectDebitRequest.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - account 4 | - address 5 | properties: 6 | account: 7 | $ref: ./CustomerInitializeDirectDebitAccount.yaml 8 | address: 9 | $ref: ./CustomerInitializeDirectDebitAddress.yaml 10 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/USSD.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: The USSD code for the provider to charge 3 | properties: 4 | type: 5 | description: The three-digit USSD code. 6 | type: string 7 | enum: 8 | - '737' 9 | - '919' 10 | - '822' 11 | - '966' 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontAddProducts.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - products 4 | properties: 5 | products: 6 | description: An array of product IDs 7 | type: array 8 | items: 9 | type: integer 10 | example: 11 | products: 12 | - 2196244 13 | - 2179824 -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontContactsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | value: 4 | type: string 5 | id: 6 | type: integer 7 | type_name: 8 | nullable: true 9 | type: 10 | type: integer 11 | required: 12 | - value 13 | - id 14 | - type_name 15 | - type 16 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BalanceCheckResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./BalanceCheckResponseArray.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PageProduct.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - products 4 | properties: 5 | products: 6 | description: A list of IDs of products to add to a page. 7 | type: array 8 | items: 9 | type: integer 10 | example: 11 | products: 12 | - 2196244 13 | - 2179824 14 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferBulkResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./TransferBulkResponseArray.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalUpate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | description: The new name for the Terminal 5 | type: string 6 | address: 7 | description: The new address for the Terminal 8 | type: string 9 | example: 10 | name: Oreos 11 | address: Somewhere on earth 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MiscellaneousListBanksResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./MiscellaneousListBanksResponseArray.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ApplePayCreateOkModel.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | description: An indicator 5 | type: boolean 6 | message: 7 | description: A short description of the response 8 | type: string 9 | example: 10 | status: true 11 | message: Domain successfully registered on Apple Pay 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MiscellaneousListStatesResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./MiscellaneousListStatesResponseArray.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SubscriptionToggle.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - code 4 | - token 5 | properties: 6 | code: 7 | description: Subscription code 8 | type: string 9 | token: 10 | description: Email token 11 | type: string 12 | example: 13 | code: "SUB_vsyqdmlzble3uii" 14 | token: "d7gofp6yppn3qz7" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalActivationToggle.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: Model for activating and deactivating a debug Terminal 3 | required: 4 | - serial_number 5 | properties: 6 | serial_number: 7 | description: Device Serial Number 8 | type: string 9 | example: 10 | serial_number: '1111150412230003899' 11 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MiscellaneousListCountriesResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./MiscellaneousListCountriesResponseArray.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MiscellaneousListProvidersResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./MiscellaneousListProvidersResponseArray.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DirectDebitActivationChargeRequest.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - customer_ids 4 | properties: 5 | customer_ids: 6 | type: array 7 | description: Array of customer IDs to trigger activation charge for 8 | items: 9 | type: integer 10 | example: 11 | - 28958104 12 | - 983697220 13 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VerifyCodeSupportedBanksArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | name: 6 | type: string 7 | slug: 8 | type: string 9 | gateway: 10 | type: string 11 | code: 12 | type: string 13 | required: 14 | - id 15 | - name 16 | - slug 17 | - gateway 18 | - code 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDestinationUnassign.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | targets: 4 | type: array 5 | description: Array of destination targets to unassign 6 | items: 7 | type: string 8 | required: 9 | - targets 10 | example: 11 | targets: 12 | - '+2548012345678' 13 | - '+2548098765432' 14 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VerifyAccessCodeSupportedBanksArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | name: 6 | type: string 7 | slug: 8 | type: string 9 | gateway: 10 | type: string 11 | code: 12 | type: string 13 | required: 14 | - id 15 | - name 16 | - slug 17 | - gateway 18 | - code 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SplitSubaccounts.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | subaccount: 4 | description: Subaccount code of the customer or partner 5 | type: string 6 | share: 7 | description: The percentage or flat quota of the customer or partner 8 | type: integer 9 | example: 10 | subaccount: ACCT_6uujpqtzmnufzkw 11 | share: 50 -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerInitializeDirectDebitResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Authorization initialized 9 | data: 10 | $ref: ./CustomerInitializeDirectDebitResponseData.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeSubmitPhone.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - phone 4 | - reference 5 | properties: 6 | phone: 7 | description: Customer's mobile number 8 | type: string 9 | reference: 10 | description: The reference of the ongoing transaction 11 | type: string 12 | example: 13 | phone: "08012345678" 14 | reference: "5bwib5v6anhe9xa" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationInitializeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Authorization initialized 9 | data: 10 | $ref: ./CustomerAuthorizationInitializeResponseData.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationVerifyResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Authorization retrieved successfully 9 | data: 10 | $ref: ./CustomerAuthorizationVerifyResponseData.yaml 11 | required: 12 | - status 13 | - message 14 | - data 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeSubmitOTP.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - otp 4 | - reference 5 | properties: 6 | otp: 7 | description: Customer's OTP for ongoing transaction 8 | type: string 9 | reference: 10 | description: The reference of the ongoing transaction 11 | type: string 12 | example: 13 | otp: "123456" 14 | reference: "5bwib5v6anhe9xa" 15 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeSubmitPin.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - pin 4 | - reference 5 | properties: 6 | pin: 7 | description: Customer's PIN for the ongoing transaction 8 | type: string 9 | reference: 10 | description: Transaction reference that requires the PIN 11 | type: string 12 | example: 13 | pin: "1234" 14 | reference: "5bwib5v6anhe9xa" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerInitializeDirectDebitAccount.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | number: 4 | type: string 5 | description: The customer's account number 6 | example: '0123456789' 7 | bank_code: 8 | type: string 9 | description: The code representing the customer's bank 10 | example: '058' 11 | required: 12 | - number 13 | - bank_code 14 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/MobileMoney.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: Details of the mobile service provider 3 | properties: 4 | phone: 5 | description: Customer's phone number 6 | type: string 7 | provider: 8 | description: >- 9 | The telco provider of customer's phone number. This can be fetched from 10 | the List Bank endpoint 11 | type: string 12 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationInitializeAccount.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | number: 4 | type: string 5 | description: The customer's account number 6 | example: '0123456789' 7 | bank_code: 8 | type: string 9 | description: The code representing the customer's bank 10 | example: '058' 11 | required: 12 | - number 13 | - bank_code 14 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DirectDebitMandateAuthorizationMeta.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | per_page: 4 | type: integer 5 | example: 10 6 | next: 7 | type: string 8 | example: MTI1OTc= 9 | count: 10 | type: integer 11 | example: 10 12 | total: 13 | type: integer 14 | example: 40 15 | required: 16 | - per_page 17 | - count 18 | - total 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferFinalize.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - transfer_code 4 | - otp 5 | properties: 6 | transfer_code: 7 | description: The transfer code you want to finalize 8 | type: string 9 | otp: 10 | description: OTP sent to business phone to verify transfer 11 | type: string 12 | example: 13 | transfer_code: TRF_vsyqdmlzble3uii 14 | otp: "928783" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChannelOptionMobileMoneyArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | key: 4 | type: string 5 | value: 6 | type: string 7 | isNew: 8 | type: boolean 9 | phoneNumberRegex: 10 | type: string 11 | phoneNumberPlaceholder: 12 | type: string 13 | required: 14 | - key 15 | - value 16 | - isNew 17 | - phoneNumberRegex 18 | - phoneNumberPlaceholder 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - refund_amount 4 | properties: 5 | refund_amount: 6 | description: The amount to refund, in the subunit of your currency 7 | type: integer 8 | uploaded_filename: 9 | description: Filename of attachment returned via response from the Dispute upload URL 10 | type: string 11 | example: 12 | refund_amount: 50000 -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ControlPanelFetchPaymentSessionTimeoutResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | payment_session_timeout: 11 | type: integer 12 | required: 13 | - payment_session_timeout 14 | required: 15 | - status 16 | - message 17 | - data 18 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ControlPanelUpdatePaymentSessionTimeoutResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | payment_session_timeout: 11 | type: integer 12 | required: 13 | - payment_session_timeout 14 | required: 15 | - status 16 | - message 17 | - data 18 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalCountsResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | count: 11 | type: integer 12 | status: 13 | type: string 14 | required: 15 | - count 16 | - status 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerFetchMandateAuthorizationsResponseMeta.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | per_page: 4 | type: integer 5 | example: 50 6 | next: 7 | type: string 8 | nullable: true 9 | example: null 10 | count: 11 | type: integer 12 | example: 1 13 | total: 14 | type: integer 15 | example: 1 16 | required: 17 | - per_page 18 | - count 19 | - total 20 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeExportResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | path: 11 | type: string 12 | expiresAt: 13 | type: string 14 | required: 15 | - path 16 | - expiresAt 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerInitializeDirectDebitResponseData.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | redirect_url: 4 | type: string 5 | example: https://link.paystack.com/ll6b0szngj1f27k 6 | access_code: 7 | type: string 8 | example: ll6b0szngj1f27k 9 | reference: 10 | type: string 11 | example: 1er945lpy4txyki 12 | required: 13 | - redirect_url 14 | - access_code 15 | - reference 16 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionExportResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | path: 11 | type: string 12 | expiresAt: 13 | type: string 14 | required: 15 | - path 16 | - expiresAt 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeUploadURLResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | signedUrl: 11 | type: string 12 | fileName: 13 | type: string 14 | required: 15 | - signedUrl 16 | - fileName 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalGetStatusResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | online: 11 | type: boolean 12 | available: 13 | type: boolean 14 | required: 15 | - online 16 | - available 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeSubmitBirthdayResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | status: 11 | type: string 12 | display_text: 13 | type: string 14 | required: 15 | - status 16 | - display_text 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PreAuthorizationReleaseResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | status: 11 | type: string 12 | reference: 13 | type: string 14 | required: 15 | - status 16 | - reference 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ShareSubaccountsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | amount: 4 | type: integer 5 | original_share: 6 | type: number 7 | fees: 8 | type: integer 9 | subaccount_code: 10 | type: string 11 | id: 12 | type: integer 13 | integration: 14 | type: string 15 | required: 16 | - amount 17 | - original_share 18 | - fees 19 | - subaccount_code 20 | - id 21 | - integration 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionCheckAuthorizationResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | amount: 11 | type: integer 12 | currency: 13 | type: string 14 | required: 15 | - amount 16 | - currency 17 | required: 18 | - status 19 | - message 20 | - data 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferBulkResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | reference: 4 | type: string 5 | recipient: 6 | type: string 7 | amount: 8 | type: integer 9 | transfer_code: 10 | type: string 11 | currency: 12 | type: string 13 | status: 14 | type: string 15 | required: 16 | - reference 17 | - recipient 18 | - amount 19 | - transfer_code 20 | - currency 21 | - status 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeSubmitBirthday.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - birthday 4 | - reference 5 | properties: 6 | birthday: 7 | description: Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21 8 | type: string 9 | format: date 10 | reference: 11 | description: The reference of the ongoing transaction 12 | type: string 13 | example: 14 | birthday: "1961-09-21" 15 | reference: "5bwib5v6anhe9xa" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationInitializeResponseData.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | redirect_url: 4 | type: string 5 | example: https://checkout.paystack.com/82t4mp5b5mfn51h 6 | access_code: 7 | type: string 8 | example: 82t4mp5b5mfn51h 9 | reference: 10 | type: string 11 | example: dfbzfotsrbv4n5s82t4mp5b5mfn51h 12 | required: 13 | - redirect_url 14 | - access_code 15 | - reference 16 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerInitializeDirectDebitAddress.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | street: 4 | type: string 5 | description: The customer's street 6 | example: Some Where 7 | city: 8 | type: string 9 | description: The customer's city 10 | example: Ikeja 11 | state: 12 | type: string 13 | description: The customer's state 14 | example: Lagos 15 | required: 16 | - street 17 | - city 18 | - state 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationInitializeAddress.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | street: 4 | type: string 5 | description: The customer's street 6 | example: 123 Main Street 7 | city: 8 | type: string 9 | description: The customer's city 10 | example: Lagos 11 | state: 12 | type: string 13 | description: The customer's state 14 | example: Lagos 15 | required: 16 | - street 17 | - city 18 | - state 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | first_name: 4 | description: Customer's first name 5 | type: string 6 | last_name: 7 | description: Customer's last name 8 | type: string 9 | phone: 10 | description: Customer's phone number 11 | type: string 12 | metadata: 13 | description: Stringified JSON object of custom data 14 | type: string 15 | example: 16 | first_name: Cecilia 17 | last_name: Jones -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalSendEventData.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: The parameters needed to perform the specified action 3 | properties: 4 | id: 5 | description: The invoice or transaction ID you want to push to the Terminal 6 | type: integer 7 | format: int64 8 | reference: 9 | description: The offline_reference from the Payment Request response 10 | type: string 11 | example: 12 | id: 7895939 13 | reference: "4634337895939" 14 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ErrorRecordsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | type: 4 | type: string 5 | name: 6 | type: string 7 | description: 8 | type: string 9 | account_number: 10 | type: string 11 | bank_code: 12 | type: string 13 | currency: 14 | type: string 15 | email: 16 | type: string 17 | required: 18 | - type 19 | - name 20 | - description 21 | - account_number 22 | - bank_code 23 | - currency 24 | - email 25 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PageUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | description: Name of page 5 | type: string 6 | description: 7 | description: The description of the page 8 | type: string 9 | amount: 10 | description: >- 11 | Amount should be in the subunit of the currency 12 | type: integer 13 | active: 14 | description: Set to false to deactivate page url 15 | type: boolean 16 | example: 17 | name: "Backyard Sale" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/FormulaSubaccountsArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | original_share: 4 | type: number 5 | fees: 6 | type: integer 7 | share: 8 | type: integer 9 | subaccount_code: 10 | type: string 11 | id: 12 | type: integer 13 | name: 14 | type: string 15 | integration: 16 | type: string 17 | required: 18 | - original_share 19 | - fees 20 | - share 21 | - subaccount_code 22 | - id 23 | - name 24 | - integration 25 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentChannelCreateEFTChargeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | reference: 11 | type: string 12 | status: 13 | type: string 14 | url: 15 | type: string 16 | required: 17 | - reference 18 | - status 19 | - url 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DirectDebitMandateAuthorizationListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Mandate authorizations retrieved successfully 9 | data: 10 | type: array 11 | items: 12 | $ref: ./DirectDebitMandateAuthorizationData.yaml 13 | meta: 14 | $ref: ./DirectDebitMandateAuthorizationMeta.yaml 15 | required: 16 | - status 17 | - message 18 | - data 19 | - meta 20 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentChannelCreateBankChargeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | reference: 11 | type: string 12 | status: 13 | type: string 14 | display_text: 15 | type: string 16 | required: 17 | - reference 18 | - status 19 | - display_text 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PreAuthorizationReserveWithSelfCheckoutResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | reference: 11 | type: string 12 | status: 13 | type: string 14 | message: 15 | type: string 16 | required: 17 | - reference 18 | - status 19 | - message 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/country.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Miscellaneous 4 | summary: List Countries 5 | description: List all supported countries on Paystack 6 | operationId: miscellaneous_listCountries 7 | responses: 8 | '200': 9 | $ref: ../components/responses/MiscellaneousListCountriesSuccess.yaml 10 | '401': 11 | $ref: ../components/responses/Unauthorized.yaml 12 | '404': 13 | $ref: ../components/responses/NotFound.yaml 14 | default: 15 | description: Server error 16 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | description: Name of the storefront 5 | type: string 6 | slug: 7 | description: > 8 | A unique identifier to access your store. Once the storefront is created, 9 | it can be accessed from 10 | 11 | https://paystack.shop/your-slug 12 | type: string 13 | description: 14 | description: The description of the storefront 15 | type: string 16 | example: 17 | description: Import and Export -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/InitializeAuthorizationCardResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | authorizationAccessCode: 11 | type: string 12 | action: 13 | type: string 14 | value: 15 | type: string 16 | required: 17 | - authorizationAccessCode 18 | - action 19 | - value 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/InitializeAuthorizationDirectdebitResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | redirect_url: 11 | type: string 12 | access_code: 13 | type: string 14 | reference: 15 | type: string 16 | required: 17 | - redirect_url 18 | - access_code 19 | - reference 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionInitializeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | authorization_url: 11 | type: string 12 | access_code: 13 | type: string 14 | reference: 15 | type: string 16 | required: 17 | - authorization_url 18 | - access_code 19 | - reference 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientBulkCreateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | success: 11 | type: array 12 | items: {} 13 | errors: 14 | type: array 15 | items: 16 | $ref: ./TransferRecipientErrorsArray.yaml 17 | required: 18 | - success 19 | - errors 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VerificationResolveAccountNumberResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | account_number: 11 | type: string 12 | account_name: 13 | type: string 14 | bank_id: 15 | type: integer 16 | required: 17 | - account_number 18 | - account_name 19 | - bank_id 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerFetchMandateAuthorizationsResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | example: true 6 | message: 7 | type: string 8 | example: Mandate authorizations retrieved successfully 9 | data: 10 | type: array 11 | items: 12 | $ref: ./CustomerFetchMandateAuthorizationsResponseData.yaml 13 | meta: 14 | $ref: ./CustomerFetchMandateAuthorizationsResponseMeta.yaml 15 | required: 16 | - status 17 | - message 18 | - data 19 | - meta 20 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerRiskAction.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - customer 4 | properties: 5 | customer: 6 | description: The customer code from the response of the customer creation 7 | type: string 8 | risk_action: 9 | description: This determines the fraud rules that should be applied to the customer 10 | type: string 11 | default: default 12 | enum: 13 | - allow 14 | - deny 15 | - default 16 | example: 17 | customer: "CUS_c6wqvwmvwopw4ms" 18 | risk_action: "deny" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PreAuthorizationInitializeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | authorization_url: 11 | type: string 12 | access_code: 13 | type: string 14 | reference: 15 | type: string 16 | required: 17 | - authorization_url 18 | - access_code 19 | - reference 20 | required: 21 | - status 22 | - message 23 | - data 24 | -------------------------------------------------------------------------------- /.github/workflows/lint-spec.yml: -------------------------------------------------------------------------------- 1 | name: Run Spectral on Pull Requests 2 | 3 | on: 4 | - pull_request 5 | 6 | jobs: 7 | build: 8 | name: Lint 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v2 12 | - name: Lint SDK specification 13 | uses: stoplightio/spectral-action@latest 14 | with: 15 | file_glob: 'sdk/*.yaml' 16 | - name: Lint distribution specification 17 | uses: stoplightio/spectral-action@latest 18 | with: 19 | file_glob: 'dist/*.yaml' 20 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DirectDebitMandateAuthorizationCustomer.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | example: 28958104 6 | customer_code: 7 | type: string 8 | example: CUS_5kye9bc41uw15pb 9 | email: 10 | type: string 11 | example: customer@email.com 12 | first_name: 13 | type: string 14 | example: Booker 15 | last_name: 16 | type: string 17 | example: Jones 18 | required: 19 | - id 20 | - customer_code 21 | - email 22 | - first_name 23 | - last_name 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferResendOTP.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - transfer_code 4 | - reason 5 | properties: 6 | transfer_code: 7 | description: The transfer code that requires an OTP validation 8 | type: string 9 | reason: 10 | description: Specify the flag to indicate the purpose of the OTP 11 | type: string 12 | default: transfer 13 | enum: 14 | - disable_otp 15 | - resend_otp 16 | - transfer 17 | example: 18 | transfer_code: TRF_vsyqdmlzble3uii 19 | reason: resend_otp 20 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/paymentrequest_totals.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Payment Request 4 | summary: Payment Request Total 5 | description: Get the metric of all pending and successful payment requests 6 | operationId: paymentRequest_totals 7 | responses: 8 | '200': 9 | $ref: ../components/responses/PaymentRequestTotalSuccess.yaml 10 | '401': 11 | $ref: ../components/responses/Unauthorized.yaml 12 | '404': 13 | $ref: ../components/responses/NotFound.yaml 14 | default: 15 | description: Server error 16 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/dedicated_account_available_providers.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Dedicated Virtual Account 4 | summary: Fetch Bank Providers 5 | operationId: dedicatedAccount_availableProviders 6 | description: Get available bank providers for a dedicated virtual account 7 | responses: 8 | '200': 9 | $ref: ../components/responses/Ok.yaml 10 | '401': 11 | $ref: ../components/responses/Unauthorized.yaml 12 | '404': 13 | $ref: ../components/responses/NotFound.yaml 14 | default: 15 | description: Server error 16 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationVerifyResponseData.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | authorization_code: 4 | type: string 5 | example: AUTH_JV4T9Wawdj 6 | channel: 7 | type: string 8 | example: direct_debit 9 | bank: 10 | type: string 11 | example: Guaranty Trust Bank 12 | active: 13 | type: boolean 14 | example: true 15 | customer: 16 | $ref: ./CustomerAuthorizationVerifyResponseCustomer.yaml 17 | required: 18 | - authorization_code 19 | - channel 20 | - bank 21 | - active 22 | - customer 23 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentChannelCreateQRChargeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | reference: 11 | type: string 12 | status: 13 | type: string 14 | qr_code: 15 | type: string 16 | url: 17 | type: string 18 | message: 19 | type: string 20 | required: 21 | - reference 22 | - status 23 | required: 24 | - status 25 | - message 26 | - data 27 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentChannelCreateUSSDChargeResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | reference: 11 | type: string 12 | status: 13 | type: string 14 | display_text: 15 | type: string 16 | ussd_code: 17 | type: string 18 | required: 19 | - reference 20 | - status 21 | - display_text 22 | - ussd_code 23 | required: 24 | - status 25 | - message 26 | - data 27 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/balance.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Balance 4 | summary: Fetch Balance 5 | operationId: balance_fetch 6 | description: Fetch the available balance on your integration 7 | responses: 8 | '200': 9 | description: '' 10 | content: 11 | application/json: 12 | schema: 13 | $ref: ../components/schemas/BalanceCheckResponse.yaml 14 | '401': 15 | $ref: ../components/responses/Unauthorized.yaml 16 | '404': 17 | $ref: ../components/responses/NotFound.yaml 18 | default: 19 | description: Server error 20 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./VirtualTerminalListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | anyOf: 20 | - type: string 21 | - type: integer 22 | page: 23 | type: integer 24 | pageCount: 25 | type: integer 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DedicatedVirtualAccountSplit.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - account_number 4 | properties: 5 | account_number: 6 | description: Valid Dedicated virtual account 7 | type: string 8 | subaccount: 9 | description: Subaccount code of the account you want to split the transaction with 10 | type: string 11 | split_code: 12 | description: >- 13 | Split code consisting of the lists of accounts you want to split the 14 | transaction with 15 | type: string 16 | example: 17 | account_number: "0033322211" 18 | split_code: "SPL_e7jnRLtzla" 19 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BulkChargeListResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | integration: 4 | type: integer 5 | domain: 6 | type: string 7 | batch_code: 8 | type: string 9 | status: 10 | type: string 11 | easy_cron_id: 12 | nullable: true 13 | reference: 14 | type: string 15 | id: 16 | type: integer 17 | createdAt: 18 | type: string 19 | updatedAt: 20 | type: string 21 | required: 22 | - integration 23 | - domain 24 | - batch_code 25 | - status 26 | - easy_cron_id 27 | - reference 28 | - id 29 | - createdAt 30 | - updatedAt 31 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerCreate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - email 4 | properties: 5 | email: 6 | description: Customer's email address 7 | type: string 8 | first_name: 9 | description: Customer's first name 10 | type: string 11 | last_name: 12 | description: Customer's last name 13 | type: string 14 | phone: 15 | description: Customer's phone number 16 | type: string 17 | metadata: 18 | description: Stringified JSON object of custom data 19 | type: string 20 | example: 21 | email: rock@sandy.com 22 | first_name: Rock 23 | last_name: Sandy -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Pull Request 3 | about: Create a PR for a new feature or bug fix 4 | 5 | --- 6 | 7 | ## Type of change 8 | 9 | - [ ] Bug fix (non-breaking change which fixes an issue) 10 | - [ ] New feature (non-breaking change which adds functionality) 11 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 12 | - [ ] Documentation update 13 | 14 | ## What issue does this change solve? 15 | A clear and concise description of what the solution is. 16 | 17 | 18 | # Additional context 19 | Add any other context or screenshots about the change. -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalListResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | code: 6 | type: string 7 | name: 8 | type: string 9 | integration: 10 | type: integer 11 | domain: 12 | type: string 13 | paymentMethods: 14 | type: array 15 | items: {} 16 | active: 17 | type: boolean 18 | created_at: 19 | type: string 20 | currency: 21 | type: string 22 | required: 23 | - id 24 | - code 25 | - name 26 | - integration 27 | - domain 28 | - paymentMethods 29 | - active 30 | - created_at 31 | - currency 32 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferInitiate.yaml: -------------------------------------------------------------------------------- 1 | description: Transfer initiation model 2 | allOf: 3 | - $ref: ./TransferBase.yaml 4 | - type: object 5 | required: 6 | - source 7 | properties: 8 | source: 9 | description: The source of funds to send from 10 | type: string 11 | default: balance 12 | currency: 13 | description: Specify the currency of the transfer. 14 | type: string 15 | default: NGN 16 | enum: 17 | - NGN 18 | - ZAR 19 | - KES 20 | - GHS 21 | example: 22 | source: balance 23 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/storefront_{id}_order.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Storefront 4 | summary: Fetch Storefront Orders 5 | description: Fetch all orders in your Storefront 6 | operationId: storefront_fetchOrders 7 | parameters: 8 | - name: id 9 | description: The unique identifier of the Storefront 10 | in: path 11 | required: true 12 | schema: 13 | type: integer 14 | example: 1559046 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderItems.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: The collection of items that make up the order 3 | required: 4 | - item 5 | - type 6 | - quantity 7 | - amount 8 | properties: 9 | item: 10 | description: The product ID of the item 11 | type: integer 12 | type: 13 | description: The type of the item. `product` is currently the acceptable value 14 | type: string 15 | quantity: 16 | description: The number of items to get 17 | type: integer 18 | amount: 19 | description: The cost of the item 20 | type: integer 21 | example: 22 | item: 2179824 23 | type: product 24 | quantity: 200000 25 | amount: 2 -------------------------------------------------------------------------------- /src/assets/openapi/paths/subscription_{code}_manage_link.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Subscription 4 | summary: Generate Update Subscription Link 5 | description: Generate a link for updating the card on a subscription 6 | operationId: subscription_manageLink 7 | parameters: 8 | - name: code 9 | in: path 10 | required: true 11 | description: Subscription code 12 | schema: 13 | type: string 14 | example: "qlgwhpyq1ts9nsw" 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/order_{id}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of the order 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 1559046 9 | get: 10 | tags: 11 | - Order 12 | summary: Fetch Order 13 | description: Fetch the details of a previously created order 14 | operationId: order_fetch 15 | responses: 16 | '200': 17 | $ref: ../components/responses/OrderFetchSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/refund_{id}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Refund 4 | summary: Fetch Refund 5 | description: Get a previously created refund 6 | operationId: refund_fetch 7 | parameters: 8 | - name: id 9 | in: path 10 | required: true 11 | description: The identifier of the refund 12 | schema: 13 | type: integer 14 | example: 15581137 15 | responses: 16 | '200': 17 | $ref: ../components/responses/RefundFetchSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/Error.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | description: An indicator for the state of the request 6 | message: 7 | type: string 8 | description: A short description of the error 9 | meta: 10 | $ref: ./ErrorMeta.yaml 11 | type: 12 | type: string 13 | description: A tag to indicate the type of the error 14 | code: 15 | type: string 16 | description: The error code 17 | enum: 18 | - validation_error 19 | - processor_error 20 | - api_error 21 | errorCodeMappingNotFound: 22 | type: boolean 23 | description: An indicator for error mapping for the request 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/directdebit_activation-charge.yaml: -------------------------------------------------------------------------------- 1 | put: 2 | tags: 3 | - Direct Debit 4 | summary: Trigger Activation Charge 5 | description: Trigger activation charge for specified customers 6 | operationId: directdebit_triggerActivationCharge 7 | requestBody: 8 | required: true 9 | content: 10 | application/json: 11 | schema: 12 | $ref: ../components/schemas/DirectDebitActivationChargeRequest.yaml 13 | responses: 14 | '200': 15 | $ref: ../components/responses/DirectDebitActivationChargeSuccess.yaml 16 | '401': 17 | $ref: ../components/responses/Unauthorized.yaml 18 | default: 19 | description: Server error 20 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/subscription_{code}_manage_email.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Subscription 4 | summary: Send Update Subscription Link 5 | description: Email a customer a link for updating the card on their subscription 6 | operationId: subscription_manageEmail 7 | parameters: 8 | - name: code 9 | in: path 10 | required: true 11 | description: Subscription code 12 | schema: 13 | type: string 14 | example: "qlgwhpyq1ts9nsw" 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalListsResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./TerminalListsResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | next: 15 | type: string 16 | nullable: true 17 | previous: 18 | type: string 19 | nullable: true 20 | perPage: 21 | type: integer 22 | required: 23 | - next 24 | - previous 25 | - perPage 26 | additionalProperties: false 27 | required: 28 | - status 29 | - message 30 | - data 31 | - meta 32 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_finalize_transfer.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transfer 4 | summary: Finalize Transfer 5 | description: Finalize an initiated transfer 6 | operationId: transfer_finalize 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/TransferFinalize.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/TransferFinalize.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/virtual_terminal_{code}_deactivate.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: code 3 | in: path 4 | description: Code of the Virtual Terminal 5 | required: true 6 | schema: 7 | type: string 8 | example: "VT_MCK5292Z" 9 | put: 10 | tags: 11 | - Virtual Terminal 12 | summary: Deactivate Virtual Terminal 13 | operationId: virtualTerminal_deactivate 14 | description: Deactivate a Virtual Terminal on your integration 15 | responses: 16 | '200': 17 | $ref: ../components/responses/VirtualTerminalDeactivateSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/storefront_{id}_publish.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of the Storefront 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 1559046 9 | post: 10 | tags: 11 | - Storefront 12 | summary: Publish Storefront 13 | description: Make your Storefront publicly available 14 | operationId: storefront_publish 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalListsResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | serial_number: 6 | type: string 7 | nullable: true 8 | device_make: 9 | type: string 10 | nullable: true 11 | terminal_id: 12 | type: string 13 | integration: 14 | type: integer 15 | domain: 16 | type: string 17 | name: 18 | type: string 19 | nullable: true 20 | address: 21 | type: string 22 | nullable: true 23 | status: 24 | type: string 25 | required: 26 | - id 27 | - serial_number 28 | - device_make 29 | - terminal_id 30 | - integration 31 | - domain 32 | - name 33 | - address 34 | - status 35 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/order_product_{id}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of the order 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 1559046 9 | get: 10 | tags: 11 | - Order 12 | summary: Fetch Product Orders 13 | description: Fetch all orders for a particular product 14 | operationId: order_product 15 | responses: 16 | '200': 17 | $ref: ../components/responses/OrderFetchProductSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/storefront_{id}_duplicate.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of the Storefront 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 1559046 9 | post: 10 | tags: 11 | - Storefront 12 | summary: Duplicate Storefront 13 | description: Duplicate a previously created Storefront 14 | operationId: storefront_duplicate 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/order_{code}_validate.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: code 3 | description: The unique code of a previously created order 4 | in: path 5 | required: true 6 | schema: 7 | type: string 8 | example: ORD_6z0lqwpmxrm7dsp 9 | get: 10 | tags: 11 | - Order 12 | summary: Validate Order 13 | description: Validate a pay for me order 14 | operationId: order_validate 15 | responses: 16 | '200': 17 | $ref: ../components/responses/OrderValidateSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/paymentrequest_finalize_{id}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of a draft payment request 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 18823736 9 | post: 10 | tags: 11 | - Payment Request 12 | summary: Finalize Payment Request 13 | description: Finalise the creation of a draft payment request for a customer 14 | operationId: paymentRequest_finalize 15 | responses: 16 | '200': 17 | $ref: ../components/responses/PaymentRequestFinalizeSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/subscription_enable.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Subscription 4 | summary: Enable Subscription 5 | description: Enable a subscription on your integration 6 | operationId: subscription_enable 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/SubscriptionToggle.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/SubscriptionToggle.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestTotalResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | pending: 11 | type: array 12 | items: 13 | $ref: ./PaymentRequestPendingArray.yaml 14 | successful: 15 | type: array 16 | items: 17 | $ref: ./PaymentRequestSuccessfulArray.yaml 18 | total: 19 | type: array 20 | items: 21 | $ref: ./PaymentRequestTotalArray.yaml 22 | required: 23 | - pending 24 | - successful 25 | - total 26 | required: 27 | - status 28 | - message 29 | - data 30 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeSubmitAddress.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - address 4 | - reference 5 | - city 6 | - state 7 | - zip_code 8 | properties: 9 | address: 10 | description: Customer's address 11 | type: string 12 | city: 13 | description: Customer's city 14 | type: string 15 | state: 16 | description: Customer's state 17 | type: string 18 | zip_code: 19 | description: Customer's zipcode 20 | type: string 21 | reference: 22 | description: The reference of the ongoing transaction 23 | type: string 24 | example: 25 | address: "140 N 2ND ST" 26 | city: "Stroudsburg" 27 | state: "PA" 28 | zip_code: "18360" 29 | reference: "5bwib5v6anhe9xa" -------------------------------------------------------------------------------- /src/assets/openapi/paths/charge_submit_address.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Charge 4 | summary: Submit Address 5 | operationId: charge_submitAddress 6 | description: Send the details of the customer's address for address verification 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/ChargeSubmitAddress.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/ChargeSubmitAddress.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/dispute_{id}_upload_url.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Dispute 4 | summary: Fetch Upload URL 5 | description: Get the URL to upload a dispute evidence 6 | operationId: dispute_uploadUrl 7 | parameters: 8 | - name: id 9 | description: The unique identifier of the dispute 10 | in: path 11 | required: true 12 | schema: 13 | type: integer 14 | example: 4734583785 15 | responses: 16 | '200': 17 | $ref: ../components/responses/DisputeUploadURLSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/storefront_verify_{slug}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: slug 3 | description: The custom slug to check 4 | in: path 5 | required: true 6 | schema: 7 | type: string 8 | example: struct_and_faces 9 | get: 10 | tags: 11 | - Storefront 12 | summary: Verify Storefront Slug 13 | description: Verify the availability of a slug before using it for your Storefront 14 | operationId: storefront_verifySlug 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_enable_otp.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transfer 4 | summary: Enable OTP requirement for Transfers 5 | description: | 6 | In the event that a customer wants to stop being able to complete transfers programmatically, this endpoint helps turn OTP requirement back on. 7 | No arguments required. 8 | operationId: transfer_enableOtp 9 | responses: 10 | '200': 11 | description: 'Successful response' 12 | content: 13 | application/json: 14 | schema: 15 | $ref: ../components/schemas/TransferEnablesOtpResponse.yaml 16 | '401': 17 | $ref: ../components/responses/Unauthorized.yaml 18 | default: 19 | description: Server error 20 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/decision_bin_{bin}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Miscellaneous 4 | summary: Resolve Card BIN 5 | description: Get the details of a card BIN 6 | operationId: miscellaneous_resolveCardBin 7 | parameters: 8 | - name: bin 9 | description: The card bank identification number 10 | in: path 11 | required: true 12 | schema: 13 | type: integer 14 | example: 539983 15 | responses: 16 | '200': 17 | $ref: ../components/responses/VerificationResolveCardBINSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/paymentrequest_notify_{id}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of a previously created payment request 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 18823736 9 | post: 10 | tags: 11 | - Payment Request 12 | summary: Send Notification 13 | description: Trigger an email reminder to a customer for a previously created payment request 14 | operationId: paymentRequest_notify 15 | responses: 16 | '200': 17 | $ref: ../components/responses/PaymentRequestSendNotificationSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_disable_otp.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transfer 4 | summary: Disable OTP for Transfers 5 | description: | 6 | This is used in the event that you want to be able to complete transfers programmatically without use of OTPs. 7 | No arguments required. You will get an OTP to complete the request. 8 | operationId: transfer_disableOtp 9 | responses: 10 | '200': 11 | description: 'Successful response' 12 | content: 13 | application/json: 14 | schema: 15 | $ref: ../components/schemas/TransferDisablesOtpResponse.yaml 16 | '401': 17 | $ref: ../components/responses/Unauthorized.yaml 18 | default: 19 | description: Server error 20 | -------------------------------------------------------------------------------- /src/views/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Paystack OAS 8 | 9 | 10 | 11 |
12 | 13 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TerminalSendEvent.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | type: 4 | description: The type of event to push 5 | type: string 6 | enum: 7 | - invoice 8 | - transaction 9 | action: 10 | description: > 11 | The action the Terminal needs to perform. For the invoice type, the action 12 | can either be process or view. 13 | 14 | For the transaction type, the action can either be process or print. 15 | type: string 16 | enum: 17 | - process 18 | - view 19 | - print 20 | data: 21 | $ref: ./TerminalSendEventData.yaml 22 | example: 23 | type: invoice 24 | action: process 25 | data: 26 | id: 7895939 27 | reference: "4634337895939" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VerifyAuthorizationCardResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | status: 11 | type: string 12 | advise: 13 | type: string 14 | message: 15 | type: string 16 | authorizationCode: 17 | type: string 18 | customerEmail: 19 | type: string 20 | description: The customer email used to initialize authorization 21 | required: 22 | - status 23 | - advise 24 | - message 25 | - authorizationCode 26 | - customerEmail 27 | required: 28 | - status 29 | - message 30 | - data 31 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/subscription_disable.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Subscription 4 | summary: Disable Subscription 5 | description: Disable a subscription on your integration 6 | operationId: subscription_disable 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/SubscriptionToggle.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/SubscriptionToggle.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/SubscriptionDisableSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BalanceFetchLedgerResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | integration: 4 | type: integer 5 | domain: 6 | type: string 7 | balance: 8 | type: integer 9 | currency: 10 | type: string 11 | difference: 12 | type: integer 13 | reason: 14 | type: string 15 | model_responsible: 16 | type: string 17 | model_row: 18 | type: integer 19 | id: 20 | type: integer 21 | createdAt: 22 | type: string 23 | updatedAt: 24 | type: string 25 | required: 26 | - integration 27 | - domain 28 | - balance 29 | - currency 30 | - difference 31 | - reason 32 | - model_responsible 33 | - model_row 34 | - id 35 | - createdAt 36 | - updatedAt 37 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: "[FEAT] Feature name goes here" 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/RefundRetryAccountDetails.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: An object that contains the customer’s account details for refund 3 | required: 4 | - currency 5 | - account_number 6 | - bank_id 7 | properties: 8 | currency: 9 | description: The currency of the customer's bank account. It should be the same as the currency the payment was made 10 | type: string 11 | account_number: 12 | description: The customer's account number 13 | type: string 14 | bank_id: 15 | description: The ID representing the customer's bank. You can get the list of bank IDs by calling the List Banks endpoint. 16 | type: string 17 | example: 18 | currency: NGN 19 | account_number: '1234567890' 20 | bank_id: '9' -------------------------------------------------------------------------------- /src/assets/openapi/paths/dispute_transaction_{id}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Dispute 4 | summary: List Transaction Disputes 5 | description: List all disputes filed for a transaction 6 | operationId: dispute_transaction 7 | parameters: 8 | - name: id 9 | description: The unique identifier of the transaction 10 | in: path 11 | required: true 12 | schema: 13 | type: integer 14 | example: 4734583785 15 | responses: 16 | '200': 17 | $ref: ../components/responses/DisputeListTransactionSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/subscription_{code}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: code 3 | in: path 4 | required: true 5 | description: The subscription code for the subscription you want to fetch 6 | schema: 7 | type: string 8 | example: "SUB_5co81xgmwg78x3d" 9 | get: 10 | tags: 11 | - Subscription 12 | summary: Fetch Subscription 13 | description: Get details of a customer's subscription 14 | operationId: subscription_fetch 15 | responses: 16 | '200': 17 | $ref: ../components/responses/SubscriptionFetchSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferBulk.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - source 4 | - transfers 5 | properties: 6 | source: 7 | description: The source of funds for the transfer. 8 | type: string 9 | default: balance 10 | currency: 11 | description: Specify the currency of the transfer. 12 | type: string 13 | default: NGN 14 | enum: 15 | - NGN 16 | - ZAR 17 | - KES 18 | - GHS 19 | transfers: 20 | description: A list of transfer object 21 | type: array 22 | items: 23 | $ref: ./TransferBase.yaml 24 | example: 25 | source: balance 26 | transfers: 27 | - amount: 120000 28 | recipient: RCP_gd9vgag7n5lr5ix 29 | reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PageListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./PageListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PlanListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./PlanListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SplitListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./SplitListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SplitUpdate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | name: 4 | description: Name of the transaction split 5 | type: string 6 | active: 7 | description: Toggle status of split. When true, the split is active, else it's inactive 8 | type: boolean 9 | bearer_type: 10 | description: This allows you specify how the transaction charge should be processed 11 | type: string 12 | enum: 13 | - subaccount 14 | - account 15 | - all-proportional 16 | - all 17 | bearer_subaccount: 18 | description: >- 19 | This is the subaccount code of the customer or partner that would bear the 20 | transaction charge if you specified subaccount as the bearer type 21 | type: string 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/customer_{id}_directdebit-mandate-authorizations.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Customer 4 | summary: Fetch Mandate Authorizations 5 | operationId: customer_fetchMandateAuthorizations 6 | description: Get the list of direct debit mandates associated with a customer 7 | parameters: 8 | - name: id 9 | in: path 10 | required: true 11 | description: The customer ID for the authorizations to fetch 12 | schema: 13 | type: integer 14 | example: 297346561 15 | responses: 16 | '200': 17 | $ref: ../components/responses/CustomerFetchMandateAuthorizationsSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./DisputeListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ProductListsResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./ProductListsResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: string 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./TransferListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/page_check_slug_availability_{slug}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: slug 3 | in: path 4 | description: The custom slug to check 5 | required: true 6 | schema: 7 | type: string 8 | example: risky-burger 9 | get: 10 | tags: 11 | - Page 12 | summary: Check Slug Availability 13 | description: Check if a custom slug is available for use when creating a payment page 14 | operationId: page_checkSlugAvailability 15 | responses: 16 | '200': 17 | $ref: ../components/responses/PageCheckSlugAvailabilitySuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/terminal_decommission_device.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Terminal 4 | summary: Decommission Terminal 5 | description: Unlink your debug device from your integration 6 | operationId: terminal_decommission 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/TerminalActivationToggle.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/TerminalActivationToggle.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/TerminalDecommissionDeviceSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import express from 'express' 2 | import fs from 'fs' 3 | import YAML from 'yaml' 4 | import path from 'path' 5 | import open from 'open'; 6 | 7 | const app = express() 8 | const port = 7070 9 | 10 | const __dirname = new URL('.', import.meta.url).pathname; 11 | const file = fs.readFileSync(path.join(__dirname, '../dist/paystack.yaml'), 'utf8') 12 | const oas = YAML.parse(file) 13 | 14 | app.use(express.static(path.join(__dirname, '/views'))); 15 | 16 | app.get('/health', (_, res) => { 17 | res.send('Server running fine...') 18 | }) 19 | 20 | app.get('/spec', (_, res) => { 21 | res.json(oas) 22 | }) 23 | 24 | app.listen(port, () => { 25 | console.log(`OAS spec is listening on port ${port}`) 26 | open(`http://localhost:${port}`); 27 | }) 28 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/RefundCreate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - transaction 4 | properties: 5 | transaction: 6 | description: The reference of a previosuly completed transaction 7 | type: string 8 | amount: 9 | description: >- 10 | Amount to be refunded to the customer. It cannot be more than the original transaction amount 11 | type: integer 12 | currency: 13 | description: Three-letter ISO currency 14 | type: string 15 | enum: 16 | - GHS 17 | - KES 18 | - NGN 19 | - USD 20 | - ZAR 21 | customer_note: 22 | description: Customer reason 23 | type: string 24 | merchant_note: 25 | description: Merchant reason 26 | type: string 27 | example: 28 | transaction: mpkr39h74k -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./StorefrontListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SubaccountListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./SubaccountListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/bank_validate.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Bank 4 | summary: Validate Bank Account 5 | description: Confirm the authenticity of a customer's account number before sending money 6 | operationId: bank_validateAccountNumber 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/BankValidateRequest.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/BankValidateRequest.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/VerificationValidateAccountSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/settlement_{id}_transactions.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Settlement 4 | summary: Fetch Settlement Transactions 5 | description: Get the transactions that make up a particular settlement 6 | operationId: settlements_transaction 7 | parameters: 8 | - name: id 9 | description: The settlement ID in which you want to fetch its transactions 10 | in: path 11 | required: true 12 | schema: 13 | type: integer 14 | example: 8610870 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/terminal_commission_device.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Terminal 4 | summary: Commission Terminal 5 | description: Activate your debug device by linking it to your integration 6 | operationId: terminal_commission 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/TerminalActivationToggle.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/TerminalActivationToggle.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/TerminalCommissionDeviceSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SubscriptionListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./SubscriptionListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/address_verification_states.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Miscellaneous 4 | summary: List States (AVS) 5 | operationId: miscellaneous_avs 6 | description: Get a list of states for a country for address verification 7 | parameters: 8 | - in: query 9 | name: country 10 | description: The country code of the states to list. It is gotten after the charge request 11 | schema: 12 | type: string 13 | example: CA 14 | responses: 15 | '200': 16 | $ref: ../components/responses/MiscellaneousListStatesSuccess.yaml 17 | '401': 18 | $ref: ../components/responses/Unauthorized.yaml 19 | '404': 20 | $ref: ../components/responses/NotFound.yaml 21 | default: 22 | description: Server error 23 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/paymentrequest_verify_{id}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of a previously created payment request 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 18823736 9 | get: 10 | tags: 11 | - Payment Request 12 | summary: Verify Payment Request 13 | description: Verify the status of a previously created payment request 14 | operationId: paymentRequest_verify 15 | responses: 16 | '200': 17 | $ref: ../components/responses/PaymentRequestVerifySuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BalanceFetchLedgerResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./BalanceFetchLedgerResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DedicatedNubanListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./DedicatedNubanListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PreAuthorizationListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./PreAuthorizationListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontListResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | id: 4 | type: integer 5 | name: 6 | type: string 7 | slug: 8 | type: string 9 | orders_count: 10 | type: integer 11 | status: 12 | type: string 13 | revenue: 14 | nullable: true 15 | currency: 16 | type: string 17 | products: 18 | type: array 19 | items: {} 20 | contacts: 21 | type: array 22 | items: {} 23 | social_media: 24 | type: array 25 | items: {} 26 | shipping_fees: 27 | type: array 28 | items: {} 29 | required: 30 | - id 31 | - name 32 | - slug 33 | - orders_count 34 | - status 35 | - revenue 36 | - currency 37 | - products 38 | - contacts 39 | - social_media 40 | - shipping_fees 41 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferRecipientListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./TransferRecipientListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - total 26 | - skipped 27 | - perPage 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerAuthorizationInitializeRequest.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - email 4 | - channel 5 | properties: 6 | email: 7 | type: string 8 | description: Customer's email address 9 | example: ravi@demo.com 10 | channel: 11 | type: string 12 | description: direct_debit is the only supported option for now 13 | enum: 14 | - direct_debit 15 | example: direct_debit 16 | callback_url: 17 | type: string 18 | description: >- 19 | Fully qualified url (e.g. https://example.com/) to redirect your customer 20 | to 21 | example: http://test.url.com 22 | account: 23 | $ref: ./CustomerAuthorizationInitializeAccount.yaml 24 | address: 25 | $ref: ./CustomerAuthorizationInitializeAddress.yaml 26 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/charge_submit_otp.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Charge 4 | summary: Submit OTP 5 | operationId: charge_submitOtp 6 | description: Submit OTP to complete a charge 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/ChargeSubmitOTP.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/ChargeSubmitOTP.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/ChargeSubmitOtpResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/charge_submit_pin.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Charge 4 | summary: Submit PIN 5 | operationId: charge_submitPin 6 | description: Submit PIN to continue a charge 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/ChargeSubmitPin.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/ChargeSubmitPin.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/ChargeSubmitPinResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DedicatedVirtualAccountCreate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - customer 4 | properties: 5 | customer: 6 | description: The code for the previously created customer 7 | type: string 8 | preferred_bank: 9 | description: >- 10 | The bank slug for preferred bank. To get a list of available banks, use 11 | the List Providers endpoint 12 | type: string 13 | subaccount: 14 | description: Subaccount code of the account you want to split the transaction with 15 | type: string 16 | split_code: 17 | description: >- 18 | Split code consisting of the lists of accounts you want to split the 19 | transaction with 20 | type: string 21 | example: 22 | customer: "CUS_bo732eugpb2qrg6" 23 | preferred_bank: "titan-paystack" -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PreAuthorizationVerifyResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | id: 11 | type: integer 12 | domain: 13 | type: string 14 | status: 15 | type: string 16 | reference: 17 | type: string 18 | amount: 19 | type: integer 20 | message: 21 | type: string 22 | currency: 23 | type: string 24 | redirecturl: 25 | type: string 26 | required: 27 | - id 28 | - domain 29 | - status 30 | - reference 31 | - amount 32 | - message 33 | - currency 34 | required: 35 | - status 36 | - message 37 | - data 38 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/terminal_{terminal_id}_presence.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Terminal 4 | summary: Fetch Terminal Status 5 | description: Check the availiability of a Terminal before sending an event to it 6 | operationId: terminal_fetchTerminalStatus 7 | parameters: 8 | - name: terminal_id 9 | in: path 10 | required: true 11 | description: The ID of the Terminal the event should be sent to. 12 | schema: 13 | type: string 14 | example: Z0R4orOU 15 | responses: 16 | '200': 17 | $ref: ../components/responses/TerminalGetStatusSuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BulkChargeFetchBulkBatchChargesResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./BulkChargeFetchBulkBatchChargesResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | perPage: 15 | type: string 16 | total: 17 | type: integer 18 | skipped: 19 | type: integer 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | required: 25 | - perPage 26 | - total 27 | - skipped 28 | - page 29 | - pageCount 30 | additionalProperties: false 31 | required: 32 | - status 33 | - message 34 | - data 35 | - meta 36 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/charge_submit_phone.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Charge 4 | summary: Submit Phone 5 | operationId: charge_submitPhone 6 | description: Submit phone number when requested 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/ChargeSubmitPhone.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/ChargeSubmitPhone.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/ChargeSubmitPhoneResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_{code}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: code 3 | description: Transfer code 4 | in: path 5 | required: true 6 | schema: 7 | type: string 8 | example: TRF_1ptvuv321ahaa7q 9 | get: 10 | tags: 11 | - Transfer 12 | summary: Fetch Transfer 13 | description: Get details of a transfer on your integration 14 | operationId: transfer_fetch 15 | responses: 16 | '200': 17 | description: 'Succesful operation' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/TransferFetchResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | '404': 25 | $ref: ../components/responses/NotFound.yaml 26 | default: 27 | description: Server error 28 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./CustomerListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | anyOf: 20 | - type: string 21 | - type: integer 22 | page: 23 | type: integer 24 | pageCount: 25 | type: integer 26 | required: 27 | - total 28 | - skipped 29 | - perPage 30 | - page 31 | - pageCount 32 | additionalProperties: false 33 | required: 34 | - status 35 | - message 36 | - data 37 | - meta 38 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontCreate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - name 4 | - slug 5 | - currency 6 | properties: 7 | name: 8 | description: Name of the storefront 9 | type: string 10 | slug: 11 | description: > 12 | A unique identifier to access your store. Once the storefront is created, 13 | it can be accessed from 14 | https://paystack.shop/your-slug 15 | type: string 16 | currency: 17 | description: Currency for prices of products in your storefront. 18 | type: string 19 | enum: 20 | - GHS 21 | - KES 22 | - NGN 23 | - USD 24 | - ZAR 25 | description: 26 | description: The description of the storefront 27 | type: string 28 | example: 29 | name: Obi and Sons 30 | slug: 'obi_and_sons' 31 | currency: NGN -------------------------------------------------------------------------------- /src/assets/openapi/paths/customer_authorization_verify_{reference}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Customer 4 | summary: Verify Authorization 5 | description: Check the status of an authorization request 6 | operationId: customer_verifyAuthorization 7 | parameters: 8 | - name: reference 9 | in: path 10 | description: The reference returned in the initialization response 11 | required: true 12 | schema: 13 | type: string 14 | example: "dfbzfotsrbv4n5s82t4mp5b5mfn51h" 15 | responses: 16 | '200': 17 | $ref: ../components/responses/CustomerAuthorizationVerifySuccess.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | '404': 21 | $ref: ../components/responses/NotFound.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/dedicated_account_assign.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Dedicated Virtual Account 4 | summary: Assign Dedicated Account 5 | operationId: dedicatedAccount_assign 6 | description: With this endpoint, you can create a customer, validate the customer, and assign a DVA to the customer. 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/DedicatedVirtualAccountAssign.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/DedicatedVirtualAccountAssign.yaml 15 | responses: 16 | '200': 17 | $ref: ../components/responses/Ok.yaml 18 | '401': 19 | $ref: ../components/responses/Unauthorized.yaml 20 | default: 21 | description: Server error 22 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/BulkChargeListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./BulkChargeListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | anyOf: 20 | - type: integer 21 | - type: string 22 | page: 23 | type: integer 24 | pageCount: 25 | type: integer 26 | required: 27 | - total 28 | - skipped 29 | - perPage 30 | - page 31 | - pageCount 32 | additionalProperties: false 33 | required: 34 | - status 35 | - message 36 | - data 37 | - meta 38 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./OrderListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | revenue: 17 | type: object 18 | skipped: 19 | type: integer 20 | perPage: 21 | type: integer 22 | page: 23 | type: integer 24 | pageCount: 25 | type: integer 26 | required: 27 | - total 28 | - revenue 29 | - skipped 30 | - perPage 31 | - page 32 | - pageCount 33 | additionalProperties: false 34 | required: 35 | - status 36 | - message 37 | - data 38 | - meta 39 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/StorefrontShippingResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | fee: 11 | type: integer 12 | name: 13 | type: string 14 | currency: 15 | type: string 16 | id: 17 | type: integer 18 | isDeleted: 19 | type: boolean 20 | createdAt: 21 | type: string 22 | updatedAt: 23 | type: string 24 | storefront: 25 | type: integer 26 | required: 27 | - fee 28 | - name 29 | - currency 30 | - id 31 | - isDeleted 32 | - createdAt 33 | - updatedAt 34 | - storefront 35 | required: 36 | - status 37 | - message 38 | - data 39 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDestinationAssign.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - destinations 4 | properties: 5 | destinations: 6 | type: array 7 | description: >- 8 | Array of objects containing recipients for payment notifications for the 9 | Virtual Terminal. 10 | items: 11 | type: object 12 | properties: 13 | target: 14 | type: string 15 | description: The WhatsApp number to receive payment notifications 16 | name: 17 | type: string 18 | description: The name of the associated WhatsApp number 19 | required: 20 | - target 21 | - name 22 | example: 23 | destinations: 24 | - target: '+2548012345678' 25 | name: John Doe 26 | - target: '+2548098765432' 27 | name: Jane Smith 28 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/PaymentRequestListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./PaymentRequestListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | anyOf: 20 | - type: integer 21 | - type: string 22 | page: 23 | type: integer 24 | pageCount: 25 | type: integer 26 | required: 27 | - total 28 | - skipped 29 | - perPage 30 | - page 31 | - pageCount 32 | additionalProperties: false 33 | required: 34 | - status 35 | - message 36 | - data 37 | - meta 38 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/charge_submit_birthday.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Charge 4 | summary: Submit Birthday 5 | operationId: charge_submitBirthday 6 | description: Submit the customer's birthday when requested 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/ChargeSubmitBirthday.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/ChargeSubmitBirthday.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/ChargeSubmitBirthdayResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/RefundListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./RefundListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | skipped: 17 | type: integer 18 | perPage: 19 | type: string 20 | page: 21 | type: integer 22 | pageCount: 23 | type: integer 24 | failedRefundCount: 25 | type: integer 26 | required: 27 | - total 28 | - skipped 29 | - perPage 30 | - page 31 | - pageCount 32 | - failedRefundCount 33 | additionalProperties: false 34 | required: 35 | - status 36 | - message 37 | - data 38 | - meta 39 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VirtualTerminalDestinationAssignResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | type: object 11 | properties: 12 | integration: 13 | type: integer 14 | target: 15 | type: string 16 | name: 17 | type: string 18 | type: 19 | type: string 20 | id: 21 | type: integer 22 | createdAt: 23 | type: string 24 | updatedAt: 25 | type: string 26 | required: 27 | - integration 28 | - target 29 | - name 30 | - type 31 | - id 32 | - createdAt 33 | - updatedAt 34 | required: 35 | - status 36 | - message 37 | - data 38 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/paymentrequest_archive_{id}.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | description: The unique identifier of a previously created payment request 4 | in: path 5 | required: true 6 | schema: 7 | type: integer 8 | example: 18823736 9 | post: 10 | tags: 11 | - Payment Request 12 | summary: Archive Payment Request 13 | description: | 14 | Archive a payment request to clean up your records. An archived payment request cannot be verified and will not 15 | be returned when listing all previously created payment requests. 16 | operationId: paymentRequest_archive 17 | responses: 18 | '200': 19 | $ref: ../components/responses/PaymentRequestArchiveSuccess.yaml 20 | '401': 21 | $ref: ../components/responses/Unauthorized.yaml 22 | default: 23 | description: Server error 24 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/settlement.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Settlement 4 | summary: List Settlements 5 | description: List settlements made to your settlement accounts 6 | operationId: settlements_fetch 7 | parameters: 8 | - name: perPage 9 | description: The number of records to fetch per request 10 | in: query 11 | schema: 12 | type: integer 13 | example: 50 14 | - name: page 15 | description: The offset to retrieve data from 16 | in: query 17 | schema: 18 | type: integer 19 | example: 2 20 | responses: 21 | '200': 22 | $ref: ../components/responses/Ok.yaml 23 | '401': 24 | $ref: ../components/responses/Unauthorized.yaml 25 | '404': 26 | $ref: ../components/responses/NotFound.yaml 27 | default: 28 | description: Server error 29 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transaction_{id}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Transaction 4 | summary: Fetch Transaction 5 | operationId: transaction_fetch 6 | description: Fetch a transaction to get its details 7 | parameters: 8 | - name: id 9 | in: path 10 | description: The ID of the transaction to fetch 11 | required: true 12 | schema: 13 | type: integer 14 | format: int64 15 | example: 4099260516 16 | responses: 17 | '200': 18 | description: '' 19 | content: 20 | application/json: 21 | schema: 22 | $ref: ../components/schemas/TransactionFetchResponse.yaml 23 | '401': 24 | $ref: ../components/responses/Unauthorized.yaml 25 | '404': 26 | $ref: ../components/responses/NotFound.yaml 27 | default: 28 | description: Server error 29 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transaction_partial_debit.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transaction 4 | summary: Partial Debit 5 | operationId: transaction_partialDebit 6 | description: Retrieve part of a payment from a customer 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/TransactionPartialDebit.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/TransactionPartialDebit.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/TransactionPartialDebitResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderFetchProductResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./OrderFetchProductResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | quantity_sold: 15 | type: integer 16 | revenue: 17 | type: integer 18 | total: 19 | type: integer 20 | skipped: 21 | type: integer 22 | perPage: 23 | type: integer 24 | pageCount: 25 | type: integer 26 | required: 27 | - quantity_sold 28 | - revenue 29 | - total 30 | - skipped 31 | - perPage 32 | - pageCount 33 | additionalProperties: false 34 | required: 35 | - status 36 | - message 37 | - data 38 | - meta 39 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transaction_verify_{reference}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Transaction 4 | summary: Verify Transaction 5 | operationId: transaction_verify 6 | description: Verify a previously initiated transaction using it's reference 7 | parameters: 8 | - name: reference 9 | in: path 10 | description: The transaction reference to verify 11 | required: true 12 | schema: 13 | type: string 14 | example: re4lyvq3s3 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/VerifyResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | '404': 25 | $ref: ../components/responses/NotFound.yaml 26 | default: 27 | description: Server error 28 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_verify_{reference}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Transfer 4 | summary: Verify Transfer 5 | description: Verify the status of a transfer on your integration 6 | operationId: transfer_verify 7 | parameters: 8 | - name: reference 9 | description: Transfer reference 10 | in: path 11 | required: true 12 | schema: 13 | type: string 14 | example: acv_9ee55786-2323-4760-98e2-6380c9cb3f67 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/TransferVerifyResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | '404': 25 | $ref: ../components/responses/NotFound.yaml 26 | default: 27 | description: Server error 28 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/bulkcharge_pause_{code}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Bulk Charge 4 | summary: Pause Bulk Charge Batch 5 | operationId: bulkCharge_pause 6 | description: Pause the processing of a charge batch 7 | parameters: 8 | - name: code 9 | description: The batch code for the bulk charge you want to pause 10 | in: path 11 | required: true 12 | schema: 13 | type: string 14 | example: "BCH_180tl7oq7cayggh" 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/BulkChargePauseResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | '404': 25 | $ref: ../components/responses/NotFound.yaml 26 | default: 27 | description: Server error 28 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/customer_set_risk_action.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Customer 4 | summary: Set Risk Action 5 | description: Set customer's risk action by whitelisting or blacklisting the customer 6 | operationId: customer_riskAction 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/CustomerRiskAction.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/CustomerRiskAction.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/CustomerWhitelistBlacklistResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/CustomerListResponseArray.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | integration: 4 | type: integer 5 | first_name: 6 | type: string 7 | nullable: true 8 | last_name: 9 | type: string 10 | nullable: true 11 | email: 12 | type: string 13 | phone: 14 | type: string 15 | nullable: true 16 | metadata: 17 | type: object 18 | nullable: true 19 | domain: 20 | type: string 21 | customer_code: 22 | type: string 23 | risk_action: 24 | type: string 25 | id: 26 | type: integer 27 | createdAt: 28 | type: string 29 | updatedAt: 30 | type: string 31 | required: 32 | - integration 33 | - first_name 34 | - last_name 35 | - email 36 | - phone 37 | - metadata 38 | - domain 39 | - customer_code 40 | - risk_action 41 | - id 42 | - createdAt 43 | - updatedAt 44 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/EftDebitOrderLogMandateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | type: 6 | type: string 7 | code: 8 | type: string 9 | message: 10 | type: string 11 | data: 12 | type: array 13 | items: 14 | $ref: ./EftDebitOrderLogMandateResponseArray.yaml 15 | meta: 16 | type: object 17 | properties: 18 | total: 19 | type: integer 20 | skipped: 21 | type: integer 22 | perPage: 23 | type: integer 24 | page: 25 | type: integer 26 | pageCount: 27 | type: integer 28 | required: 29 | - total 30 | - skipped 31 | - perPage 32 | - page 33 | - pageCount 34 | additionalProperties: false 35 | required: 36 | - status 37 | - type 38 | - code 39 | - message 40 | - data 41 | - meta 42 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_resend_otp.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transfer 4 | summary: Resend OTP for Transfer 5 | description: Generates and send a new OTP to customer in the event they are having trouble receiving one. 6 | operationId: transfer_resendOtp 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/TransferResendOTP.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/TransferResendOTP.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/TransferResendsOtpResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/EftDebitOrderListMandateResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | type: 6 | type: string 7 | code: 8 | type: string 9 | message: 10 | type: string 11 | data: 12 | type: array 13 | items: 14 | $ref: ./EftDebitOrderListMandateResponseArray.yaml 15 | meta: 16 | type: object 17 | properties: 18 | total: 19 | type: integer 20 | skipped: 21 | type: integer 22 | perPage: 23 | type: integer 24 | page: 25 | type: integer 26 | pageCount: 27 | type: integer 28 | required: 29 | - total 30 | - skipped 31 | - perPage 32 | - page 33 | - pageCount 34 | additionalProperties: false 35 | required: 36 | - status 37 | - type 38 | - code 39 | - message 40 | - data 41 | - meta 42 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/bulkcharge_resume_{code}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Bulk Charge 4 | summary: Resume Bulk Charge Batch 5 | operationId: bulkCharge_resume 6 | description: Resume the processing of a previously paused charge batch 7 | parameters: 8 | - name: code 9 | description: The batch code for the bulk charge you want to pause 10 | in: path 11 | required: true 12 | schema: 13 | type: string 14 | example: "BCH_180tl7oq7cayggh" 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/BulkChargeResumeResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | '404': 25 | $ref: ../components/responses/NotFound.yaml 26 | default: 27 | description: Server error 28 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeResolve.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - resolution 4 | - message 5 | - refund_amount 6 | - uploaded_filename 7 | properties: 8 | resolution: 9 | description: Dispute resolution. Accepted values, merchant-accepted, declined 10 | type: string 11 | message: 12 | description: Reason for resolving 13 | type: string 14 | refund_amount: 15 | description: The amount to refund, in the subunit of your integration currency 16 | type: integer 17 | uploaded_filename: 18 | description: Filename of attachment returned via response from the Dispute upload URL 19 | type: string 20 | evidence: 21 | description: Evidence Id for fraud claims 22 | type: integer 23 | example: 24 | resolution: 'merchant-accepted' 25 | message: Merchant accepted 26 | refund_amount: 50000 27 | uploaded_filename: qesp8a4df1xejihd9x5q -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/SubscriptionCreate.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - customer 4 | - plan 5 | properties: 6 | customer: 7 | description: Customer's email address or customer code 8 | type: string 9 | plan: 10 | description: Plan code 11 | type: string 12 | authorization: 13 | description: >- 14 | If customer has multiple authorizations, you can set the desired 15 | authorization you wish to use for this subscription here. 16 | 17 | If this is not supplied, the customer's most recent authorization would be 18 | used 19 | type: string 20 | start_date: 21 | description: >- 22 | Set the date for the first debit. (ISO 8601 format) e.g. 23 | 2017-05-16T00:30:13+01:00 24 | type: string 25 | format: date-time 26 | example: 27 | customer: "CUS_xnxdt6s1zg1f4nx" 28 | plan: "PLN_gx2wn530m0i3w3m" 29 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/customer_authorization_initialize.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Customer 4 | summary: Initialize Authorization 5 | description: >- 6 | Initiate a request to create a reusable authorization code for recurring 7 | transactions 8 | operationId: customer_initializeAuthorization 9 | requestBody: 10 | required: true 11 | content: 12 | application/json: 13 | schema: 14 | $ref: ../components/schemas/CustomerAuthorizationInitializeRequest.yaml 15 | application/x-www-form-urlencoded: 16 | schema: 17 | $ref: ../components/schemas/CustomerAuthorizationInitializeRequest.yaml 18 | responses: 19 | '200': 20 | $ref: ../components/responses/CustomerAuthorizationInitializeSuccess.yaml 21 | '401': 22 | $ref: ../components/responses/Unauthorized.yaml 23 | default: 24 | description: Server error 25 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionListResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: array 9 | items: 10 | $ref: ./TransactionListResponseArray.yaml 11 | meta: 12 | type: object 13 | properties: 14 | total: 15 | type: integer 16 | total_volume: 17 | type: number 18 | skipped: 19 | type: integer 20 | perPage: 21 | anyOf: 22 | - type: string 23 | - type: integer 24 | page: 25 | type: integer 26 | pageCount: 27 | type: integer 28 | required: 29 | - total 30 | - total_volume 31 | - skipped 32 | - perPage 33 | - page 34 | - pageCount 35 | additionalProperties: false 36 | required: 37 | - status 38 | - message 39 | - data 40 | - meta 41 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransferBase.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - amount 4 | - recipient 5 | - reference 6 | properties: 7 | amount: 8 | description: >- 9 | Amount to transfer in kobo if currency is NGN and pesewas if currency is 10 | GHS. 11 | type: integer 12 | recipient: 13 | description: The transfer recipient's code 14 | type: string 15 | reference: 16 | description: > 17 | To ensure idempotency, you need to provide e a unique identifier for the 18 | request. The identifier should be a lowercase alphanumeric string with 19 | only -,_ symbols allowed. 20 | type: string 21 | minimum: 16 22 | reason: 23 | description: The reason or narration for the transfer. 24 | type: string 25 | example: 26 | amount: 120000 27 | recipient: RCP_gd9vgag7n5lr5ix 28 | reference: acv_9ee55786-2323-4760-98e2-6380c9cb3f68 -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_bulk.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transfer 4 | summary: Initiate Bulk Transfer 5 | description: | 6 | Batch multiple transfers in a single request. 7 | 8 | You need to disable the Transfers OTP requirement to use this endpoint. 9 | operationId: transfer_bulk 10 | requestBody: 11 | content: 12 | application/json: 13 | schema: 14 | $ref: ../components/schemas/TransferBulk.yaml 15 | application/x-www-form-urlencoded: 16 | schema: 17 | $ref: ../components/schemas/TransferBulk.yaml 18 | responses: 19 | '200': 20 | description: '' 21 | content: 22 | application/json: 23 | schema: 24 | $ref: ../components/schemas/TransferBulkResponse.yaml 25 | '401': 26 | $ref: ../components/responses/Unauthorized.yaml 27 | default: 28 | description: Server error 29 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/ChargeMobileMoneyResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | transaction: 11 | type: integer 12 | phone: 13 | type: string 14 | provider: 15 | type: string 16 | channel_name: 17 | type: string 18 | display: 19 | type: object 20 | properties: 21 | type: 22 | type: string 23 | message: 24 | type: string 25 | timer: 26 | type: integer 27 | required: 28 | - type 29 | - message 30 | - timer 31 | required: 32 | - transaction 33 | - phone 34 | - provider 35 | - channel_name 36 | - display 37 | required: 38 | - status 39 | - message 40 | - data 41 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionPartialDebit.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - email 4 | - amount 5 | - authorization_code 6 | - currency 7 | properties: 8 | email: 9 | description: Customer's email address 10 | type: string 11 | amount: 12 | description: Specified in the lowest denomination of your currency 13 | type: integer 14 | format: int64 15 | authorization_code: 16 | description: Valid authorization code to charge 17 | type: string 18 | currency: 19 | $ref: ./Currency.yaml 20 | at_least: 21 | description: Minimum amount to charge 22 | type: string 23 | reference: 24 | description: >- 25 | Unique transaction reference. Only -, ., = and alphanumeric characters 26 | allowed. 27 | type: string 28 | example: 29 | email: tap@email.com 30 | amount: 40510 31 | authorization_code: AUTH_df1l5ehnym 32 | currency: ZAR 33 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/customer_authorization_deactivate.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Customer 4 | summary: Deactivate Authorization 5 | operationId: customer_deactivateAuthorization 6 | description: Deactivate an authorization for any payment channel. 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/CustomerDeactivateAuthorization.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/CustomerDeactivateAuthorization.yaml 15 | responses: 16 | '200': 17 | description: '' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/CustomerDeactivateAuthorizationResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/page_{id}_product.yaml: -------------------------------------------------------------------------------- 1 | parameters: 2 | - name: id 3 | in: path 4 | required: true 5 | schema: 6 | type: string 7 | post: 8 | tags: 9 | - Page 10 | summary: Add Products 11 | description: | 12 | Add products to a previously created payment page. You can only add products to pages 13 | that was created with a `product` type. 14 | operationId: page_addProducts 15 | requestBody: 16 | content: 17 | application/json: 18 | schema: 19 | $ref: ../components/schemas/PageProduct.yaml 20 | application/x-www-form-urlencoded: 21 | schema: 22 | $ref: ../components/schemas/PageProduct.yaml 23 | responses: 24 | '200': 25 | $ref: ../components/responses/PageAddProductsSuccess.yaml 26 | '401': 27 | $ref: ../components/responses/Unauthorized.yaml 28 | default: 29 | description: Server error 30 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/VerificationResolveCardBINResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | bin: 11 | type: string 12 | brand: 13 | type: string 14 | sub_brand: 15 | type: string 16 | country_code: 17 | type: string 18 | country_name: 19 | type: string 20 | card_type: 21 | type: string 22 | bank: 23 | type: string 24 | currency: 25 | type: string 26 | linked_bank_id: 27 | type: integer 28 | required: 29 | - bin 30 | - brand 31 | - sub_brand 32 | - country_code 33 | - country_name 34 | - card_type 35 | - bank 36 | - currency 37 | - linked_bank_id 38 | required: 39 | - status 40 | - message 41 | - data 42 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/dispute_{id}_evidence.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Dispute 4 | summary: Add Evidence 5 | description: Provide evidence for a dispute 6 | operationId: dispute_evidence 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/DisputeEvidence.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/DisputeEvidence.yaml 15 | parameters: 16 | - name: id 17 | description: The unique identifier of the dispute 18 | in: path 19 | required: true 20 | schema: 21 | type: integer 22 | example: 4734583785 23 | responses: 24 | '200': 25 | $ref: ../components/responses/DisputeAddEvidenceSuccess.yaml 26 | '401': 27 | $ref: ../components/responses/Unauthorized.yaml 28 | default: 29 | description: Server error 30 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transaction_timeline_{id}.yaml: -------------------------------------------------------------------------------- 1 | get: 2 | tags: 3 | - Transaction 4 | summary: Fetch Transaction Timeline 5 | operationId: transaction_timeline 6 | description: >- 7 | Fetch the steps taken from the initiation to the completion of a transaction 8 | parameters: 9 | - name: id 10 | in: path 11 | required: true 12 | description: The ID of the transaction to fetch 13 | schema: 14 | type: integer 15 | format: int64 16 | example: 3936799950 17 | responses: 18 | '200': 19 | description: '' 20 | content: 21 | application/json: 22 | schema: 23 | $ref: ../components/schemas/TransactionTimelineResponse.yaml 24 | '401': 25 | $ref: ../components/responses/Unauthorized.yaml 26 | '404': 27 | $ref: ../components/responses/NotFound.yaml 28 | default: 29 | description: Server error 30 | -------------------------------------------------------------------------------- /src/assets/openapi/paths/transfer_disable_otp_finalize.yaml: -------------------------------------------------------------------------------- 1 | post: 2 | tags: 3 | - Transfer 4 | summary: Finalize Disabling OTP for Transfers 5 | description: Finalize the request to disable OTP on your transfers 6 | operationId: transfer_disableOtpFinalize 7 | requestBody: 8 | content: 9 | application/json: 10 | schema: 11 | $ref: ../components/schemas/TransferFinalizeDisableOTP.yaml 12 | application/x-www-form-urlencoded: 13 | schema: 14 | $ref: ../components/schemas/TransferFinalizeDisableOTP.yaml 15 | responses: 16 | '200': 17 | description: 'Successful response' 18 | content: 19 | application/json: 20 | schema: 21 | $ref: ../components/schemas/TransferFinalizeDisablesOtpResponse.yaml 22 | '401': 23 | $ref: ../components/responses/Unauthorized.yaml 24 | default: 25 | description: Server error 26 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/OrderShipping.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | description: The shipping details of the order 3 | required: 4 | - street_line 5 | - city 6 | - state 7 | - country 8 | - shipping_fee 9 | properties: 10 | street_line: 11 | description: The address of for the delivery 12 | type: string 13 | city: 14 | description: The city of the delivery address 15 | type: string 16 | state: 17 | description: The state of the delivery address 18 | type: string 19 | country: 20 | description: The country of the delivery address 21 | type: string 22 | shipping_fee: 23 | description: The cost of delivery 24 | type: integer 25 | delivery_note: 26 | description: Extra details to be aware of for the delivery 27 | type: string 28 | example: 29 | street_line: Somewhere on Earth 30 | city: Atlantic 31 | state: Pacific 32 | country: Equator 33 | shipping_fee: 10000 -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/TransactionTotalsResponse.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | properties: 3 | status: 4 | type: boolean 5 | message: 6 | type: string 7 | data: 8 | type: object 9 | properties: 10 | total_transactions: 11 | type: integer 12 | total_volume: 13 | type: integer 14 | total_volume_by_currency: 15 | type: array 16 | items: 17 | $ref: ./TransactionTotalVolumeByCurrencyArray.yaml 18 | pending_transfers: 19 | type: integer 20 | pending_transfers_by_currency: 21 | type: array 22 | items: 23 | $ref: ./TransactionPendingTransfersByCurrencyArray.yaml 24 | required: 25 | - total_transactions 26 | - total_volume 27 | - total_volume_by_currency 28 | - pending_transfers 29 | - pending_transfers_by_currency 30 | required: 31 | - status 32 | - message 33 | - data 34 | -------------------------------------------------------------------------------- /src/assets/openapi/components/schemas/DisputeEvidence.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: 3 | - customer_email 4 | - customer_name 5 | - customer_phone 6 | - service_details 7 | properties: 8 | customer_email: 9 | description: Customer email 10 | type: string 11 | customer_name: 12 | description: Customer name 13 | type: string 14 | customer_phone: 15 | description: Customer mobile number 16 | type: string 17 | service_details: 18 | description: Details of service offered 19 | type: string 20 | delivery_address: 21 | description: Delivery address 22 | type: string 23 | delivery_date: 24 | description: ISO 8601 representation of delivery date (YYYY-MM-DD) 25 | type: string 26 | format: date-time 27 | example: 28 | customer_email: customer@email.com 29 | customer_name: Mensah King 30 | customer_phone: '08012345678' 31 | service_details: claim for buying cups 32 | 33 | --------------------------------------------------------------------------------