This collection covers the core merchant-facing operations of the Brassica BBus Gateway API (v1). It provides a structured set of endpoints for integrating payment and money-movement functionality into merchant systems.
\n"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"{{UserName}}\",\r\n \"password\": \"{{Password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://bbusmockserver.azurewebsites.net/Authenticate","description":"Authenticate
\nGenerates a Bearer Token used to authorize access to all protected endpoints.
\nMethod: POST
Endpoint: https://bbusmockserver.azurewebsites.net/Authenticate
\nbaseURL : https://bbusmockserver.azurewebsites.net
\n
\nRequest Body
\nSend a JSON payload with the following fields:
\n\n\n\n| Field | \nType | \nRequired | \nDescription | \n
\n\n\n\nuserName | \nstring | \nYes | \nThe account username | \n
\n\npassword | \nstring | \nYes | \nThe account password | \n
\n\n
\n
Example:
\n{\n \"userName\": \"Brassica\",\n \"password\": \"Brassica_pwd\" //use this Credentials to test on your local or postman\n}\n\n
\n
\nResponse
\nOn success, the API returns a 200 OK with a JSON body containing:
\n\n\n\n| Field | \nDescription | \n
\n\n\n\ndata.resp1 | \nThe JWT Bearer Token to use in subsequent requests | \n
\n\ndata.resp2 | \nYour server IP address | \n
\n\nresponse | \nResponse code (\"000\" indicates success) | \n
\n\nresponseMesg | \nHuman-readable status message (e.g. \"Token Generated\") | \n
\n\n
\n
Example response:
\n{\n \"data\": {\n \"resp1\": \"<JWT_TOKEN>\",\n \"resp2\": \"169.254.132.3\"\n },\n \"response\": \"000\",\n \"responseMesg\": \"Token Generated\"\n}\n\n
\n
\nUsing the Token
\nAll protected endpoints require a Bearer Token. Tokens are short-lived (1 hour). You should obtain a fresh token after each hour of authentication.
\nInclude the token in the Authorization header of every subsequent request:
\nAuthorization: Bearer <token>\n\n
","urlObject":{"path":["Authenticate"],"host":["https://bbusmockserver.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"86e83063-a3fd-4846-9249-0e8e9cd06303","name":"Accepted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userName\": \"Brassica\",\r\n \"password\": \"Brassica_pwd\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://bbusmockserver.azurewebsites.net/Authenticate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"000\",\n \"responseMesg\": \"Token Generated\",\n \"data\": {\n \"resp1\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bm4xdWVfbmFtZSI6IkJSQTIzMDgxO9Y14jciLCJVc2VySUQiOiJCUkEyMzA4MTg2NTI3IiwibmJmIjoxNzM4MjQ33DMwLCJleHAiOjE3MzgyNTA2MzAsImlhdCI6MTczODI0NzA0MH0.vK1YVwmFnCoEHzaQNYjBuJgkypnIVp8dxvnLjJz4sUg\",\n \"resp2\": \"41.76.295.105\"\n }\n}"},{"id":"f9b2207c-f017-46d4-bf02-e97f28d9b371","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://bbusmockserver.azurewebsites.net/Authenticate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"001\",\n \"responseMesg\": \"Wrong UserName or Password\"\n}"}],"_postman_id":"85b41ee8-3db1-4ec2-b45a-5acc79b91b44"},{"name":"DebitMoney","id":"2f16a531-651b-4944-9076-be083f3aa0b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://bbusmockserver.azurewebsites.net/DebitMoney","description":"DebitMoney
\nInitiates a debit (collection) from a mobile money wallet.
\n\nℹ NOTE
This is a mock server — it has no real-world effect. It is intended to demonstrate the correct request and response to pass when sending a request.
ℹ NOTE
Debit operations against mobile money accounts are subject to the customer approving a USSD prompt on their handset. Note that this will not work as this is just a playground for API testing
\n
\nMethod: POST
Endpoint: https://bbusmockserver.azurewebsites.net/debitMoney
Auth: Bearer Token
\n
\nAuthentication
\nAll requests must include a Bearer Token in the Authorization header:
\nAuthorization: Bearer <token>\n\n
\nRequest Body
\nSend a JSON payload with the following fields:
\n\n\n\n| Field | \nType | \nRequired | \nDescription | \n
\n\n\n\nchannel | \nstring | \nYes | \nMust be \"mno\" for debit (mobile money only) | \n
\n\ninstitutionCode | \nstring | \nYes | \nCode identifying the financial institution
300592- AT
300591-MTN
300594-TELECEL | \n
\n\naccountNumber | \nstring | \nYes | \nThe mobile money wallet number to debit | \n
\n\naccountName | \nstring | \nYes | \nName of the account holder | \n
\n\namount | \nstring | \nYes | \nAmount to debit (as a string, e.g. \"1.00\") | \n
\n\ndebitNaration | \nstring | \nYes | \nDescription or reference for the transaction | \n
\n\ntransactionId | \nstring | \nYes | \nUnique identifier for the transaction | \n
\n\n
\n
Example:
\n{\n \"channel\": \"mno\",\n \"institutionCode\": \"300592\",\n \"accountNumber\": \"23312345678\",\n \"accountName\": \"Jonathan Amponsah\",\n \"amount\": \"1.00\",\n \"debitNaration\": \"Testing Debit\",\n \"transactionId\": \"5365tet2555205\"\n}\n\n
\n
\nInitial Response & Callback
\nThe initial response (HTTP 202 Accepted) confirms that your request has passed validation. The final transaction outcome (SUCCESSFUL or FAILED) is delivered via a check Status
\n
\nResponses
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n202 Accepted | \nThe debit request passed validation and is being processed | \n
\n\n400 Request Not Accepted | \nThe request was rejected due to invalid or missing parameters | \n
\n\n
\n
\nKey Differences from Send Money
\n\n\n\n| Parameter | \nSend Money | \nDebit Money | \n
\n\n\n\nchannel | \n\"mno\" | \n\"mno\" only (mobile money accounts) | \n
\n\n| Narration field | \ncreditNaration | \ndebitNaration | \n
\n\n| Direction | \nCredit (funds out to recipient) | \nDebit (funds pulled from account) | \n
\n\n
\n
\nNotes
\n\nTokens are short-lived (1 hour). Obtain a fresh token before making requests if the previous token has expired.
\nEnsure transactionId is unique per transaction to avoid duplicate processing.
\nThe channel field must always be \"mno\" — debit is only supported for mobile money wallets.
\n
\n","urlObject":{"path":["DebitMoney"],"host":["https://bbusmockserver.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"63e2f07c-5bd0-486a-ac90-4782077cbe34","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transactionId\": \"123456789ABCD\",\r\n \"institutionCode\": \"300591\",\r\n \"accountNumber\": \"2335912345678\",\r\n \"accountName\": \"Jonathan Amponsah\",\r\n \"amount\": \"2.00\",\r\n \"debitNaration\": \"test\",\r\n \"serviceType\": \"test\",\r\n \"channel\": \"mno\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://bbusmockserver.azurewebsites.net/DebitMoney"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"202\",\n \"status\": \"ACCEPTED\",\n \"message\": \"Request is being processed.\",\n \"extralTransactionId\": null,\n \"transactionId\": \"123456789ABCD\",\n \"paymentURL\": null\n}"},{"id":"707462e0-d1b2-497f-bd64-770237bcbd93","name":"Request Not Accepted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://bbusmockserver.azurewebsites.net/DebitMoney"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"406\",\n \"status\": \"REQUEST_NOT_ACCEPTED\",\n \"message\": \"Request not accepted for one or more reasons.\",\n \"extralTransactionId\": \"ba745c3797d740dabd0d053f8ca1c372\",\n \"transactionId\": \"123456789ABCD\",\n \"paymentURL\": null\n}"}],"_postman_id":"2f16a531-651b-4944-9076-be083f3aa0b5"},{"name":"TransStatusQuery","id":"73508a70-da75-45dd-bb25-213a70f34ceb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionType\": \"debit\",\r\n \"transactionId\": \"94044444788894882r3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://bbusmockserver.azurewebsites.net/transStatusQuery","description":"Transaction Status Query
\nThe Transaction Status Query endpoint allows you to actively poll for the status of a previously submitted credit or debit transaction. While outcome is delivered through callbacks, you should use this endpoint to handle cases where your callback was not received, to reconcile pending transactions, or to obtain live status updates to your transaction.
\n\nℹ NOTE
This is a mock server — it has no real-world effect. It is intended to demonstrate the correct request and response format when sending a request.
\n
\nMethod: POST
Endpoint: https://bbusmockserver.azurewebsites.net/transStatusQuery
Auth: Bearer Token
\n
\nAuthentication
\nAll requests must include a Bearer Token in the Authorization header:
\nAuthorization: Bearer <token>\n\n
\nRequest Body
\nSend a JSON payload with the following fields:
\n\n\n\n| Parameter | \nValues | \nDescription | \n
\n\n\n\ntransactionType | \n\"credit\" or \"debit\" | \nSpecify whether the original transaction was a Send Money (credit) or a Debit Money (debit) operation. | \n
\n\ntransactionId | \nYour original reference | \nThe same transactionId you provided when the transaction was submitted. | \n
\n\n
\n
Example:
\n{\n \"transactionType\": \"credit\",\n \"transactionId\": \"5365tet2555127\"\n}\n\n
\n
\nResponse Body
\n{\n \"statusCode\": \"200\",\n \"status\": \"SUCCESSFUL\",\n \"message\": \"Request processed successfully.\",\n \"institutionApprovalCode\": \"25809613539\",\n \"transactionId\": \"e-55bg6-736627-63524\",\n \"extralTransactionId\": \"1e96398f-7da3-474d-a85d-a26aa6e76b93\"\n}\n\n
\n
\nResponses
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n200 OK | \nRequest accepted — transaction status returned successfully | \n
\n\n404 Not Found | \nTransaction not found for the given transactionId | \n
\n\n
\n
Get Balance
\nThe Get Balance endpoint retrieves the current available float balance on your account. Use this to display your real-time balance.
\n\nℹ NOTE\nThis is a mock server — it has no real-world effect. It is intended to demonstrate the correct request and response to pass when sending a request.
\n
\nMethod: POST\nEndpoint: /GetAvailableBalance\nAuth: Bearer Token
\n
\nRequest Body
\nThis endpoint requires no request body. Simply send an authenticated POST request to the endpoint.
\n
\nAuthentication
\nAll requests must include a Bearer Token in the Authorization header:
\nAuthorization: Bearer <token>\n
\nResponse Body
\n{\n \"accountBalance\": \"74.1985\",\n \"dateTime\": \"23-08-2023 10:59:25\"\n}\n
\nResponse Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\naccountBalance | \nYour available float balance in GHS. This reflects the amount currently available to fund outgoing credit transfers. | \n
\n\ndateTime | \nThe server timestamp at which the balance was read, in DD-MM-YYYY HH:MM:SS format. | \n
\n\n
\n
Name Enquiry
\nThe Name Enquiry endpoint allows you to verify that a given mobile money wallet or bank account number is valid and retrieve the registered account holder's name.
\n\nℹ NOTE
This is a mock server — it has no real-world effect. It is intended to demonstrate the correct request and response to pass when sending a request.
\n
\n\n⚠ IMPORTANT
It is important to perform a Name Enquiry before executing a Send Money transaction to validate the destination account and give users a chance to confirm the recipient's name.
\n
\nMethod: POST
Endpoint: /nameEnquiry
Auth: Bearer Token
\n
\nRequest Body
\n{\n \"channel\": \"mno\", // \"mno\" or \"interbank\"\n \"institutionCode\": \"300594\", // Destination institution code\n \"accountNumber\": \"2332012345678\", // 12-digit international format\n \"transactionId\": \"5365tet2555127\" // Unique reference for this enquiry\n}\n\n
\n
\nResponse Body
\n{\n \"statusCode\": \"200\",\n \"status\": \"SUCCESSFUL\",\n \"message\": \"Request processed successfully\",\n \"accountName\": \"Jonathan Amponsah\",\n \"accountNumber\": \"020412345678\",\n \"transactionId\": \"5365tet2555127\",\n \"institutionApprovalCode\": \"000000\",\n \"extralTransactionId\": \"0000000000\"\n}\n\n
\n
\nResponse Fields
\n\n\n\n| Field | \nDescription | \n
\n\n\n\naccountName | \nThe registered name of the account holder. Display this to the user for explicit confirmation before proceeding with the transfer. | \n
\n\naccountNumber | \nThe account number returned (may be in local format, without country prefix). | \n
\n\nstatusCode | \n200 indicates the account was found and validated. Any other code indicates a problem — do not proceed with the transfer. | \n
\n\n
\n
Send Money
\nThe Send Money endpoint initiates a credit transfer to a recipient's mobile money wallet (MNO) or bank account (interbank). Because transfers are processed asynchronously by the underlying payment networks, the initial API response is an acknowledgement.
\n\nℹ NOTE
This is a mock server — it has no real-world effect. It is intended to demonstrate the correct request and response to pass when sending a request.
\n
\nMethod: POST Endpoint: /sendMoney Auth: Bearer Token
\n
\nRequest Body
\n{\n \"channel\": \"interbank\", // \"mno\" or \"interbank\"\n \"institutionCode\": \"300592\", // 6-digit institution code\n \"accountNumber\": \"2332012345678\", // 12-digit for wallet or bank account digits\n \"accountName\": \"Jonathan Amponsah\", // Recipient's name\n \"amount\": \"1.00\", // Two-decimal string\n \"creditNaration\": \"Testing Credit\", // Max 50 characters\n \"transactionId\": \"5365tet2555205\" // Your unique transaction reference\n}\n\n
\nInitial Response (HTTP 202 — Accepted)
\nThe API immediately returns a 202 Accepted response to confirm your request has passed validation and is being processed.
\n{\n \"statusCode\": \"202\",\n \"status\": \"ACCEPTED\",\n \"message\": \"Request is being processed\",\n \"extralTransactionId\": \"73662553837\", // Brassica internal reference\n \"transactionId\": \"5365tet2555205\" // Your original reference echoed back\n}\n\n
\n
\nRequest Parameters
\n\n\n\n| Parameter | \nType | \nMax Length | \nDescription | \n
\n\n\n\n| channel | \nString | \n10 | \nTransfer channel. Use \"mno\" for mobile money networks; \"interbank\" for bank-to-bank transfers. | \n
\n\n| institutionCode | \nString | \n6 digits | \nUnique code identifying the destination institution (see Institution Codes section).
300952 - AT
300951-MTN
300954-TELECEL | \n
\n\n| accountNumber | \nNumbers | \n10–15 digits | \nRecipient's mobile or bank account number in international format (e.g., 233XXXXXXXXX). | \n
\n\n| accountName | \nString | \n50 chars | \nName of the account holder. | \n
\n\n| amount | \nString | \nDecimal | \nTransfer amount in GHS, formatted as a two-decimal string (e.g., \"100.00\"). | \n
\n\n| creditNaration | \nString | \n50 chars | \nA human-readable description of the transfer. | \n
\n\n| transactionId | \nAlphanumeric | \n40 chars | \nYour unique reference for this transaction. Must be unique per request. | \n
\n\n
\n
\n","urlObject":{"path":["sendMoney"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"84eff95a-7ea5-40f5-b47d-6bd2ca328a31","name":"Accepted","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"channel\": \"mno\",\r\n \"institutionCode\": \"300594\",\r\n \"accountNumber\": \"2335012345678\",\r\n \"accountName\": \"Jonathan Amponsah\",\r\n \"amount\": \"2.00\",\r\n \"creditNaration\": \"Testing Credit\",\r\n \"transactionId\": \"123456789ABCD\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://bbusmockserver.azurewebsites.net/SendMoney"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"202\",\n \"status\": \"ACCEPTED\",\n \"message\": \"Request is being processed.\",\n \"extralTransactionId\": null,\n \"transactionId\": \"123456789ABCD\",\n \"paymentURL\": null\n}"}],"_postman_id":"af6530fc-2665-4ca2-b2aa-f79edc0009ee"}],"event":[{"listen":"prerequest","script":{"id":"87d50f2c-3efd-421c-8616-189361ad06e2","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"0a6c4f87-a45e-4a65-a8b0-503d489ae4aa","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"BaseURL","value":"https://bbusmockserver.azurewebsites.net"}]}