Back to home
INTEGRATION
PAYMENT FEATURES
AFTER PAYMENT
Payout
SeerBit Payout allows merchants to send money from their pockets to a bank account.
Authentication
POST
https://pocket.seerbitapi.com/pocket/authenticate
Request Sample
The 'Authenticate' API authenticates you into the Pocket application, it generates an encrypted token that can be used to perform actions on the 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
This a sample response code
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "bearerToken": "(bearertoken)",
6 "expiryTime": "2024-06-25T19:41:11"
7 }
8} Change Password
POST
https://pocket.seerbitapi.com/pocket/user/change-password
Request Sample
The 'Authenticate' API authenticates you into the Pocket application, it generates an encrypted token that can be used to perform actions on the application.
1curl --location 'https://pocket.seerbitapi.com/pocket/user/change-password' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '
5 {
6 "currentPassowrd":"johndoe@email.com",
7 "newPassword":"password"
8 }'Get Pocket Details
GET
https://pocket.seerbitapi.com/pocket/pocket-id/(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
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
This a sample response code
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "pocketId": "((pocketID))",
6 "accountNumber": "((account number))",
7 "status": "ACTIVE",
8 "pocketFunction": "BOTH",
9 "availableBalanceAmount": "4880.00",
10 "availableBalanceCurrency": "NGN",
11 "ledgerBalanceAmount": "4880.00",
12 "ledgerBalanceCurrency": "NGN",
13 "parentId": null,
14 "fundingLink": "?ps=ZShXHvvh&po=SBP0011650",
15 "accountVerifierScheme": "BVN",
16 "accountVerifierNumber": "00000000000",
17 "reference": "primary-bz9f7c2r",
18 "tier": "UNLIMITED",
19 "subPockets": null,
20 "pocketOwner": {
21 "pocketOwnerId": "ZShXHvvh",
22 "businessName": "((Business Name))",
23 "firstName": "((First Name))",
24 "lastName": "((Last Name))",
25 "emailAddress": "email@mail.com",
26 "phoneNumber": "((phone number))",
27 "ownerVerifierScheme": "NIN",
28 "ownerVerifierNumber": "00000000000"
29 },
30 "pocketAccounts": [
31 {
32 "accountId": "zck4bsvjr351",
33 "accountNumber": "((virtual account number))",
34 "bankCode": "9PSB",
35 "bankName": "9 Payment Service Bank",
36 "reference": "e1l5suvm9oxybgpz8"
37 }
38 ],
39 "pocketFundings": null,
40 "pocketLimits": [],
41 "pocketMomos": []
42 }
43}Pocket Details
GET
https://pocket.seerbitapi.com/pocket/balance/pocket-id/((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
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
This a sample response code
1{
2 "responseCode": "00",
3 "message": "Success",
4 "data": {
5 "balanceAt": "2024-06-25T14:44:49",
6 "availableBalanceCurrency": "NGN",
7 "availableBalanceAmount": "4880.00",
8 "lastTransactionAt": "2024-06-20T10:56:34"
9 }
10} 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.
createdOn
StartDate
StartDate
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.
createdOn
EndDate
EndDate
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
This a sample response code
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": "100000238",
11 "transactionLeg": "CREDIT",
12 "transactionCurrency": "NGN",
13 "narration":
14 "Reason:Funding:Credited:100000238:Debited:SBP0000001: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:SBP0000001: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:SBP0000001: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 {
46 "createdAt": "2023-03-05T22:17:09",
47 "deleted": false,
48 "reference": "Charge-gi0hc14wb3y8",
49 "pocketId": "100000238",
50 "transactionLeg": "DEBIT",
51 "transactionCurrency": "NGN",
52 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN250.00:AvailableBalance:NGN29999550.00",
53 "transactionId": "ld7yvehgocxk",
54 "description": "Fee - Funding by account - Global - GENERIC - ALL-PURPOSE",
55 "transactionAmount": "250.00"
56 },
57
58 {
59 "createdAt": "2023-03-06T07:09:06",
60 "deleted": false,
61 "reference": "Charge-xblqhwa6prgz",
62 "pocketId": "100000238",
63 "transactionLeg": "DEBIT",
64 "transactionCurrency": "NGN",
65 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN200.00:AvailableBalance:NGN29999350.00",
66 "transactionId": "0jac4i29h751",
67 "description": "Fee - Sub pocket addition - Primary pockets - GENERIC - ALL-PURPOSE",
68 "transactionAmount": "200.00"
69 },
70 {
71 "createdAt": "2023-03-06T07:09:07",
72 "deleted": false,
73 "reference": "Charge-u295bewf3qrk",
74 "pocketId": "100000238",
75 "transactionLeg": "DEBIT",
76 "transactionCurrency": "NGN",
77 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN200.00:AvailableBalance:NGN29999150.00",
78 "transactionId": "n0u8qlxcphbv",
79 "description": "Fee - Sub pocket addition - Primary pockets - GENERIC - ALL-PURPOSE",
80 "transactionAmount": "200.00"
81 },
82 {
83 "createdAt": "2023-03-06T07:13:10",
84 "deleted": false,
85 "reference": "Charge-0aobvc59fl61",
86 "pocketId": "100000238",
87 "transactionLeg": "DEBIT",
88 "transactionCurrency": "NGN",
89 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN200.00:AvailableBalance:NGN29998950.00",
90 "transactionId": "5pokybcnzmtg",
91 "description": "Fee - Sub pocket addition - Primary pockets - GENERIC - ALL-PURPOSE",
92 "transactionAmount": "200.00"
93 },
94 {
95 "createdAt": "2023-03-06T07:13:11",
96 "deleted": false,
97 "reference": "Charge-sbk4f6to07pl",
98 "pocketId": "100000238",
99 "transactionLeg": "DEBIT",
100 "transactionCurrency": "NGN",
101 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN200.00:AvailableBalance:NGN29998750.00",
102 "transactionId": "cuwdqg7xeyh2",
103 "description": "Fee - Sub pocket addition - Primary pockets - GENERIC - ALL-PURPOSE",
104 "transactionAmount": "200.00"
105 },
106 {
107 "createdAt": "2023-03-06T09:14:48",
108 "deleted": false,
109 "reference": "Charge-nytpgud4ebxh",
110 "pocketId": "100000238",
111 "transactionLeg": "DEBIT",
112 "transactionCurrency": "NGN",
113 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN250.00:AvailableBalance:NGN29998500.00",
114 "transactionId": "yq38xgzi5v0s",
115 "description": "Fee - Funding by account - Global - GENERIC - ALL-PURPOSE",
116 "transactionAmount": "250.00"
117 },
118 {
119 "createdAt": "2023-03-06T09:18:23",
120 "deleted": false,
121 "reference": "Charge-7z3sc0qjf2vm",
122 "pocketId": "100000238",
123 "transactionLeg": "DEBIT",
124 "transactionCurrency": "NGN",
125 "narration": "Reason:Fee:Debited:100000238:Credited:SBP0000001:Amount:NGN250.00:AvailableBalance:NGN29998250.00",
126 "transactionId": "yvdzkn61ulwr",
127 "description": "Fee - Funding by account - Global - GENERIC - ALL-PURPOSE",
128 "transactionAmount": "250.00"
129 }
130 ], "pageable": {
131 "sort": {
132 "sorted": true,
133 "unsorted": false,
134 "empty": false
135 },
136 "pageSize": 10,
137 "pageNumber": 0,
138 "offset": 0,
139 "paged": true,
140 "unpaged": false
141 },
142 "last": true,
143 "totalElements": 10,
144 "totalPages": 1,
145 "sort": {
146 "sorted": true,
147 "unsorted": false,
148 "empty": false
149 },
150 "first": true,
151 "numberOfElements": 10,
152 "size": 10,
153 "number": 0,
154 "empty": false
155 }
156} Account Enquiry
POST
https://pocket.seerbitapi.com/pocket/payout/account-enquiry
Request Sample
This API allows the user to obtain information about a specific bank account.
1curl --location 'https://pocket.seerbitapi.com/pocket/user/change-password' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '
5 {
6 "accountnumber":"(account number)",
7 "bankcode":"(bank code)"
8}'Bank List
This API shows a list of supported Nigerian banks
GET
https://pocket.seerbitapi.com/pocket/banks
Transfer to Bank Account (NG)
POST
https://pocket.seerbitapi.com/pocket/payout/pocket-id/(pocketId)
Request Sample
This API allows the user to obtain information about a specific bank account.
1curl --location 'https://pocket.seerbitapi.com/pocket/payout/pocket-id/(pocketId)' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '
5 {
6 "reference":"{{reference}}",
7 "amount":"1",
8 "currency":"NGN",
9 "description":"Pockets",
10 "accountNumber":"(Account Number)",
11 "bankCode":"000013"
12}'Payout Transaction Status
This API returns the status of a payout transaction using the provided reference
GET
https://pocket.seerbitapi.com/pocket/status/reference/(reference)
Bulk Transfer to Bank Account (NG)
POST
https://pocket.seerbitapi.com/pocket/payout/v2/bulk/pocket-id/(pocketId)
Request Sample
This API allows the user to initiate a payout request from their pocket to multiple bank accounts. It will generate a batch ID, which can be queried to get the status of the transactions within the batch.
1curl --location 'https://pocket.seerbitapi.com/pocket/user/change-password' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '[
5 {
6 "reference":"1ok27yrf6-6588-5-9m6g-lor5490jk4gt656",
7 "amount":"1",
8 "currency":"NGN",
9 "description":"description",
10 "accountNumber":" bank account number ",
11 "bankCode":"000013"
12 },
13 {
14 "reference":"2ok27yrf6-658g25-9m6g-lor5490jk4gt651",
15 "amount":"1",
16 "currency":"NGN",
17 "description":" description ",
18 "accountNumber":" bank account number ",
19 "bankCode":"000013"
20 },
21 {
22 "reference":"3ok27yrf6-65g25-9m6g-lor5490jk4gt652",
23 "amount":"1",
24 "currency":"NGN",
25 "description":" description ",
26 "accountNumber":"bank account number",
27 "bankCode":"000013"
28 },
29 {
30 "reference":"4ok27yrf688-7g25-9m6g-lor5490jk4gt653",
31 "amount":"1",
32 "currency":"NGN",
33 "description":" description ",
34 "accountNumber":" bank account number ",
35 "bankCode":"000013"
36 },
37 ]'Response Sample
This a sample response code
1{
2 "message": "Your payment request has been received for processing",
3 "code": "00",
4 "body": {
5 "batchId": "(Batch ID)"
6 }
7} Bulk Payout Transaction Status
GET
https://pocket.seerbitapi.com/pocket/transaction/search?batchId=(batchid)
Response Sample
This a sample response code
1{
2 "message": "Batch IDs fetched successfully",
3 "status": "00",
4 "data": {
5 "totalElementsPerPage": 10,
6 "content": [
7 {
8 "createdAt": "2024-06-04T17:30:36",
9 "processedCount": 5,
10 "pendingCount": 0,
11 "batchId": "wgrleyb",
12 "totalCount": 5,
13 "totalBatchIdCount": 28,
14 "status": "Completed"
15 },
16 {
17 "createdAt": "2024-05-20T15:01:06",
18 "processedCount": 5,
19 "pendingCount": 0,
20 "batchId": "diz1aom",
21 "totalCount": 5,
22 "totalBatchIdCount": 28,
23 "status": "Completed"
24 },
25 {
26 "createdAt": "2024-04-19T12:30:40",
27 "processedCount": 0,
28 "pendingCount": 0,
29 "batchId": "7resh2k",
30 "totalCount": 1,
31 "totalBatchIdCount": 28,
32 "status": "Processing"
33 }, 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.