Back to home
INTEGRATION
PAYMENT FEATURES
AFTER PAYMENT
Authentication
POST
https://pocket.seerbitapi.com/pocket/authenticate
Request Sample
The 'Authenticate' API authenticates you into the Pocket application
1curl --location 'https://pocket.seerbitapi.com/pocket/authenticate' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '{
5 "email":"johndoe@email.com",
6 "password":"password"
7}'Response Sample
The code snippet below shows a sample response
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "bearerToken": "Bearer token",
6 "expiryTime": "2023-03-06T22:25:13"
7 }
8} Add a Sub-Pocket
POST
https://pocket.seerbitapi.com/pocket/pocket-id/SBP0011034/sub-pocket
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
Currency
This is the country currency of the user
Mandatory
Used to specify the monetary unit associated with the user's transactions.
selfOwned
This identifies if the pocket is owned by the merchant
Mandatory
When set to true, the entire pocketOwner block can be omitted, as the merchant owns the pocket.
pocketFunction
A string that categorizes the pocket's purpose or function within the application.
Mandatory
reference
A unique identifier for the transaction or action being performed.
Mandatory
accountVerifier
Scheme
Scheme
The scheme used to verify the account, typically a string value representing the verification method.
Optional
This must be supplied for the 'accountVerifierNumber' field.
accountVerifier
Number
Number
The number associated with the account verifier scheme, typically an identifier like a PIN or token.
Optional
This must be supplied for the 'accountVerifierScheeme' field.
pocket-id
The unique identifier for the pocket, passed as a path variable in the URL.
Mandatory
This is the pocket id of the parent pocket.
pocket-id existingPocketOwner
This value controls the inclusion of the pocketOwnerDetails block and the pocketOwnerId field.
When 'existingPocketOwner' field is set to 'true', the 'pocketOwnerDetails' block can be omitted completely but the 'pocketOwnerId' must be supplied. Similarly, when 'existingPocketOwner' field is set to 'false', then the 'pocketOwnerDetails' block must be populated and the 'pocketOwnerId' can be omitted.
businessName
This is the name of the business entity associated with the pocket.
Mandatory
'firstName' or 'lastName' or both can be set in its place)
firstName
The first name of the individual is associated with the pocket.
Mandatory
lastName
The last name of the individual is associated with the pocket.
Mandatory
emailAddress
The email address of the individual or business is associated with the pocket.
Mandatory
phoneNumber
The phone number of the individual or business is associated with the pocket.
Mandatory
ownerVerifier
Scheme
Scheme
The scheme used to verify the pocket owner, similar to the accountVerifierScheme
Optional
Must be set for the 'ownerVerifierNumber'.
ownerVerifier
Number
Number
The number associated with the owner verifier scheme, like an owner-specific PIN or token.
Optional
Must be set for the 'ownerVerifierScheme'.
canRetailPockets
This value controls the inclusion of the merchantDetails block.
When 'canRetailPockets' is set to 'true' then the 'merchantDetails' block must be populated. Otherwise, the 'merchantDetails' block can be omitted completely.
tagGroup
A group identifier for tagging purposes, categorizing pockets under specific groups.
Optional
Must be set for the 'tagName'.
tagName
The specific tag name within the tagGroup, used for detailed categorization.
Optional
Must be set for the 'tagGroup'.
Request Sample
The 'AddASubPocket' API adds a sub pocket that's delegated to a merchant's third-party user
1curl --location 'https://pocket.seerbitapi.com/pocket/pocket-id/SBP0011034/sub-pocket' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '{
5 "responseCode": "00",
6 "message": "Success",
7 "data": [
8 {
9 "pocketId": "SBP0000030",
10 "parentId": 2028,
11 "bankAccountNumber": "4014753361",
12 "bankAccountName": "J.D. Inc.",
13 "canRetailPockets": false,
14 "subPocketUserResponse": {
15 "userName": "user0032@maildomain.com",
16 "password": "user0032"
17 }
18 }
19 ]
20}'Response Sample
The code snippet below shows a sample response
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": [
5 {
6 "pocketId": "SBP0000000",
7 "parentId": 2028,
8 "bankAccountNumber": "4014401432",
9 "bankAccountName": "J.D. Inc.",
10 "canRetailPockets": false,
11 "subPocketUserResponse": {
12 "userName": "user@maildomain.com",
13 "password": "user0000"
14 }
15 }
16 ]
17} Pocket to Pocket Transfer
POST
https://pocket.seerbitapi.com/pocket/transfer/from-pocket/(pocketID)/to-pocket/(pocketID)
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
reference
A unique identifier for the transaction or action being performed.
Mandatory
This provides a unique way to reference a specific transaction or action.
pocketId
The unique identifier for the pocket.
Mandatory
Essential for identifying and referencing a specific pocket in API operations.
narration
A brief description or note about the transaction, typically a string.
Mandatory
Provides context or additional details about the transaction, useful for record-keeping and reporting.
createdOnStartDate
The start date for filtering transactions is based on their creation date, in DD-MM-YYYY format.
Optional
Helps in querying transactions created on or after this date for reporting and analysis.
createdOnEndDate
The end date for filtering transactions based on their creation date, in DD-MM-YYYY format.
Optional
Helps in querying transactions created on or before this date for reporting and analysis.
description
A merchant-defined description for the transaction or action.
Mandatory
Provides additional context and details defined by the merchant, aiding in transaction categorization and management.
page
This is the page number for paginated results.
Mandatory
Used for pagination in API responses to control which page of results is returned.
size
This is the number of records to be returned per page in paginated results.
Mandatory
Defines the size of each page in paginated API responses, controlling the number of records returned per page.
Request Sample
Dependency: Require the 'Authenticate' API
1curl --location 'https://pocket.seerbitapi.com/pocket/transfer/from-pocket/(pocketID)/to-pocket/(pocketID)' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '{
5 "amount": 100,
6 "currency": "NGN",
7 "reference": "{{reference}}",
8 "description":"Test description"
9} Response Sample
The code snippet below shows a sample response
1{
2 "responseCode": "00",
3 "message": "Successful",
4 "data": {}
5} Get Pocket Details
GET
https://pocket.seerbitapi.com/pocket/pocket-id/SBP0011034
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
pocketId
The unique identifier for the pocket, passed as a path variable in the URL.
Mandatory
This ID is passed in the URL to uniquely identify the pocket involved in the transaction or operation.
Response Sample
The code snippet below shows a sample response
Dependency: Requires the 'Authenticate' API.
Dependency: Requires the 'Authenticate' API.
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "pocketId": "SBP0000000",
6 "accountNumber": "001005756",
7 "status": "ACTIVE",
8 "pocketFunction": "BOTH",
9 "availableBalanceAmount": "28999.00",
10 "availableBalanceCurrency": "NGN",
11 "ledgerBalanceAmount": "28999.00",
12 "ledgerBalanceCurrency": "NGN",
13 "parentId": 2028,
14 "fundingLink": "https://pay.seerbitapi.com?ps=gq8wLCuB&po=SBP0000000",
15 "accountVerifierScheme": "BVN",
16 "accountVerifierNumber": "000000000000",
17 "reference": "pck012",
18 "subPockets": null,
19 "pocketOwner": {
20 "pocketOwnerId": "txryfgqw",
21 "businessName": "J.D. Inc.",
22 "firstName": "John",
23 "lastName": "Doe",
24 "emailAddress": "user@maildomain.com",
25 "phoneNumber": "0818009876",
26 "ownerVerifierScheme": "NIN",
27 "ownerVerifierNumber": "00000000000"
28 },
29 "pocketAccounts": [
30 {
31 "accountId": "f594q2mix8yg",
32 "accountNumber": "4014123456",
33 "bankCode": "bank code",
34 "reference": "5z17gnfl8jy2u4etr"
35 }
36 ],
37 "pocketFundings": null,
38 "pocketLimits": [],
39 "pocketMomos": []
40 }
41}Get All Pockets
GET
https://pocket.seerbitapi.com/pocket/pocket-id/SBP0011034
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
pocketId
The unique identifier for the pocket.
Mandatory
This ID is essential for identifying and referencing a specific pocket in API operations.
accountNumber
The internal account number associated with the pocket.
Mandatory
This is sed to link the pocket with its corresponding internal account within the system.
status
The current status of the pocket, indicating whether it is active, inactive, or closed.
Mandatory
This provides information on the operational state of the pocket.
pocketFunction
The function of the pocket, with available options: 'BOTH', 'CREDIT_ONLY', and 'DEBIT_ONLY'.
Mandatory
This defines the allowed operations on the pocket: both credit and debit, credit only, or debit only.
pocketOwnerId
The unique identifier for the owner of the pocket.
Mandatory
This is used to link the pocket to its owner, essential for authorization and management purposes.
firstName
The first name of the individual who owns the pocket.
Mandatory
lastName
The last name of the individual who owns the pocket.
Mandatory
businessName
The name of the business entity that owns the pocket.
Mandatory
Either firstName or lastName (or both) can be used in place of businessName if applicable.
emailAddress
The email address of the pocket owner (individual or business).
Mandatory
For communication, notifications, and verification purposes.
phoneNumber
The phone number of the pocket owner (individual or business).
Mandatory
For contact and verification purposes.
bankCode
The code of the bank associated with the pocket, typically represented in a standardized format.
Mandatory
Identifies the bank for the pocket's transactions, essential for routing and processing payments.
reference
A unique identifier for the transaction or action being performed involving the pocket.
Mandatory
Used for tracking and auditing transactions related to the pocket.
createdOnStartDate
The start date for filtering pockets based on their creation date, in DD-MM-YYYY format.
Optional
Helps in querying pockets created on or after this date for reporting and analysis.
createdOnEndDate
The end date for filtering pockets based on their creation date, in DD-MM-YYYY format.
Optional
Helps in querying pockets created on or before this date for reporting and analysis.
tagGroup
A merchant-defined group used for categorizing pockets.
Optional
Must be set if tagName is used, aids in organizing and managing pockets by custom-defined groups.
tagName
A merchant-defined sub-group within the tagGroup, used for detailed categorization.
Optional
Must be set if tagGroup is used, provides additional granularity for pocket categorization and management.
Response Sample
The code snippet below shows a sample response
Dependencies: Requires 'Authenticate' and 'AddAPocket' APIs.
Dependencies: Requires 'Authenticate' and 'AddAPocket' APIs.
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "content": [
6 {
7 "createdAt": "2023-01-27T13:46:46",
8 "deleted": false,
9 "pocketId": "1000000002",
10 "accountNumber": "0010000002",
11 "status": "ACTIVE",
12 "pocketFunction": "BOTH",
13 "availableBalanceCurrency": "NGN",
14 "ledgerBalanceCurrency": "NGN",
15 "parentId": null,
16 "fundingLink": "https://pay.seerbitapi.com?ps=gq8wLCuB&po=100000238",
17 "accountVerifierScheme": "BVN",
18 "accountVerifierNumber": "00000000000",
19 "reference": "100000002",
20 "pocketOwner": {
21 "createdAt": "2023-01-27T13:46:31",
22 "deleted": false,
23 "pocketOwnerId": "gq8wLCuB",
24 "businessName": "business name",
25 "firstName": "First Name",
26 "lastName": "Last Name",
27 "emailAddress": "user@maildomain.com",
28 "phoneNumber": "0706000002290",
29 "ownerVerifierScheme": "NIN",
30 "ownerVerifierNumber": "00000000000",
31 "publicKey": "SBPUBK_SCAD2TXCTYVZOORZEGXR17OTLECBGUAI",
32 "parentId": null
33 },
34 "tagGroup": "GENERIC",
35 "tagName": "ALL-PURPOSE",
36 "availableBalanceAmount": "29998250.00",
37 "ledgerBalanceAmount": "29998250.00"
38 },
39 {
40 "createdAt": "2023-03-06T07:09:04",
41 "deleted": false,
42 "pocketId": "Pocket ID",
43 "accountNumber": "Accoun Number",
44 "status": "ACTIVE",
45 "pocketFunction": "DEBIT_ONLY",
46 "availableBalanceCurrency": "NGN",
47 "ledgerBalanceCurrency": "NGN",
48 "parentId": 2028,
49 "fundingLink": "",
50 "accountVerifierScheme": "BVN",
51 "accountVerifierNumber": "000000000000",
52 "reference": "pck011",
53 "pocketOwner": {
54 "createdAt": "2023-03-06T07:09:04",
55 "deleted": false,
56 "pocketOwnerId": "x2yn7ghf",
57 "businessName": "Business Name
58 "firstName": "John",
59 "lastName": "Doe",
60 "emailAddress": "user@maildomain.com",
61 "phoneNumber": "Phone Number",
62 "ownerVerifierScheme": "NIN",
63 "ownerVerifierNumber": "00000000000",
64 "publicKey": "SBPUBK_SCAD2TXCTYVZOORZEGXR17OTLECBGUAI",
65 "parentId": 2018
66 },
67 "tagGroup": "Tag Group",
68 "tagName": "RECURRENT",
69 "availableBalanceAmount": "31001.00",
70 "ledgerBalanceAmount": "31001.00"
71 },
72 {
73 "createdAt": "2023-03-06T07:13:07",
74 "deleted": false,
75 "pocketId": "Pocket ID",
76 "accountNumber": "Account Number",
77 "status": "ACTIVE",
78 "pocketFunction": "BOTH",
79 "availableBalanceCurrency": "NGN",
80 "ledgerBalanceCurrency": "NGN",
81 "parentId": 2028,
82 "fundingLink": "https://pay.seerbitapi.com?ps=gq8wLCuB&po=SBP0000030",
83 "accountVerifierScheme": "BVN",
84 "accountVerifierNumber": "000000000000",
85 "reference": "pck012",
86 "pocketOwner": {
87 "createdAt": "2023-03-06T07:13:06",
88 "deleted": false,
89 "pocketOwnerId": "txryfgqw",
90 "businessName": "J.D. Inc.",
91 "firstName": "John",
92 "lastName": "Doe",
93 "emailAddress": "user@maildomain.com",
94 "phoneNumber": "phone number",
95 "ownerVerifierScheme": "NIN",
96 "ownerVerifierNumber": "00000000000",
97 "publicKey": "SBPUBK_SCAD2TXCTYVZOORZEGXR17OTLECBGUAI",
98 "parentId": 2018
99 },
100 "tagGroup": "Tag group",
101 "tagName": "RECURRENT",
102 "availableBalanceAmount": "28999.00",
103 "ledgerBalanceAmount": "28999.00"
104 }
105 ],
106 "pageable": {
107 "sort": {
108 "sorted": true,
109 "unsorted": false,
110 "empty": false
111 },
112 "pageSize": 10,
113 "pageNumber": 0,
114 "offset": 0,
115 "paged": true,
116 "unpaged": false
117 },
118 "last": true,
119 "totalElements": 3,
120 "totalPages": 1,
121 "sort": {
122 "sorted": true,
123 "unsorted": false,
124 "empty": false
125 },
126 "first": true,
127 "numberOfElements": 3,
128 "size": 10,
129 "number": 0,
130 "empty": false
131 }
132}Pocket Balance
GET
https://pocket.seerbitapi.com/pocket/balance/pocket-id/SBP0011034
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
pocketId
The unique identifier for the pocket, passed as a path variable in the URL.
Mandatory
This ID is passed in the URL to uniquely identify the pocket involved in the transaction or operation.
Response Sample
The code snippet below shows a sample response
Dependency: Requires 'Authenticate' API.
Dependency: Requires 'Authenticate' API.
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "balanceAt": "2023-03-06T09:30:27",
6 "availableBalanceCurrency": "NGN",
7 "availableBalanceAmount": "31001.00",
8 "lastTransactionAt": "2023-03-06T09:19:14"
9 }
10} Merchant Balance Sum
GET
https://pocket.seerbitapi.com/pocket/balances-summation/pocket-id/SBP0011034
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
pocketId
The unique identifier for the pocket, passed as a path variable in the URL.
Mandatory
This ID is passed in the URL to uniquely identify the pocket involved in the transaction or operation.
Response Sample
The code snippet below shows a sample response
Dependency: Requires 'Authenticate' API.
Dependency: Requires 'Authenticate' API.
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "merchantSubPocketsBalanceSummation": "60000.00",
6 "merchantSubPocketsBalanceSummationCurrency": "NGN",
7 "merchantAllPocketsBalanceSummation": "30058250.00",
8 "merchantAllPocketsBalanceSummationCurrency": "NGN"
9 }
10} Transaction Details
GET
https://pocket.seerbitapi.com/pocket/transaction/reference/txnP04
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
reference
A unique identifier for the transaction or action being performed.
Mandatory
Response Sample
The code snippet below shows a sample response
Dependency: Requires 'Authenticate' API.
Dependency: Requires 'Authenticate' API.
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "reference": "txnP04",
6 "pocketId": "SBP0000030",
7 "transactionLeg": "DEBIT",
8 "transactionAmount": "1001.00",
9 "transactionCurrency": "NGN",
10 "narration":
11 "Reason:Transfer:Debited:SBP0000030:Credited:SBP0000029:Amount:NGN1001:AvailableBalance:NGN28999.00",
12 "createdAt": "2023-03-06T09:19:14",
13 "createdBy": "user4@emaildomain.com",
14 "transactionId": "ajhkyr0oi8fq"
15 }
16}Find Transactions
GET
https://pocket.seerbitapi.com/pocket/transaction/search?pocketId=SBP0011034&page=0&size=10
Parameters
Name
Type
Description
Required?
public Key
string
public key - this can be copied from the seerbit dashboard
Yes
currency
string
Payment Currency
Yes
tranref
string
Transaction Reference
Yes
amount
string
Amount to be paid
Yes
description
string
Decription of the transaction
Yes
Fields
Description
Requirement
Additional Comments
reference
A unique identifier for the transaction or action being performed.
Mandatory
Used for tracking and auditing purposes. Provides a unique way to reference a specific transaction or action.
pocketId
The unique identifier for the pocket.
Mandatory
Essential for identifying and referencing a specific pocket in API operations.
narration
A brief description or note about the transaction, typically a string.
Mandatory
Provides context or additional details about the transaction, useful for record-keeping and reporting.
createdOnStartDate
The start date for filtering transactions based on their creation date, in DD-MM-YYYY format.
Optional
Helps in querying transactions created on or after this date for reporting and analysis.
createdOnEndDate
The end date for filtering transactions based on their creation date, in DD-MM-YYYY format.
Optional
Helps in querying transactions created on or before this date for reporting and analysis.
description
A merchant-defined description for the transaction or action.
Mandatory
Provides additional context and details defined by the merchant, aiding in transaction categorization and management.
page
The page number for paginated results.
Mandatory
Used for pagination in API responses to control which page of results is returned.
size
The number of records to be returned per page in paginated results.
Mandatory
Defines the size of each page in paginated API responses, controlling the number of records returned per page.
Response Sample
The code snippet below shows a sample response
Dependency: Requires 'Authenticate' API.
Dependency: Requires 'Authenticate' API.
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "content": [
6 {
7 "createdAt": "2023-01-27T13:47:39",
8 "deleted": false,
9 "reference": "fwp53c8n-C",
10 "pocketId": "pocket ID",
11 "transactionLeg": "CREDIT",
12 "transactionCurrency": "NGN",
13 "narration":
14 "Reason:Funding:Credited:100000238:Debited:SBP0000000:Amount:NGN0.0:AvailableBalance:NGN0.00",
15 "transactionId": "bui2e9lrzoch",
16 "description": "Balance migration",
17 "transactionAmount": "0.00"
18 },
19 {
20 "createdAt": "2023-03-05T22:17:09",
21 "deleted": false,
22 "reference": "txnP01-C",
23 "pocketId": "100000238",
24 "transactionLeg": "CREDIT",
25 "transactionCurrency": "NGN",
26 "narration":
27"Reason:Funding:Credited:100000238:Debited:SBP000000o:Amount:NGN30000000:AvailableBalance:NGN30000000.00",
28 "transactionId": "ovky4w0u1jrd",
29 "description": "Direct credit - GENERIC - ALL-PURPOSE",
30 "transactionAmount": "30000000.00"
31 },
32 {
33 "createdAt": "2023-03-05T22:17:09",
34 "deleted": false,
35 "reference": "Charge-ylg3i15t9qnz",
36 "pocketId": "100000238",
37 "transactionLeg": "DEBIT",
38 "transactionCurrency": "NGN",
39 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000000:Amount:NGN200.00:AvailableBalance:NGN29999800.00",
40 "transactionId": "9sn6ejvlfdqo",
41 "description": "Fee - Funding by account - Primary pockets - GENERIC - ALL-PURPOSE",
42 "transactionAmount": "200.00"
43 },
44 ],
45 "pageable": {
46 "sort": {
47 "sorted": true,
48 "unsorted": false,
49 "empty": false
50 },
51 "pageSize": 10,
52 "pageNumber": 0,
53 "offset": 0,
54 "paged": true,
55 "unpaged": false
56 },
57 "last": true,
58 "totalElements": 10,
59 "totalPages": 1,
60 "sort": {
61 "sorted": true,
62 "unsorted": false,
63 "empty": false
64 },
65 "first": true,
66 "numberOfElements": 10,
67 "size": 10,
68 "number": 0,
69 "empty": false
70 }
71}Need something else?
If you have any questions or need general help, visit our support page
Signup for developer update
You can unsubscribe at any time. Read our privacy policy.