Skip to content

API Reference

Jump to bottom
Tim Oladoyinbo edited this page Jun 12, 2020 · 1 revision

API Reference

Balance

  • list(array $queryParams): Array|Object
  • ledger(array $data): Array|Object

Bank

  • list(array $queryParams): Array|Object
  • resolveBvn(string $bvn): Array|Object
  • bvnMatch(array $data): Array|Object
  • resolveAccountNumber(array $queryParams): Array|Object
  • resolveCardBin(string $bin): Array|Object

BulkCharge

  • list(array $queryParams): Array|Object
  • fetch(string $id): Array|Object
  • initiate(string $reference, array $data): Array|Object
  • fetchChargesInABatch(string $batchId, array $queryParams): Array|Object
  • pause(string $batchCode): Array|Object
  • resume(string $batchCode): Array|Object

Charge

  • create(array $data): Array|Object
  • fetch(string $id): Array|Object
  • submitPin(array $data): Array|Object
  • submitOtp(array $data): Array|Object
  • submitPhone(array $data): Array|Object
  • submitBirthday(array $data): Array|Object
  • checkPending(string $reference): Array|Object

Country

  • list(array $queryParams): Array|Object

Customer

  • list(array $queryParams): Array|Object
  • create(array $data): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object
  • whiteOrBlackList(array $data): Array|Object
  • deactivateAuthorization(array $data): Array|Object

Dispute

  • list(array $queryParams): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object
  • listTransactionDisputes(string $transactionId): Array|Object
  • addEvidence(string $disputeId, array $data): Array|Object
  • getUploadUrl(string $disputeId): Array|Object
  • resolve(string $disputeId, array $data): Array|Object
  • export(array $queryParams): Array|Object

Integration

  • fetchPaymentSessionTimeout(): Array|Object
  • updatePaymentSessionTimeout(array $data): Array|Object

Invoice

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object
  • verify(string $invoiceCode): Array|Object
  • notify(string $invoiceId, array $data): Array|Object
  • totals(): Array|Object
  • finalize(string $invoiceId, array $data): Array|Object
  • archive(string $invoiceId, array $data): Array|Object
  • markAsPaid(string $invoiceId, array $data): Array|Object

PaymentPage

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object
  • checkSlugAvailability(string $slug): Array|Object
  • addProducts(string $pageId, array $data): Array|Object

Paystack

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

Plan

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object

Product

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object

Refund

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

Settlement

  • list(array $queryParams): Array|Object
  • fetchSettlementTransactions(string $settlementId, array $queryParams): Array|Object

SubAccount

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • fetch(string $id): Array|Object
  • update(string $id, array $data): Array|Object

Subscription

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • fetch(string $id): Array|Object
  • disable(array $data): Array|Object
  • enable(array $data): Array|Object

Transaction

  • list(array $queryParams): Array|Object
  • fetch(string $id): Array|Object
  • intialize(array $data): Array|Object
  • verify(string $reference): Array|Object
  • chargeAuthorization(array $data): Array|Object
  • timeline(string $transactionId): Array|Object
  • totals(array $queryParams): Array|Object
  • export(array $queryParams): Array|Object
  • requestReauthorization(array $data): Array|Object
  • partialDebit(array $data): Array|Object

Transfer

  • list(array $queryParams): Array|Object
  • fetch(string $id): Array|Object
  • initiate(array $data): Array|Object
  • verify(string $reference): Array|Object
  • finalize(array $data): Array|Object
  • initiateBulkTransfer(array $data): Array|Object
  • resendOtp(array $data): Array|Object
  • disableOtp(array $data): Array|Object
  • disableOtpFinalize(array $data): Array|Object
  • enableOtp(array $data): Array|Object

TransferRecipient

  • list(array $queryParams): Array|Object
  • create(array $params): Array|Object
  • update(string $id, array $data): Array|Object
  • delete(string $recipientCode): Array|Object

Verification

  • list(array $data): Array|Object

Clone this wiki locally