Api Reference

API Reference

Bank

• branches(string $bankId): Array|Object
• fxRate(array $params): Array|Object
• list(string $country): Array|Object
• resolveAccountNumber(array $params): Array|Object
• resolveBvn(string $bvn): Array|Object
• resolveCardBin(string $bin): Array|Object

Beneficiary

• create(array $params): Array|Object
• delete(string $beneficiaryId): Array|Object
• list(array $params): Array|Object

Bill

• categories(): Array|Object
• create(array $params): Array|Object
• createBulk(array $params): Array|Object
• list(array $params): Array|Object
• status(string $transactionRef): Array|Object
• validate(string $itemCode, array $params): Array|Object

Biller

• create(array $params): Array|Object
• list(array $params): Array|Object
• productAmount(string $billerCode, string $productCode): Array|Object
• products(string $billerCode): Array|Object
• updateOrder(string $orderId, array $params): Array|Object

Charge

• capturePreAuthorization(string $flw_ref, array $params): Array|Object
• create(array $params): Array|Object
• fetchBulkStatus(string $bulkId): Array|Object
• fetchBulkTransactions(string $bulkId): Array|Object
• refundPreAuthorization(string $flw_ref, array $params): Array|Object
• updateToken(string $token, array $params): Array|Object
• validate($params): Array|Object
• voidPreAuthorization(string $flw_ref, array $params): Array|Object
• withMultipleTokens($params): Array|Object
• withToken($params): Array|Object

Chargeback

• accept(string $chargeBackId): Array|Object
• decline(string $chargeBackId): Array|Object
• fetch(string $reference, array $params): Array|Object
• list(array $params): Array|Object

Flutterwave

• `getApiKey(): string
• `setApiKey($apiKey): void

Otp

• create(array $params): Array|Object
• validate(string $reference, array $params): Array|Object

PaymentPlan

• cancel(string $paymentPlanId): Array|Object
• create(array $params): Array|Object
• fetch(string $id): Array|Object
• list(array $params): Array|Object
• update(string &id array $params): Array|Object

Settlement

• fetch(string $id): Array|Object
• list(array $params): Array|Object

SubAccount

• create(array $params): Array|Object
• delete(string $subAccountId): Array|Object
• fetch(string $id): Array|Object
• list(array $params): Array|Object
• update(string &id array $params): Array|Object

Subscription

• activate(string $subscriptionId): Array|Object
• cancel(string $subscriptionId): Array|Object
• list(array $params): Array|Object

Transaction

• fee(array $params): Array|Object
• list(array $params): Array|Object
• refund(string $transactionId, array $params): Array|Object
• resendWebHook(string $transactionId, array $params): Array|Object
• timeline(string $transactionId): Array|Object
• verify(string $transactionId): Array|Object

Transfer

• create(array $params): Array|Object
• `createBulk(array $params): Array|Object
• `disableOtp($params = null): Array|Object
• `disableOtpFinalize($params): Array|Object
• `enableOtp($params = null): Array|Object
• `fee(array $params): Array|Object
• fetch(string $id): Array|Object
• `finalize($params): Array|Object
• list(array $params): Array|Object
• `resendOtp($params): Array|Object
• `toWallet(array $params): Array|Object

VirtualAccount

• create(array $params): Array|Object
• createBulk(array $params): Array|Object
• fetch(string $id): Array|Object
• fetchBulk(string $batchId): Array|Object

VirtualCard

• block(string $cardId): Array|Object
• create(array $params): Array|Object
• fetch(string $id): Array|Object
• fund(string $cardId, array $params): Array|Object
• list(array $params): Array|Object
• terminate(string $cardId): Array|Object
• transactions(string $cardId): Array|Object
• unblock(string $cardId): Array|Object
• withdraw(string $cardId, array $params): Array|Object

Wallet

• balanceByCurrency(string $currency): Array|Object
• create(array $params): Array|Object
• list(array $params): Array|Object