--- agentTools: projectIndex: https://safehavenmfb.readme.io/llms.txt --- # Create Reference Create Reference # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Safe Haven IBS API", "version": "1.0" }, "servers": [ { "url": "https://api.sandbox.safehavenmfb.com" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://example.com/oauth2/token", "scopes": {} } } } } }, "security": [ { "sec0": [] } ], "paths": { "/ussd-payment": { "post": { "summary": "Create Reference", "description": "Create Reference", "operationId": "create-reference", "parameters": [ { "name": "ClientID", "in": "header", "description": "This is your 'ibs_client_id' returned in the response when you generate an api token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "merchantName", "ussdBankCode", "callbackUrl", "settlementAccount" ], "properties": { "amount": { "type": "string" }, "merchantName": { "type": "string" }, "ussdBankCode": { "type": "string" }, "callbackUrl": { "type": "string" }, "settlementAccount": { "type": "object", "properties": { "bankCode": { "type": "string", "description": "6 digits bank code. Must be `090286`", "default": "090286" }, "accountNumber": { "type": "string", "description": "10 digits NUBAN account number" } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"statusCode\": 200,\n \"message\": \"USSD Transaction reference generated successfully\",\n \"data\": {\n \"_id\": \"6925723e2d5abb00242d1808\",\n \"client\": {\n \"searchPaid\": false,\n \"subAccountCreation\": false,\n \"longTermVirtualAccount\": false,\n \"overrideSubAccountLimit\": false,\n \"allowDebitAccountInfo\": false,\n \"allowDebitAccountName\": false,\n \"indemnitySigned\": true,\n \"_id\": \"6874eb47aaad890024be3930\",\n \"type\": \"Corporate\",\n \"kycLevel\": \"3\",\n \"fullName\": \"Primetech\",\n \"gender\": \"Others\",\n \"dateOfBirth\": null,\n \"emailAddress\": \"prince.muteh@gmail.com\",\n \"phoneNumber\": \"2347030338024\",\n \"phoneNumber2\": \"7030338024\",\n \"bvn\": \"22368809000\",\n \"nin\": \"\",\n \"tin\": \"\",\n \"contactAddress\": {\n \"street\": \"Overses quarters Kwali Abuja\",\n \"city\": \"Kwali\",\n \"state\": \"Federal Capital Territory\",\n \"country\": \"Nigeria\"\n },\n \"identificationDetails\": {\n \"status\": \"Unverified\",\n \"type\": \"CAC\",\n \"number\": \"00000000\"\n },\n \"notificationSettings\": {\n \"loginNotification\": true,\n \"newsletter\": true,\n \"productNotification\": true,\n \"vasNotification\": true,\n \"webhookNotifcation\": {\n \"url\": \"https://webhook.site/e0241829-b0c8-4cb9-a39c-05d8ce30e7b9\",\n \"enabled\": true\n }\n },\n \"subAccountPrefix\": \"Primetech\",\n \"isBlocked\": false,\n \"status\": \"Active\",\n \"referees\": [],\n \"isDeleted\": false,\n \"createdAt\": \"2025-07-14T11:34:31.383Z\",\n \"updatedAt\": \"2025-07-14T11:34:31.383Z\",\n \"identityStatus\": [],\n \"__v\": 0,\n \"cbaClientId\": \"892\",\n \"contract\": \"60e399925d3142273138a8d4\",\n \"virtualAccountLimit\": {\n \"dailyLimit\": 50000,\n \"singleTransactionLimit\": 10000,\n \"allowOtherPrefix\": \"dontAllow\"\n },\n \"documents\": {\n \"passportUrl\": \"\",\n \"idCardUrl\": \"\",\n \"signatureUrl\": \"\",\n \"certificateUrl\": \"\",\n \"mematUrl\": \"\",\n \"boardResolutionUrl\": \"\",\n \"utilityBillUrl\": \"\"\n },\n \"employmentInformation\": {},\n \"nextOfKin\": {}\n },\n \"account\": {\n \"canDebit\": true,\n \"canCredit\": true,\n \"_id\": \"6874eb48aaad890024be3931\",\n \"client\": \"6874eb47aaad890024be3930\",\n \"accountProduct\": \"60d7bd5fa4884c30a832e37a\",\n \"accountNumber\": \"0117964837\",\n \"accountName\": \"PRIMETECH\",\n \"accountType\": \"Current\",\n \"currencyCode\": \"NGN\",\n \"bvn\": \"22368809000\",\n \"accountBalance\": 12169109.829999998,\n \"bookBalance\": 12169109.829999998,\n \"interestBalance\": 0,\n \"withHoldingTaxBalance\": 0,\n \"status\": \"Active\",\n \"isDefault\": true,\n \"nominalAnnualInterestRate\": 0,\n \"interestCompoundingPeriod\": \"Daily\",\n \"interestPostingPeriod\": \"Monthly\",\n \"interestCalculationType\": \"DailyBalance\",\n \"interestCalculationDaysInYearType\": \"365\",\n \"minRequiredOpeningBalance\": 0,\n \"lockinPeriodFrequency\": 0,\n \"lockinPeriodFrequencyType\": \"Days\",\n \"allowOverdraft\": false,\n \"overdraftLimit\": 0,\n \"chargeWithHoldingTax\": true,\n \"chargeValueAddedTax\": true,\n \"chargeStampDuty\": true,\n \"notificationSettings\": {\n \"smsNotification\": true,\n \"emailNotification\": true,\n \"emailMonthlyStatement\": true,\n \"smsMonthlyStatement\": true\n },\n \"isSubAccount\": false,\n \"isDeleted\": false,\n \"createdAt\": \"2025-07-14T11:34:32.006Z\",\n \"updatedAt\": \"2025-11-24T08:58:41.880Z\",\n \"__v\": 0,\n \"cbaAccountId\": \"26372\"\n },\n \"bankCode\": \"901\",\n \"accountName\": \"Princemuteh\",\n \"amount\": 200,\n \"callbackUrl\": \"https://primetech.xom\",\n \"status\": \"Active\",\n \"fees\": 16,\n \"settlementAccount\": {\n \"bankCode\": \"999240\",\n \"accountNumber\": \"0117964837\"\n },\n \"externalReference\": \"ereee989348rrr384934893\",\n \"isDeleted\": false,\n \"createdAt\": \"2025-11-25T09:09:18.492Z\",\n \"updatedAt\": \"2025-11-25T09:09:18.492Z\",\n \"__v\": 0,\n \"accountNumber\": \"5191\",\n \"details\": {\n \"Reference\": \"5191\",\n \"Amount\": \"200\",\n \"TransactionId\": \"25112535710190905191\",\n \"TraceId\": \"6925723e2d5abb00242d1808\",\n \"UssdString\": \"*901*000*5191#\",\n \"TimeStamp\": 1764061759,\n \"Signature\": \"806cc98d335a978b8b73ca0ffebff05545603d9ff5871f4cfa2ccfcc889d121c\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200, "default": 0 }, "message": { "type": "string", "example": "USSD Transaction reference generated successfully" }, "data": { "type": "object", "properties": { "_id": { "type": "string", "example": "6925723e2d5abb00242d1808" }, "client": { "type": "object", "properties": { "searchPaid": { "type": "boolean", "example": false, "default": true }, "subAccountCreation": { "type": "boolean", "example": false, "default": true }, "longTermVirtualAccount": { "type": "boolean", "example": false, "default": true }, "overrideSubAccountLimit": { "type": "boolean", "example": false, "default": true }, "allowDebitAccountInfo": { "type": "boolean", "example": false, "default": true }, "allowDebitAccountName": { "type": "boolean", "example": false, "default": true }, "indemnitySigned": { "type": "boolean", "example": true, "default": true }, "_id": { "type": "string", "example": "6874eb47aaad890024be3930" }, "type": { "type": "string", "example": "Corporate" }, "kycLevel": { "type": "string", "example": "3" }, "fullName": { "type": "string", "example": "Primetech" }, "gender": { "type": "string", "example": "Others" }, "dateOfBirth": {}, "emailAddress": { "type": "string", "example": "prince.muteh@gmail.com" }, "phoneNumber": { "type": "string", "example": "2347030338024" }, "phoneNumber2": { "type": "string", "example": "7030338024" }, "bvn": { "type": "string", "example": "22368809000" }, "nin": { "type": "string", "example": "" }, "tin": { "type": "string", "example": "" }, "contactAddress": { "type": "object", "properties": { "street": { "type": "string", "example": "Overses quarters Kwali Abuja" }, "city": { "type": "string", "example": "Kwali" }, "state": { "type": "string", "example": "Federal Capital Territory" }, "country": { "type": "string", "example": "Nigeria" } } }, "identificationDetails": { "type": "object", "properties": { "status": { "type": "string", "example": "Unverified" }, "type": { "type": "string", "example": "CAC" }, "number": { "type": "string", "example": "00000000" } } }, "notificationSettings": { "type": "object", "properties": { "loginNotification": { "type": "boolean", "example": true, "default": true }, "newsletter": { "type": "boolean", "example": true, "default": true }, "productNotification": { "type": "boolean", "example": true, "default": true }, "vasNotification": { "type": "boolean", "example": true, "default": true }, "webhookNotifcation": { "type": "object", "properties": { "url": { "type": "string", "example": "https://webhook.site/e0241829-b0c8-4cb9-a39c-05d8ce30e7b9" }, "enabled": { "type": "boolean", "example": true, "default": true } } } } }, "subAccountPrefix": { "type": "string", "example": "Primetech" }, "isBlocked": { "type": "boolean", "example": false, "default": true }, "status": { "type": "string", "example": "Active" }, "referees": { "type": "array", "items": { "type": "object", "properties": {} } }, "isDeleted": { "type": "boolean", "example": false, "default": true }, "createdAt": { "type": "string", "example": "2025-07-14T11:34:31.383Z" }, "updatedAt": { "type": "string", "example": "2025-07-14T11:34:31.383Z" }, "identityStatus": { "type": "array", "items": { "type": "object", "properties": {} } }, "__v": { "type": "integer", "example": 0, "default": 0 }, "cbaClientId": { "type": "string", "example": "892" }, "contract": { "type": "string", "example": "60e399925d3142273138a8d4" }, "virtualAccountLimit": { "type": "object", "properties": { "dailyLimit": { "type": "integer", "example": 50000, "default": 0 }, "singleTransactionLimit": { "type": "integer", "example": 10000, "default": 0 }, "allowOtherPrefix": { "type": "string", "example": "dontAllow" } } }, "documents": { "type": "object", "properties": { "passportUrl": { "type": "string", "example": "" }, "idCardUrl": { "type": "string", "example": "" }, "signatureUrl": { "type": "string", "example": "" }, "certificateUrl": { "type": "string", "example": "" }, "mematUrl": { "type": "string", "example": "" }, "boardResolutionUrl": { "type": "string", "example": "" }, "utilityBillUrl": { "type": "string", "example": "" } } }, "employmentInformation": { "type": "object", "properties": {} }, "nextOfKin": { "type": "object", "properties": {} } } }, "account": { "type": "object", "properties": { "canDebit": { "type": "boolean", "example": true, "default": true }, "canCredit": { "type": "boolean", "example": true, "default": true }, "_id": { "type": "string", "example": "6874eb48aaad890024be3931" }, "client": { "type": "string", "example": "6874eb47aaad890024be3930" }, "accountProduct": { "type": "string", "example": "60d7bd5fa4884c30a832e37a" }, "accountNumber": { "type": "string", "example": "0117964837" }, "accountName": { "type": "string", "example": "PRIMETECH" }, "accountType": { "type": "string", "example": "Current" }, "currencyCode": { "type": "string", "example": "NGN" }, "bvn": { "type": "string", "example": "22368809000" }, "accountBalance": { "type": "number", "example": 12169109.829999998, "default": 0 }, "bookBalance": { "type": "number", "example": 12169109.829999998, "default": 0 }, "interestBalance": { "type": "integer", "example": 0, "default": 0 }, "withHoldingTaxBalance": { "type": "integer", "example": 0, "default": 0 }, "status": { "type": "string", "example": "Active" }, "isDefault": { "type": "boolean", "example": true, "default": true }, "nominalAnnualInterestRate": { "type": "integer", "example": 0, "default": 0 }, "interestCompoundingPeriod": { "type": "string", "example": "Daily" }, "interestPostingPeriod": { "type": "string", "example": "Monthly" }, "interestCalculationType": { "type": "string", "example": "DailyBalance" }, "interestCalculationDaysInYearType": { "type": "string", "example": "365" }, "minRequiredOpeningBalance": { "type": "integer", "example": 0, "default": 0 }, "lockinPeriodFrequency": { "type": "integer", "example": 0, "default": 0 }, "lockinPeriodFrequencyType": { "type": "string", "example": "Days" }, "allowOverdraft": { "type": "boolean", "example": false, "default": true }, "overdraftLimit": { "type": "integer", "example": 0, "default": 0 }, "chargeWithHoldingTax": { "type": "boolean", "example": true, "default": true }, "chargeValueAddedTax": { "type": "boolean", "example": true, "default": true }, "chargeStampDuty": { "type": "boolean", "example": true, "default": true }, "notificationSettings": { "type": "object", "properties": { "smsNotification": { "type": "boolean", "example": true, "default": true }, "emailNotification": { "type": "boolean", "example": true, "default": true }, "emailMonthlyStatement": { "type": "boolean", "example": true, "default": true }, "smsMonthlyStatement": { "type": "boolean", "example": true, "default": true } } }, "isSubAccount": { "type": "boolean", "example": false, "default": true }, "isDeleted": { "type": "boolean", "example": false, "default": true }, "createdAt": { "type": "string", "example": "2025-07-14T11:34:32.006Z" }, "updatedAt": { "type": "string", "example": "2025-11-24T08:58:41.880Z" }, "__v": { "type": "integer", "example": 0, "default": 0 }, "cbaAccountId": { "type": "string", "example": "26372" } } }, "bankCode": { "type": "string", "example": "901" }, "accountName": { "type": "string", "example": "Princemuteh" }, "amount": { "type": "integer", "example": 200, "default": 0 }, "callbackUrl": { "type": "string", "example": "https://primetech.xom" }, "status": { "type": "string", "example": "Active" }, "fees": { "type": "integer", "example": 16, "default": 0 }, "settlementAccount": { "type": "object", "properties": { "bankCode": { "type": "string", "example": "999240" }, "accountNumber": { "type": "string", "example": "0117964837" } } }, "externalReference": { "type": "string", "example": "ereee989348rrr384934893" }, "isDeleted": { "type": "boolean", "example": false, "default": true }, "createdAt": { "type": "string", "example": "2025-11-25T09:09:18.492Z" }, "updatedAt": { "type": "string", "example": "2025-11-25T09:09:18.492Z" }, "__v": { "type": "integer", "example": 0, "default": 0 }, "accountNumber": { "type": "string", "example": "5191" }, "details": { "type": "object", "properties": { "Reference": { "type": "string", "example": "5191" }, "Amount": { "type": "string", "example": "200" }, "TransactionId": { "type": "string", "example": "25112535710190905191" }, "TraceId": { "type": "string", "example": "6925723e2d5abb00242d1808" }, "UssdString": { "type": "string", "example": "*901*000*5191#" }, "TimeStamp": { "type": "integer", "example": 1764061759, "default": 0 }, "Signature": { "type": "string", "example": "806cc98d335a978b8b73ca0ffebff05545603d9ff5871f4cfa2ccfcc889d121c" } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "61e69ed05b7bd4006a962eed:65b3838508f1be0047fc5b05" } ```