Magensa's Account Management API allows Resellers to manage their merchants' account. The goal is to provide an API that parallels our current Reseller Portal UI.
\nIn this version, we are testing additional GET methods, including lookups and resources. We welcome feedback with your experience.
When a parameter for any method expects a specific range or type of value (enum) - a lookup method is exposed to support populating these specific parameters (i.e. transactionTypeFilter). In the previous version, the lookup methods for available options had the schema { name: \"\", description: \"\", value: 0 }. However, some parameters expected the int value, while others expected the string name. This has been corrected to a consistent { value: \"\" } and (if needed) description. Eliminating the int values provides a more consistent experience, wherein a string is always expected for these specific (enum) parameters.
Basic Authorization header targets \"Reseller API Users\". You may continue to use Reseller Portal credentials to login to the UI. The API AuthHeader will represent program access, similar to an API Key. Authenticate all methods with Authorization Basic header.
The methods included in this release have examples included in this collection. Each sample request has a brief write-up for what the method is, as well as optional parameters (if applicable).
\n/api/lookup methods are included to support parameters that expect specific enum values.
StartFragment
\nEndpoints in this folder support reseller merchant account discovery and transaction reporting.
\nUse these requests to:
\nFind merchants under a reseller
\nRetrieve merchant configuration details
\nList and summarize transactions for a merchant over a date range
\nFetch detail for a specific transaction
\nAccountManagement:
\nmerchants (List Merchants) — List all merchants for the reseller, with optional filters (e.g., by customer code or company name) and paging/sorting.
\nmerchantInfo — Get merchant configuration information for a given customerCode (merchant + user-level config for MPPG scope).
merchantTransactions — List transactions for a merchant (customerCode) within a startDateTime / endDateTime range, with optional filters and paging/sorting.
merchantSummary (transaction summary for merchant) — Get an aggregated transaction summary for a merchant over an optional date range.
\ntransactionDetail — Retrieve full details for a specific transaction for a merchant (by customerCode and transactionMagTranId).
Lookup:
\nmerchantSortByOptions — values for the optional sortBy parameter in the 'merchants' method (list merchants).
transactionSortByOptions — values for the optional sortBy parameter in the 'merchantTransactions' method.
transactionTypes — MPPG transaction types. Can be used for various purposes. One of which is 'merchantTransactions' transactionTypeFilter optional parameter.
processorNames — List of processors supported by MPPG. Due to the various formats, and naming conventions; these values are url encoded. Processor names are used for merchant configuration (create and update), and can also be used to query processorProperties (or components).
\nThese requests commonly rely on the following collection/environment variables:
\nbaseUrl: https://reseller.magensa.net
merchantCustomerCode: abc123(target merchant's customer code)
startDateTime: 2026-01-01T12:00:00(start transaction range)
endDateTime: 2026-03-03T12:00:00(end transaction range)
magTranId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
accountPath: accountManagement
lookupPath: lookup
Transaction detail for a specific merchant transaction, specified by customerCodeand magTranId for the target transaction.
customerTransactionId: Can be used for customer trace reference. If one is not supplied - a traceId will be generated and returned in the response.
List transactions for merchant, specified by customerCode
pageSize: Valid range is 0 - 1000. If not provided, default is 0(no limit)
pageNumber: Must be greater than zero, or omitted. If not provided, default is 1.
customerTransactionId: Can be used for customer trace reference. If one is not supplied -- a traceId will be generated and returned in the response.
transactionTypeFilter: String name to filter by transaction type. There is a lookup method that exposes all names: api/lookup/transactionTypes
sortyBy: Enum value. Valid range is 21 - 47. There is a lookup method that exposes all values: api/lookup/TransactionSortByOptions
amountFromFilter: Filter transactions by specifying an amount 'floor'
amountToFilter: Filter transactions by specifying an amount 'ceiling'
customerTransactionIdFilter: Filter by customerTransactionId
deviceSerialNumberFilter: Filter by device serial number
magTranIdFilter: Filter by MagTranID
panLastFourFilter: Filter by Last 4 of PAN
Transaction summaries for a given merchant (specified by customerCode provided in path).
startDateTime and endDateTime are optional filters to limit summary range.
If not provided - default is past 90 days.
\nRange cannot exceed 120 days
\ncustomerTransactionId: Can be used for customer trace reference. If one is not supplied - a traceId will be generated and returned in the response.
Merchant configuration info (specified by customerCode provided in path).
merchantInfo is a combination of merchant-level and user-level configuration. Scope of this call is limited to MPPG Service.
customerTransactionId: Can be used for customer trace reference. If one is not supplied -- a traceId will be generated and returned in the response.
TEConnect (Manual Entry)
\nTEConnect ApplePay
\nMPOC (Apple's Tap to Pay by iPhone)
\nDishOut (MPMP)
\nTEConnect 3DS (Paay)
\nPayment Request
\nThis method is for Master Reseller accounts only. It lists the sub-resellers associated with their account. Master Reseller API Users are supported with all methods the API offers. However, there are some methods that require the Master account to target a sub-reseller. This is specified in the request by \"targetResellerCode\".
The list returned from this method provides the resellerCodes needed to target a sub-reseller for any method that requires it.
\n","urlObject":{"path":["","reseller","list"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"db6b2ec3-69b4-47f4-9a52-9803bebee74f"},{"name":"merchants (List Merchants)","event":[{"listen":"test","script":{"exec":["const successfulMerchantsSchema = {\r"," type: \"object\",\r"," properties: {\r"," merchants: { type: \"array\" },\r"," customerTransactionID: { type: \"string\" },\r"," status: { type: \"integer\" },\r"," message: { type: \"string\" }\r"," }\r","}\r","\r","pm.test(\"Success Status Code\", () => {\r"," pm.expect(pm.response.code).to.equal(200);\r"," pm.expect(pm.response.status).to.equal(\"OK\");\r","});\r","\r","pm.test(\"Response Schema matches Swagger\", () => {\r"," pm.response.to.have.jsonBody();\r"," pm.response.to.have.jsonSchema(successfulMerchantsSchema);\r","});\r","\r","pm.test(\"Merchant List Schema matches Swagger\", () => {\r"," const parsedResponse = pm.response.json();\r"," for (const merchant of parsedResponse.merchants) {\r"," console.log(merchant);\r"," pm.expect(merchant).to.have.property(\"companyName\");\r"," pm.expect(merchant.companyName).to.be.a(\"string\");\r","\r"," pm.expect(merchant).to.have.property(\"customerCode\");\r"," pm.expect(merchant.customerCode).to.be.a(\"string\");\r","\r"," pm.expect(merchant).to.have.property(\"id\");\r"," pm.expect(merchant.id).to.be.a(\"number\");\r","\r"," pm.expect(merchant).to.have.property(\"status\");\r"," pm.expect(merchant.status).to.be.a(\"string\");\r"," }\r","});\r",""],"type":"text/javascript","packages":{},"requests":{},"id":"b43df039-33e3-45bc-a08c-f4cb002cba9c"}}],"id":"cc316cfb-c733-4369-8f3c-83c2abd0253d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic "}],"url":"//merchants","description":"List all reseller's merchants.
\ncustomerCodeFilter: Filter results by customerCode - this can be a partial or full match. For example \"x\"will match all (case insensative) customerCodes that contain a \"x\" or \"X\".
nameFilter: Filter results by companyName - this can be a partial or full match (case-insensative).
pageSize: Must be between 0 - 1000. If not provided, default is 0(no limit)
pageNumber: default is 1
sortBy: sortBy options are exposed in the lookup method /api/lookup/merchantSortByOptions, this is an enum value. Current options are Name,(company name) customerCode and customerId
customerTransactionId: Can be used for customer trace reference. If one is not supplied -- a traceId will be generated and returned in the response.
targetResellerCode: Master Reseller account must specify a sub-reseller for a merchant list. This value is ignored for Resellers that are not Master accounts.
List transactions for all merchants under a given reseller. The given reseller is assumed from the AuthHeader. If this is a Master Reseller Account - \"targetResellerCode\" must be supplied to target a sub-reseller (Master Accounts do not directly have merchants)
Use a valid AuthHeader (Reseller API User or Master Reseller API User)
\nstartDateTime is a required query parameter. ISO format (yyyy-MM-ddTHH:mm:ss)
endDateTime is a required query parameter. ISO format (yyyy-MM-ddTHH:mm:ss)
pageSize: Valid range is 0 - 1000.
pageNumber: Must be greater than zero, or omitted.
customerTransactionId: Can be used for customer trace reference. If one is not supplied - a traceId will be generated and returned in the response.
transactionTypeFilter: Enum value. Valid range is 1-9. There is a lookup method that exposes all values: api/lookup/transactionTypes
sortyBy: Enum value. Valid range is 21 - 47. There is a lookup method that exposes all valid values: api/lookup/TransactionSortByOptions
amountFromFilter: Filter transactions by specifying an amount 'floor'
amountToFilter: Filter transactions by specifying an amount 'ceiling'
customerTransactionIdFilter: Filter by customerTransactionId
deviceSerialNumberFilter
magTranIdFilter: Filter by MagTranID
panLastFourFilter: Filter by Last 4 of PAN
targetResellerCode: Master Reseller Only. Target a sub-reseller to list all merchant's transactions for a given reseller. This is ignored for resellers that are not Master Accounts. This is mandatory for Master Reseller Accounts.
If the merchant does not have transactions, there will not be a \"transactions\" property in the response. This is by design. Instead of { \"transactions\": null }, \"transactions\" is omitted from the JSON response.
Create a new MPPG Merchant, as well as the initial user with processor configuration. Typically, merchants have one user with processor configuration (User credentials to call APIs/Services), and may optionally have more users that log in to \"Merchant Portal\" (Portal Users).
\nThis method supports optional features that the caller can choose to opt-in for the merchant (and user) creation.
\nThe sample request included is required parameters only. Additional features are available to opt-in for both the create, and update methods.
\nApple Tap to Pay by iPhone
\nDishOut (MPMP merchant creation)
\nTEConnect 3DS (Paay)
\nTEConnect Manual Entry
\nTEConnect ApplePay
\nGooglePay
\nPayment Request
\nTo opt-in for an additional feature, include the corresponding block in your request. For example, to opt-in for Apple's Tap to Pay by iPhone, include the \"appleTapToPay\" block, with additional properties specific for the target feature:
In this example, the additional properties being \"appleTapToPay\":{ \"merchantCategoryCode\": \"5411\", \"merchantBannerName\": \"Example BannerName\" }
Some features have external dependencies (i.e. TEConnect ApplePay requires a validation file hosted at your registered domain) - which may fail if the dependencies are not met. For both create, and update; if a call is successful, but one or many optional features failed -- an errorList is included in the response, specifying which feature failed, and a message for the reason.
DishOut and Paay don't allow duplicate names. For all third-party cases -- the \"companyName\" value is used to on-board newly created merchants to DishOut and/or Paay. If two different merchants are created with the same \"companyName\" - only one will successfully integrate with DishOut and/or Paay.
Master Resellers must specify a \"targetResellerCode\" to on-board a merchant. Master accounts don't directly house merchants.
Updates a target MPPG merchant. The request structure is broken up by \"feature blocks\". For example, supplying a \"merchantContactInfo\" block will update the merchant's contact info (Magensa DB). If this block is not supplied in the request, the API will skip updating contct info, and move on to the next block in the request.
Each feature block is optional. The example request body has all feature blocks (as a template), but typically an update request will only include the data points you wish to update.
\nEach feature is inspected, validated, and updated independently. In the case that one or more features fails to update -- an \"errorList\" will be included with a \"featureId\" (string name) and a \"message\", indicating which feature failed to update, and why.
Magensa Contact Info. \"merchantContactInfo\"
\"processor\" info.
\"appleTapToPay\" MPOC info.
\"dishOut\" MPMP merchant info.
\"teConnectManualEntry\" pilot or production.
\"teConnect3DS\" Paay merchant profile.
\"teConnectApplePay\" domains
\"enableGooglePay\" flag.
\"paymentRequest\" info.
Generate a TSYS transactionKey, with provided TSYS credentials. This is a pass-through method, which calls TSYS directly.
This is a standalone utility method. This method may be used to call createMppgMerchant (targeting TSYS processor) with transactionKey, deviceIdProfile and developerID.
Alternately, createMppgMerchant can be called directly with a mid, userId, password, deviceIdProfile, and developerID.
createMppgMerchant method will call this method, and attempt to generate a transactionKey, before proceeding to create the MPPG merchant.
This method allows a Reseller account to be linked to their Paay account. This method may also be used by Master Resellers - but in this case the \"targetResellerCode\" becomes mandatory in request body.
This method is not validated. Meaning the Reseller (or Master Reseller, on-behalf of one of their sub-resellers) has an existing Paay account. They are populating the values in this request from their Paay portal. This method links their Magensa Reseller Account with a mapping to their Paay account.
\nThe response we receive from Paay's API determines success or failure.
\nThis method may be called one or many times. This allows for either adding a mapping entry - or updating an existing. Again - no validation. It is assumed that if an update is needed - the initial entry was inaccurate.
\nBoth Magensa and Paay only allow merchants under a given reseller - so Master Resellers must target a sub-reseller for adding/updating a mapping entry.
\n","urlObject":{"path":["","linkPaayResellerAccount"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"eebe8f2b-52ff-4275-a292-07b7775fd553"}],"id":"94692d58-2a31-4e6f-8354-8054926fabd6","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"326d3500-1fc1-4a81-8674-08cde555578c"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"37fa1b79-f9e1-452e-9ed4-883ad43cf4a0"}}],"_postman_id":"94692d58-2a31-4e6f-8354-8054926fabd6","description":""},{"name":"Lookups","item":[{"name":"merchantSortByOptions","id":"465688b1-23d5-412c-8052-03938365f491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic"}],"url":"//merchantSortByOptions","description":"sortBy OptionsLookup method to expose values used to populate the optional sortBy parameter in the /api/accountmanagement/merchants method.
name and description are helpers for what the value corresponds to.
Use the value to populate the merchant sortBy parameter. i.e: sortBy=23 corresponds to \"sort merchant list by CustomerCode.\".
sortBy OptionsLookup method to expose values used to populate the optional sortBy parameter in the /api/AccountManagement/MerchantTransactions/{customerCode} method.
name and description are helpers for what the value corresponds to.
Use the value to populate the transaction sortBy parameter. i.e: sortBy=3 corresponds to \"sort transaction list by transactionType\".
Lookup method for valid transactionTypeFilter options. These filter options may be applied to methods such as merchantTransactions.
For example: /api/AccountManagement/merchantTransactions/{customerCode}?transactionTypeFilter=\"SALE\" will filter result set by \"SALE\" transactions.
Lookup method to expose \"processorName\"(s). When creating, or updating a MPPG merchant -- use this method to lookup your target \"processorName\". The values are url encoded to support multiple naming conventions.
When creating, or updating a MPPG merchant - use this method to target a processor. Use the /api/lookup/processorProperties/{processorName} method to lookup what properties (processor authentication/configuration) your processor expects.
Processor configuration, for a merchant, allows MPPG to process transactions for the merchant as a gateway.
\n","urlObject":{"path":["","ProcessorNames"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b270eea5-b8e3-4eba-a19e-62894c8fc4e9"},{"name":"processorProperties","id":"8f08860f-c4c0-4314-a690-6aa53f514791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic ","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"","value":"","type":"text","uuid":"9ebbc044-81d2-4a6d-abe7-8dafa40e999e","disabled":true}]},"url":"//processorProperties/","description":"Lookup method to list the properties of a given processor name. These are also referred to as \"Processor Details\" or \"Processor Configuration\". These are the key names for key value pairs the given processor expects, when on-boarding (or updating) a MPPG merchant. Processor properties will vary, based on target processor.
\nThese properties will be stored, with a merchant's MPPG account, to facilitate processing transactions for a merchant.
\n","urlObject":{"path":["","processorProperties",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8f08860f-c4c0-4314-a690-6aa53f514791"},{"name":"merchantCategoryCodes","id":"83f1ccdf-adb0-4e33-af10-dc388bc8f4d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic ","type":"text"}],"url":"//merchantCategoryCodes","description":"Lookup method to expose \"merchantCategoryCode\"s. Helpful to populate the parameter for both \"appleTapToPay\" and \"teConnect3DS\", for merchant create and update methods.
This method provides caller with Magensa's Apple Domain Verification File for ApplePay \"on the web\" (TEConnect ApplePay) in Base64 format. Additionally, it provides instructions on how to host the file, expected path, and expected fileName.
This is an on-boarding specification from Apple. Both createMppgMerchant and mppgMerchant (update) methods expose the ability to on-board a merchant to TEConnect ApplePay. However, there is an external dependency (from Apple) that Magensa's domain verification file must be hosted at a particular path on all the \"domains\" the caller provides. This method contains the fileContent (File in Base64 string format), fileName (name of the file, once decoded), instructions on how to host the file, and notes : tips and common questions answered.