viewResource.Readme.md

View A Resource

Here, viewResource(link) creates a GET request to /{link}

This endpoint allows to obtain a representation of the missing resource

Usage/Examples

/**
 * Set up your function to be invoked
 */
const viewResource = async (link, debug = false) => {
  try {
    /**
     * Construct a request object and set desired parameters
     */
    const request = new mmapi.agentService.viewResource(link);

    if (debug) {
      console.log("Request: ", JSON.stringify(request, null, 4));
    }

    /**
     * Call API with your client and get a response for your call
     */
    const response = await client.execute(request);

    if (debug) {
      console.log("Response Status: ", response.status);
      console.log("Response Data: ", JSON.stringify(response.data, null, 4));
    }

    /**
     * Return a successful response
     */
    return response;
  } catch (err) {
    /**
     * Handle any errors from the call
     */
    if (debug) {
      console.log(err);
    }

    /**
     * Return an error response
     */
    return err;
  }
};

/**
 * Invoke the function
 */
viewResource('<<REPLACE-WITH-LINK>>', true);

Example Output

200

{
  "transactionReference": "REF-1635442955061",
  "creditParty": [
    {
      "key": "accountid",
      "value": "2999"
    }
  ],
  "debitParty": [
    {
      "key": "accountid",
      "value": "2999"
    }
  ],
  "type": "merchantpay",
  "transactionStatus": "pending",
  "amount": "200.00",
  "currency": "RWF",
  "creationDate": "2021-10-28T18:42:35",
  "modificationDate": "2021-10-28T18:42:35",
  "requestDate": "2021-10-28T18:42:35"
}