{"info":{"_postman_id":"18e85388-51a3-46e2-a1de-e856c385af7d","name":"Fikiwa","description":"

Here is some information that should help you understand the basic
usage of our RESTful API. Including info about making requests,
responses, potential errors, rate limiting, pagination, query parameters
and more.

\n

Authorization - Basic Authentication

\n

The authorization method supported by Fikiwa is BasicAuth.

\n

To authenticate your requests you need to provide your username and password.

\n

Product Codes

\n
SMS = 1\nUSSD = 2\nAirtime = 3\n3rd Party = 4\nDefault(Aggregate) = 5\n\n

Transaction Codes

\n
SMS = 1\nUSSD = 2\nAirtime = 3\nTransaction Reversal = 13\nWallet Statement = 14\nWallet Balance = 15\nWallet Accounts = 16\nResubmit Callback = 17\nThird Party WalletTransaction = 19\nFunds Transfer  = 22\nCurrencies = 26\nCreate Customer = 27\nCreate Customer Account = 28\nThird Party Partial Reversal = 29\nCommission Statement = 38\nCommission Balance = 39\n\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authorization - Basic Authentication","slug":"authorization-basic-authentication"},{"content":"Product Codes","slug":"product-codes"},{"content":"Transaction Codes","slug":"transaction-codes"}],"owner":"5291326","collectionId":"18e85388-51a3-46e2-a1de-e856c385af7d","publishedId":"UVktoD8j","public":true,"customColor":{"top-bar":"1c2d5a","right-sidebar":"1c2d5a","highlight":"e4a314"},"publishDate":"2022-03-02T18:24:06.000Z"},"item":[{"name":"SMS","id":"ca12fae9-1881-4ff0-970c-4f4c70f0c50e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransactionType\": \"1\",\n \"UniqueTransactionIdentifier\": \"asdaSDasdAS58\",\n \"CallbackURL\": \"https://en40lmxwfny9s.x.pipedream.net/\",\n \"Messages\": [\n {\n \"From\": \"\",\n \"To\": \"+254700000000\",\n \"Text\": \"Hello world\",\n \"SecurityCritical\": false\n }\n ]\n}"},"url":"https://sandbox.fikiwa.com:9000/api/cloudbus","description":"

TransactionType 1

\n

UniqueTransactionIdentifier A unique reference number that will be sent back to you on the provided delivery endpoint

\n

CallbackURL The Url that we will send you a delivery report once the message is terminated to the device

\n

Message object that holds multiple SMS payloads.

\n

From The Alphanumeric or short code that will be used to send the message. Leave blank if none.

\n

To SMS recipient.

\n

Text SMS body.

\n

SecurityCritical is it a sensitive text i.e. password(OTP)? If yes set to true otherwise set it to false

\n

Sample callback response:

\n
{\n    \"Id\":\"23790F3D-9DFA-EB11-8704-D5A087E4E185\",\n    \"Reference\":\"86546545VB4FG65H468W6F87W6F87WE6F87EW\",\n    \"Address\": \"+254700000000\",\n    \"StatusCode\": 5,\n    \"Status\": \"Delivered To Terminal\",\n    \"Narration\": \"Additional narration\",\n    \"AvailableBalance\":\"2510.20\"\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","cloudbus"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca12fae9-1881-4ff0-970c-4f4c70f0c50e"},{"name":"Currencies","id":"657d56ec-764d-40f8-9236-e61eb871dd97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"26\",\r\n \"UniqueTransactionIdentifier\": \"A60BBB-9C4B-45AB-AF6E-462E8369A779\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 26

\n

UniqueTransactionIdentifier is your system's unique request identifier

\n

Sample response

\n
[\n    {\n        \"Code\": 0,\n        \"Name\": \"Kenya Shilling\"\n    },\n    {\n        \"Code\": 1,\n        \"Name\": \"United Arab Emirates Dirham\"\n    }\n]\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"657d56ec-764d-40f8-9236-e61eb871dd97"},{"name":"Create Customer","id":"58a46bfa-1cd7-4c3a-8e23-88a04d010214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"27\",\r\n \"UniqueTransactionIdentifier\": \"72cb0000-f806-eb11-86b4-f4d0fa10c004\",\r\n \"Name\": \"Cairo Bank\",\r\n \"Email\": \"info@xxx.co.ke\",\r\n \"MobileLine\": \"+254705000000\",\r\n \"Address\": \"Victoria Building 105\",\r\n \"Street\": \"Victoria Street\",\r\n \"City\": \"Victoria\",\r\n \"Metadata\": [\r\n {\r\n \"MetadataId\": \"CairoAAAAAAAAAA01\",\r\n \"CurrencyCode\": 404\r\n },\r\n {\r\n \"MetadataId\": \"CairoAAAAAAAAAA02\",\r\n \"CurrencyCode\": 404\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 27

\n

UniqueTransactionIdentifier is your system's unique id for this transaction at that instance.

\n

Name description or name of the customer.

\n

Email valid email of the customer.

\n

MobileLine a valid mobile/office number in international format.

\n

Address address of the customer e.g building.

\n

Street street/lane.

\n

City city/town/hometown.

\n

MetadataId your unique identifier for that metadata leg.

\n

CurrencyCode ISO 4217 currency code number for the wallet that will be created along with the customer.

\n

Sample response

\n
{\n  \"ReferenceId\": \"eb34d201-5e65-eb11-86cc-cea3209a7e32\",\n  \"Wallets\": [\n    {\n      \"MetadataId\": \"AAAAAAAAAA01\",\n      \"ProductCode\": 3,\n      \"ProductType\": 4,\n      \"AccountNumber\": \"30003800066\",\n      \"CurrencyCode\": 404,\n      \"Status\": \"Normal\",\n      \"AvailableBalance\": 0\n    }\n  ]\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"58a46bfa-1cd7-4c3a-8e23-88a04d010214"},{"name":"Create Wallets","id":"9899585a-2efc-43e6-82a2-13f87293d94b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"28\",\r\n \"ReferenceId\":\"61C5ED8A-5F9E-E911-8203-0AB208235486\",\r\n \"UniqueTransactionIdentifier\": \"72cb0000-f806-eb11-86b4-f4d0fa10c00888\",\r\n \"Metadata\": [\r\n {\r\n \"MetadataId\": \"CairoAAAAAAAAAA01\",\r\n \"CurrencyCode\": 404\r\n },\r\n {\r\n \"MetadataId\": \"CairoAAAAAAAAAA02\",\r\n \"CurrencyCode\": 404\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 28

\n

UniqueTransactionIdentifier is your system's unique request ID for this transaction at that instance.

\n

ReferenceId is the unique ID we responded with when you created the customer for which this wallet belongs to.

\n

MetadataId unique metadata identifier for that leg.

\n

CurrencyCode standard currency code for the wallet that is being created.

\n

Sample response

\n
{\n    \"ReferenceId\": \"eb34d201-5e65-eb11-86cc-cea3209a7e32\",\n    \"Wallets\": [\n        {\n            \"MetadataId\": \"BBBBBB01\",\n            \"ProductCode\": 3,\n            \"ProductType\": 4,\n            \"AccountNumber\": \"30003800068\",\n            \"CurrencyCode\": 882,\n            \"Status\": \"Normal\",\n            \"AvailableBalance\": 0.00\n        }\n    ]\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9899585a-2efc-43e6-82a2-13f87293d94b"},{"name":"Wallets","id":"37d1131b-ae1e-4688-911a-72bd994e89eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"TransactionType\": \"16\",\n \"ReferenceId\":\"61C5ED8A-5F9E-E911-8203-0AB208235486\",\n \"UniqueTransactionIdentifier\": \"A70BBB-9C4B-45AB-AF6E-462E8369A501\"\n}"},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 16

\n

UniqueTransactionIdentifier is your system's unique request ID for this transaction at that instance.

\n

ReferenceId customer unique ID in our system.

\n

Sample response:

\n
{\n  \"Wallets\": [\n    {\n      \"ProductCode\": 3,\n      \"ProductType\": 4,\n      \"AccountNumber\": \"30003800066\",\n      \"CurrencyCode\": 404,\n      \"Status\": \"Normal\",\n      \"AvailableBalance\": 0\n    },\n    {\n      \"ProductCode\": 3,\n      \"ProductType\": 4,\n      \"AccountNumber\": \"30003800067\",\n      \"CurrencyCode\": 404,\n      \"Status\": \"Normal\",\n      \"AvailableBalance\": 0\n    },\n    {\n      \"ProductCode\": 3,\n      \"ProductType\": 4,\n      \"AccountNumber\": \"30003800068\",\n      \"CurrencyCode\": 882,\n      \"Status\": \"Normal\",\n      \"AvailableBalance\": 0\n    }\n  ]\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"37d1131b-ae1e-4688-911a-72bd994e89eb"},{"name":"Wallet Balance","id":"6445d2eb-d648-4985-bc22-52476b49a601","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransactionType\": \"15\",\n \"AccountNumber\": \"40000500218\",\n \"UniqueTransactionIdentifier\": \"A60BBB-9C4B-45AB-AF6E-462E8369A70\"\n}"},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 15

\n

AccountNumber account number for the wallet.

\n

UniqueTransactionIdentifier Your system's unique identifier for this transaction.

\n

Sample response

\n
555.5\n\n
","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6445d2eb-d648-4985-bc22-52476b49a601"},{"name":"Wallet statement","id":"3e7c56b2-d977-4ea1-8fc1-0b44cd359ae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"TransactionType\": \"14\",\n \"AccountNUmber\": \"40000500021\",\n \"UniqueTransactionIdentifier\": \"A50BBB-9C4B-45AB-AF6E-462E836911\",\n \"Statement\": {\n \"Index\": 0,\n \"Size\": 100,\n \"Filter\": \"\",\n \"StartDate\": \"21/05/2019\",\n \"EndDate\": \"24/05/2022\"\n }\n}"},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 14

\n

AccountNumber this is the account number for the wallet.

\n

UniqueTransactionIdentifier your system's unique id for this transaction.

\n

Statement json object with paging capabilities.

\n

Index start index

\n

Size item count

\n

Filter search text

\n

StartDate get statement from?

\n

EndDate get statement upto?

\n

Sample response

\n
{\n    \"ItemsCount\": 5,\n    \"BalanceBroughtFoward\": 0,\n    \"TotalDebits\": 2000,\n    \"TotalCredits\": 2555,\n    \"BalanceCarriedForward\": 555,\n    \"Transactions\": [\n        {\n            \"CreatedDate\": \"14/06/2019 12:46:50 PM\",\n            \"ValueDate\": \"14/06/2019\",\n            \"PrimaryDescription\": \"Monthly Blah Blah\",\n            \"SecondaryDescription\": \"Blah Blah Continues Here\",\n            \"Reference\": \"400001-Wingu Box\",\n            \"Debit\": 0,\n            \"Credit\": 500,\n            \"RunningBalance\": 500,\n            \"TransactionCode\": \"Third Party\"\n        }\n    ]\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e7c56b2-d977-4ea1-8fc1-0b44cd359ae7"},{"name":"Charge Wallet","id":"3dbedf30-90f8-4938-8bd8-049e7dec1a02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"TransactionType\": \"35\",\n \"UniqueTransactionIdentifier\": \"H778FBBB-9C4B-45AB-AF6E-462E8369A600\",\n \"CallbackURL\": \"https://enkaahftowy8.x.pipedream.net/\",\n \"PrimaryDescription\": \"Monthly blah blah\",\n \"SecondaryDescription\": \"blah blah for blah\"\n}"},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType pass here the transaction code for the transaction type you want to charge.

\n

UniqueTransactionIdentifier A unique identifier that will be sent back to you on the provided delivery endpoint

\n

CallbackURL The Url that we will send you a delivery report once the request is processed

\n

PrimaryDescription Description of transaction

\n

SecondaryDescription Further description of transaction

\n

Note:

\n

InitiatorReference is the UniqueTransactionIdentifier you passed in your transaction payload. During transaction reversal, pass this TransactionId as the Reference

\n

Sample success callback response:

\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"success\",\n    \"Narration\": \"\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"success\",\n    \"Narration\": \"No charges found for this transaction type\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n

Sample failed callback responses:

\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"insufficient funds\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"wallet not found\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"target product not found\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3dbedf30-90f8-4938-8bd8-049e7dec1a02"},{"name":"Commission Balance","id":"224e14fc-847a-4eed-a58c-19b99fc491dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"39\",\r\n \"ReferenceId\": \"61C5ED8A-5F9E-E911-8203-0AB208235486\",\r\n \"UniqueTransactionIdentifier\": \"A60BBB-9C4B-45AB-AF6E-462E8369A678\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 39

\n

ReferenceId customer id reference.

\n

UniqueTransactionIdentifier Your system's unique identifier for this transaction.

\n

Sample response

\n
555.5\n\n
","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"224e14fc-847a-4eed-a58c-19b99fc491dc"},{"name":"Commission Statement","id":"34903b14-806e-446b-80d9-0e5c07863cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"38\",\r\n \"ReferenceId\": \"61C5ED8A-5F9E-E911-8203-0AB208235486\",\r\n \"UniqueTransactionIdentifier\": \"A50BBB-9C4B-45AB-AF6E-462E836911\",\r\n \"Statement\": {\r\n \"Index\": 0,\r\n \"Size\": 100,\r\n \"Filter\": \"\",\r\n \"StartDate\": \"21/05/2019\",\r\n \"EndDate\": \"24/05/2022\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 38

\n

ReferenceId this is the unique customer reference from our system.

\n

UniqueTransactionIdentifier your system's unique id for this transaction.

\n

Statement json object with paging capabilities.

\n

Index start index

\n

Size item count

\n

Filter search text

\n

StartDate get statement from?

\n

EndDate get statement upto?

\n

Sample response

\n
{\n    \"ItemsCount\": 5,\n    \"BalanceBroughtFoward\": 0,\n    \"TotalDebits\": 2000,\n    \"TotalCredits\": 2555,\n    \"BalanceCarriedForward\": 555,\n    \"Transactions\": [\n        {\n            \"CreatedDate\": \"14/06/2019 12:46:50 PM\",\n            \"ValueDate\": \"14/06/2019\",\n            \"PrimaryDescription\": \"Monthly Blah Blah\",\n            \"SecondaryDescription\": \"Blah Blah Continues Here\",\n            \"Reference\": \"400001-Wingu Box\",\n            \"Debit\": 0,\n            \"Credit\": 500,\n            \"RunningBalance\": 500,\n            \"TransactionCode\": \"Third Party\"\n        }\n    ]\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"34903b14-806e-446b-80d9-0e5c07863cb0"},{"name":"Funds Transfer","id":"2a283bce-4a5a-49ba-a496-d78671f5ec52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"22\",\r\n \"UniqueTransactionIdentifier\": \"A92BJIB1-9C4B-45AB-AF6E-462E8369A44786\",\r\n \"SourceAccountNumber\": \"40000500218\",\r\n \"TargetAccountNumber\": \"40000500219\",\r\n \"Amount\": 15000,\r\n \"Reference\":\"QWERTYU001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 22

\n

SourceAccountNumber this is the account number to debit

\n

TargetAccountNumber this is the account number to credit

\n

UniqueTransactionIdentifier your system's unique id for this transaction.

\n

Amounttransaction amount.

\n

Reference transaction narration.

\n

Sample response

\n
{\n  \"Status\": \"success\",\n  \"SourceBalance\": 1200,\n  \"TargetBalance\": 5200\n}\n\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a283bce-4a5a-49ba-a496-d78671f5ec52"},{"name":"Third Party Wallet Transaction","id":"81a8882c-996a-4bd9-91e3-98225c781c36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"19\",\r\n \"UniqueTransactionIdentifier\": \"FEWRERG-YRTY56TY-ERT11188\",\r\n \"CallbackURL\": \"https://enpx5w6nlaro.x.pipedream.net\",\r\n \"PrimaryDescription\": \"JHSDGUW-001\",\r\n \"SecondaryDescription\": \"JHSDGUW-001\",\r\n \"Amount\": 100000,\r\n \"Nature\": \"Credit\",\r\n \"AccountNumber\": \"40000500218\",\r\n \"Metadata\": [\r\n {\r\n \"PrimaryDescription\": \"misc charge\",\r\n \"SecondaryDescription\": \"misc charge here again\",\r\n \"Amount\": 25,\r\n \"TransactionCode\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 19

\n

UniqueTransactionIdentifier A unique request identifier that will be sent back to you on the provided callback endpoint

\n

CallbackURL The Url that we will send you a delivery report once the request is processed

\n

PrimaryDescription Description of transaction

\n

SecondaryDescription Further description of transaction

\n

Amount Amount of parent transaction

\n

Nature Is transaction a Debit or a Credit

\n

Metadata -> TransactionCode

\n

0 - Any commission

\n

1 - Any levies

\n

Sample success callback response:

\n
{\n    \"TransactionId\": \"f4050d03-7afa-e911-8203-0ab208235486\",\n    \"Status\": \"success\",\n    \"Narration\": \"\",\n    \"AvailableBalance\": 2200,\n    \"InitiatorReference\": \"1BF8A4F7-09ED-E911-8221-C6E9087876AF\"\n}\n\n
\n

Sample failed callback responses:

\n
{\n    \"TransactionId\": \"9a166e58-79fa-e911-8203-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"Wallet or nature of transaction is in an invalid state\",\n    \"AvailableBalance\": 0,\n    \"InitiatorReference\": \"0BF8A4F7-09ED-E911-8221-C6E9087876AF\"\n}\n\n
\n

Note:

\n

InitiatorReference in the callback is the UniqueTransactionIdentifier you passed in your transaction payload.

\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"81a8882c-996a-4bd9-91e3-98225c781c36"},{"name":"Third Party Partial Reversal","id":"20add14e-d400-406f-a8e2-1278fef75088","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"19\",\r\n \"UniqueTransactionIdentifier\": \"FEWRERG-YRTY56TY-ERT11188\",\r\n \"CallbackURL\": \"https://enpx5w6nlaro.x.pipedream.net\",\r\n \"PrimaryDescription\": \"JHSDGUW-001\",\r\n \"SecondaryDescription\": \"JHSDGUW-001\",\r\n \"Amount\": 100000,\r\n \"Nature\": \"Credit\",\r\n \"AccountNumber\": \"40000500218\",\r\n \"Metadata\": [\r\n {\r\n \"PrimaryDescription\": \"misc charge\",\r\n \"SecondaryDescription\": \"misc charge here again\",\r\n \"Amount\": 25,\r\n \"TransactionCode\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 29

\n

UniqueTransactionIdentifier A unique request identifier that will be sent back to you on the provided callback endpoint

\n

CallbackURL The Url that we will send you a delivery report once the request is processed

\n

PrimaryDescription Description of transaction

\n

SecondaryDescription Further description of transaction

\n

Reference identifier of the transaction being reversed

\n

Amount Amount to reverse

\n

PartialReversalTransactionCode:

\n

0 - Any commissions that were in metadata

\n

1 - Any levies that were in metadata

\n

2 - Main transaction

\n

Sample success callback response:

\n
{\n    \"TransactionId\": \"f4050d03-7afa-e911-8203-0ab208235486\",\n    \"Status\": \"success\",\n    \"Narration\": \"\",\n    \"AvailableBalance\": 2200,\n    \"InitiatorReference\": \"1BF8A4F7-09ED-E911-8221-C6E9087876AF\"\n}\n\n
\n

Sample failed callback responses:

\n
{\n    \"TransactionId\": \"9a166e58-79fa-e911-8203-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"Wallet or nature of transaction is in an invalid state\",\n    \"AvailableBalance\": 0,\n    \"InitiatorReference\": \"0BF8A4F7-09ED-E911-8221-C6E9087876AF\"\n}\n\n
\n

Note:

\n

InitiatorReference in the callback is the UniqueTransactionIdentifier you passed in your transaction payload.

\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"20add14e-d400-406f-a8e2-1278fef75088"},{"name":"Transaction Reversal","id":"d219a8fd-cb78-47c7-b8c9-b6f6ef8e0ec6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TransactionType\": \"13\",\n \"UniqueTransactionIdentifier\": \"A92BBB-9C4B-45AB-AF6E-462E8369A559\",\n \"CallbackURL\": \"https://enkaahftowy8.x.pipedream.net/\",\n \"Reference\": \"96de2a04-947c-e911-8202-0ab208235486\"\n}"},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 13

\n

UniqueTransactionIdentifier A unique identifier that will be sent back to you on the provided delivery endpoint

\n

CallbackURL The Url that we will send you a delivery report once the request is processed

\n

Reference The \"TransactionId\" we replied with during initial callback.

\n

Sample success callback response:

\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"success\",\n    \"Narration\": \"\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n

Sample failed callback responses:

\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"Invalid transaction reference\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n
{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"Invalid payload\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n\n
\n

Note:

\n

InitiatorReference is the UniqueTransactionIdentifier you passed in your transaction payload.

\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d219a8fd-cb78-47c7-b8c9-b6f6ef8e0ec6"},{"name":"Resubmit Callback","id":"06c18ba6-c816-4141-a142-51cd7b9fb5ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TransactionType\": \"17\",\r\n \"UniqueTransactionIdentifier\": \"A92BJIB1-9C4B-45AB-AF6E-462E8369A4444\",\r\n \"CallbackURL\": \"https://enkaahftowy8.x.pipedream.net/\",\r\n \"Reference\": \"2bc989a9-33fa-e911-8203-0ab208235486\",\r\n \"SecondarReference\": \"3bc989a9-33fa-e911-8203-0ab208235486\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.fikiwa.com:9000/api/wallet","description":"

TransactionType 17

\n

UniqueTransactionIdentifier A unique identifier that will be sent back to you on the provided delivery endpoint

\n

CallbackURL The Url that we will send you a delivery report once the request is processed

\n

Reference The \"TransactionId\" we replied with during initial callback.

\n

SecondaryReference The \"UniqueTransactionIdentifier\" you sent us during the initial transaction.

\n

Reference takes precedence over SecondaryReference when both are passed. Pass only one of them when querying.

\n

Sample success callback response:

\n
\n{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"success\",\n    \"Narration\": \"\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n
\n

Sample failed callback responses:

\n
\n{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"Invalid transaction reference\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n
\n
\n{\n    \"TransactionId\": \"2394f369-227e-e911-8202-0ab208235486\",\n    \"Status\": \"failed\",\n    \"Narration\": \"Invalid payload\",\n    \"InitiatorReference\": \"A40CBB-9C4B-45AB-AF6E-462E8369A559\"\n}\n
\n","urlObject":{"protocol":"https","port":"9000","path":["api","wallet"],"host":["sandbox","fikiwa","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"06c18ba6-c816-4141-a142-51cd7b9fb5ea"}],"event":[{"listen":"prerequest","script":{"id":"d2326f50-2fb3-44a4-9fbc-62173d58ae1d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"71a6337a-5e35-44e8-8afd-32838cc5baf3","type":"text/javascript","exec":[""]}}]}