NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Flutterwave

flutterwave

Flutterwave is a payments technology company that provides payment infrastructure and APIs enabling businesses to accept and send payments in Africa and globally.

Payment ProcessingWeb del proveedor
Acciones
24
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (24)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create BeneficiaryFLUTTERWAVE_CREATE_BENEFICIARYAcción

Tool to create a new transfer beneficiary. use when you need to add a beneficiary before making a transfer.

Parámetros de entrada

  • account_bankstringObligatorio

    The beneficiary's bank code. Retrieve valid codes via the get_banks endpoint.

  • account_numberstringObligatorio

    The beneficiary's account number. Example: '0690000041'

  • beneficiary_namestring

    Optional: The full name of the beneficiary, if different from the account holder name.

Parámetros de salida

  • dataobjectObligatorio

    Details of the created beneficiary.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status, e.g., 'success'.

  • messagestringObligatorio

    Response message.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Bulk Virtual Account NumbersFLUTTERWAVE_CREATE_BULK_VIRTUAL_ACCOUNT_NUMBERSAcción

Tool to create multiple virtual account numbers. use when you need to generate multiple static virtual accounts for customers in a single request.

Parámetros de entrada

  • batch_refstringObligatorio

    Unique reference to identify this batch of virtual accounts.

  • bulk_dataobject[]Obligatorio

    List of virtual account details for each customer in the batch.

  • narrationstring

    Context or reason for this bulk creation.

Parámetros de salida

  • dataobjectObligatorio

    Details of the bulk virtual account creation request.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call.

  • messagestringObligatorio

    Message describing the outcome.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Payment LinkFLUTTERWAVE_CREATE_PAYMENT_LINKAcción

Tool to create a hosted payment link. use when you need a shareable payment url for one-time transactions.

Parámetros de entrada

  • amountnumberObligatorio

    Amount to charge; must be greater than 0

  • tx_refstringObligatorio

    Unique transaction reference

  • currencystringObligatorio

    ISO 4217 currency code

  • customerobjectObligatorio

    Customer contact information

  • redirect_urlstringObligatorio

    URL to redirect customer after payment

  • customizationsobject

    Optional customization for the payment link.

Parámetros de salida

  • dataobjectObligatorio

    Contained data for the payment link

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    API response status, e.g., 'success'

  • messagestringObligatorio

    Detailed API response message

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Payment PlanFLUTTERWAVE_CREATE_PAYMENT_PLANAcción

Tool to create a new payment plan. use after confirming plan and customer details.

Parámetros de entrada

  • namestringObligatorio

    The name of the payment plan. Appears on subscription reminder emails.

  • amountnumber

    The amount to charge each billing cycle. If omitted, uses the amount from subscription initiation.

  • currencystring

    Currency code (ISO 4217). Defaults to 'NGN'.

  • durationinteger

    The duration in billing cycles. For example, 5 for five months if interval='monthly'. If unset, the plan continues indefinitely.

  • intervalstringObligatorio

    The billing interval; one of 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'quarterly', 'bi-annually', or custom like 'every five months'.

Parámetros de salida

  • dataobjectObligatorio

    Details of the created payment plan.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call.

  • messagestringObligatorio

    Message describing the outcome.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create SubaccountFLUTTERWAVE_CREATE_SUBACCOUNTAcción

Tool to create a new subaccount. use when you need to configure split disbursement accounts.

Parámetros de entrada

  • metaobject[]

    Additional metadata as list of name/value pairs

  • countrystring

    Country code for the subaccount

  • split_typestringObligatorioenum

    Split type: 'percentage' or 'flat'

    percentageflat
  • split_valuenumberObligatorio

    Numeric split value for disbursement

  • account_bankstringObligatorio

    Bank ISO code for the subaccount

  • business_namestringObligatorio

    Business name for the subaccount

  • account_numberstringObligatorio

    Bank account number for the subaccount

  • business_emailstring

    Business email address

  • business_mobilestring

    Primary business contact mobile number

  • business_contactstring

    Business contact person name

  • business_contact_mobilestring

    Business contact mobile number

Parámetros de salida

  • dataobjectObligatorio

    Details of the created subaccount

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status ('success' or 'error')

  • messagestringObligatorio

    Response message

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Virtual AccountFLUTTERWAVE_CREATE_VIRTUAL_ACCOUNTAcción

Tool to create a new virtual account number. use after confirming customer details when assigning a unique account for bank transfers.

Parámetros de entrada

  • bvnstring

    Customer's Bank Verification Number; required if is_permanent is true.

  • emailstringObligatorio

    Customer's email address.

  • amountnumber

    Exact amount to be collected per transaction; omit to allow any amount.

  • tx_refstring

    Merchant's transaction reference to echo with incoming payments.

  • durationinteger

    Number of days before a dynamic account expires.

  • lastnamestring

    Customer's last name.

  • firstnamestring

    Customer's first name.

  • frequencyinteger

    Number of times a dynamic account can be used before expiring.

  • narrationstring

    Description shown when retrieving account details.

  • phonenumberstring

    Customer's phone number with country code.

  • is_permanentboolean

    Set to true for a static (permanent) virtual account; defaults to false (dynamic account).

Parámetros de salida

  • dataobjectObligatorio

    Details of the created virtual account.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call.

  • messagestringObligatorio

    Message describing the outcome.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete BeneficiaryFLUTTERWAVE_DELETE_BENEFICIARYAcción

Tool to delete a beneficiary by id. use when you need to remove a saved transfer beneficiary by its unique id after confirming the id.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the beneficiary to delete, obtained via the list-all-beneficiaries endpoint.

Parámetros de salida

  • datastringObligatorio

    Result of the delete operation, typically 'Deleted'.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., 'success'.

  • messagestringObligatorio

    Human-readable message about the request outcome.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Disable Payment LinkFLUTTERWAVE_DISABLE_PAYMENT_LINKAcción

Tool to disable a flutterwave payment link. use when you need to prevent further payments from an existing link after confirming the link is valid.

Parámetros de entrada

  • linkstringObligatorio

    The full URL of the payment link to disable.

Parámetros de salida

  • databoolean

    True if the link was successfully disabled; null if an error occurred.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call.

  • messagestringObligatorio

    Message describing the outcome.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch BeneficiaryFLUTTERWAVE_FETCH_BENEFICIARYAcción

Tool to retrieve details of a specific beneficiary by id. use after obtaining a beneficiary id to fetch its full details from flutterwave.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the beneficiary to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Detailed information about the requested beneficiary

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., success or error

  • messagestringObligatorio

    Description of the API response

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch SubaccountFLUTTERWAVE_FETCH_SUBACCOUNTAcción

Tool to retrieve details of a specific subaccount by id. use when you need full subaccount info after creating or updating splits.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the subaccount to retrieve

Parámetros de salida

  • dataobjectObligatorio

    The subaccount details returned by the API

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API request, e.g., 'success'

  • messagestring

    Additional information about the API response

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate Transaction ReferenceFLUTTERWAVE_GENERATE_TRANSACTION_REFERENCEAcción

Tool to generate a unique transaction reference. use when initiating a new flutterwave transaction requires a unique reference to prevent duplication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All SubscriptionsFLUTTERWAVE_GET_ALL_SUBSCRIPTIONSAcción

Tool to retrieve all subscriptions, including cancelled ones. use when you need a comprehensive list of subscription records for auditing or reporting.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    List of all subscription records

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Request status

  • messagestringObligatorio

    Descriptive outcome message

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve all transactionsFLUTTERWAVE_GET_ALL_TRANSACTIONSAcción

Tool to retrieve a list of all transactions with optional filters. use when you need to paginate or filter transaction history after confirming valid api credentials.

Parámetros de entrada

  • pageinteger

    Page number to fetch (>= 1)

  • statusstringenum

    Filter transactions by status ('successful' or 'failed')

    successfulfailed
  • tx_refstring

    Filter transactions by transaction reference

  • to_dateanydate

    End date for fetching transactions (YYYY-MM-DD)

  • currencystring

    Filter transactions by currency (e.g., 'NGN', 'USD')

  • from_dateanydate

    Start date for fetching transactions (YYYY-MM-DD)

  • customer_emailanyemail

    Filter transactions by customer email

Parámetros de salida

  • dataobject[]Obligatorio

    List of transaction objects

  • metaobjectObligatorio

    Contains pagination information

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Indicates status of the API call (e.g., 'success', 'error')

  • messagestringObligatorio

    Describes the outcome of the API call

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All Wallet BalancesFLUTTERWAVE_GET_ALL_WALLET_BALANCESAcción

Tool to retrieve all wallet balances across currencies. use when reconciling balances after authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    List of wallet balances by currency

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., 'success'

  • messagestringObligatorio

    Message describing the result

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Balances per CurrencyFLUTTERWAVE_GET_BALANCES_PER_CURRENCYAcción

Tool to retrieve wallet balance for a specific currency. use after transactions to confirm available and ledger balances in a given currency.

Parámetros de entrada

  • currencystringObligatorio

    Three-letter ISO currency code of the wallet, e.g., 'NGN', 'USD'

Parámetros de salida

  • dataobjectObligatorio

    Wallet balance data for the specified currency

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., 'success'

  • messagestringObligatorio

    Message returned by the API

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Bill CategoriesFLUTTERWAVE_GET_BILL_CATEGORIESAcción

Tool to retrieve available bill categories. use after authenticating to flutterwave to display bill payment options to users.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    List of bill categories.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the request.

  • messagestringObligatorio

    Message accompanying the response.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Multiple Refund TransactionsFLUTTERWAVE_GET_MULTIPLE_REFUND_TRANSACTIONSAcción

Tool to retrieve multiple refund transactions with optional filters. use when you need to fetch paginated refund data after confirming valid api credentials.

Parámetros de entrada

  • pageinteger

    Page number for pagination (>= 1)

  • statusstringenum

    Filter refunds by status ('completed' or 'pending')

    completedpending
  • flw_refstring

    Filter refunds by Flutterwave reference

  • to_dateanydate

    End date for filtering refunds (YYYY-MM-DD)

  • from_dateanydate

    Start date for filtering refunds (YYYY-MM-DD)

  • page_sizeinteger

    Number of records per page (>= 1)

Parámetros de salida

  • dataobject[]Obligatorio

    List of refund transactions

  • metaobjectObligatorio

    Contains pagination details

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API response, e.g., 'success'

  • messagestringObligatorio

    Message describing the API response

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Payment PlansFLUTTERWAVE_GET_PAYMENT_PLANSAcción

Tool to retrieve a list of all payment plans. use when you need to fetch and present your account’s configured billing plans.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    List of payment plans available on the account

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Indicates whether the request was successful

  • messagestringObligatorio

    Detailed message on the request outcome

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TransactionFLUTTERWAVE_GET_TRANSACTIONAcción

Tool to retrieve details of a specific transaction by id. use after obtaining the transaction id to fetch its details from flutterwave.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the transaction to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Detailed information about the requested transaction

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., success or error

  • messagestringObligatorio

    Description of the API response

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Transaction FeeFLUTTERWAVE_GET_TRANSACTION_FEEAcción

Tool to retrieve the fee for a specific transaction. use when you need to calculate the total charge including fees before initiating the transaction.

Parámetros de entrada

  • amountintegerObligatorio

    The amount to be charged from the customer (must be non-negative)

  • currencystringObligatorio

    Currency code in ISO 4217 format, e.g., NGN or USD

Parámetros de salida

  • dataobjectObligatorio

    Detailed fee information for the transaction

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., success or error

  • messagestringObligatorio

    Description of the API response

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Transfer FeeFLUTTERWAVE_GET_TRANSFER_FEEAcción

Tool to retrieve the fee for initiating a transfer. use when you need to estimate transfer costs before creating a transfer. example: "calculate the fee for transferring ngn 5000 to an account."

Parámetros de entrada

  • typestringenum

    Type of transfer: 'account', 'mobilemoney', or 'barter'.

    accountmobilemoneybarter
  • amountintegerObligatorio

    The amount to be transferred. Must be a positive integer.

  • currencystring

    ISO 4217 currency code for the transfer (e.g., 'NGN', 'USD').

Parámetros de salida

  • dataobject[]Obligatorio

    List of fee details.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call (e.g., 'success').

  • messagestringObligatorio

    Description of the API response.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Initiate Mobile Money TanzaniaFLUTTERWAVE_INITIATE_MOBILE_MONEY_TANZANIAAcción

Tool to initiate a mobile money payment in tanzania. use after collecting customer details to charge via tanzanian mobile money networks.

Parámetros de entrada

  • metaobject

    Additional custom metadata as key/value pairs

  • emailstringObligatorioemail

    Customer's email address

  • amountnumberObligatorio

    Amount to charge; must be greater than 0

  • tx_refstringObligatorio

    Unique transaction reference for this payment

  • networkstring

    Mobile money network, e.g., 'Halopesa'

  • currencystringObligatorio

    Currency code in ISO 4217 format; must be 'TZS'

  • fullnamestring

    Customer's full name

  • client_ipstring

    Customer's IP address

  • phone_numberstringObligatorio

    Customer's mobile number in international format (e.g., +255712345678)

  • device_fingerprintstring

    Device fingerprint for enhanced fraud detection

Parámetros de salida

  • dataobjectObligatorio

    Detailed data of the mobile money transaction

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call, e.g., 'success'

  • messagestringObligatorio

    Server response message

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All BeneficiariesFLUTTERWAVE_LIST_ALL_BENEFICIARIESAcción

Tool to list all saved beneficiaries. use when you need to retrieve all transfer beneficiaries associated with your account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    List of beneficiary objects

  • metaobjectObligatorio

    Pagination metadata

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the response (e.g., 'success')

  • messagestringObligatorio

    Descriptive message of the result

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

View Transaction TimelineFLUTTERWAVE_VIEW_TRANSACTION_TIMELINEAcción

Tool to retrieve the event timeline for a transaction. use after obtaining the transaction id to audit or track the sequence of events.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the transaction to retrieve its event timeline (>=1).

Parámetros de salida

  • dataobject[]Obligatorio

    List of events associated with the transaction timeline.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API call (e.g., 'success').

  • messagestringObligatorio

    Human-readable message about the API response.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not