API - Corsair

Every flutterwave.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Banks

getBranches

banks.getBranches Get branches for a bank. Risk: read

await corsair.flutterwave.api.banks.getBranches({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  branch_name?: string,
  branch_code?: string
}[]

getByCountry

banks.getByCountry Get banks by country. Risk: read

await corsair.flutterwave.api.banks.getByCountry({});

Input

Name	Type	Required	Description
`country`	`string \| number`	Yes	—
`include_provider_type`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  code?: string,
  name?: string
}[]

resolveAccount

banks.resolveAccount Resolve bank account details. Risk: read

await corsair.flutterwave.api.banks.resolveAccount({});

Input: object

Input full type

{
  account_number: string,
  account_bank: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    account_number: string,
    account_bank: string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  account_number?: string,
  account_name?: string
}

Beneficiaries

create

beneficiaries.create Create a transfer beneficiary. Risk: write

await corsair.flutterwave.api.beneficiaries.create({});

Input: object

Input full type

{
  body: {
    account_number: string,
    account_bank: string,
    beneficiary_name: string
  },
  query?: {
  }
} | {
  account_number: string,
  account_bank: string,
  beneficiary_name: string,
  query?: {
  },
  body?: {
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  bank_name?: string,
  full_name?: string
}

delete

beneficiaries.delete Delete a beneficiary by ID. Risk: destructive

await corsair.flutterwave.api.beneficiaries.delete({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number
}

get

beneficiaries.get Fetch a beneficiary by ID. Risk: read

await corsair.flutterwave.api.beneficiaries.get({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  bank_name?: string,
  full_name?: string
}

list

beneficiaries.list List all beneficiaries. Risk: read

await corsair.flutterwave.api.beneficiaries.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  bank_name?: string,
  full_name?: string
}[]

Bills

getCategories

bills.getCategories Get bill categories. Risk: read

await corsair.flutterwave.api.bills.getCategories({});

Input

Name	Type	Required	Description
`country`	`string`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  name?: string
}[]

listBillers

bills.listBillers List billers in a category. Risk: read

await corsair.flutterwave.api.bills.listBillers({});

Input

Name	Type	Required	Description
`category`	`string \| number`	Yes	—
`country`	`string`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  name?: string,
  biller_code?: string
}[]

listProducts

bills.listProducts List biller products. Risk: read

await corsair.flutterwave.api.bills.listProducts({});

Input

Name	Type	Required	Description
`biller_code`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  item_code?: string,
  name?: string,
  amount?: string | number
}[]

listRecurring

bills.listRecurring List recurring bill payments. Risk: read

await corsair.flutterwave.api.bills.listRecurring({});

Input

Name	Type	Required	Description
`status`	`any`	No	—
`from`	`any`	No	—
`to`	`any`	No	—
`page`	`number`	No	—
`limit`	`number`	No	—
`reference`	`any`	No	—
`category`	`any`	No	—
`country`	`string`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  status?: string
}[]

validateItem

bills.validateItem Validate a bill item before payment. Risk: read

await corsair.flutterwave.api.bills.validateItem({});

Input

Name	Type	Required	Description
`item_code`	`string \| number`	Yes	—
`customer`	`object`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

customer full type

{
  email: string,
  name?: string,
  phonenumber?: string
} | string

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  response_code?: string,
  response_message?: string,
  name?: string
}

Bulk Tokenized Charges

create

bulkTokenizedCharges.create Create a bulk tokenized charge batch. Risk: write

await corsair.flutterwave.api.bulkTokenizedCharges.create({});

Input: object

Input full type

{
  title: string,
  bulk_data: {
  }[],
  retry_strategy?: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    title: string,
    bulk_data: {
    }[]
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  status?: string
}

get

bulkTokenizedCharges.get Get status of bulk tokenized charges. Risk: read

await corsair.flutterwave.api.bulkTokenizedCharges.get({});

Input

Name	Type	Required	Description
`bulk_id`	`number`	Yes	—
`query`	`object`	No	—

query full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  status?: string,
  pending?: number
}

Bulk Virtual Accounts

create

bulkVirtualAccounts.create Create bulk virtual account numbers. Risk: write

await corsair.flutterwave.api.bulkVirtualAccounts.create({});

Input: object

Input full type

{
  body: {
    batch_ref: string,
    bulk_data: {
      firstname: string,
      lastname: string,
      email: string,
      bvn?: string,
      nin?: string
    }[],
    is_permanent?: boolean
  },
  query?: {
  }
} | {
  batch_ref: string,
  bulk_data: {
    firstname: string,
    lastname: string,
    email: string,
    bvn?: string,
    nin?: string
  }[],
  is_permanent?: boolean,
  query?: {
  },
  body?: {
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  batch_id?: string,
  response_code?: string
}

get

bulkVirtualAccounts.get Get details for a bulk virtual account batch. Risk: read

await corsair.flutterwave.api.bulkVirtualAccounts.get({});

Input

Name	Type	Required	Description
`batch_id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  batch_id?: string,
  status?: string
}

Cards

resolveBin

cards.resolveBin Resolve card BIN details. Risk: read

await corsair.flutterwave.api.cards.resolveBin({});

Input

Name	Type	Required	Description
`bin`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  issuing_country?: string,
  bin?: string,
  card_type?: string,
  issuer?: string
}

Chargebacks

list

chargebacks.list List chargebacks. Risk: read

await corsair.flutterwave.api.chargebacks.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`status`	`any`	No	—
`from`	`any`	No	—
`to`	`any`	No	—
`flw_ref`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string
}[]

Charges

initiateMobileMoneyTanzania

charges.initiateMobileMoneyTanzania Initiate mobile money charge in Tanzania. Risk: write

await corsair.flutterwave.api.charges.initiateMobileMoneyTanzania({});

Input: object

Input full type

{
  type: string,
  tx_ref: string,
  amount: string | number,
  currency: string,
  email: string,
  phone_number: string,
  query?: {
  },
  body?: {
  }
} | {
  type: string,
  query?: {
  },
  body: {
    tx_ref: string,
    amount: string | number,
    currency: string,
    email: string,
    phone_number: string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  tx_ref?: string,
  flw_ref?: string,
  status?: string,
  amount?: string | number,
  currency?: string
}

Payment Links

create

paymentLinks.create Create a hosted payment link. Risk: write

await corsair.flutterwave.api.paymentLinks.create({});

Input: object

Input full type

{
  tx_ref: string,
  amount: string | number,
  customer: {
    email: string,
    name?: string,
    phonenumber?: string
  } | string,
  currency?: string,
  redirect_url?: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    tx_ref: string,
    amount: string | number,
    customer: {
      email: string,
      name?: string,
      phonenumber?: string
    } | string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  link?: string
}

disable

paymentLinks.disable Disable an existing payment link. Risk: write

await corsair.flutterwave.api.paymentLinks.disable({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  status?: string
}

Payment Plans

cancel

paymentPlans.cancel Cancel a Flutterwave payment plan by ID. Risk: write

await corsair.flutterwave.api.paymentPlans.cancel({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  name?: string,
  amount?: string | number,
  interval?: string,
  status?: string
}

create

paymentPlans.create Create a payment plan. Risk: write

await corsair.flutterwave.api.paymentPlans.create({});

Input: object

Input full type

{
  amount: string | number,
  name: string,
  interval: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    amount: string | number,
    name: string,
    interval: string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  name?: string,
  amount?: string | number,
  interval?: string,
  status?: string
}

get

paymentPlans.get Get a payment plan by ID. Risk: read

await corsair.flutterwave.api.paymentPlans.get({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  name?: string,
  amount?: string | number,
  interval?: string,
  status?: string
}

list

paymentPlans.list List payment plans. Risk: read

await corsair.flutterwave.api.paymentPlans.list({});

Input

Name	Type	Required	Description
`from`	`any`	No	—
`to`	`any`	No	—
`page`	`number`	No	—
`amount`	`string \| number`	No	—
`currency`	`string`	No	—
`interval`	`string`	No	—
`status`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  name?: string,
  amount?: string | number,
  interval?: string,
  status?: string
}[]

update

paymentPlans.update Update a payment plan. Risk: write

await corsair.flutterwave.api.paymentPlans.update({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  name?: string,
  amount?: string | number,
  interval?: string,
  status?: string
}

Payout Subaccounts

list

payoutSubaccounts.list List payout subaccounts. Risk: read

await corsair.flutterwave.api.payoutSubaccounts.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`next_cursor`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_reference?: string
}[]

listRefunds

payoutSubaccounts.listRefunds List payout subaccount refunds. Risk: read

await corsair.flutterwave.api.payoutSubaccounts.listRefunds({});

Input

Name	Type	Required	Description
`status`	`string`	No	—
`from`	`any`	No	—
`to`	`any`	No	—
`reference`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string,
  tx_id?: string | number
}[]

Refunds

create

refunds.create Create a refund for a transaction. Risk: write

await corsair.flutterwave.api.refunds.create({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`amount`	`string \| number`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string,
  tx_id?: string | number
}

get

refunds.get Get refund details by ID. Risk: read

await corsair.flutterwave.api.refunds.get({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string,
  tx_id?: string | number
}

list

refunds.list List refund transactions with filters. Risk: read

await corsair.flutterwave.api.refunds.list({});

Input

Name	Type	Required	Description
`from`	`any`	No	—
`to`	`any`	No	—
`status`	`string`	No	—
`currency`	`string`	No	—
`flw_ref`	`any`	No	—
`id`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string,
  tx_id?: string | number
}[]

Settlements

list

settlements.list List settlements. Risk: read

await corsair.flutterwave.api.settlements.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`from`	`any`	No	—
`to`	`any`	No	—
`subaccount_id`	`any`	No	—
`disburse_ref`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string
}[]

Subaccounts

create

subaccounts.create Create a subaccount. Risk: write

await corsair.flutterwave.api.subaccounts.create({});

Input: object

Input full type

{
  account_bank: string,
  account_number: string,
  business_name: string,
  split_value: number,
  country: string,
  business_mobile: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    account_bank: string,
    account_number: string,
    business_name: string,
    split_value: number,
    country: string,
    business_mobile: string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  business_name?: string,
  split_value?: number
}

delete

subaccounts.delete Delete a subaccount by ID. Risk: destructive

await corsair.flutterwave.api.subaccounts.delete({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number
}

get

subaccounts.get Fetch a subaccount by ID. Risk: read

await corsair.flutterwave.api.subaccounts.get({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  business_name?: string,
  split_value?: number
}

list

subaccounts.list List all subaccounts. Risk: read

await corsair.flutterwave.api.subaccounts.list({});

Input

Name	Type	Required	Description
`account_bank`	`string`	No	—
`account_number`	`string`	No	—
`bank_name`	`any`	No	—
`page`	`number`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  business_name?: string,
  split_value?: number
}[]

update

subaccounts.update Update a subaccount. Risk: write

await corsair.flutterwave.api.subaccounts.update({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`business_name`	`string`	No	—
`split_value`	`number`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  account_number?: string,
  business_name?: string,
  split_value?: number
}

Subscriptions

list

subscriptions.list Get all subscriptions, including cancelled. Risk: read

await corsair.flutterwave.api.subscriptions.list({});

Input

Name	Type	Required	Description
`email`	`string`	No	—
`transaction_id`	`any`	No	—
`plan`	`any`	No	—
`subscribed_from`	`any`	No	—
`subscribed_to`	`any`	No	—
`next_due_from`	`any`	No	—
`next_due_to`	`any`	No	—
`page`	`number`	No	—
`status`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  status?: string,
  customer?: any,
  plan?: string | number
}[]

Transactions

generateReference

transactions.generateReference Generate a unique transaction reference. Risk: read

await corsair.flutterwave.api.transactions.generateReference({});

Input

Name	Type	Required	Description
`prefix`	`string`	No	—
`length`	`number`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  tx_ref?: string,
  reference?: string
}

get

transactions.get Get a transaction by ID. Risk: read

await corsair.flutterwave.api.transactions.get({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  tx_ref?: string,
  flw_ref?: string,
  status?: string,
  amount?: string | number,
  currency?: string
}

getFee

transactions.getFee Get transaction fee estimate. Risk: read

await corsair.flutterwave.api.transactions.getFee({});

Input

Name	Type	Required	Description
`amount`	`string \| number`	Yes	—
`currency`	`string`	Yes	—
`payment_type`	`any`	No	—
`card_first6digits`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  charge_amount?: string | number,
  fee?: string | number,
  merchant_fee?: string | number
}

list

transactions.list Retrieve all transactions. Risk: read

await corsair.flutterwave.api.transactions.list({});

Input

Name	Type	Required	Description
`from`	`string`	No	—
`to`	`string`	No	—
`page`	`number`	No	—
`status`	`any`	No	—
`tx_ref`	`string`	No	—
`customer_email`	`any`	No	—
`currency`	`string`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  tx_ref?: string,
  flw_ref?: string,
  status?: string,
  amount?: string | number,
  currency?: string
}[]

verifyByReference

transactions.verifyByReference Verify a transaction by tx_ref. Risk: read

await corsair.flutterwave.api.transactions.verifyByReference({});

Input

Name	Type	Required	Description
`tx_ref`	`string`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  tx_ref?: string,
  flw_ref?: string,
  status?: string,
  amount?: string | number,
  currency?: string
}

viewTimeline

transactions.viewTimeline View transaction timeline. Risk: read

await corsair.flutterwave.api.transactions.viewTimeline({});

Input

Name	Type	Required	Description
`id`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  note?: string,
  action?: string
}[]

Transfers

getFee

transfers.getFee Get transfer fee estimate. Risk: read

await corsair.flutterwave.api.transfers.getFee({});

Input

Name	Type	Required	Description
`amount`	`string \| number`	Yes	—
`currency`	`string`	Yes	—
`type`	`string`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  fee?: string | number,
  currency?: string
}

getRates

transfers.getRates Get transfer exchange rates. Risk: read

await corsair.flutterwave.api.transfers.getRates({});

Input

Name	Type	Required	Description
`amount`	`string \| number`	Yes	—
`destination_currency`	`string`	Yes	—
`source_currency`	`string`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  rate?: string | number,
  source?: any,
  destination?: any
}

list

transfers.list List transfers. Risk: read

await corsair.flutterwave.api.transfers.list({});

Input

Name	Type	Required	Description
`reference`	`any`	No	—
`page`	`number`	No	—
`status`	`any`	No	—
`from`	`any`	No	—
`to`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  id?: string | number,
  amount?: string | number,
  status?: string,
  reference?: string
}[]

Verification

initiateBvn

verification.initiateBvn Initiate BVN verification. Risk: write

await corsair.flutterwave.api.verification.initiateBvn({});

Input: object

Input full type

{
  bvn: string,
  firstname: string,
  lastname: string,
  redirect_url?: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    bvn: string,
    firstname: string,
    lastname: string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  url?: string,
  reference?: string
}

Virtual Accounts

create

virtualAccounts.create Create a virtual account number. Risk: write

await corsair.flutterwave.api.virtualAccounts.create({});

Input: object

Input full type

{
  email: string,
  firstname: string,
  lastname: string,
  tx_ref?: string,
  amount?: string | number,
  narration?: string,
  query?: {
  },
  body?: {
  }
} | {
  query?: {
  },
  body: {
    email: string,
    firstname: string,
    lastname: string
  }
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  account_number?: string,
  bank_name?: string,
  order_ref?: string,
  flw_ref?: string,
  amount?: string | number
}

get

virtualAccounts.get Get virtual account number details by order reference. Risk: read

await corsair.flutterwave.api.virtualAccounts.get({});

Input

Name	Type	Required	Description
`order_ref`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  account_number?: string,
  bank_name?: string,
  order_ref?: string,
  flw_ref?: string,
  amount?: string | number
}

Wallets

getBalanceByCurrency

wallets.getBalanceByCurrency Get wallet balance by currency. Risk: read

await corsair.flutterwave.api.wallets.getBalanceByCurrency({});

Input

Name	Type	Required	Description
`currency`	`string \| number`	Yes	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object`	No	—

meta full type

{
}

data full type

{
  currency?: string,
  available_balance?: string | number
}

getStatement

wallets.getStatement Get wallet statement. Risk: read

await corsair.flutterwave.api.wallets.getStatement({});

Input

Name	Type	Required	Description
`from`	`string`	No	—
`to`	`string`	No	—
`currency`	`string`	No	—
`type`	`string`	No	—
`page`	`any`	No	—
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  type?: string,
  amount?: string | number,
  currency?: string,
  created_at?: string
}[]

listBalances

wallets.listBalances Get wallet balances across currencies. Risk: read

await corsair.flutterwave.api.wallets.listBalances({});

Input

Name	Type	Required	Description
`query`	`object`	No	—
`body`	`object`	No	—

query full type

{
}

body full type

{
}

Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`message`	`string`	No	—
`meta`	`object`	No	—
`data`	`object[]`	No	—

meta full type

{
}

data full type

{
  currency?: string,
  available_balance?: string | number
}[]

​Banks

​getBranches

​getByCountry

​resolveAccount

​Beneficiaries

​create

​delete

​get

​list

​Bills

​getCategories

​listBillers

​listProducts

​listRecurring

​validateItem

​Bulk Tokenized Charges

​create

​get

​Bulk Virtual Accounts

​create

​get

​Cards

​resolveBin

​Chargebacks

​list

​Charges

​initiateMobileMoneyTanzania

​Payment Links

​create

​disable

​Payment Plans

​cancel

​create

​get

​list

​update

​Payout Subaccounts

​list

​listRefunds

​Refunds

​create

​get

​list

​Settlements

​list

​Subaccounts

​create

​delete

​get

​list

​update

​Subscriptions

​list

​Transactions

​generateReference

​get

​getFee

​list

​verifyByReference

​viewTimeline

​Transfers

​getFee

​getRates

​list

​Verification

​initiateBvn

​Virtual Accounts

​create

​get

​Wallets

​getBalanceByCurrency

​getStatement

​listBalances

Banks

getBranches

getByCountry

resolveAccount

Beneficiaries

create

delete

get

list

Bills

getCategories

listBillers

listProducts

listRecurring

validateItem

Bulk Tokenized Charges

create

get

Bulk Virtual Accounts

create

get

Cards

resolveBin

Chargebacks

list

Charges

initiateMobileMoneyTanzania

Payment Links

create

disable

Payment Plans

cancel

create

get

list

update

Payout Subaccounts

list

listRefunds

Refunds

create

get

list

Settlements

list

Subaccounts

create

delete

get

list

update

Subscriptions

list

Transactions

generateReference

get

getFee

list

verifyByReference

viewTimeline

Transfers

getFee

getRates

list

Verification

initiateBvn

Virtual Accounts

create

get

Wallets

getBalanceByCurrency

getStatement

listBalances