{"info":{"_postman_id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","name":"Payment Request","description":"

Introduction

\n

Payment Request API is a simple way for the merchant to create a customized payment request. With each payment request generated, the merchant receives the payment URL and a WebSocket token.

\n

The merchant can generate a QR code using the payment URL, and then the QR code can be displayed on the terminal, sent to customers, or printed on a receipt. Customers can make a payment by scanning the QR code while a WebSocket token is used by the merchant to connect to the service so that it can receive real-time updates on payment transactions.

\n

Payment Request API Calling Scenario:

\n

The payment URL will point to an MPPG hosted payment page. When customers scan the QR code and follow the URL, they will be directed to the MPPG hosted payment page. The MPPG hosted payment will call the Payment Request API using the Payment Request ID, which is part of the payment URL to retrieve payment details. It will then collect payment either through manual entry or a digital wallet.

\n

The MPPG hosted payment page will call an MPPG Web Service to process manual entry or digital wallet token transactions. Once the transaction is processed (either success or failure), the MPPG hosted payment page will invoke the Payment Request API to finish the process which in turn notifies the WebSocket.

\n

Transaction Sequence

\n

Below is the overall transaction sequence diagram.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"}],"owner":"33729815","collectionId":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","publishedId":"2sAYdkJVEx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-05T16:24:29.000Z"},"item":[{"name":"/api/PaymentRequest","id":"0e7aa5e2-0be7-4b9a-a3b3-33dab7d27075","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://paymentrequest.magensa.net/api/PaymentRequest","description":"

Get a list of Payment Request Summary for given filters and paginations.

\n

Query String Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterData TypeDescriptionRangeDefault
dsintegerStart date of the Payment Request creation date in format of YYYYMMDDAny valid date60 days prior to today
deintegerEnd date of the Payment Request creation date in format of YYYYMMDDAny valid datetoday
psintegerPage size for the pagination1~100020
pnintegerPage number1~total # of pages1
stintegerStatus of the Payment Request0~4All statuses
\n

Responses

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Response CodeResponse BodyNote
200PaymentRequestSummaryListInfoSuccess
400PaymentRequestListErrorInput error
401N/AAuthentication error
500PaymentRequestListErrorServer-side error
\n

API Response with All Default parameters:

\n
{\n  \"magTranID\": \"869860f8-b1b8-43a7-ad56-cbf86193d3ef\",\n  \"totalRecordsAvailable\": 2,\n  \"requests\": [\n    {\n      \"paymentRequestID\": \"2ba77b9c-ff0e-4bd4-a405-6d363037ee6d\",\n      \"transactionType\": 1,\n      \"customerTranID\": \"34344\",\n      \"customerTranRef\": \"43434\",\n      \"amount\": 10,\n      \"usageCountLimit\": 50,\n      \"currentUsageCount\": 0,\n      \"isEnabled\": true,\n      \"dateCreated\": \"2022-04-18T00:43:41.687-07:00\",\n      \"activationDate\": \"2022-04-18T07:43:12.313\",\n      \"expirationDate\": \"2022-06-17T07:43:12.313\",\n      \"status\": 2\n    },\n    {\n      \"paymentRequestID\": \"242e86f0-52d4-4137-bd56-b4d4d0e19586\",\n      \"transactionType\": 1,\n      \"customerTranID\": \"dsfadsf\",\n      \"customerTranRef\": \"asdfasdfasdtest2\",\n      \"amount\": 10,\n      \"usageCountLimit\": 40,\n      \"currentUsageCount\": 0,\n      \"isEnabled\": true,\n      \"dateCreated\": \"2022-04-21T02:05:22.6-07:00\",\n      \"activationDate\": \"2022-04-21T23:05:01.743\",\n      \"expirationDate\": \"2022-06-20T23:05:01.743\",\n      \"status\": 2\n    }\n  ]\n}\n\n\n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","name":"Payment Request","type":"collection"}},"urlObject":{"path":["api","PaymentRequest"],"host":["https://paymentrequest.magensa.net"],"query":[],"variable":[]}},"response":[{"id":"720f78be-acde-478f-9fd4-44f699688ec9","name":"/api/PaymentRequest","originalRequest":{"method":"GET","header":[],"url":{"raw":"{paymentRequestBaseURL}/api/PaymentRequest?ds=20220413&de=20220421&ps=20&pn=1","host":["{paymentRequestBaseURL}"],"path":["api","PaymentRequest"],"query":[{"key":"ds","value":"20220413"},{"key":"de","value":"20220421"},{"key":"ps","value":"20"},{"key":"pn","value":"1"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"1398754a-8a26-478d-bf39-ccef67ecc46c","name":"/api/PaymentRequest","originalRequest":{"method":"GET","header":[],"url":{"raw":"{paymentRequestBaseURL}/api/PaymentRequest?ds=20220413&de=20220421&ps=20&pn=1&st=4","host":["{paymentRequestBaseURL}"],"path":["api","PaymentRequest"],"query":[{"key":"ds","value":"20220413"},{"key":"de","value":"20220421"},{"key":"ps","value":"20"},{"key":"pn","value":"1"},{"key":"st","value":"4"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0e7aa5e2-0be7-4b9a-a3b3-33dab7d27075"},{"name":"GET Payment Requests","id":"d0c7b0d1-c1a8-4010-8b82-aad9019bfbb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ","type":"text"}],"url":"https://paymentrequest.magensa.net/api/PaymentRequest?ds=20220413&de=20220421&ps=20&pn=1&st=4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","name":"Payment Request","type":"collection"}},"urlObject":{"path":["api","PaymentRequest"],"host":["https://paymentrequest.magensa.net"],"query":[{"description":{"content":"

Start date in YYYYMMDD

\n","type":"text/plain"},"key":"ds","value":"20220413"},{"description":{"content":"

End date in YYYYMMDD

\n","type":"text/plain"},"key":"de","value":"20220421"},{"description":{"content":"

Page size for pagination

\n","type":"text/plain"},"key":"ps","value":"20"},{"description":{"content":"

Page number for pagination

\n","type":"text/plain"},"key":"pn","value":"1"},{"description":{"content":"

Status of Payment Request

\n","type":"text/plain"},"key":"st","value":"4"}],"variable":[]}},"response":[],"_postman_id":"d0c7b0d1-c1a8-4010-8b82-aad9019bfbb7"},{"name":"POST Create Payment Request","id":"b3eaa463-1dbd-4b1f-b925-9544e18e4799","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionType\": 1,\n \"customerTranID\": \"123456\",\n \"customerTranRef\": \"Reference\",\n \"amount\": 100.0,\n \"taxAmount\": 5.0,\n \"taxPercent\": 5.0,\n \"additionalInfo\": [],\n \"miscData\": \"Sample data\",\n \"processorName\": \"Processor_1\",\n \"promptForTax\": true,\n \"promptForTips\": true,\n \"termsAndTransactionInfo\": \"Terms and conditions\",\n \"usageCountLimit\": 0,\n \"isEnabled\": true,\n \"activationDate\": \"2024-01-01T00:00:00Z\",\n \"expirationDate\": \"2048-12-31T23:59:59Z\"\n}"},"url":"https://paymentrequest.magensa.net/api/PaymentRequest","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","name":"Payment Request","type":"collection"}},"urlObject":{"path":["api","PaymentRequest"],"host":["https://paymentrequest.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3eaa463-1dbd-4b1f-b925-9544e18e4799"},{"name":"GET Payment Request by ID","id":"44d27762-26e3-4941-bed3-a214a67de542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic ","type":"text"}],"url":"https://paymentrequest.magensa.net/api/PaymentRequest/{id}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","name":"Payment Request","type":"collection"}},"urlObject":{"path":["api","PaymentRequest","{id}"],"host":["https://paymentrequest.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"44d27762-26e3-4941-bed3-a214a67de542"},{"name":"PUT Update Payment Request","id":"11163c32-2d49-47f2-8abc-612f90be9445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionType\": 1,\n \"customerTranID\": \"UpdatedID\",\n \"customerTranRef\": \"UpdatedRef\",\n \"amount\": 200.0,\n \"taxAmount\": 10.0,\n \"taxPercent\": 5.0,\n \"additionalInfo\": [],\n \"miscData\": \"Updated data\",\n \"processorName\": \"UpdatedProcessor\",\n \"promptForTax\": true,\n \"promptForTips\": true,\n \"termsAndTransactionInfo\": \"Updated terms\",\n \"usageCountLimit\": 10,\n \"isEnabled\": true,\n \"activationDate\": \"2024-01-01T00:00:00Z\",\n \"expirationDate\": \"2048-12-31T23:59:59Z\"\n}"},"url":"https://paymentrequest.magensa.net/api/PaymentRequest/{id}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","id":"15652a2a-e0c5-4fa4-8e9b-ed66bd3fa28f","name":"Payment Request","type":"collection"}},"urlObject":{"path":["api","PaymentRequest","{id}"],"host":["https://paymentrequest.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"11163c32-2d49-47f2-8abc-612f90be9445"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]}},"event":[{"listen":"prerequest","script":{"id":"42835677-ccc9-400b-86e2-d71087a855cd","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"004ef583-1f55-420c-8f2c-f15c10215f2e","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"paymentRequestBaseURL","value":"https://paymentrequest.magensa.net","type":"default"}]}