Skip to main content

flutterwave@1.0.1

createCustomer(customerData, [options])
createPaymentMethod(paymentMethodData, [options])
initiatePayment(paymentData, [options])

Functions

createCustomer

createCustomer(customerData, [options]) ⇒ function

Create a new customer in Flutterwave.

ParamTypeDescription
customerDataObject
[options]RequestOptionsOptional request options

createPaymentMethod

createPaymentMethod(paymentMethodData, [options]) ⇒ function

Create a new payment method in Flutterwave.

Returns: function - - A function that takes the state and performs the operation.

ParamTypeDescription
paymentMethodDataObjectThe payment method details to send to Flutterwave.
[options]RequestOptionsOptional request options

initiatePayment

initiatePayment(paymentData, [options]) ⇒ function

Initiate a payment request to the Flutterwave API.

Returns: function - - A function that takes the state and performs the operation.

ParamTypeDescription
paymentDataObjectThe payment details to send to Flutterwave.
[options]RequestOptionsOptional request options

Interfaces

FlutterwaveState

State object returned by flutterwave API

Properties

NameDescription
datathe parsed response body from flutterwave
responsethe full response from the flutterwave server, including headers, statusCode, body, etc
referencesan array of all previous data objects used in the Job

RequestOptions

Options provided to the Flutterwave requests

Properties

NameTypeDescription
errorsobjectMap of errorCodes -> error messages, ie, { 404: 'Resource not found;' }. Pass false to suppress errors for this code.
formobjectPass a JSON object to be serialised into a multipart HTML form (as FormData) in the body.
queryobjectAn object of query parameters to be encoded into the URL.
headersobjectAn object of headers to append to the request.
parseAsstringParse the response body as json, text or stream. By default will use the response headers.
timeoutnumberRequest timeout in ms. Default: 300 seconds.