---
agentTools:
  projectIndex: https://safehavenmfb.readme.io/llms.txt
---

# Transfer

This can be used to make an intra bank transfer or NIP transfer.

Before calling the transfer endpoint, you must call the name enquiry endpoint for the account you want to transfer funds into. The `sessionId` gotten in the response will be used in this request.

# 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": {
    "/transfers": {
      "post": {
        "summary": "Transfer",
        "description": "This can be used to make an intra bank transfer or NIP transfer.\n\nBefore calling the transfer endpoint, you must call the name enquiry endpoint for the account you want to transfer funds into. The `sessionId` gotten in the response will be used in this request.",
        "operationId": "transfer",
        "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",
              "default": "471332960a20c026aca3b6364f2c6be0"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "nameEnquiryReference",
                  "debitAccountNumber",
                  "beneficiaryBankCode",
                  "beneficiaryAccountNumber",
                  "amount",
                  "saveBeneficiary"
                ],
                "properties": {
                  "nameEnquiryReference": {
                    "type": "string",
                    "description": "This is the `sessionId` returned in the name enquiry endpoint response.",
                    "default": "999240260129032422205494262753"
                  },
                  "debitAccountNumber": {
                    "type": "string",
                    "description": "The account to debit the funds from.",
                    "default": "0117964837"
                  },
                  "beneficiaryBankCode": {
                    "type": "string",
                    "description": "The bank code of the beneficiary account.",
                    "default": "999240"
                  },
                  "beneficiaryAccountNumber": {
                    "type": "string",
                    "description": "The account number of the beneficiary account.",
                    "default": "0106664982"
                  },
                  "amount": {
                    "type": "number",
                    "description": "The amount to transfer.",
                    "default": 9300,
                    "format": "float"
                  },
                  "saveBeneficiary": {
                    "type": "boolean",
                    "description": "Set to `true` to save the beneficiary.",
                    "default": false
                  },
                  "narration": {
                    "type": "string",
                    "description": "The transfer narration.",
                    "default": "Test Transfer Narration 1.1"
                  },
                  "paymentReference": {
                    "type": "string",
                    "description": "A payment reference to attach to the transfer.",
                    "default": "1233039e000X0YZ"
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "statusCode": 200,
                    "responseCode": "00",
                    "message": "Approved or completed successfully",
                    "data": {
                      "_id": "64a54765fe15020024badb3c",
                      "client": "61e5a83ac6f0ec001ee90fac",
                      "account": "61eebebf6e36f1001eeb28cd",
                      "type": "Outwards",
                      "sessionId": "999240230705103517889604437936",
                      "nameEnquiryReference": "999240230705103301782413638076",
                      "paymentReference": "",
                      "mandateReference": null,
                      "isReversed": false,
                      "reversalReference": null,
                      "provider": "BANK",
                      "providerChannel": "TRANSFER",
                      "providerChannelCode": "IBS",
                      "destinationInstitutionCode": "999240",
                      "creditAccountName": "BITAKO TECHNOLOGIES LIMITED",
                      "creditAccountNumber": "0110654321",
                      "creditBankVerificationNumber": null,
                      "creditKYCLevel": "3",
                      "debitAccountName": "BITAKO TECHNOLOGIES LIMITED / SUDO SETTLEMENT ACCOUNT",
                      "debitAccountNumber": "011234561",
                      "debitBankVerificationNumber": null,
                      "debitKYCLevel": "3",
                      "transactionLocation": "9.0932,7.4429",
                      "narration": "Fuel",
                      "amount": 5000,
                      "fees": 0,
                      "vat": 0,
                      "stampDuty": 0,
                      "responseCode": "00",
                      "responseMessage": "Approved or completed successfully",
                      "status": "Completed",
                      "isDeleted": false,
                      "createdAt": "2023-07-05T10:35:17.407Z",
                      "createdBy": "61e5a83ac6f0ec001ee90fb5",
                      "updatedAt": "2023-07-05T10:35:17.952Z",
                      "__v": 0,
                      "approvedAt": "2023-07-05T10:35:17.952Z",
                      "approvedBy": "61e5a83ac6f0ec001ee90fb5"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"statusCode\": 200,\n    \"responseCode\": \"00\",\n    \"message\": \"Approved or completed successfully\",\n    \"data\": {\n        \"_id\": \"64a54765fe15020024badb3c\",\n        \"client\": \"61e5a83ac6f0ec001ee90fac\",\n        \"account\": \"61eebebf6e36f1001eeb28cd\",\n        \"type\": \"Outwards\",\n        \"sessionId\": \"999240230705103517889604437936\",\n        \"nameEnquiryReference\": \"999240230705103301782413638076\",\n        \"paymentReference\": \"\",\n        \"mandateReference\": null,\n        \"isReversed\": false,\n        \"reversalReference\": null,\n        \"provider\": \"BANK\",\n        \"providerChannel\": \"TRANSFER\",\n        \"providerChannelCode\": \"IBS\",\n        \"destinationInstitutionCode\": \"999240\",\n        \"creditAccountName\": \"BITAKO TECHNOLOGIES LIMITED\",\n        \"creditAccountNumber\": \"0110654321\",\n        \"creditBankVerificationNumber\": null,\n        \"creditKYCLevel\": \"3\",\n        \"debitAccountName\": \"BITAKO TECHNOLOGIES LIMITED / SUDO SETTLEMENT ACCOUNT\",\n        \"debitAccountNumber\": \"011234561\",\n        \"debitBankVerificationNumber\": null,\n        \"debitKYCLevel\": \"3\",\n        \"transactionLocation\": \"9.0932,7.4429\",\n        \"narration\": \"Fuel\",\n        \"amount\": 5000,\n        \"fees\": 0,\n        \"vat\": 0,\n        \"stampDuty\": 0,\n        \"responseCode\": \"00\",\n        \"responseMessage\": \"Approved or completed successfully\",\n        \"status\": \"Completed\",\n        \"isDeleted\": false,\n        \"createdAt\": \"2023-07-05T10:35:17.407Z\",\n        \"createdBy\": \"61e5a83ac6f0ec001ee90fb5\",\n        \"updatedAt\": \"2023-07-05T10:35:17.952Z\",\n        \"__v\": 0,\n        \"approvedAt\": \"2023-07-05T10:35:17.952Z\",\n        \"approvedBy\": \"61e5a83ac6f0ec001ee90fb5\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "responseCode": {
                      "type": "string",
                      "example": "00"
                    },
                    "message": {
                      "type": "string",
                      "example": "Approved or completed successfully"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "_id": {
                          "type": "string",
                          "example": "64a54765fe15020024badb3c"
                        },
                        "client": {
                          "type": "string",
                          "example": "61e5a83ac6f0ec001ee90fac"
                        },
                        "account": {
                          "type": "string",
                          "example": "61eebebf6e36f1001eeb28cd"
                        },
                        "type": {
                          "type": "string",
                          "example": "Outwards"
                        },
                        "sessionId": {
                          "type": "string",
                          "example": "999240230705103517889604437936"
                        },
                        "nameEnquiryReference": {
                          "type": "string",
                          "example": "999240230705103301782413638076"
                        },
                        "paymentReference": {
                          "type": "string",
                          "example": ""
                        },
                        "mandateReference": {},
                        "isReversed": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "reversalReference": {},
                        "provider": {
                          "type": "string",
                          "example": "BANK"
                        },
                        "providerChannel": {
                          "type": "string",
                          "example": "TRANSFER"
                        },
                        "providerChannelCode": {
                          "type": "string",
                          "example": "IBS"
                        },
                        "destinationInstitutionCode": {
                          "type": "string",
                          "example": "999240"
                        },
                        "creditAccountName": {
                          "type": "string",
                          "example": "BITAKO TECHNOLOGIES LIMITED"
                        },
                        "creditAccountNumber": {
                          "type": "string",
                          "example": "0110654321"
                        },
                        "creditBankVerificationNumber": {},
                        "creditKYCLevel": {
                          "type": "string",
                          "example": "3"
                        },
                        "debitAccountName": {
                          "type": "string",
                          "example": "BITAKO TECHNOLOGIES LIMITED / SUDO SETTLEMENT ACCOUNT"
                        },
                        "debitAccountNumber": {
                          "type": "string",
                          "example": "011234561"
                        },
                        "debitBankVerificationNumber": {},
                        "debitKYCLevel": {
                          "type": "string",
                          "example": "3"
                        },
                        "transactionLocation": {
                          "type": "string",
                          "example": "9.0932,7.4429"
                        },
                        "narration": {
                          "type": "string",
                          "example": "Fuel"
                        },
                        "amount": {
                          "type": "integer",
                          "example": 5000,
                          "default": 0
                        },
                        "fees": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "vat": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "stampDuty": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "responseCode": {
                          "type": "string",
                          "example": "00"
                        },
                        "responseMessage": {
                          "type": "string",
                          "example": "Approved or completed successfully"
                        },
                        "status": {
                          "type": "string",
                          "example": "Completed"
                        },
                        "isDeleted": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "createdAt": {
                          "type": "string",
                          "example": "2023-07-05T10:35:17.407Z"
                        },
                        "createdBy": {
                          "type": "string",
                          "example": "61e5a83ac6f0ec001ee90fb5"
                        },
                        "updatedAt": {
                          "type": "string",
                          "example": "2023-07-05T10:35:17.952Z"
                        },
                        "__v": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "approvedAt": {
                          "type": "string",
                          "example": "2023-07-05T10:35:17.952Z"
                        },
                        "approvedBy": {
                          "type": "string",
                          "example": "61e5a83ac6f0ec001ee90fb5"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "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:61ea816377e1140037762750"
}
```