MTN MoMo API Documentation

https://momodeveloper.mtn.com/api-documentation
Admin
This documentation provides access to the MTN MoMo API, enabling developers to integrate mobile...
Tokens:3,631
Snippets:55
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Create API User Request

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Example request for creating an API user in the sandbox environment. The X-Reference-Id header serves as the unique identifier for the new user.

```HTTP
POST {baseURL}/apiuser HTTP/1.1
Host: momodeveloper.mtn.com
X-Reference-Id: c72025f5-5cd1-4630-99e4-8ba4722fad56
Ocp-Apim-Subscription-Key: d484a1f0d34f4301916d0f2c9e9106a2{"providerCallbackHost": "clinic.com"}
```

--------------------------------

### GET {baseURL}/apiuser/{APIUser}

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Retrieves the details of a specific API user, such as the Call Back Host.

```APIDOC
## GET {baseURL}/apiuser/{APIUser}

### Description
Retrieves details for a specific API user. Note that the API key cannot be retrieved via this endpoint.

### Method
GET

### Endpoint
{baseURL}/apiuser/{APIUser}

### Parameters
#### Path Parameters
- **APIUser** (string) - Required - The unique identifier for the API user.

### Response
#### Success Response (200)
- **details** (object) - Returns the details of the user, such as the Call Back Host.
```

--------------------------------

### GET /apiuser/{apiUserId}

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Retrieves the details of a specific API user.

```APIDOC
## GET {baseURL}/apiuser/{apiUserId}

### Description
Retrieves the configuration details for a specific API user, including the provider callback host and target environment.

### Method
GET

### Endpoint
{baseURL}/apiuser/{apiUserId}

### Parameters
#### Path Parameters
- **apiUserId** (string) - Required - The unique identifier for the API user.

### Response
#### Success Response (200)
- **providerCallbackHost** (string) - The host URL for provider callbacks.
- **targetEnvironment** (string) - The environment (e.g., sandbox) where the user is configured.

#### Response Example
{
  "providerCallbackHost": "clinic.com",
  "targetEnvironment": "sandbox"
}
```

--------------------------------

### GET /requesttopay/{referenceId}

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Retrieves the current status of a specific payment request using its unique reference ID.

```APIDOC
## GET /requesttopay/{referenceId}

### Description
Retrieves information and the current status of a specific resource created via a POST request.

### Method
GET

### Endpoint
/requesttopay/{referenceId}

### Parameters
#### Path Parameters
- **referenceId** (string) - Required - The unique identifier of the resource.
```

--------------------------------

### POST {baseURL}/apiuser/{APIUser}/apikey

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Creates an API key for a specified API user. The API user must be provided in the URL path.

```APIDOC
## POST {baseURL}/apiuser/{APIUser}/apikey

### Description
Creates an API key for a specified API user. The API user must be provided in the URL path.

### Method
POST

### Endpoint
{baseURL}/apiuser/{APIUser}/apikey

### Parameters
#### Path Parameters
- **APIUser** (string) - Required - The unique identifier for the API user.

### Response
#### Success Response (201)
- **apiKey** (string) - The newly created API key.
```

--------------------------------

### Create API Key Request and Response

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Request to generate an API key for a specific user and the corresponding successful response.

```HTTP
POST {baseURL}/apiuser/c72025f5-5cd1-4630-99e4-8ba4722fad56/apikey HTTP/1.1
Host: momodeveloper.mtn.com
Ocp-Apim-Subscription-Key: d484a1f0d34f4301916d0f2c9e9106a2
```

```HTTP
HTTP/1.1 201 Created date: Wed, 10 Oct 2018 09:16:15 GMT content-type: application/json;charset=utf-8 content-length: 45 { "apiKey": "f1db798c98df4bcf83b538175893bbf0" }
```

--------------------------------

### POST /requesttopay

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Creates a new payment request resource in the Wallet Platform. This is an asynchronous operation that returns a 202 Accepted status.

```APIDOC
## POST /requesttopay

### Description
Creates a new payment request resource. The request is processed asynchronously, and the resource status will initially be PENDING.

### Method
POST

### Endpoint
/requesttopay
```

--------------------------------

### POST {baseURL}/apiuser

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Creates a new API user in the Wallet platform. The Reference ID provided in the header is used as the User ID.

```APIDOC
## POST {baseURL}/apiuser

### Description
Creates a new API user in the Wallet platform. The Reference ID provided in the header is used as the User ID.

### Method
POST

### Endpoint
{baseURL}/apiuser

### Parameters
#### Request Body
- **providerCallbackHost** (string) - Required - The callback host for the provider.

### Request Example
POST {baseURL}/apiuser HTTP/1.1
Host: momodeveloper.mtn.com
X-Reference-Id: c72025f5-5cd1-4630-99e4-8ba4722fad56
Ocp-Apim-Subscription-Key: d484a1f0d34f4301916d0f2c9e9106a2
{"providerCallbackHost": "clinic.com"}

### Response
#### Success Response (201)
- **Status** (integer) - 201 Created
```

--------------------------------

### POST {baseURL}/apiuser/{APIUser}/apikey

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Generates a new API key for a specified API user.

```APIDOC
## POST {baseURL}/apiuser/{APIUser}/apikey

### Description
Generates a new API key for the specified API user.

### Method
POST

### Endpoint
{baseURL}/apiuser/{APIUser}/apikey

### Parameters
#### Path Parameters
- **APIUser** (string) - Required - The unique identifier for the API user.

### Response
#### Success Response (201)
- **apiKey** (string) - The newly generated API key.

#### Response Example
{
  "apiKey": "f1db798c98df4bcf83b538175893bbf0"
}
```

--------------------------------

### Create API User Response

Source: https://momodeveloper.mtn.com/api-documentation/api-description

Successful response indicating the creation of an API user.

```HTTP
201 Created
```
Tokens:
Raw