mtn-momo@1.0.0
This adaptor exports the following from common:
- combine()
- cursor()
- dataPath()
- dataValue()
- dateFns
- each()
- field()
- fields()
- fn()
- fnIf()
- group()
- lastReferenceValue()
- merge()
- scrubEmojis()
- sourceValue()
- util
Functions
request
request(method, path, body, options) ⇒ Operation
Make a HTTP request to the MTN MoMo API
Param | Type | Description |
---|---|---|
method | string | HTTP method to use |
path | string | Path to resource |
body | object | Object which will be attached to the HTTP request body |
options | RequestOptions | Optional request options |
This operation writes the following keys to state:
State Key | Description |
---|---|
data | the parsed response body |
response | the response from the HTTP server, including headers, statusCode, body, etc |
references | an array of all previous data objects used in the Job |
Example: Get basic user information
request("GET", "/collection/v1_0/accountholder/MSISDN/46733123451/basicuserinfo", {}, { headers: { "X-Target-Environment": "sandbox" } });
Example: Create an invoice
request("POST", "/collection/v2_0/invoice",
{
"externalId": "996b82e6-d498-4c7c-87ee-7b0654350a2c",
"amount": "100",
"currency": "EUR",
"validityDuration": "3600",
"intendedPayer": {
"partyIdType": "MSISDN",
"partyId": "46733123450"
},
"payee": {
"partyIdType": "MSISDN",
"partyId": "46733123452"
}
"description": ""
},
{
"headers": {
"X-Target-Environment": "sandbox",
"X-Reference-Id": "ceb46c4f-1523-405b-9d16-dd9ad45e202c"
}
});
Interfaces
HttpState
State object
Properties
Name | Description |
---|---|
data | the parsed response body |
response | the response from the HTTP server, including headers, statusCode, body, etc |
references | an array of all previous data objects used in the Job |
RequestOptions
Options provided to the HTTP request
Properties
Name | Type | Description |
---|---|---|
errors | object | Map of errorCodes -> error messages, ie, { 404: 'Resource not found;' } . Pass false to suppress errors for this code. |
form | object | Pass a JSON object to be serialised into a multipart HTML form (as FormData) in the body. |
query | object | An object of query parameters to be encoded into the URL. |
headers | object | An object of headers to append to the request. |
parseAs | string | Parse the response body as json, text or stream. By default will use the response headers. |
timeout | number | Request timeout in ms. Default: 300 seconds. |
tls | object | TLS/SSL authentication options. See https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions |