Skip to content

updateBatchTransaction.Readme.md

Latest commit

 

History

History
48 lines (34 loc) · 2 KB

updateBatchTransaction.Readme.md

File metadata and controls

48 lines (34 loc) · 2 KB

Update A Transaction Batch

Here, updateBatchTransaction(String batchId) creates a PATCH request to /batchtransactions/{batchId}

This endpoint updates a specific transaction batch. Only the batchStatus field can be modified.

Usage/Examples

MMClient mmClient = new MMClient("<Place your consumer key>", "<Place your consumer secret>", "<Place your API key>");
DisbursementRequest disbursementRequest = new DisbursementRequest();
List<PatchData> patchDataList = new ArrayList<>();

patchDataList.add(new PatchData("replace", "/batchStatus", "approved"));

disbursementRequest.setPatchData(patchDataList);
AsyncResponse sdkResponse = mmClient.addRequest(disbursementRequest).addCallBack("<Place your callback URL>").updateBatchTransaction("batch reference");

Additionally, if you want to use patch update details as JSON string, you can use the following code;

MMClient mmClient = new MMClient("<Place your consumer key>", "<Place your consumer secret>", "<Place your API key>");
DisbursementRequest disbursementRequest = new DisbursementRequest();

String patchDataJsonInput = "[{\"op\":\"replace\",\"path\":\"/batchStatus\",\"value\":\"approved\"}]";

disbursementRequest.setPatchData(patchDataJsonInput);
AsyncResponse sdkResponse = mmClient.addRequest(disbursementRequest).addCallBack("<Place your callback URL>").updateBatchTransaction("batch reference");

Response Example

{
  "serverCorrelationId": "e19cc34d-290b-4b8c-9f33-c9ef9fb350dd",
  "status": "pending",
  "notificationMethod": "callback",
  "objectReference": "1624",
  "pollLimit": 100
}

NOTE

In asynchronous flows, a callback mechanism or polling mechanism is utilised to allow the client to determine the request's final state. Use the viewRequestState() function for the polling mechanism to receive the status of a request, and the viewBatchTransaction() function to acquire the final representation of the Transaction object.