Skip to content

feat: Vue SDK Update (Dynamic split) #12

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

Open
Olumuyiwa24 wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: Vue SDK Update (Dynamic split) #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4e62bd9
added dynamicSplit field
Olumuyiwa24 Nov 20, 2025
d2f8e0a
added split setttlement feature
Olumuyiwa24 Nov 20, 2025
7f552ec
made changes across the main and example files
Olumuyiwa24 Nov 24, 2025
312865d
made changes across the main and example files
Olumuyiwa24 Nov 24, 2025
899e5af
updated the readme file"
Olumuyiwa24 Nov 24, 2025
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
143 changes: 99 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@
</h1>

# SeerBit Checkout Wrapper for VueJS

Seerbit Vue SDK can be used to integrate the SeerBit payment gateway into your Vue application.
This module was built and tested using VueJS 3.2.13

**Vue 3 Support:** This SDK is built for Vue 3.2+ and includes TypeScript definitions for better developer experience. It uses the Options API for backward compatibility, and can be used with both Options API and Composition API projects.

# Requirements

Register for a merchant account on [Seerbit Merchant Dashboard](https://dashboard.seerbitapi.com) to get started. \
--> Login -> Settings menu -> API Keys menu -> Copy your public key

Expand All @@ -26,41 +30,74 @@ yarn add seerbit-vue
```

## Properties
| Property | Type | Required | Default | Description |
| :--- | :-- | :-- | :-- | :-- |
| currency | <code>string</code> | Optional | NGN | The currency for the transaction e.g NGN|
| email | <code>string</code> | Required | None | The email of the user to be charged |
mobileNo | <code>string</code> | Optional | None | The mobile number of the user to be charged |
| description | <code>string</code> | Optional | None | The transaction description which is optional |
| fullName | <code>string</code> | Optional | None | The full name of the user to be charged |
| country | <code>string</code> | Optional | "NG" | Transaction country which can be optional |
| tranref | <code>string</code> | Required | None | Set a unique transaction reference for every transaction |
| amount | <code>string</code> | Required | None | The transaction amount in naira |
| callbackUrl | <code>string</code> | Optional | None | This is the redirect url when transaction is successful |
| publicKey | <code>string</code> | Required | None | Your Public key or see **Requirements** above to get yours |
| closeOnSuccess | <code>boolean</code> | Optional | False | Close checkout when trasaction is successful |
| closePrompt | <code>boolean</code> | Optional | False | Close the checkout page if transaction is not initiated |
| setAmountByCustomer | <code>boolean</code> | Optional | False | Set to true if you want user to enter transaction amount |
| pocketRef | <code>string</code> | Optional | None | This is your pocket reference for vendors with pocket |
| vendorId | <code>string</code> | Optional | None | This is the vendorId of your business using pocket |
| tokenize | <code>boolean</code> | Optional | False | Tokenize card |
| planId | <code>string</code> | Optional | None | Subcription Plan ID |
| onCallback | <code>Method</code> | Optional | None | Callback method if transaction was successful |
| onCloseCheckout | <code>Method</code> | Optional | None | Callback method if transaction was cancelled |
| buttonText | <code>String</code> | Optional | Pay With SeerBit | Text to be displayed on launch button
| autoCheckout | <code>boolean</code> | Optional | false | Launch checkout automatically if true, or display a pay button if false
| customization | <code>Object</code> | Optional | None | Customization e.g below

| Property | Type | Required | Default | Description |
| :------------- | :------------------- | :------- | :------ | :--------------------------------------------------------- |
| currency | <code>string</code> | Optional | NGN | The currency for the transaction e.g NGN |
| email | <code>string</code> | Required | None | The email of the user to be charged |
| mobileNo | <code>string</code> | Optional | None | The mobile number of the user to be charged |
| description | <code>string</code> | Optional | None | The transaction description which is optional |
| fullName | <code>string</code> | Optional | None | The full name of the user to be charged |
| country | <code>string</code> | Optional | "NG" | Transaction country which can be optional |
| tranref | <code>string</code> | Required | None | Set a unique transaction reference for every transaction |
| amount | <code>string</code> | Required | None | The transaction amount in naira |
| callbackUrl | <code>string</code> | Optional | None | This is the redirect url when transaction is successful |
| publicKey | <code>string</code> | Required | None | Your Public key or see **Requirements** above to get yours |
| closeOnSuccess | <code>boolean</code> | Optional | False | Close checkout when trasaction is successful |
| closePrompt | <code>boolean</code> | Optional | False | Close the checkout page if transaction is not initiated |

```vue
customization: {
theme: {
border_color: "#000000",
background_color: "#004C64",
button_color: "#0084A0",
},
payment_method: ["card", "account", "transfer", "wallet", "ussd"],
display_fee: true,
logo: "logo_url | base64",
| split |
<code>Object</code>
| Optional | {} | Payment split configuration object with `type` ("FLAT" or
"PERCENTAGE"), `transactionFee` ("SUB_ACCOUNT", "ALL_ACCOUNTS", "PROPORTIONATE",
or "PARENT_ACCOUNT"), and `items` array. Each item requires `subAccountCode`
(string) and `value` (string), with optional `subAccountName` |
```

| setAmountByCustomer | <code>boolean</code> | Optional | False | Set to true if you want user to enter transaction amount |
| pocketRef | <code>string</code> | Optional | None | This is your pocket reference for vendors with pocket |
| vendorId | <code>string</code> | Optional | None | This is the vendorId of your business using pocket |
| tokenize | <code>boolean</code> | Optional | False | Tokenize card |
| planId | <code>string</code> | Optional | None | Subcription Plan ID |
| onCallback | <code>Method</code> | Optional | None | Callback method if transaction was successful |
| onCloseCheckout | <code>Method</code> | Optional | None | Callback method if transaction was cancelled |
| buttonText | <code>String</code> | Optional | Pay With SeerBit | Text to be displayed on launch button |
| autoCheckout | <code>boolean</code> | Optional | false | Launch checkout automatically if true, or display a pay button if false |
| customization | <code>Object</code> | Optional | None | Customization e.g below |

```vue
customization: { theme: { border_color: "#000000", background_color: "#004C64",
button_color: "#0084A0", }, payment_method: ["card", "account", "transfer",
"wallet", "ussd"], display_fee: true, logo: "logo_url | base64", }
```

## TypeScript Support

This SDK includes TypeScript type definitions for enhanced developer experience.

### TypeScript Usage Example

```typescript
import { ref } from 'vue'
import type { DynamicSplitRule } from 'seerbit-vue'


const splits: DynamicSplitRule = {
type: "FLAT", // or "PERCENTAGE"
transactionFee: "SUB_ACCOUNT", // or "ALL_ACCOUNTS", "PROPORTIONATE", "PARENT_ACCOUNT"
items: [
{
subAccountCode: "imshia-uba-programme-Qx7aL9",
subAccountName: "", // optional
value: "3.01"
},
{
subAccountCode: "ops-costs-2sD4kA",
subAccountName: "" // optional
value: "2.00"
}
]
}
```

Expand All @@ -86,6 +123,23 @@ export default {
pocketRef: "",
tokenize: "",
currency: "NGN",

split: {
type: "FLAT", // or "PERCENTAGE"
transactionFee: "SUB_ACCOUNT", // or "ALL_ACCOUNTS", "PROPORTIONATE", "PARENT_ACCOUNT"
items: [
{
subAccountCode: "imshia-uba-programme-Qx7aL9",
subAccountName: "", // optional
value: "3.01"
},
{
subAccountCode: "ops-costs-2sD4kA",
subAccountName: "" // optional
value: "2.00"
}
]
},
customization: {
theme: {
border_color: "#000000",
Expand Down Expand Up @@ -135,22 +189,23 @@ export default {
:currency="currency"
:mobileNo="mobileNo"
:buttonText="buttonText"
:split="split"
/>
</div>
</template>

<style>
.seerbitButton {
align-self: center;
background-color: #000000;
color: #ffffff;
font-weight: 400;
cursor: pointer;
justify-content: center;
align-items: center;
border-radius: 10px;
font-size: 16px;
}
.seerbitButton {
align-self: center;
background-color: #000000;
color: #ffffff;
font-weight: 400;
cursor: pointer;
justify-content: center;
align-items: center;
border-radius: 10px;
font-size: 16px;
}
</style>
```

Expand Down
38 changes: 28 additions & 10 deletions example/src/exampleProject.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,34 @@ export default {
pocketRef: "",
tokenize: "",
currency: "NGN",
customization: {
theme: {
border_color: "#000000",
background_color: "#004C64",
button_color: "#0084A0",
},
payment_method: ["card", "account", "transfer", "wallet", "ussd"],
display_fee: true,
logo: "logo_url | base64",
customization: {
theme: {
border_color: "#000000",
background_color: "#004C64",
button_color: "#0084A0",
},

payment_method: ["card", "account", "transfer", "wallet", "ussd"],
display_fee: true,
logo: "logo_url | base64",
},
split: {
type: "FLAT", // PERCENTAGE
transactionFee: "SUB_ACCOUNT", // ALL_ACCOUNTS, PROPORTIONATE, SUB_ACCOUNT, PARENT_ACCOUNT
items: [
{
subAccountCode: "imshia-uba-programme-Qx7aL9",
subAccountName: "",
value: "3.01"
},
callbackurl: "",
{
subAccountCode: "ops-costs-2sD4kA",
subAccountName: "",
value: "2.00"
}
]
},
callbackurl: "",
buttonText: "Pay With SeerBit",
autoCheckout: false,
};
Expand Down Expand Up @@ -68,6 +85,7 @@ export default {
:mobileNo="mobileNo"
:buttonText="buttonText"
:autoCheckout="false"
:split="split"
/>
</div>
</template>
Expand Down
Loading