---
agentTools:
  projectIndex: https://docs.quidax.io/llms.txt
---

# Initiate GHS Momo deposit

This endpoint verifies otp for mobile money deposit

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Ramp Merchant API",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://ramp-be.quidax.io/api/v1/merchants/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "x-private-key",
        "in": "header",
        "x-default": "secret_key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/custodial/on_ramp_transactions/initiate_mobile_money": {
      "post": {
        "summary": "Initiate GHS Momo deposit",
        "description": "This endpoint verifies otp for mobile money deposit",
        "operationId": "initiate-ghs-momo-deposit",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "merchant_reference": {
                    "type": "string",
                    "description": "Transaction reference used in initiating the on-ramp transaction."
                  },
                  "phone_number": {
                    "type": "string",
                    "description": "Customer's phone number. You can use the banks endpoint to get a list of available banks and their codes."
                  },
                  "network_provider": {
                    "type": "string",
                    "description": "Customer's network provider. To fetch providers use this endpoint. Allowed Values, MTN, AIRTEL, and VODAFONE.",
                    "enum": [
                      "MTN",
                      "AIRTEL",
                      "VODAFONE"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"ok\",\n    \"message\": \"Mobile money deposit successfully initiated\",\n    \"data\": {\n        \"next_step\": \"PIN\",\n        \"fee\": \"23.0\",\n        \"amount\": \"1000.0\",\n        \"instruction\": \"You will receive a prompt on your mobile number ******7778 to enter your PIN to authorize your payment request of GHS 1000 to SB_fjjfjjff\",\n        \"currency\": \"ghs\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "ok"
                    },
                    "message": {
                      "type": "string",
                      "example": "Mobile money deposit successfully initiated"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "next_step": {
                          "type": "string",
                          "example": "PIN"
                        },
                        "fee": {
                          "type": "string",
                          "example": "23.0"
                        },
                        "amount": {
                          "type": "string",
                          "example": "1000.0"
                        },
                        "instruction": {
                          "type": "string",
                          "example": "You will receive a prompt on your mobile number ******7778 to enter your PIN to authorize your payment request of GHS 1000 to SB_fjjfjjff"
                        },
                        "currency": {
                          "type": "string",
                          "example": "ghs"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Mobile money failed": {
                    "value": "{\n  \"status\": \"bad_request\", \n  \"message\": \"Mobile money deposit failed\", \n  \"data\": null\n}"
                  },
                  "Name does not match": {
                    "value": "{\n  \"status\": \"bad_request\",\n  \"message\": \"Name does not match\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Mobile money failed",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Mobile money deposit failed"
                        },
                        "data": {}
                      }
                    },
                    {
                      "title": "Name does not match",
                      "type": "object",
                      "properties": {
                        "status": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "Name does not match"
                        },
                        "data": {}
                      }
                    }
                  ]
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Invalid private key": {
                    "value": "{\n  \"status\": \"forbidden\",\n  \"message\": \"Invalid private key\",\n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "forbidden"
                    },
                    "message": {
                      "type": "string",
                      "example": "Invalid private key"
                    },
                    "data": {}
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Transaction does not exist": {
                    "value": "{\n  \"status\": \"not_found\", \n  \"message\": \"Transaction does not exist\", \n  \"data\": null\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "not_found"
                    },
                    "message": {
                      "type": "string",
                      "example": "Transaction does not exist"
                    },
                    "data": {}
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6981ba5faf9470ee082aeecd:6a42827dafd5558e2d841e39"
}
```