Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ndolestudio/mtnmomo-go
MTN Mobile Money API Client in Go
https://github.com/ndolestudio/mtnmomo-go
api-client mtn mtnmobilemoney mtnmomo
Last synced: about 1 month ago
JSON representation
MTN Mobile Money API Client in Go
- Host: GitHub
- URL: https://github.com/ndolestudio/mtnmomo-go
- Owner: NdoleStudio
- License: mit
- Created: 2021-11-28T08:17:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T19:52:16.000Z (2 months ago)
- Last Synced: 2024-10-31T20:29:24.118Z (2 months ago)
- Topics: api-client, mtn, mtnmobilemoney, mtnmomo
- Language: Go
- Homepage: https://momodeveloper.mtn.com/api-documentation
- Size: 69.3 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mtnmomo-go
[](https://github.com/NdoleStudio/mtnmomo-go/actions/workflows/main.yml)
[](https://codecov.io/gh/NdoleStudio/mtnmomo-go)
[](https://scrutinizer-ci.com/g/NdoleStudio/mtnmomo-go/?branch=main)
[](https://goreportcard.com/report/github.com/NdoleStudio/mtnmomo-go)
[](https://github.com/NdoleStudio/mtnmomo-go/graphs/contributors)
[](https://github.com/NdoleStudio/mtnmomo-go/blob/master/LICENSE)
[](https://pkg.go.dev/github.com/NdoleStudio/mtnmomo-go)
This package provides a generic `go` client template for the MTN Mobile Money API
## Installation
`mtnmomo-go` is compatible with modern Go releases in module mode, with Go installed:
```bash
go get github.com/NdoleStudio/mtnmomo-go
```
Alternatively the same can be achieved if you use `import` in a package:
```go
import "github.com/NdoleStudio/mtnmomo-go"
```
## Implemented
- [API User](#api-user)
- `POST {baseURL}/apiuser`: Create API User
- `POST {baseURL}/apiuser/{APIUser}/apikey`: Create API Key
- `GET {baseURL}/apiuser/{APIUser}`: Get API user information
- [Collection](#collection)
- `POST {baseURL}/collection/token/`: Create access token
- `POST {baseURL}/collection/v1_0/requesttopay`: Request a payment from a consumer
- `GET {baseURL}/collection/v1_0/requesttopay/{referenceId}`: Get the status of a request to pay
- `GET {baseURL}/collection/v1_0/account/balance`: Get the balance of the account
- **Disbursements**
- `POST {baseURL}/disbursement/token/`: Create access token
- `POST {baseURL}/disbursement/v1_0/transfer`: Transfer money to a customer's account.
- `GET {baseURL}/disbursement/v1_0/transfer/{referenceId}`: Get the status of a transfer.
- `GET {baseURL}/disbursement/v1_0/account/balance`: Get the balance of the disbursement account
## Usage
### Initializing the Client
An instance of the client can be created using `New()`.
```go
package main
import (
"github.com/NdoleStudio/mtnmomo-go"
)
func main() {
client := mtnmomo.New(
mtnmomo.WithBaseURL("https://sandbox.momodeveloper.mtn.com/v1_0"),
mtnmomo.WithSubscriptionKey(""/* Subscription key */),
)
}
```
### Error handling
All API calls return an `error` as the last return object. All successful calls will return a `nil` error.
```go
apiUser, response, err := statusClient.APIUser.CreateAPIUser(context.Background())
if err != nil {
//handle error
}
```
### API User
#### `POST {baseURL}/apiuser`: Create API User
Used to create an API user in the sandbox target environment.
```go
userID, response, err := client.APIUser.CreateAPIUser(
context.Background(),
uuid.NewString(),
"providerCallbackHost",
)
if err != nil {
log.Fatal(err)
}
log.Println(response.HTTPResponse.StatusCode) // 201
```
#### `POST {baseURL}/apiuser/{APIUser}/apikey`: Create API Key
Used to create an API key for an API user in the sandbox target environment.
```go
apiKey, response, err := client.APIUser.CreateAPIKey(context.Background(), "userID")
if err != nil {
log.Fatal(err)
}
log.Println(apiKey) // e.g "f1db798c98df4bcf83b538175893bbf0"
```
#### `GET {baseURL}/apiuser/{APIUser}`: Get API user information
Used to get API user information.
```go
apiUser, response, err := client.APIUser.CreateAPIKey(context.Background(), "userID")
if err != nil {
log.Fatal(err)
}
log.Println(apiUser.TargetEnvironment) // e.g "sandbox"
```
### Collection
#### `POST {baseURL}/collection/token/`: Create access token
This operation is used to create an access token which can then be used to authorize and authenticate towards the other end-points of the API.
```go
authToken, response, err := client.Collection.Token(context.Background())
if err != nil {
log.Fatal(err)
}
log.Println(authToken.AccessToken) // e.g eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....
```
#### `POST {baseURL}/collection/v1_0/requesttopay`: Request a payment from a consumer
This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment. The transaction will be executed once the payer has authorized the payment.
```go
callbackURL := "http://callback-url.com"
response, err := client.Collection.RequestToPay(
context.Background(),
referenceID,
&mtnmomo.RequestToPayParams{
Amount: "10",
Currency: "EUR",
ExternalID: uuid.NewString(),
Payer: &mtnmomo.RequestToPayPayer{
PartyIDType: "MSISDN",
PartyID: "673978334",
},
PayerMessage: "Test Payer Message",
PayeeNote: "Test Payee Note",
},
&callbackURL,
)
if err != nil {
log.Fatal(err)
}
log.Println(response.HTTPResponse.StatusCode) // e.g 201 (Accepted)
```
#### `GET {baseURL}/collection/v1_0/requesttopay/{referenceId}`: Get the status of a request to pay
This operation is used to get the status of a request to pay. X-Reference-Id that was passed in the post is used as reference to the request.
```go
status, _, err := client.Collection.GetRequestToPayStatus(context.Background(), referenceID)
if err != nil {
log.Fatal(err)
}
log.Println(status.Status) // SUCCESSFUL
```
#### `GET {baseURL}/collection/v1_0/account/balance`: Get the balance of the account
```go
balance, _, err := client.Collection.GetAccountBalance(context.Background())
if err != nil {
log.Fatal(err)
}
log.Println(balance.AvailableBalance) // "1000"
```
## Testing
You can run the unit tests for this client from the root directory using the command below:
```bash
go test -v
```
### Security
If you discover any security related issues, please email [email protected] instead of using the GitHub issues.
## Credits
- [Acho Arnold](https://github.com/achoarnold)
- [All Contributors](../../contributors)
- [Go HTTP Client Template](https://github.com/NdoleStudio/go-http-client)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details