API Endpoint Documentation
Updated: 24-March-2025 | Previous: 10-Feb-25
May change with prior notice.
| # | Method | Endpoint Address | Updated | Previous |
| 1 | POST | http://10.10.0.159:4005/api/postFinancialData | 24-March-2025 |
| 2 | GET | http://10.10.0.159:4005/api/postReceiptsToIports/:mposId | 24-March-2025 |
| 3 | PUT | http://10.10.0.159:4005/api/voidTransaction | 24-March-2025 |
| 4 | GET | http://10.10.0.159:4005/api/removeReceiptsByMposId/:mposId | 24-March-2025 |
| 5 | GET | http://10.10.0.159:4005/api/ping | 26-March-2025 |
| Method | Endpoint Address / Description | Updated |
| POST | STAGING: http://10.10.0.159:4005/api/postFinancialData
Request Details | Type | Description | Required | | API Key | The key generated from the gatekeeper sso. Put this in the request's Authentication as Bearer Token. | Yes |
Request Payload: | Name | Description | Type | Required | | MposId | The Device Id. | number(10) | Yes | | CashierId | The Id of the cashier. | numbber(10) | Yes | | DebtorCode | The defined Cashier/Debtor code. Defaults to 1 if no value is supplied. | string(20) | Yes | | ReceiptNumber | The registered invoice number. | string(20) | Yes | | ReceiptDate | The registered invoice date. | Date | Yes | | ReceiptAmount | Base cost issued in the receipt. | number(38,2) | Yes | | TerminalCode | The terminal code of the issuing party. | string(10) | Yes | | PaymentMethod | The payment type used for the transaction. Payment method character list to be updated. Defaults to ‘C’ for CASH. | string(1) | Yes | | SCN | Refers to the Ship Call Number. | string(20) | No | | VoyageNumber | The vessel Identity through the arrival and depature at the port. | string(40) | No | | CustomerTin | Customer declared TIN. Defaults to 111111111 if no value is supplied. | string(20) | Yes | | CustomerName | Customer declared Name. Defaults to "Cash" if no value is supplied. | string(120) | Yes | | CustomerAddress | Customer declared personal address. Defaults to "NO ADDR" if no value is supplied. | string(120) | Yes | | BusinessStyle | MPOS defined business style. | string(255) | No | | DiscountCode | MPOS defined discount code. | string(20) | No | | DiscountRate | MPOS defined discount rates. Should be mandatory if discount code is supplied. | number(6,2) | No | | DiscountAmount | MPOS defined discount amount. Should be mandatory if discount code is supplied. | number(8,2) | No | | PaymentRefNo | Reference number given by transactions paid with Gcash or PayMaya. | string(50) | No | | Remarks | OPTIONAL: Referring to the comments noted for the transaction. | string(255) | No | | Status | Status for the transaction.- A - Active: Default status for all incoming transactions
- P - Pending: Transaction is awaiting Bridge to iPorts data posting.
- V - Voided: Transaction is voided.
- R - Removed: Transaction is cleared/removed from the batch. Transactions with this status will not be posted to iPorts
| string(2) | Yes | | OrgId | Organization id. | number | No | | CreatedOn | Date when the transaction is created. | Date | No | | CreatedAt | Date time when the transaction is created. | Date | No | | CreatedBy | Terminal or vessel Id used. | number(10) | Yes | | InboundPort | OPTIONAL: Inbound Port Id | string | No | | OutboundPort | OPTIONAL: Outbound Port Id | string | No | | VoidId | OPTIONAL: Generated Void Series | number | No | | RefundId | OPTIONAL: Generated Refund Series | number | No | | Receipt Lines* | | ServiceCode | MPOS defined service code. | string(12) | Yes | | ServiceDescription | Refers to the description given to the service. | string(20) | No | | Qty | Refers to the quantity of the service. | number(38,2) | No | | Rate | MPOS defined rate for the service. | number(38,2) | No | | PrimaryAmount | Initial payable amount of the service. | number(38,2) | No | | VatAmount | MPOS Value Added Tax amount. | number(38,2) | No | | EwtAmount | MPOS Expanded Witholding Tax amount. | number(10,2) | No | | CwtAmount | MPOS Credidted Witholding Tax amount. | number(10,2) | No | | DiscountCode | MPOS defined discount code per line. | string(20) | No | | DiscountAmount | MPOS defined discount amount per line. It should be mandatory if discount code is supplied. | number(38,2) | No | | Realtime | Accepts the values: "true" or "false".Defaults to "false" if nothing is supplied. True makes the mode of posting to iPorts to Realtime while false adds the transaction in the device batch for Batch Posting. | string(4) | No |
receiptIdsn - Generated UUID for the posted transaction. transactionId - Indicates the transaction Id based off the MPOS Id. receiveTime - The time and date when the transaction is posted.
| Error Name | Description | Fix | | Invalid Type | The supplied input for that key does not match the required type. | Make sure that the value supplied to the object is properly typed. For example:- If the name requires a type of number, supply values without quotation marks such as 1024 instead of "1024"
- If the name requires a type of string, supply with a quotation mark such as "2024".
- If the name requires a type of date, supply a valid date like "2024-12-31" which follows the ISO 8601 international standard which is YYYY-MM-DD.
See Request Payload for references. | | UnauthorizedAccess | The supplied API key does not have the correct permissions to access the API being called. | Contact the support team to determine the permissions and accessible content for your key. | | InvalidApiKey | The supplied API key is invalid or already expired, revoked or replaced, and cannot be used for any API request calls. | Log in to the Account Center to generate another valid key. Seeguide on how to generate an API key using Gatekeeper UI. | | PaymentMethod | A specific key which is only allowed to receive the following values strictly:Will return an error message:"your-value-here" is not included on the selections: "C". | Simply change the value you are providing to one of the choices listed in the Description column. | | DiscountCode | A specific key which when supplied, will require DiscountRate andDiscountAmount to be present on the payload. Will return an error message:"The payload is incomplete. Discount Rate or Discount Amount is missing." | Supply the required / missing values. Specifically DiscountRateand DiscountAmount with their proper type. |
| 24-March-2025 |
| GET | STAGING: http://10.10.0.159:4005/api/postReceiptsToIports/:mposId
API endpoint that determines the end of a batch transaction based on the device Id. Call this whenever you reached the last transaction for a specific device.
!IMPORTANT! This endpoint initiates the batch insert into the financial system entities, do not forget to call this at the end of each batch per device.
Request Details: | Type | Description | Required | | API Key | The key generated from the gatekeeper sso. Put this in the request's Authentication as Bearer Token. | Yes |
 | 24-March-2025 |
| PUT | STAGING: http://10.10.0.159:4005/api/voidTransaction
API endpoint that voids a posted transaction in iPorts updating the status from "A" for Active to "V" for Voided. The supplied IDSN necessary for the payload is found in the successful transaction return payload.
!IMPORTANT! Be extra cautious when calling this endpoint since a voided transaction is considered as a deleted transaction and would not be included in the overall transaction total amount counting.
Request Details: | Type | Description | Required | | API Key | The key generated from the gatekeeper sso. Put this in the request's Authentication as Bearer Token. | Yes |
| Name | Description | Type | Required | | ReceiptIDSN | The unique identifier that is returned when a transaction is successfully posted to iPorts. | string(36) | Yes |
 | 24-March-2025 |
| GET | STAGING: http://10.10.0.159:4005/api/removeReceiptsByMposId/:mposId
Endpoint that clears the current batch depending on the device ID. This will clear all transactions under the given device ID that are not yet posted to iPorts
!IMPORTANT! This endpoint will clear all of the transactions from the batch, you will have to redo the whole batch submission. Once executed, cleared transactions are not retrievable.
Request Details: | Type | Description | Required | | API Key | The key generated from the gatekeeper sso. Put this in the request's Authentication as Bearer Token. | Yes |
 | 24-March-2025 |
| GET | STAGING: http://10.10.0.159:4005/api/ping
This endpoint is for pinging and checking if the server is currently up and running. | 24-March-2025 |