Skip to content

Add support for subaccounts #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2022
Merged

Add support for subaccounts #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions example/src/App.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,30 @@ export default function App() {
description: 'Payment for items in cart',
logo: 'https://assets.piedpiper.com/logo.png',
},

subaccounts: [
{
// vendor A
id: "RS_D87A9EE339AE28BFA2AE86041C6DE70E",
transaction_split_ratio: 2,
transaction_charge_type: "flat",
transaction_charge: 100,
},
{
// vendor B
id: "RS_344DD49DB5D471EF565C897ECD67CD95",
transaction_split_ratio: 3,
transaction_charge_type: "flat",
transaction_charge: 100,
},
{
// vendor C
id: "RS_839AC07C3450A65004A0E11B83E22CA9",
transaction_split_ratio: 5,
transaction_charge_type: "flat",
transaction_charge: 100,
},
],
};

const handleFlutterPayment = useFlutterwave(config);
Expand Down
18 changes: 16 additions & 2 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Check out {@link https://developer.flutterwave.com/docs/flutterwave-standard} for more information.
*/

export interface FlutterWaveProps {
export interface FlutterWaveProps {
/**
* Your transaction reference. This MUST be unique for every transaction
*/
Expand Down Expand Up @@ -66,12 +66,25 @@ export interface FlutterWaveProps {
* function to be called when the payment is completed successfully
*/
callback: (data: FlutterWaveResponse) => void;

/**
* function to be called when the mono connection is closed
*/
onclose: () => void;
public_key: string;
/**
* An array of objects containing the subaccount IDs to split the payment into.
* e.g subaccounts: [
{
id: "RS_A8EB7D4D9C66C0B1C75014EE67D4D663",
transaction_split_ratio: 2,
transaction_charge_type: "flat_subaccount",
transaction_charge: 4200,
},
]
* Check out {@link https://developer.flutterwave.com/docs/collecting-payments/split-payments/} for more information on subaccounts.
*/
subaccounts?: Array<unknown>;
}

export interface FlutterwaveConfig {
Expand All @@ -85,6 +98,7 @@ export interface FlutterwaveConfig {
redirect_url?: FlutterWaveProps['redirect_url'];
payment_plan?: FlutterWaveProps['payment_plan'];
payment_options: FlutterWaveProps['payment_options'];
subaccounts?: FlutterWaveProps['subaccounts'];
}

export interface InitializeFlutterwavePayment {
Expand Down