Overview
\nThe Original Credit Transaction (OCT), commonly referred to as Push to Card, enables merchants to facilitate near-instantaneous fund transfers directly to a customer’s eligible Visa or Mastercard debit or credit card. Unlike traditional refund processes that can only return funds from a previous purchase, OCT allows for independent disbursements of funds to a cardholder's account.
\nThis feature is designed for high-velocity industries that require frictionless, real-time payouts, such as:
\n- \n
Gaming & Betting: Real-time withdrawal of player winnings.
\n \nMarketplaces: Payouts to sellers or service providers.
\n \nCorporate Disbursements: Instant insurance claims, rebates, or compensation payments.
\n \nMerchant Settlements: Faster access to processed funds for sub-merchants.
\n \n
By utilizing the Paysecure /payout API with the PAYOUT-CARDS method, you benefit from a unified orchestration layer that handles the complexities of card network routing, ensuring high success rates and global reach while maintaining the same security standards as your standard payment integrations.
\n
Integration Steps
\n- \n
Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the Paysecure Merchant Portal.
\n \nCollect Card Details: Use a secure method to collect the recipient's card number and expiry date or can you Paysecure's cashier to do that.
\n \nExecute Payout: Call the
\n/payoutendpoint with the OCT-specific payout method. \nHandle Webhooks: Listen for the
\npaidorfailureevents to update your internal records. \n
Mandatory parameters in the request body:
\nNote:
\nIf the merchant is not PCI DSS compliant then they will need to use our cashier and asking the user to enter the card details there. Check the cashier section for more details. If the merchant is PCI DSS compliant then they can use the payout API and send the card details as shown above.
\nIf the merchant wants to use token_reference for doing a payout, then please have a look at the Network Tokenisation Section.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b20ed466-3953-4fdc-88ca-adb9afe12944","id":"b20ed466-3953-4fdc-88ca-adb9afe12944","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0e0833e0-f2d7-457d-97ed-a715dbb2b75d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purpose\": \"Testing cards payout\",\r\n \"currency\": \"GBP\",\r\n \"merchantRef\": \"YOUR ORDER ID\", // optional\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amount\": 100.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Rahul Agarwal\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Rahul Agarwal\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"Testing cards payout\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"YOUR ORDER ID\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"GBP\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"CARDS\",\r\n \"success_callback\": \"\",\r\n \"failure_callback\": \"\"\r\n}"},{"id":"43446118-b6b3-4995-952c-3a7676d5192f","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purpose\": \"Testing cards payout\",\r\n \"currency\": \"GBP\",\r\n \"merchantRef\": \"YOUR ORDER ID\", // optional\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amount\": 100.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Rahul Agarwal\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+44 9876543210\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"extraParam\": {\r\n \"cardNumber\": \"5431240006334004\",\r\n \"cardHolderName\": \"Rahul Agarwal\",\r\n \"expiryYear\": \"2030\",\r\n \"expiryMonth\": \"11\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"Testing cards payout\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"YOUR ORDER ID\",\r\n \"status\": \"error\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"GBP\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"BANKTRANSFER\",\r\n \"success_callback\": \"\",\r\n \"failure_callback\": \"\"\r\n}"}],"_postman_id":"3065075c-9f4e-401e-ba84-180bc403b02e"}],"id":"b20ed466-3953-4fdc-88ca-adb9afe12944","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"fa45e560-c706-4b4a-90d2-e91f643ba232","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"f731e712-cbad-4975-9d01-47b92adf6ec7","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"b20ed466-3953-4fdc-88ca-adb9afe12944","description":""}],"id":"965ae360-2693-47d8-b889-50a0c401343f","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e8a74862-a410-4357-bcf9-5b53a60615f9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"69a2cb71-17fd-494c-a773-449c5d656c88"}}],"_postman_id":"965ae360-2693-47d8-b889-50a0c401343f","description":""},{"name":"💰 APMs (Alternative Payment Methods)","item":[{"name":"🇨🇦 Interac e-Transfer","item":[{"name":"Concepts","item":[],"id":"65cfe3ae-be17-4405-9c3b-7f178f4b881b","description":"Interac Overview
\nInterac is a leading Canadian payment network that facilitates secure, real-time transactions between bank accounts. It offers multiple payment options, including Interac e-Transfers.
\nInterac e-Transfer allows users to send and receive money directly between bank accounts using email or SMS. It provides a fast, secure, and convenient alternative to traditional payment methods, accessible through most Canadian banks' online and mobile banking platforms.
\nPaysecure’s Interac product suite enables merchants to initiate:
\n- \n
PayIns: Consumers can utilise Interac e-Transfer to transfer funds from their bank account, through their bank’s app or website.
\n \nPayouts: Facilitate real-time disbursements directly to consumers' accounts.
\n \n
PayIn Flows
\nHow it works
\nInterac e-Transfer enables merchants with capability to support easy collection from customers. Merchants can initiate payment requests to provide secure, efficient, and flexible options for collecting payments from customers.
\nKey Steps
\nFlow
\n- \n
Initiate Payment Request: The merchant initiates a PayIn (deposit/collection) transaction by sending a request to the Paysecure
\n/purchasesAPI. The payload must specifyINTERAC-ETRANSFERas the payment method and include the customer’s email address or mobile number, the amount to be collected, and an optional message. \nGenerate Security Question & Answer: The API responds with a security question and answer that the customer must use to complete the transfer, adding an additional layer of security. By default, the request remains valid for 30 days. The merchant can configure a longer expiry period, but not shorter than 30 days.
\n \nCustomer Completes the Transfer: The customer logs into their online banking platform, inputs the amount, enter the deposit email and security question and answer, and authorizes the transfer to the merchant’s account.
\n \nConfirm Transfer Completion: Once the funds are successfully transferred, Paysecure sends a webhook to the merchant containing the transaction details and confirmation of payment status.
\n \nUpdate Merchant’s Account: The merchant’s system updates the customer’s account balance to reflect the successful receipt of funds.
\n \n
PayOut flows
\nHow it works
Paysecure offers the ability to make payouts to customers', individuals', or businesses' bank accounts using Interac e-Transfers. Whether for refunds, rewards, or other types of disbursements, the Payouts API ensures efficient and reliable transactions, supporting real-time fund transfers and comprehensive transaction tracking over Interac e-transfers.
Key Steps
\nFlow
\n- \n
Initiate Payout Request: The merchant calls the Paysecure
\n/PayoutAPI. This request includes the customer’s email address or mobile number, the amount to be transferred, and an optional message. \nSecurity Question & Answers (Optional): For the customers that have their auto-deposit turned off , the merchant can share the security question and answer at their cashier or via email. The customer must use these Security question and answer to receive the funds, adding an extra layer of security. For customers with auto-deposit turned on, the funds will be received instanteneously.
\n \nCustomer Deposits Funds (Optional): The customer with auto-deposit turned off, will have to follows the link received on their email from Interac and follow the instructions to receive the funds into their acount. For customers with auto-deposit turned on, the funds will be received instanteneously.
\n \nConfirm Payout Completion: Upon successful deposit, the merchant will receive the webhook with transaction info and the status.
\n \nUpdate Merchant’s Account: The merchant’s system updates the customer’s account balance to reflect the withdrawn funds.
\n \n
Transaction Limits:
\nThe limits outlined below are generally for personal accounts and can vary by financial institution and account type. For business accounts, higher limits may apply. It’s advisable to check with your bank for the most accurate limits pertaining to your account
\nPay Ins:
\nPay Outs:
\n","_postman_id":"65cfe3ae-be17-4405-9c3b-7f178f4b881b"},{"name":"PayIn API","item":[{"name":"Purchases","id":"49808215-864c-45c9-bc89-45f46818bfc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\r\n \"brand_id\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) which can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThe purchase.expireInMin, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
However, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5bc04cd3-2e36-4ed9-8228-7d37db8c9f8a","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\r\n \"brand_id\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"purchaseId\":\"67efd0ff97be603f97a3a697\",\"client\":{\"customerId\":\"NA\",\"email\":\"ashishm.21190@gmail.com\",\"phone\":\"+447755564318\",\"full_name\":\"Test test\",\"date_of_birth\":\"1970-07-10\",\"street_address\":\"10 New Burlington Street Apt. 214\",\"country\":\"CA\",\"city\":\"London\",\"zip_code\":\"W1S 3BE\",\"cc\":[],\"bcc\":[],\"gender\":\"MALE\",\"avatarUrl\":\"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\"stateCode\":\"QLD\"},\"updated_on\":1743769856,\"type\":\"purchase\",\"paymentMethod\":\"INTERAC-ETRANSFER\",\"amountUnit\":\"MAJOR\",\"errorMsg\":\"\",\"redirectType\":\"GET\",\"force_recurring\":false,\"created_on\":1743769855,\"merchantRef\":\"67efd0ff97be603f97a3a697\",\"merchantName\":\"arunsinghal\",\"purchase\":{\"currency\":\"CAD\",\"products\":[{\"name\":\"test\",\"quantity\":1.0,\"price\":1.0,\"discount\":0,\"tax_percent\":\"0.00\"}],\"total\":1.0,\"language\":\"en\",\"notes\":\"\",\"debt\":0,\"total_formatted\":1.0,\"expireInMin\":\"43200\",\"taxAmount\":0.0,\"taxPercent\":0.0,\"request_client_details\":[],\"email_message\":\"\"},\"payment\":{\"is_outgoing\":false,\"payment_type\":\"PURCHASE\",\"amount\":1.0,\"currency\":\"CAD\",\"net_amount\":1.0,\"fee_amount\":0.0,\"pending_amount\":0.0,\"pending_unfreeze_on\":null,\"description\":\"\",\"paid_on\":1743769855,\"remote_paid_on\":1743769855},\"issuer_details\":{\"website\":\"\",\"legal_street_address\":\"\",\"legal_country\":\"\",\"legal_city\":\"\",\"legal_zip_code\":\"\",\"bank_accounts\":[{}],\"legal_name\":\"test6\",\"brand_name\":\"test6\",\"registration_number\":\"\",\"tax_number\":\"\"},\"transaction_data\":{\"payment_method\":\"\",\"flow\":\"payform\",\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"},\"country\":\"\",\"attempts\":[{\"client_ip\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"type\":\"execute\",\"payment_method\":\"INTERAC-ETRANSFER\",\"flow\":\"payform\",\"successful\":true,\"country\":\"INTERAC-ETRANSFER\",\"processing_time\":1743769855,\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"}}]},\"status\":\"PAYMENT_IN_PROCESS\",\"status_history\":[{\"status\":\"created\",\"timestamp\":1743769855},{\"status\":\"pending_execute\",\"timestamp\":1743769855},{\"status\":\"payment_in_process\",\"timestamp\":1743769856},{\"status\":\"viewed\",\"timestamp\":1744026697}],\"viewedOn\":1744026697,\"is_test\":false,\"brand_id\":\"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\"send_receipt\":false,\"is_recurring_token\":false,\"skip_capture\":false,\"reference_generated\":\"PS620\",\"issued\":\"2025-04-04\",\"due\":1743769855,\"refund_upto\":0,\"cc_descriptor\":\"Africhange Technologies\",\"fraudScore\":\"NA\",\"trustScore\":\"NA\",\"payInDetails\":{\"name\":\"INTERAC\",\"emailAddress\":\"transfer@ieft.ca\",\"secretQA\":\"66a8c78af1fc2f768304bce4\",\"secretAnswer\":\"ps8766a8af\"},\"paidOn\":0,\"receivedAmt\":0.0,\"refund_availability\":\"NONE\",\"refundable_amount\":0.0,\"success_redirect\":\"https://your.redirect.url/getResponse.jsp?success=true\",\"failure_redirect\":\"https://your.redirect.url/getResponse.jsp?success=false\",\"cancel_redirect\":\"\",\"success_callback\":\"https://your.success.callback.url\",\"failure_callback\":\"https://your.success.failure.url\",\"platform\":\"API\",\"created_from_ip\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"checkout_url\":\"https://api.choicepay.ca/payments/67efd0ff97be603f97a3a697/\",\"payoutProcess\":false}"}],"_postman_id":"49808215-864c-45c9-bc89-45f46818bfc2"},{"name":"Get Status","id":"62b97f74-2b7a-4ea1-8a58-79b22b210eb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0f235715-3da2-42cd-83ac-5c351c67a624","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6790e75fa46a5a5bb0b00e55\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"gender\": \"MALE\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1737549752,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1737549663,\n \"merchantRef\": \"6790e75fa46a5a5bb0b00e55\",\n \"merchantName\": \"arunsinghal\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 2,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"43200\",\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"CAD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1737549663,\n \"remote_paid_on\": 1737549663\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-ETRANSFER\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC\",\n \"processing_time\": 1737549663,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1737549664\n },\n {\n \"status\": \"paid 2.0\",\n \"timestamp\": 1737549752\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1737549750\n }\n ],\n \"viewedOn\": 1738749942,\n \"is_test\": false,\n \"brand_id\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS376\",\n \"issued\": \"2025-01-22\",\n \"due\": 1737549663,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"Africhange Technologies\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"name\": \"INTERAC\",\n \"emailAddress\": \"deposit@ieft.ca\",\n \"secretQA\": \"66a8c78af1fc2f768304bce4\",\n \"secretAnswer\": \"ps8766a8af\"\n },\n \"paidOn\": 1737549752,\n \"receivedAmt\": 2,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"failure_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6790e75fa46a5a5bb0b00e55/\",\n \"payoutProcess\": false\n}"},{"id":"439ccb42-f2d9-45e4-acf6-5f8994821433","name":"Purchases Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"62b97f74-2b7a-4ea1-8a58-79b22b210eb7"}],"id":"58d6007f-79ab-44f7-a87c-e00432a030ab","description":"API Flow
\n![](\"https://lh7-us.googleusercontent.com/cfWw_RYZ9eZVEKzKjeRW4I_VwbBTyqH78LUrJG6ulp7FkE1pXVD6DZr9MnQXB9KH_oLFasJDb156naCsBc2bgotPaVY7LtGOJNifpTOb5uks3fjAKpgVhU4dsXQmQ7hFKNFIVhZEl2p8fCN1YufsRaA\"){kind=spacer}
\n\n- \n
The merchant initiates the purchase via the create purchase API. If successful, they receive PayIn details along with a checkout URL in the response JSON
\n \nThe merchant then has 2 options
\n- \n
Redirect the end-user to the checkoutURL present in the response, where the customer is shown the following details required to make Interac payments:
\n- \n
Payment Amount
\n \nDeposit email address
\n \nSecret Question
\n \nSecret Answer
\n \n
\nRetrieve the PayIn details in the response JSON (as shown below) to create a webpage within the merchant’s IT estate, and show to user the PayIn instruction
\n \n
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2a was employed, the user would be redirected to the appropriate success or failure redirect URL.
\n \n
\"payInDetails\": {\n \"name\": \"INTERAC-ETRANSFER\",\n \"emailAddress\": \"deposit@ieft.ca\",\n \"secretQA\": \"6789df35bbefe612e3cb4641\",\n \"secretAnswer\": \"PS7466835\"\n }\n\nTo Initiate a payment, the very first call to make is /payout/
\nwith the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"57f6b692-d141-4483-b883-ca2ef9ef9dc2","id":"57f6b692-d141-4483-b883-ca2ef9ef9dc2","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6e9144ee-11ae-47c7-9a79-e45d5c2a9c63","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"phone\": \"+14378817874\",\r\n \"email\": \"gouridausa+2@gmail.com\",\r\n \"full_name\": \"Pay secure\",\r\n \"stateCode\": \"CT\",\r\n \"country\": \"CA\",\r\n \"city\": \"Torronto\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\"\r\n },\r\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\r\n \"purpose\": \"entertainment\",\r\n \"currency\": \"CAD\",\r\n \"amount\": 5.00,\r\n \"success_redirect\": \"https://success.com\",\r\n \"failure_redirect\": \"https://failure.com\",\r\n \"pending_redirect\": \"https://pending.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_type\": \"Payout\",\n \"payoutId\": \"69cd1236e36738557e988399\",\n \"client\": {\n \"_type\": \"PClientDetails\",\n \"customerId\": \"NA\",\n \"email\": \"gouridausa+2@gmail.com\",\n \"phone\": \"+14378817874\",\n \"full_name\": \"Ashish Mistry\",\n \"date_of_birth\": null,\n \"street_address\": \"test test\",\n \"country\": \"CA\",\n \"city\": \"Torronto\",\n \"zip_code\": \"234567\",\n \"documentId\": null,\n \"documentType\": null,\n \"spei_clabe\": null,\n \"spei_debitCard\": null,\n \"spei_mobileNo\": null,\n \"stateCode\": \"CT\"\n },\n \"updated_on\": 1775047222,\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"beneficiaryDetail\": null,\n \"amountUnit\": \"MAJOR\",\n \"amount\": 5,\n \"errorMsg\": \"paid\",\n \"issued\": \"2026-04-01\",\n \"responseMsg\": null,\n \"purpose\": \"Transfer Interac\",\n \"created_on\": 1775047222,\n \"custUniqueId\": \"ashishm.21190@gmail.com\",\n \"amount_in_usd\": 3.6,\n \"merchantRef\": \"69cd1236e36738557e988399\",\n \"instruction\": null,\n \"merchant_id\": null,\n \"usePrivateKey\": null,\n \"merchantName\": null,\n \"agentId\": 0,\n \"parentId\": 0,\n \"whiteId\": 0,\n \"year\": null,\n \"month\": null,\n \"day\": null,\n \"hour\": 12,\n \"bankid\": null,\n \"setCurr\": \"CAD\",\n \"pspReference\": null,\n \"bankmid\": null,\n \"bankname\": null,\n \"status\": \"paid\",\n \"status_history\": [\n {\n \"_type\": \"Status\",\n \"status\": \"created\",\n \"timestamp\": 1775047222,\n \"updatedBy\": null,\n \"paidReason\": null\n },\n {\n \"_type\": \"Status\",\n \"status\": \"paid\",\n \"timestamp\": 1775047239,\n \"updatedBy\": null,\n \"paidReason\": null\n }\n ],\n \"viewedOn\": null,\n \"currency\": \"CAD\",\n \"actionStatus\": {\n \"_type\": \"ApiError\",\n \"message\": null,\n \"actualMessage\": null,\n \"merchantName\": null,\n \"code\": \"success\",\n \"status\": \"paid\",\n \"callback_url\": null,\n \"method\": null,\n \"beneficiaryId\": null,\n \"profileId\": null,\n \"payInBankDetail\": null,\n \"pix_payload\": null,\n \"payInDetails\": {\n \"_type\": \"PayInDetail\",\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"ashishm.21190@gmail.com\",\n \"secretQA\": \"q691236367385579883992851\",\n \"secretAnswer\": \"a691236367385579883992851\",\n \"reference_number\": null,\n \"payment_method\": null,\n \"transaction_expiry\": null,\n \"qrCode\": null,\n \"gpayUri\": null,\n \"phonepeUri\": null,\n \"paytmUri\": null,\n \"intentUri\": null,\n \"generatedLink\": null,\n \"instruction\": null,\n \"paymentUrl\": null,\n \"script\": null,\n \"clabe\": null,\n \"beneficiary\": null,\n \"amount\": null,\n \"linkExpiresOn\": null,\n \"cardExpiresOn\": null,\n \"subStatus\": null\n },\n \"balance\": null,\n \"vab\": null,\n \"authKey\": null,\n \"methodExecutionTime\": null,\n \"password\": null,\n \"salt\": null,\n \"nextCall\": null,\n \"nextURL\": null,\n \"descriptor\": null,\n \"currentTime\": 1775047239,\n \"custVerificationString\": null,\n \"instructions\": null,\n \"trustScore\": null,\n \"trustLevel\": null,\n \"no_Of_Cust_Hits\": null,\n \"no_Of_Hits\": null,\n \"referer\": null,\n \"clientIp\": null,\n \"merchantIp\": null,\n \"isS2s\": null,\n \"otp\": null,\n \"userDeviceId\": null,\n \"isAllowed\": null,\n \"logo_url\": null,\n \"transactionExpireInMin\": null,\n \"mandateReferenceId\": null\n },\n \"fx_Currency\": null,\n \"fx_Amount\": null,\n \"referer\": null,\n \"clientIp\": \"95.217.22.130\",\n \"merchantIp\": \"95.217.22.130\",\n \"transFees\": null,\n \"MDR\": null,\n \"ruleName\": \"Rule_Not_Applied\",\n \"cascade_Num\": null,\n \"conversionRiskFactorApplied\": null,\n \"feesDeducted\": 0,\n \"signature\": null,\n \"puId\": \"\",\n \"uId\": 0,\n \"authKey\": \"\",\n \"currency_conversion\": null,\n \"success_callback\": \"\",\n \"failure_callback\": \"\",\n \"success_redirect\": \"https://success.com\",\n \"failure_redirect\": \"https://failure.com\",\n \"pending_redirect\": \"https://pending.com\"\n}"},{"id":"b68c4d75-64a9-4719-b0b7-27a5ce673484","name":"create payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"phone\": \"+14378817874\",\n \"email\": \"gouridausa+2@gmail.com\",\n \"full_name\": \"Pay secure\",\n \"stateCode\": \"CT\",\n \"country\": \"CA\",\n \"city\": \"Torronto\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\"\n },\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"purpose\": \"entertainment\",\n \"currency\": \"CAD\",\n \"amount\": 5.00,\n \"success_redirect\": \"https://success.com\",\n \"failure_redirect\": \"https://failure.com\",\n \"pending_redirect\": \"https://pending.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Insufficient Balance [5.23]\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"6285014e-7757-494e-a52a-3f674e461af7"},{"name":"Get Status","id":"1febcfd0-2d97-4054-bf4b-d5ff9796b0af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"57f6b692-d141-4483-b883-ca2ef9ef9dc2","id":"57f6b692-d141-4483-b883-ca2ef9ef9dc2","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8cecfe91-70cb-4a1f-9b8b-666513720be3","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"66bf2e76e3defc36cd575481\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Ashish Mistry\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1723805728,\n \"payoutMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 12,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1723805302,\n \"merchantRef\": \"66bf2e76e3defc36cd575481\",\n \"merchantName\": \"arunsinghal\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1723805302\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1723805310\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1723805728\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1738750221\n }\n ],\n \"viewedOn\": 1738750221,\n \"currency\": \"USD\",\n \"paymentOn\": 1723805728,\n \"payOutDetails\": {\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"ashishm.21190@gmail.com\",\n \"secretQA\": \"q66276336575481202\",\n \"secretAnswer\": \"a66276336575481202\"\n },\n \"success_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\",\n \"failure_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\"\n}"},{"id":"f97b9603-1fdc-4361-ae1a-49cf689c397c","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"1febcfd0-2d97-4054-bf4b-d5ff9796b0af"}],"id":"57f6b692-d141-4483-b883-ca2ef9ef9dc2","description":"API Flow
\n![](\"https://lh7-us.googleusercontent.com/Uxy8jmp5RP-c360-oIMAZy2As8naqJdARgKsWU0x_BtszfJlwdRVM6-obffbtjTABfI9V0hxH4Ad-Ns96We42lIMdL434tTzLJ6aEQBt0dzX_ZXeM4RtG_kmEeem7WIsN520Zh5PS3xTFYNzOmks0ak\")
\n\n- \n
The merchant initiates a PayOut via the payout API.
\n \nAfter a successful or failed payment attempt, the status is reflected on the response, and the details on the status history. You can also get the status through getStatus (purchases/{payID}) API.
\n \n
API for checking available balance
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \n
Note: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.
\n","urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"15cdf23d-0f5c-4fa2-a6ca-3bed86c7fcda","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\n \"status\": \"success\",\n \"data\": [\n {\n \"currency\": \"AUD\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"BRL\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"EUR\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"INR\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"JPY\",\n \"balance\": \"0.00\"\n },\n {\n \"currency\": \"USD\",\n \"balance\": \"0.00\"\n }\n ]\n}"},{"id":"b4503189-c378-4109-b803-dbc9ff982712","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"No currency account found\"\n}"}],"_postman_id":"9b940b63-d3ae-46e5-88e0-914e274f7036"}],"id":"331fc9ae-44b2-4f2b-9f7b-e27a9c5ed1a2","_postman_id":"331fc9ae-44b2-4f2b-9f7b-e27a9c5ed1a2","description":""}],"id":"0157d363-ae87-4aa5-9197-f05993504b91","_postman_id":"0157d363-ae87-4aa5-9197-f05993504b91","description":""},{"name":"🇨🇦 Interac Request Money","item":[{"name":"Concepts","item":[],"id":"8b8ad1e2-9b08-4cea-993e-3f8426b85c95","description":"PayIn Flows
\nHow It Works
\nWith Interac Request Money, payments are made seamless and secure. Customers are provided with a deposit link upon initiating a transaction on the merchant's website. They are redirected to a secure payment page, where their bank is selected, and the payment is completed effortlessly. Payments are processed instantly, ensuring real-time confirmation and updates. This method enhances the checkout experience, builds customer trust, and increases conversions, making it an ideal choice for businesses seeking a reliable payment solution.
\nKey Steps
\nFlow
\n- \n
Initiate Transfer Request: Upon the custeomer's intent to pay, the merchant calls the
\n/purchasesAPI withINTERAC-REQUEST-MONEYin the Payment Method Param, to initiate a PayIn (deposit/collections) transaction. This request includes the customerʼs email address, mobile number, the amount to be collected, and an optional message. With this method, the customer do not need any security question and answer to proceed with the payment. \nDeposit Link:
\n- \n
- A unique deposit link is generated and presented to the customer. This link will be valid for 24 hrs. This time cannot be changed. \n
\nRedirection to Payment Page:
\n- \n
The customer is redirected to the deposit link and shown payment details:
\n- \n
Amount due.
\n \nA list of supported banks.
\n \n
\n
\nBank Selection:
\n- \n
The customer selects their bank from a dropdown menu.
\n \nThey are redirected to their banking portal.
\n \n
\nPayment Confirmation:
\n- \n
The customer logs into their banking portal
\n \nCompletes the payment on their banking app/website.
\n \nInstant payment confirmation is displayed on the merchant’s website.
\n \nThe customer’s balance is updated.
\n \n
\n
PayOut flows
\nHow it works
\nPaysecure offers the ability to make payouts to customers', individuals', or
businesses' bank accounts using Interac e-Transfers. Whether for refunds,
rewards, or other types of disbursements, the Interac Payouts API ensures
efficient and reliable transactions, supporting real-time fund transfers and
comprehensive transaction tracking.
Key Steps
\nFlow
\n- \n
Initiate Payout Request: The merchant calls
\n/payoutAPI. This request includes the customerʼs email address or mobile number, the amount to be transferred, and an optional message. the Payout Method isPAYOUT-INTERAC-REQUEST-MONEY.\nGenerate Security Question & Answer (Optional): If necessary, the merchant can show the security question and answer (received in the response) that the customer may need to provide to receive the funds, adding an extra layer of security.
\n \nSend Notification: The customer receives an email notification with payout instructions. If the customerʼs Interac auto deposit is turned on, the funds will automatically be deposited to the customerʼs designated account, without needing to enter the security question and answer.
\n- \n
- If customer's auto-deposit is turned off, The customer logs into their banking portal, follow the payment instructions and completes the payment. \n
\nConfirm Payout Completion: Upon successful payout, a success webhook will be received, with information about the transaction along with the status.
\n \nUpdate Merchantʼs Account: The merchantʼs system updates the customerʼs account balance to reflect the withdrawn funds.
\n \n
Transaction Limits:
\nThe limits outlined below are generally for personal accounts and can vary by financial institution and account type. For business accounts, higher limits may apply. It’s advisable to check with your bank for the most accurate limits pertaining to your account
\nPay Ins:
\nPay Outs:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"38a3f7a8-dd06-4bed-8e0f-22be9f67291f","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ecbce1f9-ff11-4b3b-bdf5-249005e9e032","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"8b8ad1e2-9b08-4cea-993e-3f8426b85c95"},{"name":"PayIn API","item":[{"name":"Create Purchase","id":"58a3f40d-37aa-4949-96dc-1bd772ee1e77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"MALE\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 1\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"brand_id\": \"0cea7af3-23b2-4278-ab94-acf4076cbee4\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a2db96ff-e627-435f-8640-a67f863f9ab9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"MALE\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 1\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"brand_id\": \"0cea7af3-23b2-4278-ab94-acf4076cbee4\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"670cb0affcc7f4706acb65e0\",\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"gender\": \"MALE\",\n \"avatarUrl\": \"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1728884911,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1728884911,\n \"merchantRef\": \"670cb0affcc7f4706acb65e0\",\n \"merchantName\": \"ajay03\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"1440\",\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"CAD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1728884911,\n \"remote_paid_on\": 1728884911\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"r4\",\n \"brand_name\": \"r4\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-DEBIT\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"110.235.229.9\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-DEBIT\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC-DEBIT\",\n \"processing_time\": 1728884911,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-DEBIT\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1728884911\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1728884911\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1728884911\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"0cea7af3-23b2-4278-ab94-acf4076cbee4\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS3\",\n \"issued\": \"2024-10-14\",\n \"due\": 1728884911,\n \"refund_upto\": 1744433315,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 1,\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.url\",\n \"failure_callback\": \"https://your.success.failure.url\",\n \"platform\": \"API\",\n \"created_from_ip\": \"110.235.229.9\",\n \"checkout_url\": \"https://api.paysecure.net/payments/670cb0affcc7f4706acb65e0/\",\n \"payoutProcess\": false\n}"},{"id":"4739c817-68d9-4f7f-abed-9312cd589383","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"London\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\n \"country\": \"CA\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\",\n \"gender\": \"MALE\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test \",\n \"price\": 1\n }\n ]\n },\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\n \"brand_id\": \"0cea7af3-23b2-4278-ab94-acf4076cbee4\",\n \"success_redirect\": \"https://your.redirect.url/getResponse\",\n \"failure_redirect\": \"https://your.redirect.url/getResponse\",\n \"success_callback\": \"https://your.success.callback.url\",\n \"failure_callback\": \"https://your.success.failure.url\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"58a3f40d-37aa-4949-96dc-1bd772ee1e77"},{"name":"Get Status","id":"a2460696-94a9-4ab8-919e-223be957f99b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a488dd65-61ba-4a55-8f86-38dcbeb75d91","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"670cb0affcc7f4706acb65e0\",\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"CA\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"gender\": \"MALE\",\r\n \"avatarUrl\": \"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1728884911,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1728884911,\r\n \"merchantRef\": \"670cb0affcc7f4706acb65e0\",\r\n \"merchantName\": \"ajay03\",\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1,\r\n \"price\": 1,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1,\r\n \"expireInMin\": \"1440\",\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1,\r\n \"currency\": \"CAD\",\r\n \"net_amount\": 1,\r\n \"fee_amount\": 0,\r\n \"pending_amount\": 0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1728884911,\r\n \"remote_paid_on\": 1728884911\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"r4\",\r\n \"brand_name\": \"r4\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1,\r\n \"masked_pan\": \"INTERAC-DEBIT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"110.235.229.9\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"INTERAC-DEBIT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"INTERAC-DEBIT\",\r\n \"processing_time\": 1728884911,\r\n \"extra\": {\r\n \"amount\": 1,\r\n \"masked_pan\": \"INTERAC-DEBIT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1728884911\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1728884911\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1728884911\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1728884911\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"0cea7af3-23b2-4278-ab94-acf4076cbee4\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS3\",\r\n \"issued\": \"2024-10-14\",\r\n \"due\": 1728884911,\r\n \"refund_upto\": 1744433315,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1,\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.9\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/670cb0affcc7f4706acb65e0/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"0ea8a8ff-e534-4530-a89c-1eeb2ba886e0","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"a2460696-94a9-4ab8-919e-223be957f99b"}],"id":"e4bb36f6-8725-47e4-b399-41d327597bcb","description":"API Flow
\n- \n
The merchant calls the INTERAC-REQUEST-MONEY /purchases API to initiate a Payin (deposit/collections) transaction.
\n \nPayment link is generated, and customer is redirected to follow the payment instructions.
\n \nAfter successful or failed payment by the end user, an appropriate webhook would be sent back to the merchant.
\n \n
To Initiate a payment, the very first call to make is /payout/
\nwith the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3004222a-d09c-4a2c-861d-7f22f4262854","id":"3004222a-d09c-4a2c-861d-7f22f4262854","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"547d7cc6-5794-4558-a04c-1bb0f0c6b7bb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"670cb200fcc7f4706acb6759\",\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Ashish Mistry\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1728885248,\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1728885248,\n \"merchantRef\": \"670cb200fcc7f4706acb6759\",\n \"status\": \"PAYOUT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1728885248\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1728885253\n }\n ],\n \"currency\": \"CAD\",\n \"paymentOn\": 0,\n \"payOutDetails\": {\n \"emailAddress\": \"ashishm.21190@gmail.com\",\n \"secretQA\": \"q670200747066759362\",\n \"secretAnswer\": \"a670200747066759362\"\n },\n \"success_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\",\n \"failure_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\"\n}"},{"id":"e42327f5-0a2f-4503-bb4f-7350b72cd6f1","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-REQUEST-MONEY\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"1c2a5432-07a0-45a6-b634-f46e9118db66"},{"name":"Get Status","id":"180253bc-2864-4037-a867-0b3f6fd87922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"3004222a-d09c-4a2c-861d-7f22f4262854","id":"3004222a-d09c-4a2c-861d-7f22f4262854","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"86aacfea-f125-4218-a781-b9498b170f62","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"670926784600a76f8d8a1b43\",\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Ashish Mistry\",\n \"country\": \"CA\"\n },\n \"updated_on\": 1728653103,\n \"payoutMethod\": \"PAYOUT-INTERAC-DEBIT\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1728652920,\n \"merchantRef\": \"670926784600a76f8d8a1b43\",\n \"merchantName\": \"Ajay002\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1728652920\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1728652924\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1728653103\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1729154507\n }\n ],\n \"viewedOn\": 1729154507,\n \"currency\": \"CAD\",\n \"paymentOn\": 1728653103,\n \"payOutDetails\": {\n \"emailAddress\": \"ashishm.21190@gmail.com\",\n \"secretQA\": \"q6709267846007688143362\",\n \"secretAnswer\": \"a6709267846007688143362\"\n },\n \"success_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\",\n \"failure_callback\": \"https://webhook.site/d7660184-d724-480c-bad0-cf0480f5518e\"\n}"},{"id":"3e28a6ed-1375-43d2-bbb2-a5afa6aea8e5","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"180253bc-2864-4037-a867-0b3f6fd87922"}],"id":"3004222a-d09c-4a2c-861d-7f22f4262854","description":"API Flow
\n\n\n- \n
The merchant initiates a PayOut via the payout API.
\n \nRetrieve the PayOut details in the response JSON, where the customer is shown the following details required to make Interac payout: Security Question, Security Answer
\n \nAfter a successful or failed payment attempt, the status is reflected on the response, and the details of the status history. You can also get the status through getStatus (purchases/{payID}) API.
\n \n
API for Checking Balance payout
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \n
Note: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e58689d5-c4b5-49fe-bd14-20b977cd01cc","id":"e58689d5-c4b5-49fe-bd14-20b977cd01cc","name":"Get Balance API","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"840b686b-dd98-48e2-9796-d5761a07ca15","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"currency\": \"CAD\",\r\n \"balance\": \"2.22\",\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\",\r\n \"status\": \"success\"\r\n}"},{"id":"2081ceb2-9cc5-42b4-ae70-9157ef11c3c1","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"INTERAC-REQUEST-MONEY\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}"}],"_postman_id":"1b34e9b6-d640-4a22-8c74-c5f68601b8c2"}],"id":"e58689d5-c4b5-49fe-bd14-20b977cd01cc","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"17932c18-6a06-463b-ad8d-e527e11d9592","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"61223523-081b-4263-bf8f-f900174a1c5d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"e58689d5-c4b5-49fe-bd14-20b977cd01cc","description":""}],"id":"91ea0bd8-d11f-4d1c-b213-c7eb984b59ec","description":"Interac Request Money Overview
\nInterac is a leading Canadian payment network that facilitates secure, real-time transactions between bank accounts. It offers multiple payment methods, including Request Money.
\nInterac Request Money method allows users to send and receive money directly between bank accounts using payment link. It provides a fast, secure, and convenient alternative to traditional payment methods, accessible through most Canadian banks' online and mobile banking platforms.
\nInterac Request Money payment suite enables merchants to initiate:
\n- \n
PayIns: Consumers can utilise Interac e-Transfer to transfer funds from their bank account, through their bank’s app or website.
\n \nPayouts: Facilitate real-time disbursements directly to consumers' accounts.
\n \n
Customer Payment Journey
\n- \n
Merchant creates a payment request via Paysecure API and receives a Reference ID.
\n \nCustomer is shown the Reference ID, the recipient email/mobile, and the exact amount.
\n \nCustomer logs into their bank and initiates a transfer using these details.
\n \nCustomer must input the Reference ID in the message/memo field of the transfer.
\n \nPaysecure matches the Reference ID and the payment amount to validate the transaction.
\n \n
Edge Cases
\n- \n
Incorrect or Missing Reference ID: Payment cannot be matched. The transaction will not be marked as successful and the amount will be auto-refunded after the transaction expires.
\n \nOverpayment: The transaction will be marked as Paid and the excess amount will be auto-refunded to the customer.
\n \nUnderpayment: The transaction remains in In Progress status. The customer can:
\n- \n
Pay the remaining amount using the same Reference ID, which will update the status to Paid, OR
\n \nWait for expiry, after which the initial payment is auto-refunded.
\n \n
\nExpired Transactions: All transactions are valid for 24 hours. Any payment made after expiry is auto-refunded.
\n \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThe purchase.expireInMin, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
However, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2a2b3ac4-b498-46c0-9ea3-ed254bd28938","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-EXPRESS\",\r\n \"brand_id\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6890aba7faa4173bbbbb76c6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"seo2009@test.com\",\n \"phone\": \"+447755564318\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1754311599,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-EXPRESS\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1754311591,\n \"extraParam\": {\n \"reference\": \"wkdjabf43\"\n },\n \"merchantRef\": \"6890aba7faa4173bbbbb76c6\",\n \"merchantName\": \"arunsinghal\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1.0,\n \"price\": 100.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"expireInMin\": \"1440\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 100.0,\n \"currency\": \"CAD\",\n \"net_amount\": 100.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1754311592,\n \"remote_paid_on\": 1754311592\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"INTERAC-EXPRESS\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.176, 104.23.216.90, 18.68.12.74\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-EXPRESS\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC-EXPRESS\",\n \"processing_time\": 1754311592,\n \"extra\": {\n \"amount\": 100.0,\n \"masked_pan\": \"INTERAC-EXPRESS\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1754311591\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1754311592\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1754311599\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS1060\",\n \"issued\": \"2025-08-04\",\n \"due\": 1754311591,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"payInDetails\": {\n \"name\": \"INTERAC E-TRANSFER\",\n \"emailAddress\": \"fund@ieft.ca\",\n \"reference_number\": \"8g1lya\"\n },\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.176, 104.23.216.90, 18.68.12.74\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6890aba7faa4173bbbbb76c6/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"f306faf8-2432-4c74-bfc0-859a63632697"}],"id":"df3c815e-af7b-42e0-903c-cccb8a5f8502","description":"How It Works
\nInterac-Express uses a Reference ID-based flow to streamline collections. Merchants generate a transaction-specific ID which customers must include when transferring funds from their bank account. This ensures precise, secure, and automated payment reconciliation.
\nKey Steps
\nFlow:
\n- \n
Initiate Payment Request
\n
Merchant initiates a PayIn by calling the/purchasesAPI. The request must include:- \n
\npaymentMethod:INTERAC-EXPRESS\nCustomer email or mobile
\n \nAmount
\n \nOptional message
\n \n
\nReference ID Generation
\n
Paysecure returns a uniqueReference IDassociated with the transaction. This ID is valid for 24 hours and must be included by the customer in the message/memo field during their bank transfer. \nCustomer Transfer
\n
The customer logs into their online or mobile banking, inputs the transfer amount, adds the Paysecure-provided email or mobile, and includes the Reference ID exactly as provided. \nValidation & Matching
\n
Paysecure validates the incoming transfer by matching the Reference ID and amount.- \n
If matched correctly, the transaction is marked as successful.
\n \nSee edge cases above for incorrect, underpaid, overpaid, or expired scenarios.
\n \n
\nWebhook Notification
\n
Once the transfer is matched and verified, Paysecure sends a webhook to the merchant with full transaction details and status. \nMerchant Reconciliation
\n
Merchant updates the customer account or order status based on the received webhook data. \n
To Initiate a payment, the very first call to make is /payout/
\nwith the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\n","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"249cde06-9ec3-435d-ae65-0d72ca36e9e4","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"brandId","value":"your-brand-id","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"ashishm.21190@gmail.com\",\r\n \"country\": \"CA\",\r\n \"phone\": \"+14377717874\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"purpose\": \"test payout\",\r\n \"currency\": \"CAD\",\r\n \"payoutMethod\": \"PAYOUT-INTERAC-EXPRESS\",\r\n \"amount\": 10,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"67efc0586720dd3a164fe8b3\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"CA\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test Person-uk\"\n },\n \"updated_on\": 1743765592,\n \"payoutMethod\": \"PAYOUT-INTERAC-EXPRESS\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 10,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1743765592,\n \"merchantRef\": \"67efc0586720dd3a164fe8b3\",\n \"merchantName\": \"arunsinghal\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1743765592\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1743765610\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1744025266\n }\n ],\n \"viewedOn\": 1744026844,\n \"currency\": \"CAD\",\n \"paymentOn\": 1743765610,\n \"success_callback\": \"https://success.com\",\n \"failure_callback\": \"https://failure.com\"\n}"}],"_postman_id":"beb5ce5e-de69-4e81-8d7d-b469399e388a"}],"id":"970c9e16-f400-410a-8fc7-9c8a34e1e6e3","description":"How It Works
\nMerchants can send funds to customers using Interac-Express by specifying the recipient’s email or mobile. Funds are typically delivered in real-time, depending on the recipient’s bank setup.
\nKey Steps
\nFlow:
\n- \n
Initiate Payout Request
\n
Merchant initiates a payout using the/payoutAPI, passing:- \n
\npaymentMethod:INTERAC-EXPRESS\nRecipient email or mobile number
\n \nAmount
\n \nOptional message
\n \n
\nRecipient Notification
\n
The customer receives a notification from their bank to accept the incoming funds. If the recipient has Auto-Deposit enabled, funds are deposited instantly. Otherwise, the customer must manually claim the payment via the bank’s standard process. \nWebhook Confirmation
\n
Paysecure notifies the merchant via webhook once the payout has been successfully claimed or credited. \nUpdate Records
\n
Merchant updates the customer's profile or balance based on payout status. \n
\n","_postman_id":"970c9e16-f400-410a-8fc7-9c8a34e1e6e3"}],"id":"a9bd276c-9cf0-4c98-bb80-95ca796ec3f2","description":"
Overview
\nInterac-Express is a real-time Canadian payment method that enables secure bank-to-bank transfers through customer-initiated actions via their banking apps or websites. It’s designed for fast, reference-based validation—no security questions, no delays.
\nPaysecure enables merchants to use Interac-Express for:
\n- \n
PayIns: Customers initiate bank transfers referencing a unique ID tied to their transaction.
\n \nPayouts: Businesses can send funds directly to customer accounts in near real-time.
\n \n
PayIn Flows
\nHow it works
To initiate a PIX payment, a payer can scan the code using their PIX payment app (such as Itau, NuBank, etc).
These codes comply with BCB’s infrastructure requirements to ensure that the merchant's details are stored securely and there are no errors during the payment journey.
Key Steps
\n![](\"https://lh7-us.googleusercontent.com/UcxDawvzgu9zw6gCa8i_KrzNRn2baEIsJOJfAkuyBWu9yl3Hky5JyA0xQnNrT18ovLe4Lwl2sdD0kjKMFQUrYUMvnKimvRbxLio0pd5xjNy63PlYeV4phxMspF6sYGLug0OHaw__oWW8UE8m2Nt-3XA\")
\n\nFlow
\n- \n
Merchant platforms can create a dynamic QR code by passing the relevant parameter using Paysecure’s API.
\n \nThe platform can display the dynamic QR code on its app or any website at checkout or on a third-party app.
\n \nThe payer scans the QR code from the PIX app of their choice on their mobile.
\n \nThe payer authorizes the transaction on the app by entering a valid PIN.
\n \nOnce the payment is done, the merchant platform receives a transaction status callback from Paysecure to a pre-configured endpoint.
\n \nThe platform can also check the request status using the reference ID generated from the collection request using the Check Payment Status API.
\n \n
PayOut flows
\nHow it works
\nTo initiate a payout, the merchant has to give Paysecure the PIX details such as the recipient's PIX key (e.g., CPF/CNPJ, phone number, or email), amount, and any additional information.
\nIf the merchant has enough balance, then the transaction amount will be deducted from the merchant balance and sent to the user.
\nKey Steps
\n![](\"https://lh7-us.googleusercontent.com/ezT3e0yYTc3TGWJ87RKK6sQpMhbgfr5Q-NfSMxnjz4WTxMJs5tr9-mUME-a2PpvYtA8QOrrKGw29dQFHdGcLsBiNW-jF-xiFxbuJZa0a7jd-zI3aIe6mO-JVSj6NIwiTyvBU_VVGGLdtOrjmX8Usf1k\")
\n\nFlow
\n- \n
Initiation:
\n- \n
User initiates: The process starts with a user requesting payout from the merchant.
\n \nMerchant approval: if everything is OK, the merchant approves payout request
\n \n
\nProcessing:
\n- \n
Payment details: Using Paysecure’s API, the merchant provides the recipient's Pix key (which can be a phone number, email, CPF/CNPJ, or random key) and the transfer amount.
\n \nFunds check: Paysecure verifies if sufficient funds are available in the merchant account to cover the transfer.
\n \nProcessing & Key mapping: the recipient's Pix key is validated using the DICT (Transactional Identifier Directory). This central database links Pix keys with users' bank accounts.
\n \n
\nPayout:
\n- \n
- Instant transfer: If everything checks out, the payer's bank instantly transfers the funds to the recipient's bank account. The recipient typically receives confirmation messages from their respective bank about the successful transaction. \n
\n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nRequest Body Parameters:
\nNote: the object “pix_payload.payload” contains all the necessary fields to create a page containing a QR code and other information on the merchant portal. The field “pix_payload.qr_code” value is in Base64. This can be used to show the QR code image. The field \"pix_payload.expiration_date\" is in UTC time.
\nEssential Optional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"61e7905f-af6e-41a3-910a-22b56594ed9c","id":"61e7905f-af6e-41a3-910a-22b56594ed9c","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"16d67c87-cf25-4407-a4a6-ddb409f890b5","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"tax_number\": \"39933551809\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"BRL\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"PIX\",\r\n \"merchantRef\": \"test12\",\r\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"65f9368cb905381ba207b3c4\",\n \"client\": {\n \"email\": \"test@gmail.com\",\n \"full_name\": \"test test\",\n \"country\": \"BR\",\n \"city\": \"Brasília\",\n \"stateCode\": \"SP\",\n \"street_address\": \"Praça da Bíblia 1308\",\n \"zip_code\": \"57312-140\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+558262362732\",\n \"tax_number\": \"39933551809\"\n },\n \"updated_on\": 1710831244,\n \"type\": \"purchase\",\n \"paymentMethod\": \"PIX\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1710831244,\n \"merchantRef\": \"65f9368cb905381ba207b3c4\",\n \"merchantName\": \"test\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"price\": 10\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"total_formatted\": 1,\n \"timezone\": \"MIT\"\n },\n \"issuer_details\": {\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"newbrand\",\n \"brand_name\": \"newbrand\"\n },\n \"transaction_data\": {},\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1764922723\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1764922723\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1764922727\n }\n ],\n \"pix_payload\": {\n \"payload\": \"00020101021226800014br.gov.bcb.pix2558pix.asaas.com/qr/cobv/e3eb36eb-7e9b-404d-9bd3-b486a42da3445204000053039865802BR5925A55 CONSULTORIA EM CREDIT6009Sao Paulo61080455202062070503***630451CA\",\n \"qr_code\": \"iVBORw0KGgoAAAANSUhEUgAAAZ8AAAGfCAIAAAAPgEjDAAAP4UlEQVR42u3bUY7cSA4EUN … ..\",\n \"expiration_date\": \"2025-03-27 23:59:59\"\n },\n \"is_test\": false,\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS2696\",\n \"issued\": \"2024-03-19\",\n \"due\": 1710831244,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"183.83.53.0\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/33ddc21c6073a7ac722288f0b2ec35be/\",\n \"payoutProcess\": false\n}"},{"id":"6bd612b1-cdba-4f33-a8f6-9f6c40ff6733","name":"Purchase-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"tax_number\": \"39933551809\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"BRL\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"PIX\",\r\n \"merchantRef\": \"test12\",\r\n \"brand_id\": \"90ed1084-6753-465d-8a21-e2cc604ff814\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Brand not found!\",\n \"code\": \"transaction_error\"\n}"}],"_postman_id":"9dc2c43e-b2c8-4eae-bdb4-2da4b2e1e1bb"},{"name":"Get Status","id":"3ebf2e9a-a957-4cd1-bf33-0e71471e6f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase, including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f768d1ee-4c4b-4e5c-9a88-d3aab292a316","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"65f9368cb905381ba207b3c4\",\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"Test test\",\r\n \"tax_number\": \"39933551809\"\r\n },\r\n \"updated_on\": 1710831244,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1710831244,\r\n \"merchantRef\": \"65f9368cb905381ba207b3c4\",\r\n \"merchantName\": \"test\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"price\": 10.0\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"total_formatted\": 1.0,\r\n \"timezone\": \"MIT\"\r\n },\r\n \"issuer_details\": {\r\n \"bank_accounts\": [\r\n {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\"\r\n }\r\n ],\r\n \"legal_name\": \"newbrand\",\r\n \"brand_name\": \"newbrand\"\r\n },\r\n \"transaction_data\": {},\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831244\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS2696\",\r\n \"issued\": \"2024-03-19\",\r\n \"due\": 1710831244,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"223.182.100.34\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/65f9368cb905381ba207b3c4/\"\r\n}\r\n"},{"id":"7e8adca0-f65d-44b8-8146-4a49aeb24664","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"3ebf2e9a-a957-4cd1-bf33-0e71471e6f06"}],"id":"61e7905f-af6e-41a3-910a-22b56594ed9c","description":"API Flow
\n![](\"https://lh7-us.googleusercontent.com/QiIrZmMWISniXvk4h0Wpq5y4QDrWlUNK8cVUra7HhfDL9B12sdZv7kwGJ24R8Hs6AKPLRKZJafk1p5S3jCikw0V1lIBTVUy67hEgNRNNjH5Q2HysOP-3HlHZAjZiVvPsohyopIwZA48ejeFF0Ul1PX4\"){kind=spacer}
\n\n- \n
Initiate Purchase: The merchant calls the create purchase API to start the purchase process.
\n \nGet Checkout URL: If the API call is successful, the response body contains a checkout URL.
\n \nRedirect Client: The merchant redirects the client to the checkout URL received.
\n \nClient Payment: The client is presented with a QR code to complete the payment.
\n- \n
- Please note that instead of redirecting to the checkout URL, the information to create a page on the merchant’s digital estate itself containing the QR code and other information can be achieved by utilizing the data on the “pix_payload“ object in the response. \n
\nPayment Outcome: After the payment attempt, the client is redirected to a URL indicating success or failure, which was specified in the create purchase API.
\n \nCallback Posting: Upon successful or failed payment, the entire payload of the transaction is posted to designated success or failure callback URLs.
\n \n
This API is used to initate refund of the purchases that have status as PAID
Once the refund has been initiated, the status of the purchase would become REFUND_IN_PROCESS and once the refund has been approved by the bank, the status woud become REFUNDED
Purchase ID is mandatory for this API.
\nIf due to some reason, the refund has failed, the status would again become PAID
Response Examples
\nIn the response examples you can see instances of both successful and unsuccessful in refund of purchases.
To Initiate a payout, the very first call to make is /payout/ API with the required data in the request body.
\nTo generate a PayOut, you are required to provide the API key (in the header), which can be located in the Dashboard section of your merchant account login.
The following (see table below) are the mandatory parameters that are required to create a payout request.
\nMandatory parameters in the request body:
\nAdditional parameters for this usecase:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"30eff71f-84de-4f87-bb03-f17c4693f217","id":"30eff71f-84de-4f87-bb03-f17c4693f217","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e90d4e0d-43ff-45be-bca1-cb7057e096a7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"purpose\": \"payout to test\",\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amount\": 10,\r\n \"currency\": \"BRL\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\",\r\n \"documentType\": \"evp\"\r\n },\r\n \"updated_on\": 1710831765,\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"created_on\": 1710831768,\r\n \"merchantName\": \"test\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831765\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1710831768\r\n }\r\n ],\r\n \"currency\": \"BRL\",\r\n \"purpose\": \"payout to test\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}"},{"id":"51d5f12c-bb41-4f51-b876-c7c0294fec06","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"purpose\": \"payout to test\",\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amount\": 20,\r\n \"currency\": \"BRL\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \r\n \"documentType\": \"evp\"\r\n },\r\n \"updated_on\": 1710831765,\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 20.0,\r\n \"errorMsg\": \"errors.wallet.transfer_balance_insufficient\",\r\n \"created_on\": 1710831768,\r\n \"merchantRef\": \"65f93895c96bae142f7b1765\",\r\n \"merchantName\": \"test\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831765\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1710831768\r\n }\r\n ],\r\n \"currency\": \"BRL\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}\r\n"}],"_postman_id":"6544159d-64d5-45ca-a3e2-51a02d86d2d5"},{"name":"Get Status","id":"c3d3a40b-7a8b-44d6-b763-568d521af133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"30eff71f-84de-4f87-bb03-f17c4693f217","id":"30eff71f-84de-4f87-bb03-f17c4693f217","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"08a3e69a-0314-4f87-8645-bc52b18cce2a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65f93895c96bae142f7b1765\",\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"BR\",\r\n \"city\": \"Brasília\",\r\n \"stateCode\": \"SP\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"57312-140\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+558262362732\",\r\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\",\r\n \"documentType\": \"evp\"\r\n },\r\n \"updated_on\": 1710831765,\r\n \"payoutMethod\": \"Payout-PIX\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"created_on\": 1710831768,\r\n \"merchantName\": \"test\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710831765\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1710831768\r\n }\r\n ],\r\n \"currency\": \"BRL\",\r\n \"purpose\": \"payout to test\",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n}"},{"id":"ddae3566-a77d-4adf-be78-5d6a901c6b1a","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"65f93895c96bae142f7b1765\",\n \"client\": {\n \"email\": \"test@gmail.com\",\n \"full_name\": \"test test\",\n \"country\": \"BR\",\n \"city\": \"Brasília\",\n \"stateCode\": \"SP\",\n \"street_address\": \"Praça da Bíblia 1308\",\n \"zip_code\": \"57312-140\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+558262362732\",\n \"documentId\": \" 97c1c590-554b-4449-a0f1-8da9f9756937\", \n \"documentType\": \"evp\"\n },\n \"updated_on\": 1710831765,\n \"payoutMethod\": \"Payout-PIX\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 20.0,\n \"errorMsg\": \"errors.wallet.transfer_balance_insufficient\",\n \"created_on\": 1710831768,\n \"merchantRef\": \"65f93895c96bae142f7b1765\",\n \"merchantName\": \"test\",\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1710831765\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1710831768\n }\n ],\n \"currency\": \"BRL\",\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\n \"pending_redirect\": \"https://test.com/getResponse.jsp?success=pending\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.com\"\n}"}],"_postman_id":"c3d3a40b-7a8b-44d6-b763-568d521af133"}],"id":"30eff71f-84de-4f87-bb03-f17c4693f217","description":"Payout API Flow
\n![](\"https://lh7-us.googleusercontent.com/C3wVvecNtQw4_DB4-8CRpFabuqko5aLMycrWTkTjyCTHPuK1Of3lNOiyyTV2wKCwT0gLmsFZkfAgJ4sa6NHBp3ea0l6dD9gJAX2FQhOTG4p7pa-YZzQRXY5aHsYOB8uGk76XIcBZ7rLq9G4gHbHnYqU\")
\n\nAPI Steps
\n- \n
The merchant initiates a PayOut via the payout API.
\n \nAfter a successful or failed payment attempt, the status is reflected on the response and the details of the status history.
\n \nTo get the status of the transaction, call “/purchases/{purchaseId}/” API.
\n \n
Fawry Overview
\nFawry is a leading Egyptian payment network that facilitates secure, online and offline transactions across various financial services. It offers multiple payment options, including Fawry Pay, enabling seamless transactions between businesses and consumers.
\nFawry Pay allows users to make and receive payments directly through various channels, such as retail points, mobile apps, and online platforms. It provides a fast, secure, and convenient alternative to traditional payment methods, accessible through numerous banks and financial institutions in Egypt.
\nPaysecure’s Fawry product suite enables merchants to initiate:
\n- \n
PayIns: Consumers can use Fawry Pay to transfer funds from their bank account or via Fawry’s extensive network of retail locations and online services.
\n \nPayouts*: Facilitate real-time disbursements directly to consumers' accounts or through Fawry's network.
\n \n
*Note: Payouts APIs are under development and will be availabe soon
\nPayIn Flows
\nHow it works
\nPaysecure’s Fawry PayIn leverages Fawry’s payment network to support a wide range of collection scenarios. Merchants can initiate payment requests via various channels such as mobile apps, online platforms, or physical retail points, providing secure, efficient, and flexible options for collecting payments from customers.
\nKey Steps
\nPayIn Flow
\n- \n
Initiate Payment: The customer initiates a payment by clicking on a ”Pay with FAWRY” button and selecting the deposit amount on the merchant’s website or app.
\n \nReceive Unique Reference Code: The customer is provided with a unique reference code for the payment.
\n \nGo to Fawry Agent: The customer visits a Fawry agent, which can be any shop or retail location within Fawry’s extensive network.
\n \nProvide Reference Code: The customer provides the unique reference code to the Fawry agent.
\n \nMake Payment: The customer pays the amount due in cash or through available electronic payment methods at the Fawry agent.
\n \nReceive Confirmation: The customer receives a confirmation message indicating that the payment was successful, either via SMS, email, or app notification.
\n \n
Transaction Limits:
\nPay Ins:
\nPay Outs:
\n","_postman_id":"25492c68-43fc-45f3-a849-d90b8f704176"},{"name":"PayIn API","item":[{"name":"Purchases","id":"22e9c043-4797-43d4-90bf-368eb1df18e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"DEEPAKDEEPAKSINGHAL@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"EG\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"FawryPay\",\r\n \"brand_id\": \"{{brand_id}}\",\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e1f3ecda-10d1-4c2d-8fdb-122a04ebdc39","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"DEEPAKDEEPAKSINGHAL@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"EG\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"FawryPay\",\r\n \"brand_id\": \"{{brand_id}}\",\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"667cfb2cf0bd8d672c8fc562\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719466796,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"FAWRYPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719466796,\r\n \"merchantRef\": \"667cfb2cf0bd8d672c8fc562\",\r\n \"instruction\": \"Please use the reference number 9350804722 to pay 10 EGP for this order at Fawrypay store. Complete the payment before 6/29/2024 5:39:59 AM +00:00\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"EGP\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719466796,\r\n \"remote_paid_on\": 1719466796\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"110.235.229.106\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"FAWRYPAY\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"FAWRYPAY\",\r\n \"processing_time\": 1719466796,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719466796\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719466796\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719466796\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10252\",\r\n \"issued\": \"2024-06-27\",\r\n \"due\": 1719466796,\r\n \"refund_upto\": 1735015199,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"reference_number\": \"9350804722\",\r\n \"payment_method\": \"PAYATFAWRY\",\r\n \"transaction_expiry\": \"29 Jun 2024 05:39:59:054 +0000\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.106\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/667cfb2cf0bd8d672c8fc562/\"\r\n}"},{"id":"64625cc5-8472-4df2-ba36-1df834eda4fe","name":"Create Purchase","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"22e9c043-4797-43d4-90bf-368eb1df18e8"},{"name":"Get Status","id":"70919d61-e6e2-4ea9-9872-88f2a350eef5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9dfdeeaa-b8a3-453b-a198-4c50aa71cb00","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"667cfc59f0bd8d672c8fc6c8\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"Test test\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719467097,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"FAWRYPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719467097,\r\n \"merchantRef\": \"667cfc59f0bd8d672c8fc6c8\",\r\n \"instruction\": \"Please use the reference number 9350717665 to pay 10 EGP for this order at Fawrypay store. Complete the payment before 6/29/2024 5:45:00 AM +00:00\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"EGP\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"EGP\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719467097,\r\n \"remote_paid_on\": 1719467097\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"110.235.229.106\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"FAWRYPAY\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"FAWRYPAY\",\r\n \"processing_time\": 1719467097,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"FAWRYPAY\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719467097\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719467097\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719467097\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719467160\r\n }\r\n ],\r\n \"viewedOn\": 1719467160,\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10253\",\r\n \"issued\": \"2024-06-27\",\r\n \"due\": 1719467097,\r\n \"refund_upto\": 1735015500,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"reference_number\": \"9350717665\",\r\n \"payment_method\": \"PAYATFAWRY\",\r\n \"transaction_expiry\": \"29 Jun 2024 05:45:00:245 +0000\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://your.success.redirect.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.106\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/667cfb2cf0bd8d672c8fc562/\"\r\n}"},{"id":"2a337056-e9ed-4dbb-b908-3062d98a8200","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"70919d61-e6e2-4ea9-9872-88f2a350eef5"}],"id":"c8829e83-c0dc-463b-afce-0fa4195e3040","description":"API Flow
\n\n\n- \n
The merchant initiates the purchase via the create purchase API. If successful, they receive PayIn details (Unique Ref Code) along with a checkout URL in the response JSON
\n \nThe merchant then has 2 options
\n- \n
Use the PayIn details in the JSON to create a webpage within the merchant’s IT estate, and show to user the PayIn instruction
\n \nOr direct the end-user to our checkout URL, where the client sees bank details for payment.
\n \n
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2b was the method employed, the user would be redirected to the appropriate redirect URL.
\n \n
To Initiate a payment, the very first call to make is/payout/
\nwith the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\n","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"","value":null},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[{"id":"2db4e2be-2ffc-44f1-af6b-115876831499","name":"create payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"country\" : \"EG\",\r\n \"phone\" : \"9586445444\",\r\n\"full_name\": \"Test Person-uk\",\r\n\"documentId\":\"29206260104051\"\r\n },\r\n \"purpose\" : \"test payout\",\r\n \"currency\" : \"EGP\",\r\n \"payoutMethod\" : \"Payout-fawrypay\",\r\n \"amount\" : 20,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payout/","host":["https://api.paysecure.net/api/v1"],"path":["payout",""],"query":[{"key":"","value":null,"disabled":true},{"key":null,"value":"","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6687d86dde5d5c0feecf7621\",\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"phone\": \"9586445444\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"EG\",\r\n \"documentId\": \"29206260104051\"\r\n },\r\n \"updated_on\": 1720178797,\r\n \"payoutMethod\": \"PAYOUT-FAWRYPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 20.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1720178797,\r\n \"merchantRef\": \"6687d86dde5d5c0feecf7621\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1720178797\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1720178799\r\n }\r\n ],\r\n \"currency\": \"EGP\",\r\n \"paymentOn\": 0,\r\n \"payOutDetails\": {\r\n \"instruction\": \"Please use transaction reference 20514294 with the BTC 77361 at any Fawry store to get cashout within 72 hrs\"\r\n },\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}"},{"id":"40ce6702-3769-418d-9747-0f223e9015d0","name":"create payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"country\" : \"EG\",\r\n \"phone\" : \"9586445444\",\r\n\"full_name\": \"Test Person-uk\",\r\n\"documentId\":\"29206260104051\"\r\n },\r\n \"purpose\" : \"test payout\",\r\n \"currency\" : \"EGP\",\r\n \"payoutMethod\" : \"Payout-fawrypay\",\r\n \"amount\" : 20,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/payout/","host":["https://api.paysecure.net/api/v1"],"path":["payout",""],"query":[{"key":"","value":null,"disabled":true},{"key":null,"value":"","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":" {\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"fc2ca64a-217b-43dd-a24f-3f115e5e07fc"},{"name":"Get Status","id":"45ea3d2c-5629-4518-9244-ab3d597623e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"542f60a8-a4ea-4393-a167-2ffdb78b4386","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6685467c0e5b201a73f91256\",\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"phone\": \"9586445444\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"EG\",\r\n \"documentId\": \"29206260104051\"\r\n },\r\n \"updated_on\": 1720010823,\r\n \"payoutMethod\": \"PAYOUT-FAWRYPAY\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountNumber\": \"123456789011\",\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"IMPS\",\r\n \"ifscCode\": \"SBIN0001077\",\r\n \"payeeName\": \"deepak singhal\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 20.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1720010364,\r\n \"merchantRef\": \"6685467c0e5b201a73f91256\",\r\n \"merchantName\": \"test\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1720010364\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1720010367\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1720010582\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1720010823\r\n }\r\n ],\r\n \"viewedOn\": 1720179568,\r\n \"currency\": \"EGP\",\r\n \"paymentOn\": 1720010823,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}"},{"id":"9266b19d-2b27-4a8b-ad5a-55a65a43fc0b","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"45ea3d2c-5629-4518-9244-ab3d597623e0"}],"id":"b2278ff9-c01f-4717-afe6-38dc2eb43ed9","description":"API Flow
\n\n\n- \n
The merchant initiates a PayOut via the payout API.
\n \nAfter a successful or failed payment attempt, the status is reflected on the response, and the details on the status history. You can also get the status through getStatus (purchases/{payID}) API.
\n \n
API for Checking Balance payout
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \n
Note: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.
\n","urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ebd94aa8-e888-4175-8680-2422b9638f9b","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"paymentMethod\": \"FAWRYPAY\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"AUD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"CAD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"EGP\",\r\n \"balance\": \"-1.20\"\r\n },\r\n {\r\n \"currency\": \"EUR\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"GBP\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"INR\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"NGN\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"USD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"ZAR\",\r\n \"balance\": \"0.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"f8a13b99-1ba4-4601-8a3b-b3a41a82802a","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"INTERAC\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}\r\n"}],"_postman_id":"6178d832-c187-4abf-8d5c-a0da6b147ae2"}],"id":"a437ea4f-17a0-4a06-aee7-b5119ae2a403","_postman_id":"a437ea4f-17a0-4a06-aee7-b5119ae2a403","description":""}],"id":"0a21775d-1d55-4268-a968-5cdba811965a","_postman_id":"0a21775d-1d55-4268-a968-5cdba811965a","description":""},{"name":"🇮🇳 UPI Solution","item":[{"name":"Concepts","item":[],"id":"dd980600-8bdc-443d-a067-d18ce0e1f7f7","description":"UPI Overview
\nThe Unified Payments Interface (UPI) technology unifies various banking functions, smooth fund routing, and merchant payments under one roof by enabling numerous bank accounts into a single mobile application (of any participating bank).
\nPaysecure’s UPI product suite enables merchants to initiate:
\n- \n
PayIns: Consumers can utilise UPI to transfer funds from their bank account, through their bank’s app or website.
\n \nPayouts: Facilitate real-time disbursements directly to consumers' accounts by UPI ID, IMPS, RTGS,NEFT.
\n \n
PayIn Flows
\nHow it works
\nPaysecure’s UPI PayIn API lets the platforms collect funds from payers through intent flow/payment link without entering the payer's VPA. Suitable for app or mobile-based flows.
\nKey Steps
\nFlow
\n- \n
Initiate Transfer Request: The merchant sends a request to the UPI PayIn API to initiate a PayIn (deposit/collections) transaction. This request includes the customer’s email address or mobile number, the amount to be collected, and an optional message.
\n \nUPI payment options: The API generates a Multiple payment option (PayTM, GPay, PhonePe apps as well by scanning QR code) where end user can select any one payment option to complete the transaction.
\n \nUser pays using their App: User will then pay the amount using their desired payment app and method through default UPI apps or by scanning the QR code via any bank app)
\n \nConfirm Transfer Completion: Once the transfer is completed by the end user, the paysecure would send webhook of payment completion with the status. The balance of merchant would be updated to reflect the new transaction’s outcome.
\n \nUpdate Merchant’s Account: The merchant would then update (on the merchant’s system) the customer’s account balance to reflect the received funds.
\n \n
PayOut flows
\nHow it works
\nOur APIs enable payouts through various channels, including IMPS, UPI, RTGS, and NEFT, to user's bank accounts.
\nHere are some common use cases, though not limited to these:
\n- \n
Vendor Payouts: Quickly settle payments for goods or services with your vendors or distributors.
\n \nPayroll & Reimbursements: Disburse salaries, ad-hoc payments, or employee reimbursements to staff or agents.
\n \nDisbursements: Facilitate loan or credit disbursements to merchants or consumers' bank accounts via your own or a lender's account.
\n \n
*Key Steps*
\nFlow
\n- \n
We recommend that merchan't validate the bank accounts of their customer's bank account before doing payouts.
\n \nEnsure that enough balance is there in your merchant account do the payout.
\n \nThe merchant platform initiates the creation of a payout by passing beneficiary details, along with payout details.
\n \nBeneficiary's bank details
\n- \n
Beneficiary's transfer Type (IMPS, RTGS, NEFT, UPI)
\n \nBeneficiary's ifsc Code (if transferType is either of IMPS, RTGS, or NEFT)
\n \nBeneficiary's payee Name (if transferType is either of IMPS, RTGS, or NEFT)
\n \nBeneficiary's bank Account Number (if transferType is either of IMPS, RTGS, or NEFT)
\n \n
\nUpon completion of the payout, reaching either a Success or Failure state, Paysecure notifies the merchant’s platform via webhook, providing the final status of the transaction and additional details.
\n \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Payment Methods allowed: UPI-QR and UPI-INTENT
\nPossible Error Messages
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f9e660c3-3b6a-4118-82bd-44e0c81c5b79","id":"f9e660c3-3b6a-4118-82bd-44e0c81c5b79","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"56bbdd7a-b24e-4698-8b7f-1aeabae3033f","name":"UPI-QR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"IN\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"302022\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634988765\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"UPI-QR\",\r\n \"merchantRef\": \"test12\", // optional\r\n \"brand_id\": \"{{merchant_brand_id}}\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Success","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"6682942d5273633e7b8d30c8\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719833645,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI-QR\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719833645,\r\n \"merchantRef\": \"6682942d5273633e7b8d30c8\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719833645,\r\n \"remote_paid_on\": 1719833645\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"110.235.229.42\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI-QR\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1719833645,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719833645\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10421\",\r\n \"issued\": \"2024-07-01\",\r\n \"due\": 1719833645,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"expiration_date\": \"2025-03-27 23:59:59\",\r\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.42\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6682942d5273633e7b8d30c8/\"\r\n}\r\n"},{"id":"491031bd-36e8-4fbe-9d1c-4b0768a50188","name":"UPI-INTENT","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"full_name\": \"test test\",\r\n \"country\": \"IN\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"Praça da Bíblia 1308\",\r\n \"zip_code\": \"302022\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634988765\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"UPI-INTENT\",\r\n \"merchantRef\": \"test12\", // optional\r\n \"brand_id\": \"{{merchant_brand_id}}\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"6682942d5273633e7b8d30c8\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"EG\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1719833645,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI-INTENT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1719833645,\r\n \"merchantRef\": \"6682942d5273633e7b8d30c8\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1719833645,\r\n \"remote_paid_on\": 1719833645\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"110.235.229.42\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI-COLLECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1719833645,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1719833645\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1719833645\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10421\",\r\n \"issued\": \"2024-07-01\",\r\n \"due\": 1719833645,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"transaction_expiry\": \"2026-02-21 07:11:13\",\r\n \"intentUri\": \"upi://pay?pa=bom260101330774%40mahb&am=101&tn=jamb&tr=jamb&pn=V%20S%20ENTERPRISEScu=\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.42\",\r\n \"checkout_url\": \"https://api.paysecure.net/payments/6682942d5273633e7b8d30c8/\"\r\n}"}],"_postman_id":"32a80665-c3c7-4885-be73-1019375c755a"},{"name":"Get Status","id":"f3be53e4-055b-4f75-b94d-d211abe3b39b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f9e660c3-3b6a-4118-82bd-44e0c81c5b79","id":"f9e660c3-3b6a-4118-82bd-44e0c81c5b79","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4f518cf7-b059-472f-86f9-0c8514efd2c2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66c4667bb993c970367c288a\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"IN\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"UPI\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1724147324,\r\n \"merchantRef\": \"66c4667bb993c970367c288a\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"expireInMin\": \"35\",\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1724147324,\r\n \"remote_paid_on\": 1724147324\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"103.59.75.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"UPI\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"UPI\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"UPI\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInDetails\": {\r\n \"expiration_date\": \"2025-03-27 23:59:59\",\r\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\"\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://staging.paysecure.net\",\r\n \"failure_callback\": \"https://staging.paysecure.net\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.113\",\r\n \"checkout_url\": \"https://staging.paysecure.net/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"fd6179b7-fca3-47c2-8254-211282082c7b","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"f3be53e4-055b-4f75-b94d-d211abe3b39b"}],"id":"f9e660c3-3b6a-4118-82bd-44e0c81c5b79","description":"API Flow
\n\n\n- \n
The merchant initiates the purchase via the create purchase API. If successful, they receive a checkout URL in the response JSON. Sometimes they can also get an object of PayIn Details which they can use to make the payment.
\n \nThe merchant then has 2 options
\n- \n
Upon utilizing the checkout URL, depending on the payment method passed, the user will be presented with several payment choices from which to choose in order to complete the payment:
\n- \n
QR Code
\n \nPhonePe, Googlepay or Paytm intent flow
\n \n
\nRetrieve the PayIn details in the response JSON (as shown below).
\n \n
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2a was the method employed, the user would be redirected to the appropriate redirect URL.
\n \n
Available Payment Methods: UPI-QR and UPI-INTENT
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"42cacc0d-d134-4323-bd90-34cd80aa23cf","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"381327d3-02d0-4fdc-a168-8cc4e061c2e1","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"f9e660c3-3b6a-4118-82bd-44e0c81c5b79"},{"name":"Payout","item":[{"name":"PayOut","id":"a500ebbb-7c93-46d8-837b-00d31c0d158f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"customer141@gmail.com\",\n \"phone\": \"+91 9634088651\",\n \"country\": \"IN\",\n \"zip_code\": \"302018\",\n \"city\": \"Jaipur\",\n \"street_address\": \"Vaishali Nagar\",\n \"full_name\": \"Rahul Jain\",\n \"stateCode\": \"RJ\"\n },\n \"beneficiaryDetail\": {\n \"bankAccountName\": \"Rahul Jain\",\n \"bankAccountNumber\": \"123456789012\",\n \"ifscCode\": \"HDFC021212\"\n },\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\n \"amount\": 100,\n \"currency\": \"INR\",\n \"purpose\": \"payout for testing\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"To Initiate a payment, the very first API call to make is /payout/ with the required data in the request body.
To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\nAdditional parameters for this usecase:
\nBank Names:
\nThis API tells you about all the details of a Payout, including its history.
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ce38a709-cf1c-4480-8e12-a7c4bb2e2949","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"customer141@gmail.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Jaipur\",\r\n \"street_address\": \"Vaishali Nagar\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Rahul Jain\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"payout for testing\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"6977137755e0628e3600c562\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1769411447\r\n },\r\n\r\n ],\r\n \"currency\": \"INR\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"BANKTRANSFER\",\r\n \"success_callback\": \"\",\r\n \"failure_callback\": \"\"\r\n}"},{"id":"1b78846d-3d7e-4eeb-9ecb-7961396608e4","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"6977137755e0628e3600c562\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"customer141@gmail.com\",\r\n \"phone\": \"+91 9634088651\",\r\n \"country\": \"IN\",\r\n \"zip_code\": \"302018\",\r\n \"city\": \"Jaipur\",\r\n \"street_address\": \"Vaishali Nagar\",\r\n \"full_name\": \"Rahul Jain\",\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1769411447,\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Rahul Jain\",\r\n \"bankAccountNumber\": \"123456789012\",\r\n \"ifscCode\": \"HDFC021212\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100.0,\r\n \"errorMsg\": \"This customer can not be processed !\",\r\n \"purpose\": \"payout for testing\",\r\n \"created_on\": 1769411447,\r\n \"merchantRef\": \"6977137755e0628e3600c562\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1769411447\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1769411447\r\n }\r\n ],\r\n \"currency\": \"INR\",\r\n \"extraFee\": \"0\",\r\n \"paymentOn\": 0,\r\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n \"redirectType\": \"POST\",\r\n \"sessionId\": \"\",\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"trxMethod\": \"BANKTRANSFER\",\r\n \"success_callback\": \"\",\r\n \"failure_callback\": \"\"\r\n}"}],"_postman_id":"608342b1-dff5-48fb-b73f-3fe3286733aa"}],"id":"87db92b1-5b1f-4118-87c7-b5e97e4de751","description":"API Flow
\n\n\n- \n
The merchant initiates the payout via the create payout API. If successful, they will receive a paid status in the response. If any additional fields are required from the user, the status would be in pending and the user needs to be redirected to the checkout_url.
\n \nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If the user would be redirected to the checkout_url for some additional details, once the user clicks on Pay, the user will be redirected to the appropriate redirect URL.
\n \n
Available payout methods: PAYOUT-BANKTRANSFER
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"42cacc0d-d134-4323-bd90-34cd80aa23cf","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"381327d3-02d0-4fdc-a168-8cc4e061c2e1","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"87db92b1-5b1f-4118-87c7-b5e97e4de751"}],"id":"57bfd92d-a8ed-4707-a1eb-a6e603816199","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"614f1f41-357c-49f2-93b6-f4f3996d1377","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"cafa4f62-060e-4ebc-8a1d-969c36d83409","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"57bfd92d-a8ed-4707-a1eb-a6e603816199","description":""},{"name":"🇲🇽 SPEI Payments","item":[{"name":"Concepts","item":[],"id":"26e6991a-0ca5-45e9-9099-38d5905b5343","description":"- \n
CLABE (Clave Bancaria Estandarizada): A 18-digit standardized bank account identifier used to route funds correctly.
\n \nExpiration Window: SPEI instructions typically expire within a 3 days; merchants must display clear expiry times to reduce failed payments.
\n \nWebhook-Driven Confirmation: Once funds arrive, the SPEI network triggers a webhook to notify your system—no polling required.
\n \n
Customer Journey
\n- \n
Select SPEI at Checkout:
\n- \n
User adds items to cart, proceeds to checkout, and clicks “Pay with SPEI.”
\n \nMerchant’s site sends a Payin API request to generate SPEI instructions.
\n \n
\nDisplay Payment Instructions:
\n- \n
Merchant shows a summary screen with:
\n- \n
Beneficiary CLABE (One-time CLABE)
\n \nBeneficiary Name
\n \nAmount (MXN)
\n \nExpiration Time (e.g., “Expires in 2 hours”)
\n \n
\n
\nCustomer Initiates Transfer:
\n- \n
Customer logs into their bank’s web/mobile app.
\n \nThey select “Transfer via SPEI,” enter the provided CLABE, amount, and reference.
\n \nCustomer confirms transfer (two-factor auth, OTP, or biometric—bank-dependent).
\n \n
\nFunds Sent & Confirmation:
\n- \n
Once Banco de México settles the transfer (typically <15 minutes), PaySecure’s SPEI webhook fires.
\n \nMerchant backend receives webhook payload with transaction status = “paid” (or “error,” “cancelled,” as applicable).
\n \n
\nMerchant Acknowledges Payment:
\n- \n
Backend updates order status to “Paid”
\n \nFrontend redirects customer to success page or sends confirmation email/SMS.
\n \n
\nEdge Cases & Failure Handling:
\n- \n
If customer never initiates transfer before expiration, status = “expired.”
\n \nIf customer sends incorrect CLABE/amount, merchant receives webhook with error codes—trigger “error” flow.
\n \n
\n
1. Endpoint & Authentication
\nhttp POST <https://api.paysecure.net/api/v1/purchases>\nHeaders:\n Authorization: Bearer {LIVE_API_KEY}\n Content-Type: application/json\n\n– Use your live or sandbox API key in the Authorization header.
– All requests must be sent as application/json.
\n
2. Request Payload Structure
\nSupply a JSON payload with these top‐level objects:
\n- \n
\nclient(customer details) \n
\npurchase(order details) \n
\npaymentMethod(string, must be\"SPEI\") \n
\nextraParam(optional, leave{}if unused) \n
\nstatus(set to\"created\") \n
\nbrand_id(your merchant/brand UUID) \nRedirect & callback URLs
\n \n
\n
3. Displaying SPEI Instructions to End User
\nOnce you parse payInDetails from the response:
- \n
Show CLABE, Beneficiary & Amount
\n \nDisplay Expiration
\n \nShow Redirect Path (Optional)
\n- \n
- If you’re using the hosted
checkout_url, simply redirect customers to it and let Paysecure handle the UI. \n
\n- If you’re using the hosted
\n
4. Webhook Handling & Status Transitions
\n- \n
Configure Webhooks
\n- \n
- In Paysecure’s Dashboard, set your
success_callbackandfailure_callbackURLs (one for each event type). \n
\n- In Paysecure’s Dashboard, set your
Listen for These Events:
\n- \n
\npayment.paid– Banco de México has settled the transfer. \n
\npayment.error– CLABE/amount mismatch or network error. \n
\npayment.expired– Customer did not pay beforeexpireInMin. \n
\nUpdate Order Status:
\n- \n
On
\npayment.paid: mark as paid, trigger fulfillment, send confirmation. \nOn
\npayment.error: alert customer, allow retry or alternative payment. \nOn
\npayment.expired: cancel order. \n
\n
Payout API Integration (SPEI)
\n\n
1. Endpoint & Authentication
\nhttp POST https://api.paysecure.net/api/v1/payout/\nHeaders:\n Authorization: Bearer {LIVE_API_KEY}\n Content-Type: application/json\n\n- \n
Use your live or sandbox API key in the
\nAuthorizationheader. \nAll requests must be sent as
\napplication/json. \n
\n
2. Request Payload Structure
\nSubmit a JSON payload containing:
\n- \n
\nclient(beneficiary details) \n
\npurpose(should be\"payout\") \n
\ncurrency(always\"MXN\") \n
\npayoutMethod(must be\"PAYOUT-SPEI\") \n
\namount(numeric, in major units) \nRedirect & callback URLs
\n \n
jsonCopy{\n \"client\": {\n \"email\": \"ashishm.21190@gmail.com\",\n \"country\": \"MX\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\n \"stateCode\": \"test\",\n \"spei_clabe\": \"012180027944986158\"\n },\n \"purpose\": \"payout\",\n \"currency\": \"MXN\",\n \"payoutMethod\": \"PAYOUT-SPEI\",\n \"amount\": 20,\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.com\"\n}\n\n- \n
client.email, client.phone, client.full_name, client.country, client.stateCode: Required beneficiary/contact info.
\n \nclient.spei_clabe: 18-digit CLABE of beneficiary’s bank account (validate format client-side to avoid runtime failures).
\n \npurpose: Always set to
\n\"payout\". \ncurrency: Must be
\n\"MXN\". \npayoutMethod: Must be
\n\"PAYOUT-SPEI\". \namount: Numeric amount (e.g.,
\n20for MXN 20.00). \nsuccess_redirect / failure_redirect: URLs for end-user redirect after they click “Return to Merchant” (GET).
\n \nsuccess_callback / failure_callback: Webhook endpoints for asynchronous payout status notifications.
\n \n
\n
3. Sample Response & Key Fields
\njsonCopy{\n \"payoutId\": \"683d778dc74d23074a56ea94\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"MARCO ANTONIO FERNANDEZ RAMIREZ\",\n \"country\": \"MX\",\n \"spei_clabe\": \"012180027944986155\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1748858765,\n \"payoutMethod\": \"PAYOUT-SPEI\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 20.0,\n \"errorMsg\": \"This customer can not be processed !\",\n \"purpose\": \"test payout\",\n \"created_on\": 1748858765,\n \"merchantRef\": \"683d778dc74d23074a56ea94\",\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748858765\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1748858765\n }\n ],\n \"currency\": \"MXN\",\n \"paymentOn\": 0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\n \"redirectType\": \"GET\",\n \"success_callback\": \"https://test1.com\",\n \"failure_callback\": \"https://test2.com\"\n}\n\n- \n
payoutId (
\nstring): Unique PaySecure identifier for this payout request. \nclient.customerId:
\n\"NA\"for a new beneficiary or your internal customer ID if returning. \nclient.spei_clabe: Echoed beneficiary CLABE (note: if the CLABE in response differs by a digit, double-check formatting/validation).
\n \nupdated_on / created_on: Unix timestamps (seconds since epoch).
\n \npayoutMethod:
\n\"PAYOUT-SPEI\". \namountUnit:
\n\"MAJOR\"indicates amount is in MXN major units (no subunit conversion required). \namount:
\n20.0(MXN 20.00). \nerrorMsg: Describes any immediate rejection reason. If non-empty,
\nstatuswill be\"ERROR\". \npurpose: Echo of the
\n\"payout\"field or any custom string you passed. \nmerchantRef: Mirror of
\npayoutIdby default; can be overwritten if you pass a custom reference. \nstatus: One of:
\n- \n
\n\"created\"→ request accepted, preparing SPEI transfer \n
\n\"processing\"→ SPEI transfer initiated, awaiting Banco de México settlement \n
\n\"success\"→ funds successfully delivered \n
\n\"error\"→ immediate failure (e.g., invalid CLABE, validation issue) \n
\nstatus_history: Array showing timestamped states from
\n\"created\"→\"processing\"→ (\"success\"or\"error\"). \npaymentOn: Unix timestamp when the transfer actually occurred (0 if not delivered).
\n \nredirectType: Always
\n\"GET\", meaning customer is redirected via HTTP GET to your provided URL. \nsuccess_redirect / failure_redirect / success_callback / failure_callback: Echo of whatever you passed in request.
\n \n
Note: If you see \"status\": \"ERROR\" and an errorMsg, do not retry automatically—inspect the message, correct client data, then reinitiate a new payout request.
\n
5. Handling Payout Webhooks & Status Flow
\n- \n
Configure Webhooks
\n- \n
- In your PaySecure Dashboard, register your
success_callbackandfailure_callbackURLs (these will receive POSTs once SPEI settles or fails). \n
\n- In your PaySecure Dashboard, register your
Listen for Events
\n- \n
\npayout.success: Banco de México confirmed the credit to beneficiary’s CLABE. \n
\npayout.error: CLABE invalid, account closed, or transfer rejected. \n
\nUpdate Your Records
\n- \n
On
\npayout.success: Mark disbursement as complete; notify your finance/operations teams. \nOn
\npayout.error: Log failure details, alert operations for manual review, and optionally retry after fixing the root cause. \n
\n
Overview
\nSPEI (Sistema de Pagos Electrónicos Interbancarios) is Mexico’s real-time interbank transfer network operated by Banco de México. By integrating SPEI as a payment option, merchants can offer a frictionless, low-cost alternative to cards—funds settle in minutes, not days. SPEI is ubiquitous in Mexico (think coffee-to-cash within seconds), and this integration lets you tap into that network without reinventing the wheel.
\nKey benefits:
\n- \n
Instant Settlement: Funds move from payer’s bank to merchant’s account in near real-time.
\n \nBroad Adoption: Over 90% of Mexican bank accounts are SPEI-enabled.
\n \nLow Fees: Typically lower transaction fees compared to card rails.
\n \nRegulatory Compliance: Leverages Banco de México’s secure infrastructure and industry-standard validations.
\n \n
Mobile Money Overview
\nMobile Money is a digital payment service that allows users to send, receive, and manage money via their mobile devices. It facilitates secure and instant transactions directly between mobile wallets in the country, offering a convenient alternative to traditional banking methods in Africa.
\nThis payment method enables merchants to accept payments via Mobile Money from number of countries in Africa, and also to do payouts as well (to cutomer's local mobile wallet)
\nPayins
\nHow It Works
\nThe payin process harnesses mobile money capabilities to support effortless collections. Merchants can initiate payment requests via USSD, offering a secure, efficient, and flexible method to collect customer payments.
\n\n\n💡 Note that the refunds are not possible over Mobile Money. Merchants have to initiate a PayOut request manually to process any refunds.
\n
Key Steps
\n- \n
Initiate Transfer Request:
\n
The merchant sends a transaction request to the Mobile Money PayIn API. This request includes the customer’s mobile number, the collection amount, and an optional message. \nSend Notification:
\n
The customer receives a USSD pop-up with payment instructions on their mobile device. \nCustomer Completes Transfer:
\n
The customer follows the USSD instructions, enters their security PIN if required, and authorizes the transfer of funds to the merchant’s account. \nConfirm Transfer Completion:
\n
Once the payment is successful, the merchant receives a confirmation via a webhook indicating a successful transaction. \nUpdate Merchant’s Account:
\n
The merchant’s system updates the customer’s account balance to reflect the received funds. \n
Payouts
\nThe payout API offers seamless payouts to customers over mobile money. Whether processing refunds, rewards, or other disbursements, our APIs delivers efficient, reliable transactions with real-time fund transfers and detailed transaction tracking.
\nKey Steps:
\n- \n
Initiate Payout Request:
\n
When a customer requests a withdrawal, the merchant site calls the Paysecure Payouts API to start the mobile money payout. This request includes the customer’s mobile number, the transfer amount, and the currency. \nSend Notification:
\n
Customers receive an immediate USSD notification confirming the successful payout, while merchants are notified via an instant webhook. \nUpdate Merchant’s Account:
\n
The merchant’s account balance is promptly updated to reflect the transaction. \n
Fully Supported Countries: Pay-ins & Pay-outs
\n\n
Footnotes:
\n- \n
For Cameroon, a licence is required.
\n \nMTN support in Uganda covers only pay-ins (collections).
\n \nAirtel support in Zambia covers only pay-ins (collections).
\n \n
Partially Supported Countries
\nPay-ins (Collections) Only – Crossborder
\nAdditional countries going live in General Release in Q2 2025: Botswana, Congo Brazzaville, and Gabon.
\nSouth Africa will go liver in Q3 2025.
\n\n
Pay-outs (Disbursement) Only – Crossborder
\nAdditional countries going live in General Release in Q2 2025 (subject to successful testing and compliance review): Botswana, Congo Brazzaville, Gabon, Ivory Coast (Côte d'Ivoire), Nigeria, Rwanda, Senegal, and Tanzania.
South Africa will go live in Q3.
More countries to be launched in Q2 – please speak with your Account Manager or Sales Representative for further details.
Region Abbreviations:
\n- \n
FSSA: Francophone Sub-Saharan Africa
\n \nSEA: Southern and Eastern Africa
\n \nAWA: Anglophone West Africa
\n \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c3272678-8c3d-4a56-b6ec-2b6abad272c3","id":"c3272678-8c3d-4a56-b6ec-2b6abad272c3","name":"PayIn API","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"6d8b64fc-4fec-40a2-a46d-471b4e19e86f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"akshaya singhal\",\n \"email\": \"akshaya@gmail.com\",\n \"country\": \"CD\",\n \"city\": \"London\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"purchase\": {\n \"currency\": \"CDF\",\n \"products\": [\n {\n \"name\": \"Test Product\",\n \"price\": \"100\"\n }\n ]\n },\n \"paymentMethod\": \"MOBILEMONEY\",\n \"brand_id\": \"your-brand-id\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Dec 2024 14:59:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=pWCTJZboe33ICYkJiwuwk9QQ4TLxjgXAKCGEbQUbwdP%2Bdbr%2FHFvOVzWWsAS7UIypOGSXOnu52hAILUoGn0yrB2iqXMR9PhPHoTuxnVIEyihZEXx8Fv7QXgASe%2F4CUAQc%2BMupXRwPfFI%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8edd237addbf0f97-EWR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=223565&min_rtt=223292&rtt_var=63299&sent=15&recv=16&lost=0&retrans=0&sent_bytes=4524&recv_bytes=3359&delivery_rate=19323&cwnd=255&unsent_bytes=0&cid=6b5591269d33c417&ts=10327&x=0\""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69ec68f9f76f0f58bd700058\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"agarapex@gmail.com\",\n \"phone\": \"243995980380\",\n \"full_name\": \"Rahul Agarwal\",\n \"date_of_birth\": \"1994-31-04\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"country\": \"CD\",\n \"city\": \"Jaipur\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"RJ\"\n },\n \"updated_on\": 1777101049,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MOBILEMONEY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1777101049,\n \"merchantRef\": \"69ec68f9f76f0f58bd700058\",\n \"purchase\": {\n \"currency\": \"CDF\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 1000.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1000.0,\n \"requestAmount\": 1000.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"Testing\",\n \"brand_name\": \"Testing\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777101049\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1711\",\n \"issued\": \"2026-04-25\",\n \"due\": 1777101049,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.0,\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://google.com/\",\n \"failure_redirect\": \"https://paysecure.net\",\n \"pending_redirect\": \"https://facebook.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://staging.paysecure.net/merchant\",\n \"failure_callback\": \"https://staging.paysecure.net/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"2406:b400:75:584c:8889:bfe5:9552:8720\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/5f95c39387eefc684560013794f41455/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"46af627b-0976-4433-a642-c89f04497544"}],"id":"c3272678-8c3d-4a56-b6ec-2b6abad272c3","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"01f39bca-f385-49ef-94ec-4d74b94590cf","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"5a3cd411-e01a-4595-b9d3-dc1c9f85eded","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"c3272678-8c3d-4a56-b6ec-2b6abad272c3","description":""},{"name":"Payout API","item":[{"name":"Payout","id":"a4eeaba3-6437-4676-9991-c20b5603c577","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"akshaya singhal\",\n \"email\": \"akshaya@gmail.com\",\n \"country\": \"CD\",\n \"city\": \"London\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"purpose\": \"Testing payout\",\n \"currency\": \"CDF\",\n \"payoutMethod\": \"PAYOUT-MOBILEMONEY\",\n \"amount\": 100.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"To Initiate a payout, the very first call to make is /payout/ API with the required data in the request body.
\nTo generate a PayOut, you are required to provide the API key (in the header), which can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"af88a1fa-f54a-44e6-9339-8b08fdcf6ab9","id":"af88a1fa-f54a-44e6-9339-8b08fdcf6ab9","name":"Payout API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"74bf4153-5231-48c6-bf34-80f04313ab95","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"full_name\": \"akshaya singhal\",\n \"email\": \"akshaya@gmail.com\",\n \"country\": \"CD\",\n \"city\": \"London\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"purpose\": \"Testing payout\",\n \"currency\": \"CDF\",\n \"payoutMethod\": \"PAYOUT-MOBILEMONEY\",\n \"amount\": 100.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"69ec70c5b7b9052cc4823367\",\n \"client\": {\n \"customerId\": \"NA\",\n \"full_name\": \"akshaya singhal\",\n \"email\": \"akshaya@gmail.com\",\n \"country\": \"CD\",\n \"city\": \"London\",\n \"stateCode\": \"RJ\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"date_of_birth\": \"1994-31-04\",\n \"phone\": \"+243999999999\"\n },\n \"updated_on\": 1777103045,\n \"payoutMethod\": \"PAYOUT-MOBILEMONEY\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 100.0,\n \"errorMsg\": \"\",\n \"is_test\": false,\n \"purpose\": \"Testing payout\",\n \"created_on\": 1777103045,\n \"merchantRef\": \"69ec70c5b7b9052cc4823367\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777103045\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1777103045\n }\n ],\n \"currency\": \"CDF\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"checkout_url\": \"https://api.choicepay.ca/payout/0685d9437d0eb79e48ee8158542d9918/\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"redirectType\": \"POST\",\n \"sessionId\": \"\",\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"utc_offset\": \"NA\"\n}"}],"_postman_id":"a4eeaba3-6437-4676-9991-c20b5603c577"}],"id":"af88a1fa-f54a-44e6-9339-8b08fdcf6ab9","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e5e8cf42-6e5f-4ccc-8a9a-c6dcf09877c6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"1e5e8c08-f87e-479e-8c7c-e25db0db2530","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"af88a1fa-f54a-44e6-9339-8b08fdcf6ab9","description":""}],"id":"f50a1563-a6d6-4611-8a9b-40a3d3569cca","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b177c2ae-d430-4717-9bde-9a46c46ba114","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"b4de97bb-3c28-4ede-83f0-642e8b2a2bc3","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"f50a1563-a6d6-4611-8a9b-40a3d3569cca","description":""},{"name":"🌎 Google Pay Redirect","item":[{"name":"Concepts","item":[],"id":"9321edd6-8d85-49db-a100-8f71334ce5e8","description":"Overview
\nGoogle Pay enables customers to make payments on a merchant’s website or app using credit or debit cards securely stored in their Google Account. During checkout, Google Pay presents a payment sheet where customers can select their preferred card and confirm the transaction.
\nCustomers add their payment cards to the Google Pay wallet, which securely stores the card details. When making a purchase, they simply choose Google Pay as the payment method and complete the payment using a saved card—eliminating the need to enter card information repeatedly.
\n\n
Features
\n- \n
Convenient: Customers can pay using cards already saved in Google Pay, reducing friction during checkout.
\n \nSecure: Uses tokenization to ensure sensitive card information is never exposed during the payment flow.
\n \n3D Secure support: The payment handle created through the integration supports 3D Secure authentication when required, enabling secure transactions.
\n \nWide coverage: Supported across multiple regions and currencies.
\n \n
\n
By integrating Google Pay through the Paysecure API, you can offer your customers a fast, secure, and seamless payment experience.
\n\n
Note
\nThis is a redirection-based payment method. During the payment flow, the user is redirected to a third-party application or interface, where the Google Pay button is displayed for completing the transaction.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3689411e-823f-4b25-b92c-6ea3ad01be49","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"e1823e12-d492-42be-9907-ad507a512152","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"9321edd6-8d85-49db-a100-8f71334ce5e8"},{"name":"APIs","item":[{"name":"Purchases","id":"5d920ac8-00ac-497e-815a-9ff1e4dc3571","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"rahultest@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Rahul Agarwal\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"brand_id\": \"your-brandid\",\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\",\r\n \"success_redirect\": \"https://your-redirect-url?issucces=true\",\r\n \"pending_redirect\": \"https://your-redirect-url?ispending=true\",\r\n \"failure_redirect\": \"https://your-redirect-url?isfailure=true\",\r\n \"success_callback\": \"https://your-webhook-url\",\r\n \"failure_callback\": \"https://your-webhook-url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
OVERVIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nMandatory Parameters
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: PaySecure creates the session and associates it with the merchant’s checkout page. This session remains active on the backend, allowing the customer to continue the payment process without interruption.
\n \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
This API tells you about all the details of a purchase (PayIn), including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"4343530a-d2c9-4451-9282-511a0c127003","id":"4343530a-d2c9-4451-9282-511a0c127003","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e6651942-f04b-4851-b431-df1c8e6c0ae1","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69634df44549cbd3547ac750\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"rahultest@gmail.com\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Rahul Agarwal\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1768115701,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY-REDIRECT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1768115700,\r\n \"merchantRef\": \"69634df44549cbd3547ac750\",\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards\",\r\n \"quantity\": 1.0,\r\n \"price\": 1.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1.0,\r\n \"requestAmount\": 1.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1.0,\r\n \"currency\": \"EUR\",\r\n \"net_amount\": 1.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1768115700,\r\n \"remote_paid_on\": 1768115700\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Testing\",\r\n \"brand_name\": \"Testing\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"GOOGLEPAY-REDIRECT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"183.83.53.41\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"GOOGLEPAY-REDIRECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"GOOGLEPAY-REDIRECT\",\r\n \"processing_time\": 1768115700,\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"GOOGLEPAY-REDIRECT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1768115701\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1768115701\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS363\",\r\n \"issued\": \"2026-01-11\",\r\n \"due\": 1768115700,\r\n \"refund_upto\": 1783664101,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"0\",\r\n \"trustScore\": \"1\",\r\n \"extraFee\": \"0\",\r\n \"pix_payload\": {},\r\n \"payInDetails\": {},\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1.0,\r\n \"success_redirect\": \"https://your-redirect-url?issucces=true\",\r\n \"pending_redirect\": \"https://your-redirect-url?ispending=true\",\r\n \"failure_redirect\": \"https://your-redirect-url?isfailure=true\",\r\n \"success_callback\": \"https://your-webhook-url\",\r\n \"failure_callback\": \"https://your-webhook-url\"\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"183.83.53.41\",\r\n \"checkout_url\": \"https://api.choicepay.ca/payments/deb852445bd4b0fa6c4587f652174ab9/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"afebd644-1ca2-4858-b508-e897f7067f2b","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"8ea51fca-2dcc-440e-a281-ad78e19d4999"}],"id":"4343530a-d2c9-4451-9282-511a0c127003","description":"API Flow
\n- \n
The merchant initiates the purchase via the create purchase API and passing the appropriate payment method. If successful, they receive a checkout URL in the response JSON.
\n \nUpon utilizing the checkout URL, the user will be presented with a screen where he will be shown a button to pay via Googlepay.
\n \nAfter clicking the button, the user will see all the cards stored in the google wallet and he can choose one of the cards to make the purchase.
\n \nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. The user would also be redirected to the appropriate redirect URL.
\n \n
Overview
\nApple Pay enables customers to make payments on a merchant’s website or app using credit or debit cards securely stored in their Apple Wallet. During checkout, Apple Pay presents a payment sheet where customers can select their preferred card and confirm the payment using Touch ID, Face ID, or their device passcode.
\nCustomers add their payment cards to Apple Wallet, which securely stores the card information. When making a purchase, they simply select Apple Pay as the payment method and complete the transaction using a saved card—eliminating the need to manually enter card details for each payment.
\n\n
Features
\n- \n
Convenient: Customers can pay using cards already saved in Apple Pay, reducing checkout friction.
\n \nSecure: Uses device-specific tokenization (DPAN/MPAN) to protect sensitive card data during the payment process.
\n \n3D Secure support: The payment handle created through the integration supports 3D Secure authentication when required, ensuring secure transactions.
\n \nWide coverage: Supported across multiple regions and currencies.
\n \n
\n
By integrating Apple Pay through the Paysecure API, you can provide your customers with a fast, secure, and seamless payment experience.
\n\n
Note
\nThis is a redirection-based payment method. During the payment flow, the user is redirected to a third-party application or interface, where the Apple Pay button is displayed to complete the payment.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3689411e-823f-4b25-b92c-6ea3ad01be49","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"e1823e12-d492-42be-9907-ad507a512152","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"3cec7ff8-e53b-4e0c-99c9-2752ea75ba89"},{"name":"APIs","item":[{"name":"Purchases","id":"c6e162ac-9043-4c1d-b099-3023cb63fa2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"rahultest@gmail.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"RJ\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Rahul Agarwal\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards \",\r\n \"price\": 10\r\n }\r\n ]\r\n },\r\n \"brand_id\": \"your-brandid\",\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\",\r\n \"success_redirect\": \"https://your-redirect-url?issucces=true\",\r\n \"pending_redirect\": \"https://your-redirect-url?ispending=true\",\r\n \"failure_redirect\": \"https://your-redirect-url?isfailure=true\",\r\n \"success_callback\": \"https://your-webhook-url\",\r\n \"failure_callback\": \"https://your-webhook-url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/","description":"To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
OVERVIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nMandatory Parameters
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: PaySecure creates the session and associates it with the merchant’s checkout page. This session remains active on the backend, allowing the customer to continue the payment process without interruption.
\n \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
This API tells you about all the details of a purchase (PayIn), including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"244e1dc4-2e65-49df-9603-13b033c55a84","id":"244e1dc4-2e65-49df-9603-13b033c55a84","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"7bbe0532-9c73-49dc-b6b7-5e5ae4fc9251","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69634df44549cbd3547ac750\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"rahultest@gmail.com\",\r\n \"phone\": \"+91 9634088561\",\r\n \"full_name\": \"Rahul Agarwal\",\r\n \"date_of_birth\": \"1994-31-04\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"RJ\"\r\n },\r\n \"updated_on\": 1768115701,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"APPLEPAY-REDIRECT\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1768115700,\r\n \"merchantRef\": \"69634df44549cbd3547ac750\",\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"gaming cards\",\r\n \"quantity\": 1.0,\r\n \"price\": 1.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 1.0,\r\n \"requestAmount\": 1.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 1.0,\r\n \"currency\": \"EUR\",\r\n \"net_amount\": 1.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1768115700,\r\n \"remote_paid_on\": 1768115700\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Testing\",\r\n \"brand_name\": \"Testing\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"APPLEPAY-REDIRECT\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"183.83.53.41\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"APPLEPAY-REDIRECT\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"APPLEPAY-REDIRECT\",\r\n \"processing_time\": 1768115700,\r\n \"extra\": {\r\n \"amount\": 1.0,\r\n \"masked_pan\": \"APPLEPAY-REDIRECT\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1768115700\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1768115701\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1768115701\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS363\",\r\n \"issued\": \"2026-01-11\",\r\n \"due\": 1768115700,\r\n \"refund_upto\": 1783664101,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"0\",\r\n \"trustScore\": \"1\",\r\n \"extraFee\": \"0\",\r\n \"pix_payload\": {},\r\n \"payInDetails\": {},\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 1.0,\r\n \"success_redirect\": \"https://your-redirect-url?issucces=true\",\r\n \"pending_redirect\": \"https://your-redirect-url?ispending=true\",\r\n \"failure_redirect\": \"https://your-redirect-url?isfailure=true\",\r\n \"success_callback\": \"https://your-webhook-url\",\r\n \"failure_callback\": \"https://your-webhook-url\"\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"183.83.53.41\",\r\n \"checkout_url\": \"https://api.choicepay.ca/payments/deb852445bd4b0fa6c4587f652174ab9/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"f21572cc-a323-4b92-8e88-ea8571cc715b","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"8b7d7852-2f6b-43a4-981d-381cf8640167"}],"id":"244e1dc4-2e65-49df-9603-13b033c55a84","description":"API Flow
\n- \n
The merchant initiates the purchase via the create purchase API and passing the appropriate payment method. If successful, they receive a checkout URL in the response JSON.
\n \nUpon utilizing the checkout URL, the user will be presented with a screen where he will be shown a button to pay via Applepay.
\n \nAfter clicking the button, the user will see all the cards stored in the Apple wallet and he can choose one of the cards to make the purchase.
\n \nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. The user would also be redirected to the appropriate redirect URL.
\n \n
Get started
\nPaysecure’s Server-to-Server (S2S) integration for Google Pay allows merchants to process Google Pay transactions securely from their backend systems. In this model, merchants are responsible for generating the Google Pay payment token on their client application and sending it to their server, which then communicates with Paysecure APIs.
\nThis integration uses DIRECT tokenization, where payment data is securely generated by Google Pay and passed to Paysecure for processing.
\nThis integration is recommended for merchants who require:
\n- \n
Integration with Google Pay wallets
\n \nSecure handling of tokenized payment data
\n \nFlexibility in choosing PCI scope (encrypted vs decrypted flow)
\n \n
\n
How it works
\nThe Google Pay S2S payment flow follows a two-step process:
\n1. Generate Google Pay Token (Client-side)
\nThe merchant integrates Google Pay SDK (Web/Android) to generate a payment token using DIRECT flow.
\n2. Submit Token via S2S
\nThe merchant server sends the Google Pay token (encrypted or decrypted) to Paysecure via the /purchase API.
\n\n
Supported Tokenization Type
\nPaysecure supports DIRECT flow only.
\nPAYMENT_GATEWAY flow is not supported yet.
\n\n
Google Pay Processing Overview
\nGoogle Pay transactions are processed as card-not-present payments using tokenized card data (PAN/DPAN) along with a cryptogram provided by Google Pay.
\nThese transactions go through:
\n- \n
Card network (Visa, Mastercard, etc.)
\n \nIssuing bank authorization
\n \nRisk and fraud checks
\n \n
\n
Integration Options
\nPaysecure supports two integration modes:
\n\n
1. Encrypted Token Flow (Recommended)
\nIn this flow, the merchant sends the encrypted Google Pay token to Paysecure. Paysecure decrypts and processes the payment.
\nKey Characteristics
\n- \n
Merchant does not handle PAN
\n \nReduced PCI scope
\n \nRecommended for most merchants
\n \n
PCI Impact
\nMerchants can significantly reduce PCI DSS scope since sensitive card data is handled by Paysecure.
\n\n
2. Decrypted Token Flow
\nIn this flow, the merchant decrypts the Google Pay token and sends decrypted token details to Paysecure.
\nKey Characteristics
\n- \n
PAN is available at merchant side
\n \nFaster processing
\n \nFull control over payment data
\n \n
PCI Impact
\nMerchants must be PCI DSS compliant (SAQ D) as they handle raw card data.
\n\n
Before you begin
\nEnsure the following prerequisites are met:
\n- \n
You have received your API credentials from Paysecure.
\n \nYou have a valid Google Merchant ID
\n \nYou have integrated Google Pay SDK to generate tokens
\n \nYou have configured DIRECT tokenization in Google Pay
\n \nYour server can make secure HTTPS requests
\n \nYou have a valid brand_id provided by Paysecure
\n \n
Additional Requirements (Encrypted Flow)
\n- \n
Generate EC key pair (P-256 / secp256r1)
\n \nRegister public key in Google Pay Console
\n \nShare private key securely with Paysecure
\n \n
Additional Requirements (Decrypted Flow)
\n- \n
Implement token decryption using Google Tink library
\n \nEnsure full PCI DSS compliance
\n \n
To process a Google Pay transaction, a Purchase must first be created using the /purchases API. The Google Pay token must be included in the request under extraParam.googlepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Flow Diagram:
\nTo process a Google Pay transaction, a Purchase must first be created using the /purchases API. The Google Pay token must be included in the request under extraParam.googlepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Flow Diagram:
\nThis API tells you about all the details of a purchase (PayIn), including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"00f20fbd-c463-4137-b120-3628f0bd57fa","id":"00f20fbd-c463-4137-b120-3628f0bd57fa","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"05adb543-5008-4800-94a8-a914e5b024fb","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"himanshu1@paysecure.net\",\r\n \"full_name\": \"OpHM\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"SB-124\",\r\n \"country\": \"BR\",\r\n \"city\": \"DLJPR\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"f1764688-d991-481b-be63-9ee7f33dcd31\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://google.com/\",\r\n \"failure_redirect\": \"https://facebook.com/\",\r\n \"pending_redirect\": \"https://paysecure.net\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.80.161.238\",\r\n \"checkout_url\": \"https://api.choicepay.ca/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.choicepay.ca/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"7fb23790-4b86-4b46-8241-75fe235ceb00","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"3650713e-dbbe-43e8-b7f2-09cd0b1ce0f8"}],"id":"00f20fbd-c463-4137-b120-3628f0bd57fa","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6ff637b4-6d33-454d-9510-bd0f0c7822e6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"997f4d68-cf32-4e3e-b85f-dabd79a83a02","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"00f20fbd-c463-4137-b120-3628f0bd57fa","description":""}],"id":"82a70137-3b50-42dd-b13b-c78308dde29e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5edc9d3a-d3d6-4aa0-bf4b-d62efef1f209","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"13c2507f-e1c9-45f3-b599-0f551ebfe68c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"82a70137-3b50-42dd-b13b-c78308dde29e","description":""},{"name":"🌎 Apple Pay (Seamless)","item":[{"name":"Concepts","item":[],"id":"c6a84b27-89f1-4950-b951-b5fe7685a8ca","description":"Get started
\nPaysecure’s Server-to-Server (S2S) integration for Apple Pay allows merchants to process Apple Pay transactions securely from their backend systems. In this model, merchants are responsible for generating the Apple Pay payment token on their client application and sending it to their server, which then communicates with Paysecure APIs.
\nThis integration uses DIRECT tokenization, where payment data is securely generated by Apple Pay and passed to Paysecure for processing.
\nThis integration is recommended for merchants who require:
\n- \n
Integration with Apple Pay wallets
\n \nSecure handling of tokenized payment data
\n \nFlexibility in choosing PCI scope (encrypted vs decrypted flow)
\n \n
\n
How it works
\nThe Apple Pay S2S payment flow follows a two-step process:
\n1. Generate Apple Pay Token (Client-side)
\nThe merchant integrates Apple Pay SDK (Web/Android) to generate a payment token using DIRECT flow.
\n2. Submit Token via S2S
\nThe merchant server sends the Apple Pay token (encrypted or decrypted) to Paysecure via the /purchase API.
\n\n
Apple Pay Processing Overview
\nApple Pay transactions are processed as card-not-present payments using:
\n- \n
Tokenized card data (DPAN)
\n \nCryptogram generated by Apple
\n \nDevice-based authentication (Face ID / Touch ID / Passcode)
\n \n
These transactions go through:
\n- \n
Card network (Visa, Mastercard, Amex, etc.)
\n \nIssuing bank authorization
\n \nRisk and fraud checks
\n \n
\n
Integration Options
\nPaysecure supports two integration modes:
\n\n
1. Encrypted Token Flow (Recommended)
\nIn this flow, the merchant sends the encrypted Apple Pay token to Paysecure. Paysecure decrypts and processes the payment.
\nKey Characteristics
\n- \n
Merchant does not handle PAN
\n \nReduced PCI scope
\n \nRecommended for most merchants
\n \n
PCI Impact
\nMerchants can significantly reduce PCI DSS scope since sensitive card data is handled by Paysecure.
\n\n
2. Decrypted Token Flow
\nIn this flow, the merchant decrypts the Apple Pay token and sends card details to Paysecure.
\nKey Characteristics
\n- \n
PAN/DPAN available at merchant side
\n \nFull control over payment data
\n \n
PCI Impact
\nMerchants must be PCI DSS compliant (SAQ D) as they handle raw card data.
\n\n
Before you begin
\nEnsure the following prerequisites are met:
\n- \n
You have received your API credentials from Paysecure
\n \nYou have an Apple Merchant ID
\n \nYou have configured Apple Pay on your domain/app
\n \nYour server can make secure HTTPS requests
\n \nYou have a valid brand_id provided by Paysecure
\n \n
\n
Additional Requirements (Encrypted Flow)
\n- \n
Configure Apple Pay certificates (Payment Processing Certificate)
\n \nShare certificate details securely with Paysecure (if required)
\n \n
\n
Additional Requirements (Decrypted Flow)
\n- \n
Implement Apple Pay token decryption
\n \nUse Apple’s Payment Processing certificate and private key
\n \nEnsure full PCI DSS compliance
\n \n
To process an Apple Pay transaction, a Purchase must be created using the /purchases API. The Apple Pay token must be included under extraParam.applepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
To process an Apple Pay transaction, a Purchase must be created using the /purchases API. The Apple Pay token must be included under extraParam.applepay_param.
\nTo generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nParameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
This API tells you about all the details of a purchase (PayIn), including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d6b3e1ec-5e8c-4dad-89b1-94de65b6052b","id":"d6b3e1ec-5e8c-4dad-89b1-94de65b6052b","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"88812de1-05f4-46cc-a6df-5071b35383e1","name":"Purchase - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"69cce01f5bae56fd5547a993\",\r\n \"client\": {\r\n \"customerId\": \"NA\",\r\n \"email\": \"himanshu1@paysecure.net\",\r\n \"full_name\": \"OpHM\",\r\n \"date_of_birth\": \"1800-01-01\",\r\n \"street_address\": \"SB-124\",\r\n \"country\": \"BR\",\r\n \"city\": \"DLJPR\",\r\n \"zip_code\": \"110001\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"DL\"\r\n },\r\n \"updated_on\": 1775034399,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"GOOGLEPAY\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"errorCode\": \"NA\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1775034399,\r\n \"merchantRef\": \"69cce01f5bae56fd5547a993\",\r\n \"purchase\": {\r\n \"currency\": \"USD\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"requestAmount\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"request_client_details\": [],\r\n \"email_message\": \"\"\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"Omega Pixel\",\r\n \"brand_name\": \"Omega Pixel\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {},\r\n \"country\": \"\",\r\n \"attempts\": []\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1775034399\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"f1764688-d991-481b-be63-9ee7f33dcd31\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS1032\",\r\n \"issued\": \"2026-04-01\",\r\n \"due\": 1775034399,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"extraFee\": \"0\",\r\n \"paidOn\": 0,\r\n \"receivedAmt\": 0.0,\r\n \"taxAmount\": 0.0,\r\n \"surcharge\": 0.0,\r\n \"surchargeType\": \"\",\r\n \"sessionId\": \"\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://google.com/\",\r\n \"failure_redirect\": \"https://facebook.com/\",\r\n \"pending_redirect\": \"https://paysecure.net\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.80.161.238\",\r\n \"checkout_url\": \"https://api.choicepay.ca/payments/6b5a5977ac8e022facb31f3346f61ed0/\",\r\n \"direct_post_url\": \"https://api.choicepay.ca/api/v1/p/69cce01f5bae56fd5547a993/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"5012686e-170a-4ece-8938-1c36efe4e863","name":"Purchase - failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"440ee1d3-bbab-4cea-839f-906bbfa21015"}],"id":"d6b3e1ec-5e8c-4dad-89b1-94de65b6052b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6ff637b4-6d33-454d-9510-bd0f0c7822e6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"997f4d68-cf32-4e3e-b85f-dabd79a83a02","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"d6b3e1ec-5e8c-4dad-89b1-94de65b6052b","description":""}],"id":"59acd0e3-9f0b-432f-bd6f-f6bf5479c57b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5edc9d3a-d3d6-4aa0-bf4b-d62efef1f209","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"13c2507f-e1c9-45f3-b599-0f551ebfe68c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"59acd0e3-9f0b-432f-bd6f-f6bf5479c57b","description":""},{"name":"🌐 Paymint - Crypto Wallet","item":[{"name":"Concepts","item":[],"id":"1ed487a7-97d2-418f-8ece-197e8ed30fcb","description":"Customer Payment Flow
\n1. Onboarding & Wallet Creation
\n- \n
Customer visits your site and selects a product/service.
\n \nAt checkout, if the merchant has not pre-populated the email field, the system prompts the customer to input their email address.
\n \n
2. Fiat Payment Initiation
\n- \n
Customer selects a payment method and pays in fiat (currency shown on the checkout screen).
\n \nPaysecure monitors the transaction and, on successful payment, give success to merchant.
\n \nOn the backend, we convert the amount to stablecoin (e.g., USDC).
\n \n
3. Post Fiat-Payment Notification
\n- \n
- Merchant can track the transaction through webhooks or the Paysecure dashboard. \n
4. Fiat to Crypto Conversion (Behind the scenes)
\n- \n
The fiat amount is converted to crypto using Paysecure’s exchange integrations.
\n \nThe converted crypto is credited to the customer’s wallet in real time.
\n \n
5. Merchant Crypto Settlement
\n- \n
The required amount is automatically transferred from the customer’s Paymint wallet to your merchant's Paymint wallet.
\n \nBoth transactions (funding and transfer) are recorded in Paysecure’s ledger for compliance and traceability.
\n \n
6. Wallet Management
Customer Dashboard Access Customers can manage their Paymint wallets through paymint.locker, where they can view wallet balance and transaction history.
7. Wallet Security
\n- \n
2FA verification for wallet access.
\n \nLedger integrity checks for all transactions.
\n \n
Wallet Recovery or Closure
\n- \n
- Customers can recover wallet access via OTP/email. \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThe purchase.expireInMin, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
However, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4719aa82-9154-4d48-9647-d86a0ab84de9","name":"Purchase- success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"seo2009@test.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"London\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"CA\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"CAD\",\r\n \"expireInMin\": \"80\",\r\n \"products\": [\r\n {\r\n \"name\": \"test \",\r\n \"price\": 100\r\n }\r\n ]\r\n },\r\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\r\n \"brand_id\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\r\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"pending_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://your.success.callback.url\",\r\n \"failure_callback\": \"https://your.success.failure.url\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"purchaseId\":\"67efd0ff97be603f97a3a697\",\"client\":{\"customerId\":\"NA\",\"email\":\"ashishm.21190@gmail.com\",\"phone\":\"+447755564318\",\"full_name\":\"Test test\",\"date_of_birth\":\"1970-07-10\",\"street_address\":\"10 New Burlington Street Apt. 214\",\"country\":\"CA\",\"city\":\"London\",\"zip_code\":\"W1S 3BE\",\"cc\":[],\"bcc\":[],\"gender\":\"MALE\",\"avatarUrl\":\"https://res.cloudinary.com/w22/image/upload/v1663783641/photos/currencies/ngn.png\",\"stateCode\":\"QLD\"},\"updated_on\":1743769856,\"type\":\"purchase\",\"paymentMethod\":\"INTERAC-ETRANSFER\",\"amountUnit\":\"MAJOR\",\"errorMsg\":\"\",\"redirectType\":\"GET\",\"force_recurring\":false,\"created_on\":1743769855,\"merchantRef\":\"67efd0ff97be603f97a3a697\",\"merchantName\":\"arunsinghal\",\"purchase\":{\"currency\":\"CAD\",\"products\":[{\"name\":\"test\",\"quantity\":1.0,\"price\":1.0,\"discount\":0,\"tax_percent\":\"0.00\"}],\"total\":1.0,\"language\":\"en\",\"notes\":\"\",\"debt\":0,\"total_formatted\":1.0,\"expireInMin\":\"43200\",\"taxAmount\":0.0,\"taxPercent\":0.0,\"request_client_details\":[],\"email_message\":\"\"},\"payment\":{\"is_outgoing\":false,\"payment_type\":\"PURCHASE\",\"amount\":1.0,\"currency\":\"CAD\",\"net_amount\":1.0,\"fee_amount\":0.0,\"pending_amount\":0.0,\"pending_unfreeze_on\":null,\"description\":\"\",\"paid_on\":1743769855,\"remote_paid_on\":1743769855},\"issuer_details\":{\"website\":\"\",\"legal_street_address\":\"\",\"legal_country\":\"\",\"legal_city\":\"\",\"legal_zip_code\":\"\",\"bank_accounts\":[{}],\"legal_name\":\"test6\",\"brand_name\":\"test6\",\"registration_number\":\"\",\"tax_number\":\"\"},\"transaction_data\":{\"payment_method\":\"\",\"flow\":\"payform\",\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"},\"country\":\"\",\"attempts\":[{\"client_ip\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"type\":\"execute\",\"payment_method\":\"INTERAC-ETRANSFER\",\"flow\":\"payform\",\"successful\":true,\"country\":\"INTERAC-ETRANSFER\",\"processing_time\":1743769855,\"extra\":{\"amount\":1.0,\"masked_pan\":\"INTERAC-ETRANSFER\"}}]},\"status\":\"PAYMENT_IN_PROCESS\",\"status_history\":[{\"status\":\"created\",\"timestamp\":1743769855},{\"status\":\"pending_execute\",\"timestamp\":1743769855},{\"status\":\"payment_in_process\",\"timestamp\":1743769856},{\"status\":\"viewed\",\"timestamp\":1744026697}],\"viewedOn\":1744026697,\"is_test\":false,\"brand_id\":\"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\"send_receipt\":false,\"is_recurring_token\":false,\"skip_capture\":false,\"reference_generated\":\"PS620\",\"issued\":\"2025-04-04\",\"due\":1743769855,\"refund_upto\":0,\"cc_descriptor\":\"Africhange Technologies\",\"fraudScore\":\"NA\",\"trustScore\":\"NA\",\"payInDetails\":{\"name\":\"INTERAC\",\"emailAddress\":\"transfer@ieft.ca\",\"secretQA\":\"66a8c78af1fc2f768304bce4\",\"secretAnswer\":\"ps8766a8af\"},\"paidOn\":0,\"receivedAmt\":0.0,\"refund_availability\":\"NONE\",\"refundable_amount\":0.0,\"success_redirect\":\"https://your.redirect.url/getResponse.jsp?success=true\",\"failure_redirect\":\"https://your.redirect.url/getResponse.jsp?success=false\",\"cancel_redirect\":\"\",\"success_callback\":\"https://your.success.callback.url\",\"failure_callback\":\"https://your.success.failure.url\",\"platform\":\"API\",\"created_from_ip\":\"103.59.75.41, 162.158.88.44, 130.176.93.146\",\"checkout_url\":\"https://api.choicepay.ca/payments/67efd0ff97be603f97a3a697/\",\"payoutProcess\":false}"}],"_postman_id":"92d46cd4-9e67-424e-99bc-ca81676c90ac"},{"name":"Get Status","id":"b431e2a4-2e55-4322-a223-3f4861e0f761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"01e5e26f-1b1a-4d55-ac2c-79bc2e26a63c","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6790e75fa46a5a5bb0b00e55\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"ashishm.21190@gmail.com\",\n \"phone\": \"+14377717874\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"gender\": \"MALE\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1737549752,\n \"type\": \"purchase\",\n \"paymentMethod\": \"INTERAC-ETRANSFER\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"Transaction succeeded-APPROVED\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1737549663,\n \"merchantRef\": \"6790e75fa46a5a5bb0b00e55\",\n \"merchantName\": \"arunsinghal\",\n \"purchase\": {\n \"currency\": \"CAD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 2,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"43200\",\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"CAD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1737549663,\n \"remote_paid_on\": 1737549663\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\n \"type\": \"execute\",\n \"payment_method\": \"INTERAC-ETRANSFER\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"INTERAC\",\n \"processing_time\": 1737549663,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"INTERAC-ETRANSFER\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1737549663\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1737549664\n },\n {\n \"status\": \"paid 2.0\",\n \"timestamp\": 1737549752\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1737549750\n }\n ],\n \"viewedOn\": 1738749942,\n \"is_test\": false,\n \"brand_id\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS376\",\n \"issued\": \"2025-01-22\",\n \"due\": 1737549663,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"Africhange Technologies\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"name\": \"INTERAC\",\n \"emailAddress\": \"deposit@ieft.ca\",\n \"secretQA\": \"66a8c78af1fc2f768304bce4\",\n \"secretAnswer\": \"ps8766a8af\"\n },\n \"paidOn\": 1737549752,\n \"receivedAmt\": 2,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.redirect.url/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://your.redirect.url/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"failure_callback\": \"https://webhook.site/83df9776-3590-4e25-9222-870e931ac868\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.42, 172.71.186.102, 130.176.183.14\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6790e75fa46a5a5bb0b00e55/\",\n \"payoutProcess\": false\n}"},{"id":"ab504a8a-46e6-44f3-bfa1-0ff18f16f872","name":"Purchases Error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"b431e2a4-2e55-4322-a223-3f4861e0f761"}],"id":"67f75209-0017-4799-9838-0e9c3ebc564f","description":"API Flow
\n- \n
The merchant initiates the purchase via the
\n/purchasesAPI. If successful, they receive PayIn details along with a checkout URL in the response JSON \nThe merchant then has 2 options
\n- \n
If the \"paymentMethod\" is passed, the payment instructions are shared with the customer. The flow differs as per the payment method.
\n \nIf the \"paymentMethod\" is not passed, the custoemr is redirected to Paysecure cashier and complet the payment.
\n \n
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant and the user would be redirected to the appropriate success or failure redirect URL.
\n \n
Overview
\nPaymint is a new payment method by Paysecure that allows your customers to pay in fiat while you receive funds directly in cryptocurrency, such as USDC. With Paymint, you can offer your customers a seamless payment experience in their local currency, while crypto conversion and settlement are handled in the background.
This guide explains the core concepts and outlines the API integration steps required to enable Paymint on your platform.
1. What Is a Neosurf Voucher?
\nA Neosurf voucher is a prepaid payment instrument that lets users make online purchases without needing a bank account or credit card. Each voucher comes with a unique code (and sometimes a PIN) and is issued in fixed denominations. These vouchers are particularly popular for digital goods and services such as gaming, software, and entertainment.
\nKey Features:
\n- \n
Prepaid & Secure: Funds are preloaded, reducing fraud risk.
\n \nAnonymous: No need to share personal banking details.
\n \nFixed Denominations: Typically available in preset values (e.g., €10, €20, €50).
\n \nInstant Use: Once purchased, the voucher can be used immediately for online transactions.
\n \n
\n
2. How Can a Customer Buy a Neosurf Voucher?
\nNeosurf vouchers are available both online and at physical retail locations. Availability varies by region, and the list below provides a general guide.
\nEurope
\n- \n
Western & Central Europe:
\n- \n
Countries: France, Germany, United Kingdom, Italy, Spain, Belgium, Netherlands, Luxembourg, Switzerland, Austria, Portugal, Ireland, Denmark, Sweden, Norway, Finland.
\n \nWhere to Buy: Local convenience stores, newsagents, supermarkets, and authorized online resellers.
\n \n
\nEastern Europe:
\n- \n
Countries: Poland, Czech Republic, Hungary, Romania, etc.
\n \nWhere to Buy: Local retail outlets and specialized online vendors.
\n \n
\n
North America
\n- \n
United States & Canada:
\n- \n
- Where to Buy: Select online vendors and select physical retail outlets (availability may be limited). Always verify with local authorized distributors. \n
\n
Asia
\n- \n
Southeast Asia:
\n- \n
Countries: Singapore, Malaysia, Indonesia, Thailand.
\n \nWhere to Buy: Authorized e-voucher platforms online.
\n \n
\nOther Regions:
\n- \n
- Availability may vary. Check the Neosurf official website for up-to-date information. \n
\n
Africa
\n- \n
Example Countries:
\n- \n
- South Africa, Morocco, Tunisia: Available through select online platforms and local authorized vendors. \n
\n
Oceania
\n- \n
Australia & New Zealand:
\n- \n
- Vouchers may be available primarily via online resellers; check local availability. \n
\n
\n\nNote: For the most comprehensive and current list of regions and authorized vendors, please refer to the official Neosurf website or contact Neosurf support.
\n
\n
3. How to Pay Using a Neosurf Voucher
\nThe payment process using a Neosurf voucher with Paysecure is streamlined to offer a secure and user-friendly checkout experience. The high-level flow is as follows:
\n- \n
User Selects Neosurf at Checkout:
\nOn your payment page, the customer chooses “Neosurf” as their payment method.
\n \nAPI Call Initiation:
\n- \n
Merchant invokes Paysecure’s
\n/v1/purchasesendpoint withpaymentMethod = NEOSURF. \nPaysecure returns a
\ncheckoutUrlwhere the customer is redirected to Neosurf page and asked to enter their Neosurf voucher code or pay via MyNeosurf account in selected regions. \n
\nVoucher Validation:
\nNeosurf checks the voucher’s validity and available balance. If valid, the billing amount is debited from the voucher.
\n \nTransaction Confirmation:
\nA successful webhook response confirms the transaction, and the merchant system can finalize the order.
\n \n
4. Why Should a Merchant Accept NeoSurf Voucher?
\nIntegrating Neosurf offers several compelling advantages for merchants:
\n- \n
Broader Customer Reach:
\n- \n
- Attract customers without bank accounts or credit cards, especially in regions where traditional banking is less prevalent. \n
\nEnhanced Security & Reduced Fraud:
\n- \n
- Prepaid vouchers reduce the risk of fraudulent transactions since funds are preloaded. \n
\nIncreased Conversion Rates:
\n- \n
- Offering a simple and fast payment option can lower cart abandonment rates, particularly in digital and gaming markets. \n
\nCustomer Privacy:
\n- \n
- NeoSurf enables anonymous transactions, appealing to users concerned about data privacy. \n
\nCompetitive Advantage:
\n- \n
- Stand out by offering multiple payment options, making your platform more attractive to a diverse audience. \n
\nStreamlined Integration:
\n- \n
- With direct integration via Paysecure’s API, merchants can quickly add NeoSurf without complex changes to their existing payment workflows \n
\n
Accepting NeoSurf not only diversifies your payment portfolio but also taps into a growing market of digital consumers looking for secure, convenient, and privacy-focused payment options.
\n","_postman_id":"7252f287-c86d-450c-977a-27a17be513ac"},{"name":"Payin API","item":[{"name":"Purchases","id":"120ba5e0-b3d5-4480-a21c-03eadbd4f27d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"example22@paysecure.net\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"NEOSURF\",\n \"brand_id\": \"{{your_brand_id_}}\",\n \"send_receipt\": \"\",\n \"skip_capture\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"The API endpoint /v1/purchases is a POST request used to create a new purchase. The request body should contain the client information including email, address, and phone, the purchase details such as currency and products, the payment method, and various callback and redirect URLs.
\nFinal Steps for Payin API Integration
\n- \n
Set Up Authentication & Headers
\n- \n
Endpoint: POST >
\n \nHeaders (mandatory):
\n- \n
Authorization: Bearer {LIVE_API_KEY}
\n \nContent-Type: application/json
\n \n
\n
\nConstruct the Request Payload
\n- \n
Build a JSON body with:
\n- \n
client object (KYC/AML fields):
\n- \n
email
\n \ncountry (ISO-2 code)
\n \ncity
\n \nstateCode
\n \nstreet_address
\n \nzip_code
\n \nphone
\n \n
\npurchase object:
\n- \n
currency
\n \nproducts array (≥1 item with name and price)
\n \n
\nTop-level fields:
\n- \n
paymentMethod (e.g., \"NEOSURF\")
\n \nbrand_id (your Brand UUID)
\n \nsuccess_redirect (HTTPS URL after success)
\n \nfailure_redirect (HTTPS URL after failure)
\n \n
\n
\n
\nInvoke the Payin API
\n- \n
Send the JSON payload to https://api.paysecure.net/v1/purchases
\n \nExpect 200 OK with a response containing:
\n- \n
purchaseId
\n \nstatus = PENDING
\n \ncheckout_url
\n \n
\n
\nExtract Key References
\n- \n
purchaseId (e.g., 68394314d3c4ef68d6cbb58c): for tracking/reconciliation.
\n \ncheckout_url (e.g., https://api.paysecure.net/payments/68394314d3c4ef68d6cbb58c/): redirect here so the customer can complete voucher entry.
\n \nRedirect Customer
\nwindow.location.href = response.checkout_url;Customer enters their 10-digit Neosurf voucher on redirected page. \n
\nListen for Webhook Notifications
\n- \n
Ensure your endpoint handles:
\n- \n
purchase.paid
\n \npurchase.error
\n \npurchase.cancelled
\n \n
\nEach payload will include purchaseId, status, amount, currency, etc.
\n \n
\n
Mandatory Parameters
\n","urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"17233b96-b785-4d48-8564-a465be451246","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"example22@paysecure.net\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"price\": \"1\"\n }\n ]\n },\n \"paymentMethod\": \"NEOSURF\",\n \"brand_id\": \"{{your_brand_id_}}\",\n \"send_receipt\": \"\",\n \"skip_capture\": \"\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"683d6bab12b471481d4f66cf\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"example22@paysecure.net\",\n \"phone\": \"9999999999\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1748855724,\n \"type\": \"purchase\",\n \"paymentMethod\": \"NEOSURF\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1748855723,\n \"merchantRef\": \"683d6bab12b471481d4f66cf\",\n \"merchantName\": \"arunsinghal\",\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 1,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 1,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 1,\n \"currency\": \"AUD\",\n \"net_amount\": 1,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1748855723,\n \"remote_paid_on\": 1748855723\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"NEOSURF\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.242, 162.158.23.126, 130.176.183.12\",\n \"type\": \"execute\",\n \"payment_method\": \"NEOSURF\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"NEOSURF\",\n \"processing_time\": 1748855723,\n \"extra\": {\n \"amount\": 1,\n \"masked_pan\": \"NEOSURF\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748855723\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1748855723\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1748855724\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"30f7ce6e-3b7e-46a2-9b50-484fc55be689\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS784\",\n \"issued\": \"2025-06-02\",\n \"due\": 1748855723,\n \"refund_upto\": 1749024924,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"paidOn\": 0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 1,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.242, 162.158.23.126, 130.176.183.12\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/683d6bab12b471481d4f66cf/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"120ba5e0-b3d5-4480-a21c-03eadbd4f27d"}],"id":"81b36078-69fc-4f59-938c-162480cd2a86","_postman_id":"81b36078-69fc-4f59-938c-162480cd2a86","description":""},{"name":"Payout API","item":[{"name":"Payout API","id":"a2e61826-e638-45a1-9d52-82cfffee405d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"akshayadeepsinghal@gmail.com\",\n \"country\": \"AU\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"stateCode\": \"test\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-NEOSURF\",\n \"amount\": 1,\n \"success_callback\": \"https://success.com\",\n \"failure_callback\": \"https://failure.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"Create Payout
\nThis endpoint allows you to initiate a payout transaction.
\nRequest Body
\n- \n
\nclient(object, required): Details of the client initiating the payout.- \n
\nemail(string): The email of the client. \n
\ncountry(string): The country of the client. \n
\nphone(string): The phone number of the client. \n
\nfull_name(string): The full name of the client. \n
\nstateCode(string): The state code of the client. \n
\n
\npurpose(string, required): The purpose of the payout. \n
\ncurrency(string, required): The currency of the payout. \n
\npayoutMethod(string, required): The method of payout. \n
\namount(number, required): The amount of the payout. \n
\nsuccess_callback(string, required): The URL to which the success callback will be sent. \n
\nfailure_callback(string, required): The URL to which the failure callback will be sent. \n
Response Body
\nThe response will contain the details of the initiated payout transaction.
\n","urlObject":{"protocol":"https","path":["api","v1","payout",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"0c96792c-9c7a-4b84-a1be-97e5a162b85b","name":"New Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{your_API_Key}}"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"akshayadeepsinghal@gmail.com\",\n \"country\": \"AU\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"stateCode\": \"test\"\n },\n \"purpose\": \"test payout\",\n \"currency\": \"AUD\",\n \"payoutMethod\": \"PAYOUT-NEOSURF\",\n \"amount\": 1,\n \"success_callback\": \"https://success.com\",\n \"failure_callback\": \"https://failure.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"payoutId\": \"683d6fee57aff00ab5faf3c6\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"akshayadeepsinghal@gmail.com\",\n \"phone\": \"+11111111\",\n \"full_name\": \"PAYOUT USER\",\n \"country\": \"AU\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1748856814,\n \"payoutMethod\": \"PAYOUT-NEOSURF\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1,\n \"errorMsg\": \"\",\n \"purpose\": \"test payout\",\n \"created_on\": 1748856814,\n \"merchantRef\": \"683d6fee57aff00ab5faf3c6\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1748856814\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1748856816\n }\n ],\n \"currency\": \"AUD\",\n \"paymentOn\": 1748856816,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"redirectType\": \"POST\",\n \"success_callback\": \"https://success.com\",\n \"failure_callback\": \"https://failure.com\"\n}"}],"_postman_id":"a2e61826-e638-45a1-9d52-82cfffee405d"}],"id":"879fab7b-7b05-48c9-8cc9-83a6c2f4a9ab","_postman_id":"879fab7b-7b05-48c9-8cc9-83a6c2f4a9ab","description":""}],"id":"ee3d7a36-88f2-43d9-b5f2-48e854c83239","description":"Neosurf is now available as a payment method on Paysecure, giving your customers a fast, secure, and convenient prepaid payment option. This guide explains what a Neosurf voucher is, how to acquire one across different regions, how to process a payment with it, and other key details of the integration.
\n","_postman_id":"ee3d7a36-88f2-43d9-b5f2-48e854c83239"},{"name":"🇦🇺 PayID","item":[{"name":"Concepts","item":[],"id":"a513eff8-0040-4872-9f1f-5e9c53351119","description":"What is a PayID?
\nA PayID is a user-friendly alias (such as an email, mobile number, or ABN) linked to a bank account. Payments made to a PayID are resolved in real-time via the NPP (New Payments Platform) to the associated account.
\nUse Cases
\n- \n
PayIn: Accept customer payments instantly with lower failure rates and no chargebacks.
\n \nPayOut: Send real-time refunds, payroll, commissions, or supplier settlements via PayID.
\n \n
\n
PayIn Customer Journey
\n- \n
Customer Initiates Payment
\n
On the merchant’s checkout page or app, the user selects PayID as the payment method and proceeds. \nAPI Call to Paysecure
\n
The merchant initiates aPOST /purchasesrequest with transaction details (amount, currency). Paysecure responds with apurchaseId,checkoutUrl, and a merchant PayID to which the customer should transfer funds. \nCustomer Authorizes via Banking App
\n
The customer logs into their internet or mobile banking, enters the PayID (received from Paysecure), the exact amount, and confirms the transfer. \nReal-time Bank Transfer
\n
The customer’s bank processes the payment via NPP. Funds are instantly credited to Paysecure’s account. \nWebhook Notification
\n
Once payment is received, Paysecure sends a webhook (purchase.paid) to the merchant. Merchant updates order status to “paid.” \nError Handling
\n
If the payment fails (due to invalid PayID, rejection by bank, or insufficient funds), Paysecure returns apurchase.failedstatus. \n
\n
PayOut Customer Journey
\n- \n
User Requests Withdrawal
\n
A user initiates a payout (e.g., a refund, reward, or withdrawal) from the merchant interface. \nMerchant Approval
\n
The merchant verifies and approves the request. \nAPI Call to Paysecure
\n
Merchant sends aPOST /payoutsrequest with:- \n
Recipient's PayID (e.g., email or phone)
\n \nAmount
\n \nCurrency
\n \nOptional reference or metadata
\n \n
\nBank Transfer via NPP
\n
Paysecure initiates the payout. Funds are credited to the recipient’s bank account in real-time via NPP. \nWebhook Notification
\n
Once successful, Paysecure notifies the merchant (payout.success) so they can update their system. \nFailure Scenarios
\n
If the PayID is invalid or unregistered, the payout fails. Paysecure responds with an error, and the merchant can retry after fixing the issue. \n
\n","_postman_id":"a513eff8-0040-4872-9f1f-5e9c53351119"},{"name":"Payin API","item":[{"name":"Purchases","id":"13518cad-f986-4965-a8d7-40d727f1abcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"seo2009@test.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"Sydney\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\n \"country\": \"AU\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"price\": 100\n }\n ]\n },\n \"paymentMethod\": \"PAYID\",\n \"brand_id\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\n \"success_redirect\": \"
Purchase API Endpoint
\nThis endpoint allows you to create a new purchase transaction. It processes the purchase details, including client information, product details, and payment method, and returns the result of the transaction.
\nRequest Format
\n- \n
Method: POST
\n \nURL:
\nhttps://api.paysecure.net/api/v1/purchases\nRequest Body: The request should be in JSON format and must include the following structure:
\n \n
Response Structure
\nThe response will contain the result of the purchase transaction. The structure of the response may include:
\n- \n
status: Indicates the success or failure of the transaction.
\n \nmessage: A descriptive message regarding the transaction status.
\n \ntransaction_id: Unique identifier for the transaction (if successful).
\n \nredirect_url: URL to redirect the user based on the transaction result.
\n \n
Make sure to handle the response appropriately based on the status returned.
\n","urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"e5317fce-70d4-4c71-9bd3-5e235299c91d","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"seo2009@test.com\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"city\": \"Sydney\",\n \"full_name\": \"Test test\",\n \"zip_code\": \"W1S 3BE\",\n \"country\": \"AU\",\n \"stateCode\": \"QLD\",\n \"phone\": \"+447755564318\"\n },\n \"purchase\": {\n \"currency\": \"AUD\",\n \"products\": [\n {\n \"name\": \"test\",\n \"price\": 100\n }\n ]\n },\n \"paymentMethod\": \"PAYID\",\n \"brand_id\": \"f6aff7d7-bb40-4857-bc84-9b4c8310b043\",\n \"success_redirect\": \"Payout Request API
\nThis endpoint allows clients to initiate a payout transaction. It requires specific details about the client and the payout method to process the request successfully.
\nRequest Format
\nThe request must be sent as a JSON object in the raw body. The following parameters are expected:
\n- \n
client: An object containing client information.
\n- \n
email (string): The email address of the client.
\n \ncountry (string): The country of the client.
\n \nphone (string): The phone number of the client.
\n \nfull_name (string): The full name of the client.
\n \n
\npurpose (string): A brief description of the reason for the payout (e.g., \"testing payout\").
\n \ncurrency (string): The currency in which the payout is to be made (e.g., \"AUD\").
\n \npayoutMethod (string): The method used for the payout (e.g., \"PAYOUT-PAYID\").
\n \namount (number): The amount to be paid out.
\n \nextraParam: An object containing additional payout parameters.
\n- \n
payId (string): The unique identifier for the payout.
\n \nbankName (string): The name of the bank associated with the payout.
\n \naccountName (string): The name on the account receiving the payout.
\n \n
\nsuccess_callback (string): A URL that will be called upon successful completion of the payout.
\n \nfailure_callback (string): A URL that will be called if the payout fails.
\n \n
Response Structure
\nThe response from this endpoint will typically include details about the status of the payout request, which may include:
\n- \n
A success message or error details.
\n \nA transaction ID for tracking purposes.
\n \nAny additional information relevant to the payout process.
\n \n
Ensure to handle both success and failure callbacks appropriately based on the response received from this endpoint.
\n","urlObject":{"protocol":"PayID is a real-time payment method in Australia built on the New Payments Platform (NPP). It allows customers to make or receive payments using simple identifiers like their mobile number or email address, eliminating the need to remember BSB and account numbers.
\nPaysecure enables merchants to both accept payments (PayIn) and send payouts (PayOut) using PayID. Transactions are settled instantly, and users benefit from seamless user experience with low friction.
\n","_postman_id":"1bfa27ea-6d5d-4ea3-96a0-fdc6218087bc"},{"name":"🌐 CryptoBridge","item":[{"name":"Concepts","item":[],"id":"7996156e-73f2-4897-b2c9-3096d5f2f5dd","description":"💸 Customer PayIn Journey
\n- \n
Checkout
\n
Customer chooses CryptoBridge as the payment method on merchant's checkout page. \nPayment Pop-up Opens
\n
A secure pop-up opens where the customer:- \n
Selects their preferred exchange or DeFi wallet
\n \nLinks the account
\n \nSelects the eligible token and blockchain network
\n \n
\nFee Preview
\n
Customer reviews the full fee structure:- \n
Gas Fee: Network charge
\n \nInstitution Fee: Fee from exchange or wallet provider
\n \nClient Fee: Optional merchant fee (can be configured via
\nclientFeeparam) \n
\nAuthentication & Confirmation
\n
The customer authenticates (if required by the linked wallet or exchange) and confirms the transfer. \nPayment & Notification
\n
On successful transfer:- \n
Crypto is sent to the merchant's receiver address
\n \nWebhook is triggered to notify merchant of successful payment
\n \nCustomer is redirected to success or failure URL based on transaction outcome
\n \n
\nSmart-Finding (Auto Swap)
\n
If customer lacks sufficient balance in selected token, the system suggests a real-time token swap—reducing drop-offs and boosting conversions. \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\n💡 Key Fields Explained
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9c83ec79-0519-44a1-ae6a-172ce50ba8b3","id":"9c83ec79-0519-44a1-ae6a-172ce50ba8b3","name":"Payin API","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"464d69c5-e208-4517-a598-172e02ff9d27","name":"Purchases","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"gaurav@gmail.com\",\n \"full_name\": \"Gaurav Test\",\n \"country\": \"US\",\n \"city\": \"123\",\n \"stateCode\": \"NYC\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"9999999999\"\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"price\": 5.86\n }\n ]\n },\n \"paymentMethod\": \"CRYPTO-BRIDGE\",\n \"brand_id\": \"cec67fe3-a01d-4d0d-b100-9fafb200fe15\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"extraParam\": {\n \"clientFee\": 0.1, //optional\n \"toAddress\": [\n {\n \"symbol\": \"ETH\",\n \"networkName\": \"ETHEREUM\",\n \"address\": \"0xc4db7bBB898B98D15be823454d1dff6C308BC9A4\"\n },\n {\n \"symbol\": \"USDC\",\n \"networkName\": \"POLYGON\",\n \"address\": \"0xc4cs7bBB898B89D15be823445d1dff6C380BC9D3\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"6874ce9402f0f25ed8fc66a7\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"gaurav@gmail.com\",\n \"phone\": \"9999999999\",\n \"full_name\": \"Test test\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"test test\",\n \"country\": \"US\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"39933551809\",\n \"stateCode\": \"NYC\"\n },\n \"updated_on\": 1752485524,\n \"type\": \"purchase\",\n \"paymentMethod\": \"CRYPTO-BRIDGE\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"GET\",\n \"force_recurring\": false,\n \"created_on\": 1752485524,\n \"extraParam\": {\n \"clientFee\": 0.1,\n \"toAddress\": [\n {\n \"symbol\": \"ETH\",\n \"network\": \"ETHEREUM\",\n \"address\": \"0xc4db7bBB898B98D15be823454d1dff6C308BC9A4\"\n },\n {\n \"symbol\": \"USDC\",\n \"network\": \"POLYGON\",\n \"address\": \"0xc4cs7bBB898B89D15be823445d1dff6C380BC9D3\"\n }\n ]\n },\n \"merchantRef\": \"6874ce9402f0f25ed8fc66a7\",\n \"merchantName\": \"test\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"quantity\": 1,\n \"price\": 5.86,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 5.86,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"taxAmount\": 0,\n \"taxPercent\": 0,\n \"request_client_details\": [],\n \"timezone\": \"Asia/Hong_Kong\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 5.86,\n \"currency\": \"USD\",\n \"net_amount\": 5.86,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1752485524,\n \"remote_paid_on\": 1752485524\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"iUnicharge\",\n \"brand_name\": \"iUnicharge\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 5.86,\n \"masked_pan\": \"CRYPTO-BRIDGE\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.157, 172.69.203.75, 18.68.12.102\",\n \"type\": \"execute\",\n \"payment_method\": \"CRYPTO-BRIDGE\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"CRYPTO-BRIDGE\",\n \"processing_time\": 1752485524,\n \"extra\": {\n \"amount\": 5.86,\n \"masked_pan\": \"CRYPTO-BRIDGE\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1752485524\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1752485524\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1752485524\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"cec67fe3-a01d-4d0d-b100-9fafb200fe15\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1682\",\n \"issued\": \"2025-07-14\",\n \"due\": 1752485524,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"100\",\n \"trustScore\": \"2\",\n \"paidOn\": 0,\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.157, 172.69.203.75, 18.68.12.102\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/6874ce9402f0f25ed8fc66a7/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"e5aac5c2-09fc-4459-a55b-3ae1fec3bc2b"}],"id":"9c83ec79-0519-44a1-ae6a-172ce50ba8b3","description":"🔗 How to Accept Payments with CryptoBridge (PayIn API)
\nTo let your customers pay in crypto (while you list your prices in fiat), you need to initiate a Create Purchase API call from your backend when a customer selects CryptoBridge at checkout. This API tells PaySecure the details of the transaction, customer, and where to redirect the user after payment.
\n🔥 What Happens When You Call This API
\n- \n
You send order details (amount, products, etc.) in USD or any fiat currency
\n \nYou specify that the payment method is
\nCRYPTO-BRIDGE\nOptionally, you can add your own processing fee using
\nclientFee— this will be shown to the customer before they confirm payment \nPaySecure returns a secure
\ncheckout_urlwhich you can use to redirect the customer to a crypto payment pop-up \nThe customer pays using their crypto wallet or exchange, and once it's confirmed:
\n- \n
You get an instant webhook notification
\n \nThe user is redirected back to your success or failure page
\n \n
\n
📖 Overview
\nCryptoBridge is a fiat-denominated crypto payment method that allows merchants to list goods and services in fiat while accepting payment in crypto. The platform automatically handles real-time conversion, token selection, and network routing—abstracting all crypto complexities from the merchant.
\nCustomers can link their exchange or DeFi wallets (from over 400+ supported providers including Binance, Coinbase, Metamask, etc.) and make seamless crypto transfers. Fees such as gas, institutional charges, and optional merchant processing fees are transparently displayed and deducted before confirmation.
\n\n
✅ Key Benefits
\n- \n
Fiat-based pricing with crypto-native checkout
\n \nNo crypto inventory management needed
\n \nReal-time conversion of fiat to eligible tokens
\n \nAccess to 400+ exchanges and DeFi wallets
\n \nSmart token swapping feature for low-balance users – improves approval rates by up to 40%
\n \nFull transparency in fee breakdown: gas, institutional, merchant/client fee
\n \nWebhook-based confirmation for real-time order processing
\n \n
Payin
\nThe PayIn flow proceeds as follows:
\n- \n
Customer Initiates: The merchant’s site or app presents Virtual Account as a payment option to its customers. The customer selects it and clicks on Pay.
\n \nAPI Request: The merchant calls Paysecure’s PayIn API (e.g. POST
\n/purchases) with the transaction amount and the currency. Paysecure returns a purchase ID and provide a URL for the customer to continue. \nVirtual Account Displayed: The customer is shown their unique bank account details in which they need to deposit the money.
\n \nCustomer Authorisation: The customer logs into their online/mobile banking and adds the bank account as a beneficiary and amount provided by Paysecure. They confirm the transaction in their banking app.
\n \nReal-time Transfer: The customer’s bank sends the funds to the virtual account generated for the user.
\n \nNotification: Once payment is received, Paysecure triggers a webhook to the merchant with details (amount, currency, payer info, timestamp, etc.). The purchase status in Paysecure can also be queried via the get status API.
\n \nMerchant Fulfillment: Upon webhook confirmation, the merchant fulfills the order or credits the customer’s wallet.
\n \nIf any step fails (e.g. the bank account is invalid, the customer’s bank declines the transfer, or there are insufficient funds), Paysecure returns an error status. The merchant sees the payment failed and can prompt the customer to retry or choose another method.
\n \n
Payin API
\nIntegration Steps: To integrate Virtual Account payments with Paysecure, follow these steps:
\n- \n
Enable Virtual Account in Paysecure: Sign up with Paysecure and ensure the Virtual Account payment method is enabled for your merchant account. Get your API keys for authentication (test and live).
\n \nConfigure Webhooks: Set up Paysecure webhooks (e.g. transaction.paid, transaction.failed) so your system is notified of payment status changes.
\n \nImplement PayIn (Customer Payments): In your checkout flow, allow the customer to choose Virtual Account and then call Paysecure’s PayIn API (e.g. POST /purchases ) with parameters such as amount, currency and paymentMethod=VIRTUAL-ACCOUNT. To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header). Both can be located in the Dashboard section of your merchant account login.
\n \n
This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e61f373e-86e6-4269-b9fb-6e61c78c31b2","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"65f95faa70fe897720c40a15\",\r\n \"client\": {\r\n----\r\n },\r\n \"updated_on\": 1710841770,\r\n \"type\": \"purchase\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1710841770,\r\n \"merchantRef\": \"65f95faa70fe897720c40a15\",\r\n \"merchantName\": \"test\",\r\n \"purchase\": {\r\n----\r\n },\r\n \"issuer_details\": {\r\n-----\r\n },\r\n \"transaction_data\": {\r\n----\r\n },\r\n \"status\": \"CREATED\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1710841770\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS2697\",\r\n \"issued\": \"2024-03-19\",\r\n \"due\": 1710841770,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"paymentMethod\" : \"BANKTRANSFER\",\r\n \"brand_id\": \"90ed108b-6753-465d-8a21-e2cc604ff814 \",\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\"\r\n \"cancel_redirect\": \"\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"110.235.229.223\",\r\n \"checkout_url\": \"https://app.paysecure.net/payments/65f95faa70fe897720c40a15/\"\r\n}\r\n"},{"id":"8aab2a7a-a219-4da6-81e0-f884f297d3a9","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"f9054032-1a2f-4657-a1ef-a706115ead59"}],"id":"4fadd540-91b3-4fc4-b4f5-2358215f660e","_postman_id":"4fadd540-91b3-4fc4-b4f5-2358215f660e","description":""}],"id":"5c3b9f8c-0fa3-433c-88e5-b51b374b47dd","description":"A Virtual Account (VA) is a unique, system-generated bank account number provided to a merchant or end-customer for the purpose of collecting payments.
\nUnlike a traditional pooled account where many customers pay into the same bank account and merchants must rely on payer references to reconcile funds, a Virtual Account is unique per customer, transaction, or use case. This ensures that when a payment is received, it is automatically mapped and reconciled to the correct merchant/customer without manual intervention.
\nConcepts
\n- \n
Unique Identifiers: Each VA has its own account number or IBAN.
\n \nSeamless Reconciliation: Payments are matched automatically based on the VA, eliminating reliance on free-text references.
\n \nLocal & Cross-Border Coverage: Can be issued in multiple currencies and geographies (e.g., USD ACH, EUR SEPA, GBP FPS, INR UPI).
\n \nTemporary or Permanent: Can be dynamic (per transaction/session) or static (per customer).
\n \nBank-Grade Security: Issued through Paysecure’s partner banks and fully compliant with local regulations.
\n \n
Benefits
\n- \n
Operational Efficiency – no manual reconciliation of payer references.
\n \nImproved Customer Experience – clear payment instructions, fewer failed/misapplied payments.
\n \nGlobal Reach – merchants can collect funds locally in multiple regions without needing a local bank entity.
\n \nScalability – supports thousands of customers with individual VAs.
\n \n
Use Cases
\n- \n
User-Specific Collections & Attribution: Assign a unique VA to each user or customer, enabling precise tracking and reconciliation. Ideal for platforms needing granular visibility into who sent what and when.
\n \nDigital Wallets & Balances: Support digital wallets by integrating dedicated VAs per wallet to manage real-time balances.
\n \nIn-House Banking / Treasury Management: Use VAs to simulate an internal banking structure. This supports efficient ledger transfers between your internal entities, lowering operational cost and friction.
\n \nOne-Time Transaction Handling (Events, Invoices, Deposits): Create temporary or dynamic VAs for specific, short-term needs.
\n \nLocal & Multi-Currency Receivables: Facilitate local payments in multiple currencies and countries without opening physical accounts.
\n \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nEssential Optional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nUpon successul create on a Purchase you'd get a \"purchaseId\" . Use this ID for the next step in Server to server call by calling p/{purchaseId}/?s2s=true .
paymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"91acdd13-96dc-4951-a2fe-f35eba7bc261","id":"91acdd13-96dc-4951-a2fe-f35eba7bc261","name":"🌎 Paypal Wallet","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f3a48139-3449-452c-9e4c-828fb597f757","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"example@paysecure.net\",\n \"country\": \"US\",\n \"city\": \"New York\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"+1 202 555 0185\"\n },\n \"purchase\": {\n \"products\": [\n {\n \"name\": \"Apple\",\n \"price\": \"10\"\n }\n ]\n },\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e \",\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"paymentMethod\" : \"PAYPAL\",\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sun, 15 Feb 2026 03:50:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"bff1fdeb-28e1-453f-b2c0-99f3a69a4938"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3b66cea026f27925ba048cc96a0885ca.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"yfsFsvL9XV7VqG78CQKk9laeRufDW3YWnRMAbS5V0kuDeFbLRHCRoA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=ph60P%2FQ%2BttujGhCyzKI4n0CieSKGeWXBq3hNAFV28RI6CHN0ZTI40y6TOdReaik7ID1%2BIrBFGqV3ifMplb6P4ahjmnh9pVLeT9kmoh4DzVA%3D\"}]}"},{"key":"CF-RAY","value":"9ce1d6ba4e8891fa-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"64b032c3c6dccf7d329d9e7e\",\n \"client\": {\n \"email\": \"example@paysecure.net\",\n \"country\": \"US\",\n \"city\": \"New York\",\n \"stateCode\": \"ca\",\n \"street_address\": \"test test\",\n \"zip_code\": \"234567\",\n \"phone\": \"+1 202 555 0185\"\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1689268934,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1689268934,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"Apple\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1689268934\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS161\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"issued\": \"2023-07-13\",\n \"due\": 1689268934,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://api.paysecure.net/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"http://api.paysecure.net/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"c343ab6f-a8cf-4efa-99d0-3961f2a20202"}],"id":"91acdd13-96dc-4951-a2fe-f35eba7bc261","description":"Overview
\nThe PayPal Wallet integration enables merchants to accept payments from over 400 million active users worldwide. As one of the most trusted names in digital payments, offering PayPal can significantly increase conversion rates by providing a familiar, secure, and friction-free checkout experience.
\nUnlike traditional card payments where users must manually enter sensitive details, the PayPal Wallet allows customers to pay using their stored credentials (credit cards, bank accounts, or PayPal balance) via a secure login.
\nKey Features & Benefits
\n- \n
Higher Approval Rates: Transactions are authenticated directly by the user via their PayPal app or login, reducing the risk of fraud and issuer declines.
\n \nFrictionless Checkout: Supports \"One Touch™\" payments, allowing returning users to skip login and pay in a single click.
\n \nGlobal Reach: Automatically handles currency conversion, allowing you to accept payments from customers in 200+ markets.
\n \nSecurity: Sensitive financial details are never shared with the merchant, minimizing your PCI compliance burden.
\n \n
How it Works
\nSince PayPal requires user authentication, the integration follows a Redirect pattern:
\n- \n
Initiate: You send a purchase request to Paysecure with
\npaymentMethod: PAYPAL. \nRedirect: Paysecure returns a
\ncheckout_url. You send the customer's browser to this URL. \nAuthenticate: The customer logs into PayPal and approves the amount.
\n \nReturn: PayPal redirects the customer back to your
\nsuccess_redirectURL, and Paysecure triggers a server-to-server webhook to confirm the status. \n
OVERIEW
\nThe createCustomer API allows merchants to create a customer profile on PaySecure when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the PaySecure Cashier. The API takes in customer information and returns a unique customerID that can be passed in purchase payload, eliminating the need for customers to manually enter their details during transactions.
\nUser Flow
\n- \n
Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n \nMerchant calls the
\ncreateCustomerAPI: The merchant sends aPOSTrequest to the Paysecure API with the customer's details. \nCustomer ID generation: Paysecure processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent session creation, ensuring the customer doesn’t need to re-enter their details for future payments. \n
\n
Benefits
\n- \n
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n \nFaster Checkout: The merchant can use the
\ncustomerIdfor faster payment processing. \nData Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n \n
Implementing createCustomer on merchant site:
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
- \n
Call
\ncreateCustomer: This API call generates a unique customer ID. \nUse of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n \n
Upon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
- \n
Persistent Customer Profiles: This approach can help build or maintain a persistent customer profile, ensuring the customer ID is available for any subsequent payment sessions without needing to call
\ncreateCustomeragain. \nIntegration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n \n
The method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Paysecure API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c97c753a-5d00-4906-ae7b-550aba404b1b","id":"c97c753a-5d00-4906-ae7b-550aba404b1b","name":"Virtual Cards Payout","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["app","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"c0763be9-e9d9-4e35-8900-ee14e088b5d6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.paysecure.net/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\",\n \"fullName\": \"Rahul Agarwal\",\n \"emailId\": \"rahul+26@paysecure.net\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"1d666074-39be-4b90-aec9-e9de78fbdcb9\",\n \"city\": \"Jaipur\",\n \"zipCode\": \"302018\",\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"},{"id":"ce282aa6-0f89-497b-bc84-9c5e93ffe2a1","name":"Invalid Customer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.paysecure.net/api/v1/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer with this information does not exist\",\n \"code\": \"customer_does_not_exist\"\n}"}],"_postman_id":"9e2b13ba-635c-4dce-9b40-58ccb661c89c"},{"name":"Create PayOut","id":"0014bee0-7718-44fe-9a1b-6151a82c9e21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"customer141@email.uk\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"payoutMethod\": \"Payout-virtual-cards\",\r\n \"amount\": 10,\r\n \"currency\": \"USD\",\r\n \"purpose\": \"payout to test\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\",\r\n \"extraParam\": {\r\n \"productType\": \"WELFARE\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/","description":"To Initiate a payout, the very first call to make is /payout/
\nwith the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c97c753a-5d00-4906-ae7b-550aba404b1b","id":"c97c753a-5d00-4906-ae7b-550aba404b1b","name":"Virtual Cards Payout","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0a31fc49-3229-428f-839e-2334e31c6b44","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"customer141@email.uk\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"payoutMethod\": \"Payout-virtual-cards\",\r\n \"amount\": 10,\r\n \"currency\": \"USD\",\r\n \"purpose\": \"payout to test\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\",\r\n \"extraParam\": {\r\n \"productType\": \"WELFARE\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"685faaf0b93cc30dd78957c6\",\r\n \"client\": {\r\n \"customerId\": \"685fa7d7b93cc30dd78956c1\",\r\n \"email\": \"rahul+7@paysecure.net\",\r\n \"phone\": \"+918839471520\",\r\n \"full_name\": \"Rahul Agarwal\",\r\n \"street_address\": \"Vaishali Jaipur\",\r\n \"country\": \"FR\",\r\n \"city\": \"jaipur\",\r\n \"zip_code\": \"202020\",\r\n \"stateCode\": \"RA\"\r\n },\r\n \"updated_on\": 1751100145,\r\n \"payoutMethod\": \"PAYOUT-VIRTUAL-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 5.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"payout to test\",\r\n \"created_on\": 1751100145,\r\n \"merchantRef\": \"685faaf0b93cc30dd78957c6\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1751100145\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1751100145\r\n }\r\n ],\r\n \"currency\": \"EUR\",\r\n \"paymentOn\": 1751100145,\r\n \"taxAmount\": 0.0,\r\n \"taxPercent\": 0.0,\r\n \"redirectType\": \"POST\",\r\n \"extraParam\": {\r\n \"productType\": \"HOTAC\"\r\n },\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}"},{"id":"8e0fbb14-1ef1-4e54-a861-f76b5448827c","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"customer141@email.uk\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"payoutMethod\": \"Payout-virtual-cards\",\r\n \"amount\": 10,\r\n \"currency\": \"USD\",\r\n \"purpose\": \"payout to test\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\",\r\n \"extraParam\": {\r\n \"productType\": \"WELFARE\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"684fe6980696787075207f8d\",\r\n \"client\": {\r\n \"customerId\": \"684fe5700eb6476b179037aa\",\r\n \"email\": \"customer141@email.uk\",\r\n \"phone\": \"1234567890\",\r\n \"country\": \"SG\",\r\n \"full_name\": \"Test Person-uk\"\r\n },\r\n \"updated_on\": 1750066843,\r\n \"payoutMethod\": \"PAYOUT-VIRTUAL-CARDS\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 100,\r\n \"errorMsg\": \"Deep link was not able to create\",\r\n \"purpose\": \"testing payout\",\r\n \"created_on\": 1750066843,\r\n \"merchantRef\": \"684fe6980696787075207f8d\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1750066843\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1750067894\r\n }\r\n ],\r\n \"currency\": \"USD\",\r\n \"extraParam\": {\r\n\t\t \"productType\" : \"Hotac\"\r\n },\r\n \"paymentOn\": 0,\r\n \"taxAmount\": 0,\r\n \"taxPercent\": 0,\r\n \"redirectType\": \"POST\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}"}],"_postman_id":"0014bee0-7718-44fe-9a1b-6151a82c9e21"}],"id":"c97c753a-5d00-4906-ae7b-550aba404b1b","description":"Overview
\nThe Virtual Card Payout solution is designed to modernize how merchants distribute funds to their users. Traditionally, payouts (winnings, compensation, or rewards) required collecting sensitive bank details, which added friction and delayed access to funds.
\nWith Paysecure's Swiipr integration, merchants can instantly issue Virtual Mastercards directly to a user's mobile device. These cards are immediately usable online or in-store via digital wallets (Apple Pay / Google Pay).
\nCore Use Cases
\n- \n
Gaming & Sweepstakes: Instantly pay out winnings to players without waiting for bank transfers.
\n \nAirline Compensation: Issue immediate funds for delayed flights or lost luggage (e.g., for food/hotel vouchers).
\n \nWelfare & Relief: Distribute emergency funds securely and instantly.
\n \n
The \"Deeplink\" User Journey
\nUnlike standard payouts that go to an account, this flow delivers a card to the user:
\n- \n
Merchant Request: You send a payout request to Paysecure with the user's mobile number and amount.
\n \nInstant Notification: The user receives an SMS or Email containing a secure Deeplink.
\n \nActivation:
\n- \n
New Users: The link prompts them to download the Swiipr App.
\n \nExisting Users: The link opens the app directly.
\n \n
\nClaim & Spend: The user validates their mobile number, claims the virtual card, and provisions it to their Apple Wallet or Google Pay in one tap.
\n \n
Key Features
\n- \n
Instant Issuance: Cards are generated in real-time.
\n \nMobile-First: The entire experience is handled via the user's smartphone.
\n \nSecure: No sensitive bank data is exchanged; funds are loaded onto a prepaid Mastercard.
\n \nFlexible Funding: Merchants pre-fund their account, ensuring 100% approval rates for valid requests.
\n \n
PayIn Flows
\nHow it works
\nPaysecure's A2A paying system, utilizes the powerful Virtual Accounts capabilities, enabling you to support a wide range of scenarios using the following methods.
\nKey Steps
\n![](\"https://lh7-us.googleusercontent.com/XMBcrVkVU_Iak6-k1uzllUV3Lr6e_wVP_25CzedW8zYahgDiRS1KmuGMn8obKpQ8DnSrMuNvE4GvFEcoe3_0oeDNnAsGtfGf9EtQnNZpnoFNt9iAuoWtSjBDwXIAm6a3fdeY61GPtXbJUw0d_bGBRIU\")
\n\nFlow
\n- \n
The merchant platform retrieves the account details (Account number, IBAN, and SWIFT code) for the merchant-assigned currency account intended for the PayIn.
\n \nThese account details are then provided to the payer, who is instructed to make the payment to this account.
\n \nThe payer accesses their banking app and inputs the provided account details along with the transaction amount.
\n \nUpon receiving the money from the payer, Paysecure promptly receives an Inward Credit Notification (ICN) webhook from its banking partner, confirming that the funds have been deposited into the corresponding virtual account.
\n \nThe ICN contains all relevant transaction details. Paysecure forwards this notification to the merchant to inform them of the transaction.
\n \n
PayOut flows
\nHow it works
Paysecure offers the ability to make payments to customers', individuals', or businesses' bank accounts using various transfer methods via its dashboard or suite of APIs. The dashboard consolidates all available features accessible through APIs, allowing you to easily go live with minimal technical setup.\"
Key Steps
\n![](\"https://lh7-us.googleusercontent.com/Zuu8ZB-0YkxC4jOKNmeEqwM6LMvLMxdTewRcU9AzcNQUOttY3aqan6-ojn2OOU7cF5B2npN8zrPPFnjbV90i2Uu0Ai05H-a730GMu52zK39fTEy0WWIEP3HC9UDTf4t78nagMG1-GannNAvqOXmD9vM\")
\n\nFlow
\n- \n
The merchant platform initiates the creation of a payout by passing beneficiary details, along with payout details.
\n \nBeneficiary details include
\n \nBeneficiary ID (email or phone)
\n \nBeneficiary's address (is mandatory but not validated. So if you have this data we recommend you send it, otherwise, use some random value.)
\n \nBeneficiary's bank details
\n \nBeneficiary's name
\n \nUpon completion of the payout, reaching either a Success or Failure state, Paysecure notifies the merchant’s platform via webhook, providing the final status of the transaction and additional details.
\n \n
HTTP Response Code
\nYou will not get Error codes if HTTPS response code is 200 or 202.
\nError Codes and Messages
\nwith http code(400,404,401,415,405)
\nBelow is the list of possible error codes and the corresponding messages from Paysecure System
\nFormat
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nTo Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nDigital Signature (Optional Parameter) :
\nTo ensure authenticity and non-repudiation of the the pay in request, there is an option to digitally sign the pay in request by using the merchant's public key.
\nPublic key generation :-
\nSignature generation :-
\nThis digitial signature is generated by encrypting the following elements of the pay in request:
Plaintext= Client.email+purchase.currency+ purchase.products.price+brand_id
Example of encrypt plaintext with public key in java:-
\nprivate String encryptData(String plaintext, PublicKey publicKey) throws Exception {\n Cipher cipher = Cipher.getInstance(\"RSA\");\n cipher.init(Cipher.ENCRYPT_MODE, publicKey);\n byte[] encryptedbytes = cipher.doFinal(message.getBytes());\n return new String(Base64.getEncoder * ().encode(encryptedbytes));\n}\n\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"acb10383-777a-4edf-9e65-3466df80ae85","id":"acb10383-777a-4edf-9e65-3466df80ae85","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3bf1a565-919e-49cb-93b2-f1d8390635e1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"Zurich\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brandid\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66334635a2cf2a7da7b192ab\",\r\n \"client\": {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\",\r\n \"email\": \"test3@gmail.com\",\r\n \"phone\": \"+447755564318\",\r\n \"full_name\": \"\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"personal_code\": \"\",\r\n \"street_address\": \"asdfsa\",\r\n \"country\": \"GB\",\r\n \"city\": \"a\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"shipping_street_address\": \"\",\r\n \"shipping_country\": \"\",\r\n \"shipping_city\": \"\",\r\n \"shipping_zip_code\": \"\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"legal_name\": \"\",\r\n \"brand_name\": \"\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\",\r\n \"documentId\": \"\",\r\n \"documentType\": \"\",\r\n \"bankAccountNumber\": \"\",\r\n \"bankAccount\": \"\",\r\n \"bankCode\": \"\",\r\n \"description\": \"\",\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1714636341,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"GET\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1714636341,\r\n \"merchantRef\": \"66334635a2cf2a7da7b192ab\",\r\n \"merchantName\": \"merchant002\",\r\n \"feesDeducted\": 0.3,\r\n \"purchaseIdShortCode\": “4000013\",\r\n \"purchase\": {\r\n \"currency\": \"JPY\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 5000.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 5000.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 5000.0,\r\n \"currency\": \"JPY\",\r\n \"net_amount\": 5000.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1714636341,\r\n \"remote_paid_on\": 1714636341\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {\r\n \"bank_account\": \"\",\r\n \"bank_code\": \"\"\r\n }\r\n ],\r\n \"legal_name\": \"gdhnb\",\r\n \"brand_name\": \"gdhnb\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 5000.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"103.59.75.41\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"BANKTRANSFER\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"BANKTRANSFER\",\r\n \"processing_time\": 1714636341,\r\n \"extra\": {\r\n \"amount\": 5000.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAYMENT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1714636341\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1714636341\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1714636341\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"76fad4ea-2ba2-4511-8989-3bed04e7d5bb\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS8937\",\r\n \"issued\": \"2024-05-02\",\r\n \"due\": 1714636341,\r\n \"refund_upto\": 0,\r\n \"cc_descriptor\": \"\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"payInBankDetails\": {\r\n \"accountName\": \"ｴｱｰｳｵﾚﾂｸｽｼﾞｬﾊﾟﾝｶﾌﾞｼｷｶｲｼｬ\",\r\n \"accountNumber\": \"3194368\",\r\n \"bankName\": \"MUFG BANK, LTD. 三菱UFJ銀行\",\r\n \"swiftCode\": \"BOTKJPJT\",\r\n \"branchName\": \"ワカタケ\",\r\n \"accountType\": \"CHECKING\",\r\n \"payment_routing_parameters\": {\r\n \"BANK_CODE\": \"0005\",\r\n \"BRANCH_CODE\": \"809\"\r\n }\r\n },\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 0.0,\r\n \"success_redirect\": \"https://test.com/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://test.com/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://test1.com\",\r\n \"failure_callback\": \"https://test2.com\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.41\",\r\n \"checkout_url\": \"https://staging.paysecure.net/payments/66334635a2cf2a7da7b192ab/\"\r\n}"},{"id":"292943d8-91cb-4b8a-bdc0-36e285e0cf71","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"test@gmail.com\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"city\": \"Zurich\",\r\n \"full_name\": \"Test test\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"country\": \"DE\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"stateCode\": \"QLD\",\r\n \"phone\": \"+447755564318\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"product name\",\r\n \"price\": \"16\"\r\n }\r\n ]\r\n },\r\n \"merchantRef\": \"your-order-id\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"brand_id\": \"your-brandid\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"b3953ca2-3fb6-478e-8356-b8bbf05350a9"},{"name":"Get Status","id":"ba5c46f3-e7c6-4b0a-9067-65ec6307aa7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"acb10383-777a-4edf-9e65-3466df80ae85","id":"acb10383-777a-4edf-9e65-3466df80ae85","name":"PayIn API","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"51c2097c-0e71-4887-b7ce-35faa84eb727","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"purchaseId\": \"66c4667bb993c970367c288a\",\r\n \"client\": {\r\n \"email\": \"deepakdeepaksinghal@gmail.com\",\r\n \"date_of_birth\": \"1970-07-10\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"country\": \"IN\",\r\n \"city\": \"London\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"cc\": [],\r\n \"bcc\": [],\r\n \"stateCode\": \"QLD\"\r\n },\r\n \"updated_on\": 1724147324,\r\n \"type\": \"purchase\",\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"amountUnit\": \"MAJOR\",\r\n \"errorMsg\": \"\",\r\n \"redirectType\": \"POST\",\r\n \"force_recurring\": false,\r\n \"created_on\": 1724147324,\r\n \"merchantRef\": \"66c4667bb993c970367c288a\",\r\n \"merchantName\": \"merchant002\",\r\n \"purchase\": {\r\n \"currency\": \"INR\",\r\n \"products\": [\r\n {\r\n \"name\": \"test\",\r\n \"quantity\": 1.0,\r\n \"price\": 10.0,\r\n \"discount\": 0,\r\n \"tax_percent\": \"0.00\"\r\n }\r\n ],\r\n \"total\": 10.0,\r\n \"language\": \"en\",\r\n \"notes\": \"\",\r\n \"debt\": 0,\r\n \"total_formatted\": 1.0,\r\n \"expireInMin\": \"35\",\r\n \"request_client_details\": [],\r\n \"timezone\": \"MIT\",\r\n \"email_message\": \"\"\r\n },\r\n \"payment\": {\r\n \"is_outgoing\": false,\r\n \"payment_type\": \"PURCHASE\",\r\n \"amount\": 10.0,\r\n \"currency\": \"INR\",\r\n \"net_amount\": 10.0,\r\n \"fee_amount\": 0.0,\r\n \"pending_amount\": 0.0,\r\n \"pending_unfreeze_on\": null,\r\n \"description\": \"\",\r\n \"paid_on\": 1724147324,\r\n \"remote_paid_on\": 1724147324\r\n },\r\n \"issuer_details\": {\r\n \"website\": \"\",\r\n \"legal_street_address\": \"\",\r\n \"legal_country\": \"\",\r\n \"legal_city\": \"\",\r\n \"legal_zip_code\": \"\",\r\n \"bank_accounts\": [\r\n {}\r\n ],\r\n \"legal_name\": \"test6\",\r\n \"brand_name\": \"test6\",\r\n \"registration_number\": \"\",\r\n \"tax_number\": \"\"\r\n },\r\n \"transaction_data\": {\r\n \"payment_method\": \"\",\r\n \"flow\": \"payform\",\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n },\r\n \"country\": \"\",\r\n \"attempts\": [\r\n {\r\n \"client_ip\": \"103.59.75.113\",\r\n \"type\": \"execute\",\r\n \"payment_method\": \"BANKTRANSFER\",\r\n \"flow\": \"payform\",\r\n \"successful\": true,\r\n \"country\": \"BANKTRANSFER\",\r\n \"processing_time\": 1724147324,\r\n \"extra\": {\r\n \"amount\": 10.0,\r\n \"masked_pan\": \"BANKTRANSFER\"\r\n }\r\n }\r\n ]\r\n },\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"pending_execute\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"payment_in_process\",\r\n \"timestamp\": 1724147324\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1724147324\r\n }\r\n ],\r\n \"is_test\": false,\r\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\r\n \"send_receipt\": false,\r\n \"is_recurring_token\": false,\r\n \"skip_capture\": false,\r\n \"reference_generated\": \"PS10907\",\r\n \"issued\": \"2024-08-20\",\r\n \"due\": 1724147324,\r\n \"refund_upto\": 1725871728,\r\n \"cc_descriptor\": \"test1\",\r\n \"fraudScore\": \"NA\",\r\n \"trustScore\": \"NA\",\r\n \"refund_availability\": \"NONE\",\r\n \"refundable_amount\": 10.0,\r\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\r\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\r\n \"cancel_redirect\": \"\",\r\n \"success_callback\": \"https://staging.paysecure.net\",\r\n \"failure_callback\": \"https://staging.paysecure.net\",\r\n \"platform\": \"API\",\r\n \"created_from_ip\": \"103.59.75.113\",\r\n \"checkout_url\": \"https://staging.paysecure.net/payments/66c4667bb993c970367c288a/\",\r\n \"payoutProcess\": false\r\n}"},{"id":"ad9f9087-c08f-4440-95ae-56f214d99211","name":"Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}\r\n"}],"_postman_id":"ba5c46f3-e7c6-4b0a-9067-65ec6307aa7e"}],"id":"acb10383-777a-4edf-9e65-3466df80ae85","description":"API Flow
\n\n\n- \n
The merchant initiates the purchase via the create purchase API. If successful, they receive PayIn bank details along with a checkout URL in the response JSON
\n \nThe merchant then has 2 options
\n- \n
Use the PayIn bank details in the JSON to create a webpage within the merchant’s IT estate, and show to user the PayIn instruction
\n \nOr direct the end-user to our checkout URL, where the client sees bank details for payment.
\n \n
\nAfter a successful or failed payment by the end user, an appropriate webhook would be sent to the merchant. If option 2b was the method employed, the user would be redirected to the appropriate redirect URL.
\n \n
To Initiate a payment, the very first call to make is /payout/ with the required data in the request body.
\nTo generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\nRequired parameters in the request body for this use case:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ce79c05a-e657-4ead-af25-56db5e2e6ed5","id":"ce79c05a-e657-4ead-af25-56db5e2e6ed5","name":"PayOut API","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3a695858-b127-466b-b747-1f9c4145e6d6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"AT\",\r\n \"city\": \"Zurich\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Rahul Agarwal\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankCountryCode\": \"AT\"\r\n },\r\n \"purpose\": \"Testing payout\",\r\n \"currency\": \"EUR\",\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"amount\": 10.0,\r\n \"brandId\": \"f2f689d5-ca86-4514-94b9-f41bcdf857d7\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Accepted","code":202,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"DE\",\r\n \"city\": \"Zurich\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n\t\"beneficiaryDetail\":{\r\n \"bankAccountName\": \"Rahul Agarwal\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankName\": \"ICICI Bank\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"Currency Account has insufficient balance.\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1711254972,\r\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\r\n \"status\": \"PAID\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1711254964\r\n },\r\n {\r\n \"status\": \"paid\",\r\n \"timestamp\": 1711254972\r\n }\r\n ],\r\n \"currency\": \"EUR\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}\r\n"},{"id":"c168f1cb-8b50-4b3b-9061-c70c5642589f","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"rahul@gmail.com\",\r\n \"country\": \"DE\",\r\n \"city\": \"Zurich\",\r\n \"stateCode\": \"QLD\",\r\n \"full_name\": \"Test test\",\r\n \"street_address\": \"10 New Burlington Street Apt. 214\",\r\n \"zip_code\": \"W1S 3BE\",\r\n \"phone\": \"+448839471521\",\r\n \"gender\": \"M\",\r\n \"date_of_birth\": \"1970-07-10\"\r\n },\r\n \"beneficiaryDetail\": {\r\n \"bankAccountName\": \"Rahul Agarwal\",\r\n \"bankAccountNumber\": \"645101511808\",\r\n \"bankName\": \"ICICI Bank\"\r\n },\r\n \"purpose\": \"Testing payout\",\r\n \"currency\": \"EUR\",\r\n \"payoutMethod\": \"PAYOUT-BANKTRANSFER\",\r\n \"amount\": 10.0,\r\n \"brandId\": \"f2f689d5-ca86-4514-94b9-f41bcdf857d7\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":" {\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"ef3cf2f8-8a76-408e-8d91-65cd4718d223"},{"name":"Get Status","id":"baa9dba7-bdd1-422d-a687-885285255028","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ce79c05a-e657-4ead-af25-56db5e2e6ed5","id":"ce79c05a-e657-4ead-af25-56db5e2e6ed5","name":"PayOut API","type":"folder"}},"urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"075aa7f7-5e18-49eb-8d0c-7a5af30586b5","name":"Get Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\r\n \"client\": {\r\n \"email\": \"customer141@email.uk\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"street_address\": \"Random city address\",\r\n \"country\": \"SG\",\r\n \"city\": \"Singapore\",\r\n \"zip_code\": \"123456\",\r\n \"stateCode\": \"test\"\r\n },\r\n \"updated_on\": 1711254964,\r\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\r\n \"beneficiaryDetail\":{\r\n \"bankName\": \"DBS Bank\", \r\n \"bankAccountName\": \"test test\",\r\n \"bankAccountCurrency\": \"SGD\",\r\n \"bankAccountNumber\": \"12345640\",\r\n \"bankCountryCode\" : \"SG\",\r\n \"swiftCode\": \"DBSSSGSG\",\r\n \"routing_param\" :\r\n {\r\n \"bankCode\": \"897678\",\r\n \"bankBranchCode\" : \"888\"\r\n \r\n }\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 1000.0,\r\n \"errorMsg\": \"Currency Account has insufficient balance.\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1711254972,\r\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\r\n \"status\": \"ERROR\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1711254964\r\n },\r\n {\r\n \"status\": \"error\",\r\n \"timestamp\": 1711254972\r\n }\r\n ],\r\n \"currency\": \"USD\",\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"fdb5f241-5084-4bae-8aaf-20297563889e","name":"Get Status-error","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"baa9dba7-bdd1-422d-a687-885285255028"}],"id":"ce79c05a-e657-4ead-af25-56db5e2e6ed5","description":"API Flow
\n\n\nAt the time of onboarding, the merchant will be given the option of currency accounts. Typically, a merchant will have one currency account in one jurisdiction, but our platform allows for multiple currency accounts for merchants. Please contact your account manager if you need multicurrency accounts. Please note that there may be some restrictions on multicurrency accounts depending on the jurisdictions and commercials.
\nOur system also caters to multiple business accounts within one merchant account for better financial risk management. If more than one business is onboarded for a merchant (each needing its own KYB), then our system would handle the complexity of balance distribution among the accounts in the backend and give simple easy-to-use APIs for merchants.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ae71a942-2749-49ef-9783-b595f71b08c4","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"3af63fb2-0168-4456-83ef-39ad60d80cf7","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"ce79c05a-e657-4ead-af25-56db5e2e6ed5"},{"name":"Get Balance API","item":[{"name":"Checking Balance","id":"b619baf8-78ec-4215-bade-8dfbeb7c0758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance","description":"API for Checking Balance payout
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \n
Note: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"e9d3740f-4a2e-408f-8c3e-b55fb602f330","id":"e9d3740f-4a2e-408f-8c3e-b55fb602f330","name":"Get Balance API","type":"folder"}},"urlObject":{"path":["getBalance"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a49d512b-fd0c-4180-a8ef-b667cd9170f1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"paymentMethod\": \"BANKTRANSFER\",\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"currency\": \"AUD\",\r\n \"balance\": \"0.00\"\r\n },\r\n {\r\n \"currency\": \"USD\",\r\n \"balance\": \"46813.79\"\r\n },\r\n {\r\n \"currency\": \"JPY\",\r\n \"balance\": \"1012.00\"\r\n }\r\n ]\r\n}\r\n"},{"id":"b76970ed-b13e-44e3-bd55-70d8b594d901","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"paymentMethod\": \"BANKTRANSFER\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/getBalance"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"No currency account found\"\r\n}\r\n"}],"_postman_id":"b619baf8-78ec-4215-bade-8dfbeb7c0758"}],"id":"e9d3740f-4a2e-408f-8c3e-b55fb602f330","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"30376090-c3be-4a4f-8966-111ec4f2a6b4","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"a1c6dfa6-5da4-4178-88bd-8c49bb769b85","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"e9d3740f-4a2e-408f-8c3e-b55fb602f330","description":""}],"id":"781ccd8d-5dab-481f-b281-8fe9ce8a1ece","_postman_id":"781ccd8d-5dab-481f-b281-8fe9ce8a1ece","description":""},{"name":"🌐 Open Banking","item":[{"name":"Concepts - OpenBanking - EUR 🇪🇺 & UK 🇬🇧","item":[],"id":"fc12767d-d62e-47b5-a121-ddb1c9d51f72","description":"Paysecure leverages its OpenBanking network across Europe and UK to make secure and fast payments, making top choice for customers in respective regions. It allows customers to pay in EUR or GBP via Paysecure Gateway, directly through their bank account.
\nPaysecure Gateway is a web page that handles all the user interaction during a payment initiation process:
\n- \n
user credentials input
\n \ninteractive confirmation
\n \nprogress reporting
\n \nerror reporting
\n \n
After your application has received an URL for executing a payment using Paysecure, you can redirect your end-user to it. There, they will see a screen that lets them pick a provider to execute a payment.
\nYour user will also be asked to input credentials and, if needed, any of the interactive credentials. After the process is done, the user will be redirected back to your application URL
\nPayIn User Flow
\nStep 1: Initiating the Payment
\n- \n
- Customer Selects 'OPEN BANKING' Payment Option: At the checkout page, the customer selects 'Open Banking' as their preferred payment method. \n
Step 2: Redirect to Bank Login
\n- \n
Customer Selects Their Bank: The customer selects the provider/bank from the list of supported providers/banks on the Paysecure Gateway.
\n \nCustomer is Redirected to Bank Login Page: Platform securely redirects customers to their bank’s online banking login page.
\n \n
Step 3: Logging into Online Banking
\n- \n
Customer Logs In The customer logs into their online banking account using their credentials.
\n \nSecure Session: The login session is safe, and the customer’s banking credentials are not shared with any third party or any merchant.
\n \n
Step 4: Confirming the Payment
\n- \n
Payment Details: The customer reviews the pre-filled payment details, including the amount and beneficiary information.
\n \nAuthorise Payment: The customer authorises the payment using their bank’s authentication method (e.g., OTP, password).
\n \n
Step 5: Payment Processing and Confirmation
\n- \n
Bank Processes Payment: The customer’s bank processes the payment and debits the amount from the customer’s account.
\n \nInstant Confirmation to the Paysecure gateway: Once the payment is processed, payment confirmation is received through a webhook url.
\n \n
Step 6: Notification to Merchant
\n- \n
Paysecure Confirms Payment to Merchant: Paysecure gateway immediately notifies the merchant of the successful payment.
\n \nOrder Completion: The merchant completes and confirms the order to the customer.
\n \n
Step 7: Customer Redirect
\n- \n
Redirect to Merchant’s Site: After confirming the payment, the customer is redirected back to the merchant’s website.
\n \nPayment Confirmation Page: The merchant’s website displays a payment confirmation page to the customer.
\n \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nEssential Optional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nUpon successul create on a Purchase you'd get a \"purchaseId\" . Use this ID for the next step in Server to server call by calling p/{purchaseId}/?s2s=true .
paymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"54f3816d-6b35-4562-9f52-173372acb6ca","id":"54f3816d-6b35-4562-9f52-173372acb6ca","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c3f21d6e-4cde-44ec-a18c-c8de7d985627","name":"Open Banking EU & UK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"alpha7.bravo@bravapay.com\",\r\n \"country\": \"GB\",\r\n \"city\": \"London\",\r\n \"stateCode\": \"LND\",\r\n \"street_address\": \"10 New Burlington StreetApt. 214\",\r\n \"zip_code\": \"SW1A0AA\",\r\n \"full_name\": \"shiba sharma\",\r\n \"date_of_birth\": \"2004-04-31\",\r\n \"phone\": \"+447755564318\",\r\n \"gender\": \"male\"\r\n },\r\n \"purchase\": {\r\n \"currency\": \"GBP\",\r\n \"products\": [\r\n {\r\n \"name\": \"e-commerce\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"retail\",\r\n \"price\": \"11\"\r\n }\r\n ],\r\n \"total\": 21\r\n },\r\n \"paymentMethod\": \"OPEN-BANKING\",\r\n \"brand_id\": \"{{Your.brandID}}\",\r\n \"merchantRef\": \"This API tells you about all the details of a purchase, including its history
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"54f3816d-6b35-4562-9f52-173372acb6ca","id":"54f3816d-6b35-4562-9f52-173372acb6ca","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","64bff12bf63e36669499e97d",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"037a934f-ec94-436a-a44d-64d0db734ced","name":"Purchases - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/64bfdb7df63e36669499e82f/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:45:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfdb7df63e36669499e82f\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690296521,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690295168,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 9,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 9,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 9,\n \"currency\": \"USD\",\n \"net_amount\": 9,\n \"fee_amount\": 10.2591,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1690295205,\n \"remote_paid_on\": 1690295205\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1690295205,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 9,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690295168\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690295193\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1690295205\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1690296521\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690299929\n }\n ],\n \"viewedOn\": 1690299929,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS192\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690295168,\n \"refund_upto\": 1705843623,\n \"cc_descriptor\": \"test-cardeye\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 9,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfdb7df63e36669499e82f/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfdb7df63e36669499e82f/\"\n}"},{"id":"bcd59586-8036-49c0-80d1-5f67adedf79a","name":"Purchases-error","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/64bfd7c9f63e36669499e779/"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 25 Jul 2023 15:44:06 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64bfd7c9f63e36669499e779\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"example@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1690294251,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1690294220,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 100,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 100,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"149.86.53.48\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"US\",\n \"processing_time\": 1690294279,\n \"extra\": {\n \"expiry_month\": \"10\",\n \"amount\": 100,\n \"card_issuer\": \"1-800-432-3117\",\n \"masked_pan\": \"411111XXXXXX1111\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"cardholder_name\": \"dk\",\n \"expiry_year\": \"23\"\n },\n \"error\": {\n \"message\": \"Transaction Failed\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1690294220\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1690294251\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1690294299\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1690294382\n }\n ],\n \"viewedOn\": 1690299845,\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS188\",\n \"issued\": \"2023-07-25\",\n \"due\": 1690294220,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64bfd7c9f63e36669499e779/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64bfd7c9f63e36669499e779/\"\n}"}],"_postman_id":"29d22f47-5c14-4f91-a3fe-81af282b6e0b"},{"name":"Refund","id":"437c9e85-8b8a-4f98-9781-009872fc252c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/657af976c3fceb7beb30eeb4/refund","description":"This API is used to initate refund of the purchases that have status as PAID can be initiated for refund
Once the refund has been initiated, the status of the purchase would become REFUND_IN_PROCESS and once the refund has been approved by the bank, the status woud become REFUNDED
Purchase ID is mandatory for this API.
\nCurrently we don't support partial refunds.
\nResponse Examples
\nIn the response examples you can see instances of both successful and unsuccessful in refund of purchases.
Overview
\nOpen Banking refers to the integration with local bank transfer systems in specific countries, enabling users to make payments directly from their bank accounts through a secure and trusted interface. This is particularly useful for regions where direct bank transfers are a preferred payment method over cards or other APMs.
\nPaysecure leverages Open Banking to facilitate transactions for different regions, enabling businesses to access localized payment options without the complexity of managing individual bank integrations. Each third-party service is tailored to the specific financial infrastructure of the country or region, ensuring compliance, security, and ease of use.
\nKey Benefits of Open Banking:
\n- \n
Localized Payment Options: Supports region-specific payment methods, giving customers familiar and trusted ways to pay.
\n \nSecure Transactions: Payments are processed directly through the customer’s bank, enhancing trust and security.
\n \nReal-Time Verification: Enables real-time confirmation of payments, reducing risks and improving cash flow.
\n \nCompliance: Adheres to local and international regulatory standards like PSD2 for Europe, ensuring that payments are secure and compliant.
\n \n
This setup allows Paysecure to offer a diverse range of bank transfer options to its global clientele, catering to the specific needs of different regions while maintaining a consistent and secure payment experience.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e8a74862-a410-4357-bcf9-5b53a60615f9"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"69a2cb71-17fd-494c-a773-449c5d656c88"}}],"_postman_id":"530085f8-be2d-454b-9b38-f4eadbdc5771"},{"name":"🪙 On Ramp","item":[],"id":"a8c38c29-0e96-4de4-af92-fcd12c5acd63","description":"Overview
\nPaysecure provides a user-friendly, direct integration with Quickbit wallet where users can purchase and manage their crypto funds easily. Integrating this interface into your payment process is a straightforward process, requiring just a few simple steps.
\nWe continuously work on improving the integration flow, and as we roll out updates, both customers and merchants can look forward to an enhanced and improved payment experience.
\nIntegration Flow
\nStep 1
\nThe first call to the PaySecure API is POST /purchases initiated by the merchant's backend when they receive a request from the user to make a QuickBit purchase.
\nIt's essential to ensure that the request body includes:
\n- \n
success_redirect - URL where the user will be redirected from Quickbit after completing the purchase
\n \nfailure_redirect - URL where the user will be redirected from Quickbit if the purchase fails
\n \npaymentMethod - Payment method requested. It must specify QBPAYFTOPUP.
\n \n
\n\nIt is important to note that paymentMethod is not a mandatory parameter. If it is not provided, the redirect URL will point to Paysecure Cashier. It must be provided for direct payment with Quickbit.
\n
Here's a sample body of the request:
\n{\n \"client\": {\n \"email\": \"john.doe@paysecure.net\",\n \"country\":\"GB\",\n \"city\":\"London\",\n \"stateCode\":\"Marleybone\",\n \"street_address\":\"221B Baker Street\",\n \"zip_code\":\"NW1 6XE\",\n \"phone\":\"9999999999\"\n },\n \"purchase\": {\n \"products\": [\n {\n \"name\": \"QBit Payment\",\n \"price\": \"10\"\n }\n ]\n },\n \"status\": \"created\",\n \"brand_id\": \"brand_id_from_the_portal\",\n \"paymentMethod\":\"QBPAYFTOPUP\",\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\"\n}```\nIf the request is successful the response will include a parameter called CheckOutURL. That is the QBit payment URL that should be loaded to the customer to proceed with the payment. Here is an example of what a successful response looks like:\n```{\n \"purchaseId\": \"657a10b3c0daf365fa98cdf9\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"john.doe@paysecure.net\",\n \"phone\": \"9999999999\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"221B Baker Street\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"zip_code\": \"NW1 6XE\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"Marleybone\"\n },\n \"updated_on\": 1702498483,\n \"type\": \"purchase\",\n \"paymentMethod\": \"QBPAYFTOPUP\",\n \"amountUnit\": \"MINOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1702498483,\n \"merchantRef\": \"657a10b3c0daf365fa98cdf9\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"QBit Payment\",\n \"quantity\": 1.0,\n \"price\": 1000.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"brand1\",\n \"brand_name\": \"brand1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1702498483\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"brand_id_from_the_portal\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS185\",\n \"issued\": \"2023-12-13\",\n \"due\": 1702498483,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://google.com\",\n \"failure_redirect\": \"https://yahoo.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"135.129.121.137\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/657a10b3casd23123122/\",\n \"merchantIp\": \"10.10.10.10\"\n}\n\nStep 2
\nOnce the customer is redirected to the CheckOutURL page they will see will depend on the user's country. For the users in Sweden, the page will look like this:
For user's in other countries, the page will look following:
\nOn this page, new users will have to verify their identity and existing users will be prompted to log in.
\nStep 3
\nIn the Quickbit app, the user will be requested to provide their payment details:
\nOnce the payment goes through, the user has to confirm sending the transaction to complete the process:
\nStep 4
\nDepending on the outcome of the payment at Quickbit, the customer will be directed to the:
\n- \n
If the payment is successful - the URL specified in
\nsuccess_redirectthat was provided in the initialPOST /purchasesrequest \nIf the payment is unsuccessful - the URL specified in
\nfailure_redirectthat was provided in the initialPOST /purchasesrequest \n
Concepts
\n- \n
APM Integration: Merchants integrate with set of Paysecure APIs to manage both incoming (pay-ins) and outgoing (payouts) funds.
\n \nAsynchronous Communication: Both payin and payout flows use callback URLs and webhooks to confirm transaction statuses, ensuring the merchant system stays updated.
\n \nSecure Redirection: Customers are securely redirected from the merchant site to the 3rd-party's cashier page for payments and back to the merchant site upon completion.
\n \nUPI Payment Options: The integration supports UPI-based payments, presenting customers with choices, like UPI Dynamic QR and UPI intevent via VPA, during the checkout process.
\n \nBeneficiary Details: For payouts, essential beneficiary details, including the Virtual Payment Address (VPA), must be provided to correctly route funds.
\n \n
\n
Key Steps in the Integration Process
\nPayIn Flow
\n- \n
Customer Selection:
\n
The customer selects UPI as the payment method on the merchant’s website. \nAPI Call to Create Purchase:
\n
The merchant system calls the PaysecurecreatePurchaseAPI to initiate the transaction. \nRedirection to Third-Party Cashier Page:
\n
The customer is redirected to 3rd-party's cashier page using the provided checkout URL. \nPayment Options Display:
\n
On the cashier page, the customer is presented with multiple UPI payment options, such as:- \n
UPI Dynamic QR
\n \nUPI Intent (via VPA)
\n \n
\nTransaction Execution:
\n
The customer completes the payment using their UPI app. \nCallback & Confirmation:
\n
Upon a successful payment, success callback is sent to the merchant’s designated URL. The customer is then redirected back to the merchant’s checkout page, where they see confirmation of a successful payment and an updated balance. \n
Payout Flow
\n- \n
Payout Request Initiation:
\n
The customer initiates a payout request directly on the merchant’s website. \nBeneficiary Details Entry:
\n
The customer enters the Virtual Payment Address (VPA) where they wish to receive the payout. \nAPI Call to Process Payout:
\n
The merchant calls the payout API to process the request.- \n
Input: Payout amount, beneficiary details (including VPA), and other required parameters.
\n \nCallback: A callback URL is set up to receive asynchronous updates.
\n \n
\nPayout Execution:
\n
Payout is processed to the customer’s specified VPA. \nWebhook Notification:
\n
A success webhook is triggered upon the successful completion of the payout. \nBalance Update:
\n
Both the customer’s and merchant’s account balances are updated to reflect the transaction. \n
To Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nOptional Parameters
\nexpireInMin
\nThis parameter, when passed in the PayIn request, sets the time window within which a customer should make the Interac payment through their bank's app. If a customer doesn't complete the payment within the configured time window, the status of the payment will be marked as 'EXPIRED' in Paysecure.
\nHowever, in certain cases, a payment made outside of this window could still be successful i.e. customer's account may be debited which would result in inconsistencies among Paysecure's, merchant's and customer's status of the transaction. To avoid such cases it is advised to set the expiry time limit appropriately and advise the customers to make payment within this window. However, if there is an inconsistency between the status at Paysecure and at customer's Bank, the merchant and Paysecure will reconcile the amounts during the settlement.
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\npaymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Possible Error Messages
\nNote: For certain use cases, in addition to long format purchase Id, Paysecure also provides a 7 digit unique code for each purchase starting with digit 4, eg 4000001
\n“purchaseIdShortCode”: “4000013\"
\n","urlObject":{"path":["purchases",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fd6ee71-2fac-4d79-aee3-480cdb9f7b89"},{"name":"Get Status","id":"bc90df10-0abd-4141-ab96-11d50ac29397","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/","description":"This API tells you about all the details of a purchase (PayIn), including its history
\nNote: With respect to bank transfers, the purchase request is synonymous with the PayIn request.
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5db195bb-9c71-4677-88a8-d071584a9b97","name":"Purchases-success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"66c4667bb993c970367c288a\",\n \"client\": {\n \"email\": \"deepakdeepaksinghal@gmail.com\",\n \"date_of_birth\": \"1970-07-10\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"country\": \"IN\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1724147324,\n \"type\": \"purchase\",\n \"paymentMethod\": \"UPI\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1724147324,\n \"merchantRef\": \"66c4667bb993c970367c288a\",\n \"merchantName\": \"merchant002\",\n \"purchase\": {\n \"currency\": \"INR\",\n \"products\": [\n {\n \"name\": \"test\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"expireInMin\": \"35\",\n \"request_client_details\": [],\n \"timezone\": \"MIT\",\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10,\n \"currency\": \"INR\",\n \"net_amount\": 10,\n \"fee_amount\": 0,\n \"pending_amount\": 0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1724147324,\n \"remote_paid_on\": 1724147324\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"test6\",\n \"brand_name\": \"test6\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"103.59.75.113\",\n \"type\": \"execute\",\n \"payment_method\": \"UPI\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"UPI\",\n \"processing_time\": 1724147324,\n \"extra\": {\n \"amount\": 10,\n \"masked_pan\": \"UPI\"\n }\n }\n ]\n },\n \"status\": \"PAYMENT_IN_PROCESS\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1724147324\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1724147324\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"c4003b2c-22d4-4dc1-ad0c-c6b54f8c9636\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS10907\",\n \"issued\": \"2024-08-20\",\n \"due\": 1724147324,\n \"refund_upto\": 1725871728,\n \"cc_descriptor\": \"test1\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"payInDetails\": {\n \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAb0AAAG9AQAAAACpVZXpAAAH7UlEQVR4nO1cQY7qSgw0yiJLjpCbJBdDIhIXg5vkCCyzQPi7qtwkM2/zNcsYpIfeQFcvTNtdLtsx/9trtS/wC/wCv8A/AZ9mdnpevb9bt6zj+TWso3Uen17i33nGkgverotN/orP7FoHeHV/AG1nfnoZ+kfYrcdKv8ei/gEMvljxRkQZ4MVi5Ww2nm9LbBF/xnLYd7YVVu3dZ262hPUvA3+CUsCnDesJ39/PHhidtlg5cRFek9+WtSgwPO595ldGI4dTAohX/8ZpG2Hp8MdiQPnjEL7XIWJdEae6BfvgC0SxCGCx2Q2fvf5x5GMDGckRov7X2+8r4NhAvW6O82QrHBBeuGBHHjSHK7rDtDxtv8jD0YERv8PPwAHcRjogbv43/BF/wuZwytgHO9r4serxgbIg7vvzPNALY1GHzXDrwYJji2JgTsvOkY8PxGnDDYeVsPHcYjWoUtx6jF04cjPsa8PmjxWAroMWUbtbdPPHPuGZsOqdX8SfOJXGu26zagVgLILHraTWvOUDjRuuU4jq4a2xj8y9hLd6HaArFcMtD997gVoHJYCRwa8H2HzgWVxBDkoBxR5lraVHxIpgdWXEcjJKHrmw+S2Z071F8gLA+JSGCkwEbISoOFnJHiNtvSAhgc0RpyKmw/BeBqgUFUcJGIPWAZnjY1VXis+bUMdw93McHph0kXedfA/pBfMx5CKLlJCJ9n3+FEkOD1QSiuUyrSWaQfyuc0eS3UElm+m8ZYDNqrCbkQMgMMGWEcCQhdEB6a1Jsps/VgCGybASWTtOFu1Lz8SlD/lsgheepBXFupaUFQEiC4MXzozaRjYQrnhRAksioORDbx8doAAQkfwM3qzrP4MVI3lwRqeEOEgTgc37eyVg5zxFZNAuboR0HlkY5VZdbszbELtk6SpAk/DV44yBB2H5zFSWgR3KPAkSKIHZT3nt6EA4INgPmKJRim/1L1MljKI8zS0NbSwElG5qrX6DwsQkDQh5Kr91prI3V4jfqHUBYKfKH9jPQPbDCpchTkmop/xzgiYi9dULASm2863TQeuxGYuDYVUzmtFOm3tuxaDjA+Fi0AehAZFB0zOpfxikD4Uo7YOw9SFIBYAqkN4UyRnY4ZnNFWnfVlpX7WeTEI8PBGWepDvLZCDPopBZOQVVgj+CCNwaaaoBxP8p/zDloN5jZI/sQABGeYe7ctftyBUAPpmmozqBpAyZ/ArxmXmqfJTqIZVWbLGJJBWAtCXqN8rCqIN1rqh9N0qIs84dGzU2raMAkPEbJjMWt85atJg1fZXZhm7CURyqDvCpWpejnUci4QrxmWSSVQwqRGwT47qdEFQBOPCWpxeCPBulsl55KiyIOM96hiLWw+sAndSQB+1KqQxnjEBmIC+xb2NNjFnJp95RASjimEViKtAiTWoEM1bf1YHK2vKOPR4fiJuLyrIZuk0hNOP6Z9McsxJk8gsJEm44sYEqQHaghvF4fQk9ch+9MXR3aOdRJA9KsJVKDw9k1FbDE1WyiOkUghiwSQlQycmyz5mCRyWgZxAyFU2dJJvxm59RsgerlmS/XXMFgOzfYU3H1OFuSlaRnq288JyuyL5dhLJPB0IBIBa9mbCrOYxaqkqlqPwhlcU1B89Ud/wnklcABjdCmi4dEcoyo1Nrt2yVsDGrGGpqrgNUqY8siQblQXMeOcZv6Ijr1LpYdjWd4wM9h2yYcanE02gRxY3WmSHSxBKP1wFK4NFVz0i0jZUwO2Viz3PHA7nrfD4+8MlRLCRl4NITs42WxPdZxKGQdpXSah/aWQDo5IcJVB2ZhBrHi0UcmjY7eH/8HAWAraaTxMfSAU1ah9E9L8pAVD6tBGQnt/h1bMFGg3fLMdjUwvaMNfMOzCJtR+7wQPWucKBmZjjnV61DjJtxXkJpiO1qOhWAOV/TYhKcUpM2F91rxqGJVrHYdXcXAPIA5dDsIPXwnUZWOxRpgrMjEzORW8GrAnDO4tbE8QnORrCfBeeOMvSk3h/LLR6FgNtIIyui1OglaTAhYXNYamicufGdIx8eqFz9ZTkMYWy8dA1vqRp4Ir/2WcLINlBQAPgkIWQQz0c8OFvlkl8zA5lzGAeHz9+FgO6ii+y9QCRSowHdTtH9xOZTjWBn6asKUK2VvtBaUuFH+R62oAZkObLfKzM71wHCqhyVaFPpIs/emndV+mLfBmtivv85Dg9kAwajE+K3kg8lpq3YA0dlY48GAM+FgDklq7wDoVtUaVT/e/YdJDdiUcPrAHmeFJhemkBKMunZ/y6nZDeYGMKmzB8eCBshHW1T6VhuqdabzmI+P2Tpm1OWAWoei88uSBV+o9G7eimfN4O0f9e/enyg9PgL5Xk9tqDP9OKmKilbCNU0dxL6Wgr4aOlo/yGOagQ7yeZqwYRnXndlxArAnNHfRvbzXlML5ktJmWdij2rgsxAQVlVJMF2xaUCcGuUH6n9SpX3f9XR8IF7qQIiTlUWcznXf5/CRZfflqIGuaxkgDEVqaOyX4+VmnNvic2SyTCi5VRWfdgVUAF5dUVtj6KrpwL545dMX7TNg/LMaeHygnr7YxNM2JcEvVOLJrISKolk9oPpxW7ep+JJodLJqnkpN9Vs1IFxsarqzpLKHsrUXGaW1+vrFfj3w8+BA+iOHA1omrxbCJ9F67IP2oUK04+QFgC2Sq8U7x5CGTyVsaL3LLjIp9ywC/NPrC/wCv8Av8C/A/wCpreUSrYyOqQAAAABJRU5ErkJggg==\",\n \"gpayUri\": \"gpay://upi/pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"phonepeUri\": \"phonepe://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"paytmUri\": \"paytmmp://pay?ver=01&mode=15&am=5.00&mam=1.00&cu=INR&pa=npstpay@timecosmos&pn=NPST%20PAY&mc=6012&tr=NPST040120220010&tn=QR%20SIT%20testing&mid=NPSTPAY001&msid=NPSTPAY001-001&mtid=NPSTPAY001-001&category=02&url=http://google.com\",\n \"generatedLink\": \"https://staging.decf.in/pay/514o5z3m9z\"\n },\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10,\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=true\",\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?success=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://staging.paysecure.net\",\n \"failure_callback\": \"https://staging.paysecure.net\",\n \"platform\": \"API\",\n \"created_from_ip\": \"103.59.75.113\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/66c4667bb993c970367c288a/\",\n \"payoutProcess\": false\n}"},{"id":"40b063cd-4299-4d6a-a073-a81e6063c918","name":"Purchases","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error Message\",\n \"code\": \"error_code\"\n}"}],"_postman_id":"bc90df10-0abd-4141-ab96-11d50ac29397"}],"id":"0400d8ef-9edf-42c4-86c6-104dad3fe7ec","description":"PayIn API Flow
\n- \n
Initiation:
\n- \n
Merchant system calls paysecure
\nPurchasesAPI. \nResponse: Returns a checkout URL and initiates a callback URL.
\n \n
\nRedirection:
\n- \n
- Customer is redirected to the cashier page. \n
\nPayment Method Selection:
\n- \n
- The cashier page displays options such as UPI Dynamic QR and UPI ID. \n
\nTransaction Processing:
\n- \n
- Customer completes the payment using a UPI app. \n
\nSuccess Callback:
\n- \n
- On successful payment, a scuccess wehook is triggered \n
\nFinalization:
\n- \n
- Customer is redirected back to the merchant site where the transaction status is displayed and the balance is updated. \n
\n
To Initiate a payment, the very first call to make is /payout/ with the required data in the request body.
To generate a Payout, you are required to provide the API key (in the header) can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a Payout request.
\nMandatory parameters in the request body:
\n","urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"disabled":true,"key":"","value":null},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[],"_postman_id":"a59f629c-ed9c-4879-a15f-417d33703f4c"},{"name":"Get Status","id":"59071608-6b3c-4c21-8157-3dad60b3a776","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/","description":"This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId in the API URL
\nPossible Value of Status
\nThe webhook will only be triggered for paid transactions or errors.
\nPaid: \"success_callback\": \"https://success.com\",
\nError: \"failure_callback\": “https://failure.com”
\n","urlObject":{"path":["getpayout","{payoutId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1fad7407-d8b4-48ed-b46b-8955b50bb570","name":"Get success Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"payoutId\": \"66838ae86d41e41c10a8656d\",\r\n \"client\": {\r\n \"email\": \"Yogesh@gmail.com\",\r\n \"phone\": \"766533230591\",\r\n \"full_name\": \"Test Person-uk\",\r\n \"country\": \"CA\"\r\n },\r\n \"updated_on\": 1719896808,\r\n \"payoutMethod\": \"PAYOUT-UPI\",\r\n \"beneficiaryDetail\": {\r\n \"upi\": \"charles.babbage@okhdfc\",\r\n \"transferType\": \"UPI\"\r\n },\r\n \"amountUnit\": \"MAJOR\",\r\n \"amount\": 10.0,\r\n \"errorMsg\": \"\",\r\n \"purpose\": \"test payout\",\r\n \"created_on\": 1719896808,\r\n \"merchantRef\": \"66838ae86d41e41c10a8656d\",\r\n \"merchantName\": \"newMerchant777\",\r\n \"status\": \"PAYOUT_IN_PROCESS\",\r\n \"status_history\": [\r\n {\r\n \"status\": \"created\",\r\n \"timestamp\": 1719896808\r\n },\r\n {\r\n \"status\": \"payout_in_process\",\r\n \"timestamp\": 1719896810\r\n },\r\n {\r\n \"status\": \"viewed\",\r\n \"timestamp\": 1719900796\r\n }\r\n ],\r\n \"viewedOn\": 1719900796,\r\n \"currency\": \"INR\",\r\n \"paymentOn\": 0,\r\n \"success_callback\": \"https://success.com\",\r\n \"failure_callback\": \"https://failure.com\"\r\n}\r\n"},{"id":"315f78c8-ca23-4fa1-893e-11f047382428","name":"Get Error Status","originalRequest":{"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/getpayout/{payoutId}/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Error Message\",\r\n \"code\": \"error_code\"\r\n}"}],"_postman_id":"59071608-6b3c-4c21-8157-3dad60b3a776"}],"id":"931819da-077a-4579-8888-95934b1edf80","description":"Payout API Flow
\n- \n
Customer Action:
\n- \n
- Customer initiates a payout request on the merchant site and inputs their VPA. \n
\nInitiation:
\n- \n
Merchant system calls its payout API.
\n \nInput Data: Includes payout amount, beneficiary details (with VPA), and callback URL.
\n \n
\nProcessing:
\n- \n
- The payout request is processed. \n
\nWebhook Notification:
\n- \n
- Upon successful payout, merchant receives a success webhook. \n
\nFinalization:
\n- \n
- Merchant system updates both customer and merchant balances accordingly. \n
\n
This is a versatile payment solution that supports both pay-ins (customer payments) and payouts (customer withdrawals) primarily using UPI-based transactions. This integration enables merchants to provide seamless payment experiences on their platforms, offering multiple UPI payment options such as UPI Dynamic QR and UPI Intent (via VPA) payments. The integration leverages asynchronous callbacks and webhooks to ensure real-time transaction status updates and balance synchronization.
\n","_postman_id":"9b80d8e4-0c86-4bfc-a301-ad7c1edd01b3"}],"id":"15b03d02-3041-4381-b1d6-6a8c16352419","_postman_id":"15b03d02-3041-4381-b1d6-6a8c16352419","description":""}],"id":"0fe88ad2-34f9-4ff4-9ad7-55c35e39e514","_postman_id":"0fe88ad2-34f9-4ff4-9ad7-55c35e39e514","description":""},{"name":"Trust Score","item":[{"name":"TrustScore Detailed","id":"35ab4812-eb0b-466a-a362-8f3457c13353","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/trustScore","description":"Overview
\nPaysecure TrustScore's proprietary API combines email, phone number, IP and URL so that you can request and receive a user trust score from our enriched data, rules, and scoring in a single API call.
\nOur take on Trust is different from the usual approach to fraud. This API tells you how much you can trust this user. It’s based on 100+ data points to which we have access. We use complex algorithms based on data sanity and customer behaviour in our partner network.
\nAlso, the additional optional parameter would be used to boost the accuracy of our response. So the more data we get the better we can ascertain the users' trust. So please endeavour to send as much information about the user as possible.
\nTrust Score & Usage
\nTrustScore offers two distinct endpoints: General and Detailed.
The General endpoint provides basic information by indicating whether a transaction is permitted or not. It gives a simple 'yes' or 'no' response regarding whether the transaction can proceed.
\nOn the other hand, the Detailed endpoint offers a more comprehensive evaluation. It furnishes an in-depth analysis of the transaction's authenticity, providing a detailed assessment beyond a simple allowance or denial, offering nuanced insights and information about the transaction's legitimacy.
\nDetailed TrustScore
\nTrust scores range from 0 to 5. A trust score of 0 indicates that we have limited information about the user, and it corresponds to the lowest level of trust. In addition to the TrustScore, we offer eight other flags to help assess the user's overall profile and determine appropriate actions to take. We suggest flagging or blocking users, transactions, or clicks as high risk based on a combination of the following factors: email deliverability, proxy usage, VPN usage, Tor usage, and recent abusive behavior.
\nEvery company has a unique target audience, so you might achieve better results by only flagging or blocking entities with low trust scores and recent instances of abuse. Keep in mind that mobile IP addresses are frequently misused and recycled by mobile carriers. Therefore, for mobile lookups, we advise giving more weight to the trust score, VPN usage, and Tor usage, as opposed to proxy usage.
\nPermission
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at PaySecure to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nMandatory Parameters (in body)
\nOther optional paramters:
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse
\nIn the response examples, you can observe both instances of a successful TrustScore response and an unsuccessful one.
\nPlease note that there are a lot of parameters to determine the trust level and give you some additional details on the email and IP of the user.
\nin a successful trust score call the following data would be provided:
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","urlObject":{"path":["trustScore"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"fb8d87ea-5a7d-44d1-a881-f09e32d796de","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/trustScore"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"trustScore\": 0,\n \"deliverable\": \"false\",\n \"proxy\": \"false\",\n \"vpn\": \"false\",\n \"tor\": \"false\",\n \"active_vpn\": \"false\",\n \"active_tor\": \"false\",\n \"recent_abuse\": \"false\",\n \"bot_status\": \"false\"\n}"},{"id":"7bbccfc3-812d-4e19-a47b-e4572bea1b47","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/trustScore"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"35ab4812-eb0b-466a-a362-8f3457c13353"},{"name":"checkTransactionAllowed","id":"41e54637-ea23-4638-9b1c-85498cca0eb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"111.11.11.11\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"https://www.asos.com/\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/checkTransAllowed","description":"General TrustScore
\nRequest for the checkTransactionAllowed endpoint is identical to the TrustScore API. Only thing different is the response. Instead of detailed score, this endpoint only returns transactionAllowed parameter that can have either YES or NO value.
Permission
\nAccess to this API has to be given to you by the admin. So please contact your sales representative at Paysecure to get access to this API, if you get a 401 error of \"You are not allowed to call this API service\".
\nMandatory Parameters (in body)
\nOther optional paramters:
\nThe optional parameters are self-explanatory and appropriate values can be given in string format.
\nResponse
\nResponse contains a single parameter: transactionAllowed which can either be YES or NO .
{\n\"transactionAllowed\" : \"YES\"\n}\n\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\nthe possible error codes one can get on calling this APIs are:
\nfor example:
\n","urlObject":{"path":["checkTransAllowed"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4fd67bc9-63ff-46d8-a270-a8d748b5ef5a","name":"TrustScoreExists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/checkTransAllowed"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:21:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=r2%2FuLwSilxdD1lpiI1VqpgF0Tu9etiNhupySeBHl0zcU8XV1z8kwR%2FJ00ti4xpMdrTXW%2BkqZkLGrkkaUnMWFsaYlg%2FfA9UC4wIKwmc9LHUwna491EmnC3b3vlabzhUJ11CMpnVmicUE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da590e8d4345a0-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionAllowed\": \"YES\"\n}"},{"id":"ec014e56-45ce-4d7c-8fd7-7534c48c7950","name":"TrustScoreError","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredinput\": {\r\n \"ip\": \"2001:8004:cc2:fadb:9958:4523:6c42:e3f2\",\r\n \"email\": \"test@gmail.com\",\r\n \"url\": \"http://test.com\"\r\n },\r\n \"optionalInput\": {\r\n \"last_bets\": null,\r\n \"last_wins\": \"\",\r\n \"total_bonuses\": \"\",\r\n \"last_real_bets\": \"\",\r\n \"last_real_wins\": \"\",\r\n \"total_deposits\": \"\",\r\n \"last_bonus_bets\": \"\",\r\n \"last_bonus_wins\": \"\",\r\n \"average_real_bet\": \"\",\r\n \"last_bets_amount\": \"\",\r\n \"last_wins_amount\": \"\",\r\n \"average_bonus_bet\": \"\",\r\n \"bonus_to_deposits\": \"\",\r\n \"last_deposit_date\": \"\",\r\n \"total_withdrawals\": \"\",\r\n \"is_phone_confirmed\": \"\",\r\n \"money_in_money_out\": \"\",\r\n \"last_deposit_amount\": \"\",\r\n \"last_freespins_date\": \"\",\r\n \"last_freespins_name\": \"\",\r\n \"last_free_bonus_date\": \"\",\r\n \"last_free_bonus_name\": \"\",\r\n \"total_bonuses_amount\": \"\",\r\n \"last_freespins_amount\": \"\",\r\n \"last_freespins_status\": \"\",\r\n \"last_real_bets_amount\": \"\",\r\n \"last_real_wins_amount\": \"\",\r\n \"total_deposits_amount\": \"\",\r\n \"last_bonus_bets_amount\": \"\",\r\n \"last_bonus_wins_amount\": \"\",\r\n \"last_free_bonus_amount\": \"\",\r\n \"last_free_bonus_status\": \"\",\r\n \"last_deposit_bonus_date\": \"\",\r\n \"last_deposit_bonus_name\": \"\",\r\n \"last_freespins_currency\": \"\",\r\n \"last_freespins_wagering\": \"\",\r\n \"withdrawals_to_deposits\": \"\",\r\n \"last_free_bonus_currency\": \"\",\r\n \"last_free_bonus_wagering\": \"\",\r\n \"total_withdrawals_amount\": \"\",\r\n \"withdrawal_ewallet_email\": \"\",\r\n \"last_deposit_bonus_amount\": \"\",\r\n \"last_deposit_bonus_status\": \"\",\r\n \"last_deposit_bonus_currency\": \"\",\r\n \"last_deposit_bonus_wagering\": \"\",\r\n \"session\": \"\",\r\n \"payment_mode\": \"\",\r\n \"card_fullname\": \"\",\r\n \"card_bin\": \"\",\r\n \"card_hash\": \"\",\r\n \"card_last\": \"\",\r\n \"card_expire\": \"\",\r\n \"avs_result\": \"\",\r\n \"cvv_result\": \"\",\r\n \"sca_method\": \"\",\r\n \"user_bank_account\": \"\",\r\n \"user_bank_name\": \"\",\r\n \"user_balance\": \"\",\r\n \"user_verification_level\": \"\",\r\n \"status_3d\": \"\",\r\n \"regulation\": \"\",\r\n \"payment_provider\": \"\",\r\n \"phone_number\": \"\",\r\n \"transaction_type\": \"\",\r\n \"transaction_amount\": \"\",\r\n \"transaction_currency\": \"\",\r\n \"merchant_id\": \"\",\r\n \"details_url\": \"\",\r\n \"name\": \"\",\r\n \"person_type\": \"\",\r\n \"gender\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StagingBaseURL}}/checkTransAllowed"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 29 Oct 2023 09:28:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=herXY1o%2BFZa%2F3qNFjvh4ANgP%2FD0DdAVVFm0vUZDAst2rFkieItm%2Fu0VN24DYrdp7MHMHFKWLvrsBYVIxjDPDaLgJjeGBvlTP2iZoB5EnG1hPPHUVXRNP%2FGMmOTh%2Fp7gsyj0vihW1kMk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"81da6398ab144913-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"41e54637-ea23-4638-9b1c-85498cca0eb6"}],"id":"3a696fea-6a8e-4702-b451-f56154171d91","_postman_id":"3a696fea-6a8e-4702-b451-f56154171d91","description":""},{"name":"Cashier APIs","item":[{"name":"Customer","id":"80a9faa2-891c-4b9e-ab87-ae455e81b3dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fullName\": \"Rahul Agarwal\",\r\n \"emailId\": \"rahul+26@paysecure.net\",\r\n \"dateOfBirth\": \"1994-06-03\",\r\n \"phoneNo\": \"+91 797639082\",\r\n \"city\": \"Jaipur\",\r\n \"stateCode\": \"RJ\",\r\n \"zipCode\": \"302018\",\r\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\r\n \"country\": \"IN\",\r\n \"merchantCustomerId\": \"rahultestcustomer@paysecure.net\",\r\n \"CustRegDate\": \"2023-12-27\", //non-mandatory - customer registration date on merchant site\r\n \"SuccessTxn\": \"32\", //non-mandatory - total successful customer orders on merchant site\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"param2\": \"value2\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/customer","description":"OVERIEW
\nThe createCustomer API allows merchants to create a customer profile on PaySecure when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the PaySecure Cashier. The API takes in customer information and returns a unique customerID that can be passed in purchase payload, eliminating the need for customers to manually enter their details during transactions.
\nUser Flow
\n- \n
Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n \nMerchant calls the
\ncreateCustomerAPI: The merchant sends aPOSTrequest to the Paysecure API with the customer's details. \nCustomer ID generation: Paysecure processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent session creation, ensuring the customer doesn’t need to re-enter their details for future payments. \n
\n
Benefits
\n- \n
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n \nFaster Checkout: The merchant can use the
\ncustomerIdfor faster payment processing. \nData Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n \n
Implementing createCustomer on merchant site:
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
- \n
Call
\ncreateCustomer: This API call generates a unique customer ID. \nUse of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n \n
Upon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
- \n
Persistent Customer Profiles: This approach can help build or maintain a persistent customer profile, ensuring the customer ID is available for any subsequent payment sessions without needing to call
\ncreateCustomeragain. \nIntegration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n \n
The method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Paysecure API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["app","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"1a133d7c-abb6-4ca4-bd0f-7ed51b3215e9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.paysecure.net/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\",\n \"fullName\": \"Rahul Agarwal\",\n \"emailId\": \"rahul+26@paysecure.net\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"1d666074-39be-4b90-aec9-e9de78fbdcb9\",\n \"city\": \"Jaipur\",\n \"zipCode\": \"302018\",\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"},{"id":"e60b568b-3bba-40b7-ae58-04c0d02cda54","name":"Invalid Customer","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.paysecure.net/api/v1/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer with this information does not exist\",\n \"code\": \"customer_does_not_exist\"\n}"}],"_postman_id":"8db7e7d8-d5b9-481f-99ed-c76418c182eb"},{"name":"Customer","event":[{"listen":"test","script":{"id":"272f785d-43b9-49f8-8029-580e45c98165","exec":["var template = `","","","| Customer ID | ","First Name | ","Last Name | ","Phone | ","|
|---|---|---|---|---|
| {{response.customerId}} | ","{{response.firstName}} | ","{{response.lastName}} | ","{{response.email}} | ","{{response.phone}} | ","
Whenever a customer or the merchant updates customer details on the merchant site, a PATCH request must be made to synchronize these changes with Paysecure.
\nThis API endpoint allows you to update the customer details using an HTTP PATCH request. The request should be sent to https://api.paysecure.net/api/v1/{customerId}/patchCustomer.
\nRequest Body
\nThe request body should be in raw format and include the following parameters:
\n- \n
\nfullName(string): The full name of the customer. \n
\nemailId(string): The email address of the customer. \n
\ndateOfBirth(string): The date of birth of the customer. \n
\nphoneNo(string): The phone number of the customer. \n
\ncity(string): The city of the customer. \n
\nstateCode(string): The state code of the customer. \n
\nzipCode(string): The zip code of the customer. \n
\naddress(string): The address of the customer. \n
\ncountry(string): The country of the customer. \n
\ncreatedOn(string): Time when the customer was created. \n
\ncustRegDate(string): Customer registration date (Non-Mandatory). \n
\nsuccessTxn(string): Success transaction details (Non-Mandatory). \n
\nlastActivity(string): Time of the last activity. \n
\nlastUpdated(string): Time when the last patch was called. \n
\nextraParam(object): Additional parameters includingparam1,param2,param3,param4with their respective values. \n
Response
\nThe response will contain the updated customer details or a success message upon successful update.
\n","urlObject":{"protocol":"https","path":["api","v1","{PaysecureCustomerId}","patchCustomer"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"315616af-fd27-4629-b572-43cd29d4d80f","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Authorisation","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@paysecure.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"city\": \"Dausa\",\n \"stateCode\": \"Raj\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"CustRegDate\": \"2023-12-28\",\n \"SuccessTxn\": \"33\",\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/{PaysecureCustomerId}/patchCustomer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\",\n \"fullName\": \"Gouri Shankar3\",\n \"emailId\": \"gouri@paysecure.com\",\n \"dateOfBirth\": \"1990-11-27\",\n \"phoneNo\": \"+91 9413666514\",\n \"brandID\": \"brandID\",\n \"city\": \"Dausa\",\n \"zipCode\": \"202021\",\n \"address\": \"Somnath Nagar\",\n \"country\": \"IN\",\n \"stateCode\": \"Raj\",\n \"custRegDate\": \"2023-12-28\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 1763377024,\n \"lastActivity\": 1763377024,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"0b904593-8381-4b27-89bd-ec6dc13ee794"},{"name":"Purchase Session","id":"f1041a2e-6810-448a-989b-cea08fcb2b8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Accept","value":"*/*","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": \"68fed1855ebbe829416b08c6\",\r\n \"merchantRef\": \"rahultestcustomer1@paysecure.net\", // optional\r\n \"currency\": \"EUR\",\r\n \"products\": [\r\n {\r\n \"name\": \"Product1\",\r\n \"price\": \"10\"\r\n },\r\n {\r\n \"name\": \"Product2\",\r\n \"price\": \"12\"\r\n }\r\n ],\r\n \"totalAmount\": \"22\", // optional, but if present have precedence over sum of prices mentioned above.\r\n \"paymentMethod\": \"VISA\", //optional\r\n \"success_redirect\": \"https://merchant-success-page.com/\",\r\n \"failure_redirect\": \"https://merchant-failure-page.com/\",\r\n \"pending_redirect\": \"https://merchant-pending-page.com/\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\",\r\n \"extraParam\": {\r\n \"param1\": \"value1\",\r\n \"showCryptoConversion\": \"yes\",\r\n \"cryptoCurrencies\": \"[\\\"BTC\\\",\\\"ETH\\\",\\\"USDT\\\",\\\"XRP\\\",\\\"LTC\\\",\\\"DOGE\\\",\\\"ETC\\\",\\\"BNB\\\",\\\"USDC\\\",\\\"SOL\\\",\\\"ADA\\\",\\\"BCH\\\",\\\"DASH\\\",\\\"BTG\\\",\\\"ZEC\\\",\\\"DGB\\\",\\\"EOS\\\",\\\"XLM\\\",\\\"TRX\\\",\\\"QTUM\\\",\\\"POL\\\",\\\"SHIB\\\",\\\"LINK\\\",\\\"DAI\\\",\\\"TON\\\",\\\"AVAX\\\",\\\"FDUSD\\\",\\\"ARB\\\",\\\"OP\\\"]\",\r\n \"param3\": \"value3\",\r\n \"param4\": \"value4\"\r\n }\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"OVERIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nMandatory Parameters
\nShow Crypto Conversion
\nAdditionally, there are some default extra parameters that you can pass for allowing Crypto Conversion on Paysecure's cashier itself.
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: PaySecure creates the session and associates it with the merchant’s checkout page. This session remains active on the backend, allowing the customer to continue the payment process without interruption.
\n \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
This API is used to initiate a payout session for a customer. By passing the customerId (generated via the createCustomer API) and specifying \"type\": \"payout\", a payout session is started.
A sessionURL is returned in the response, which can be used to redirect the customer to the payout cashier. The customer can then select the payout method, pass required parameters, and the payout will be processed.
Parameters:
\nRequest Headers:
\n- \n
BrandId: Your unique brand ID (required).
\n \nContent-Type: application/json (required).
\n \n
Response:
\nThe API will return a JSON object containing the sessionURL that can be used to redirect the customer to the payout cashier.
{\n \"sessionUrl\": \"https://api.paysecure.net/payoutSession/68341ad35f895955355d5452/\",\n \"brandId\": \"brand_id_value\",\n \"customerId\": \"67c9983fba18400ab6cceb8f\",\n \"sessionId\": \"68341ad35f895955355d5452\",\n \"expiryOn\": 1748246103,\n \"createdOn\": 1748245203\n}\n\nThis endpoint retrieves the details of a session identified by the provided session ID.
\n\n\nNote that this API only respond once the SessionURL, received in the response for session API, is clicked.
\n
\n\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","name":"Cashier APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases","{Session ID}",""],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"e78d5794-1977-41c9-a328-8775e3a39555","name":"202 Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/6950e4ba5205280b71ac2010/"},"status":"Accepted","code":202,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6950e4e3e4a1b008c2fae5c3\",\n \"client\": {\n \"customerId\": \"69034a5a61b460084d20c23b\",\n \"email\": \"rahul+23@paysecure.net\",\n \"phone\": \"+919634088561\",\n \"full_name\": \"Rahul Agarwal\",\n \"street_address\": \"Vaishali Jaipur\",\n \"country\": \"NA\",\n \"city\": \"jaipur\",\n \"zip_code\": \"202020\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"RA\"\n },\n \"updated_on\": 1766909180,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,JCB,AMEX,CRYPTO-BRIDGE,FawryPay,INTERAC-E-TRANSFER,INTERAC-REQUEST-MONEY,MOBILEMONEY,NEOSURF,PAYID,PIX,SPEI,THIRDPARTY-UPI,DISCOVER,BANKTRANSFER,VIRTUAL-IBAN,UPI-COLLECT,UPI-QR,VIRTUAL-ACCOUNT,DINERS,NETBANKING,THIRDPARTY-NETBANKING,MAYA,GCASH,INTERAC-EXPRESS,QRPH\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"This customer can not be processed !\",\n \"errorCode\": \"NA\",\n \"savedCardUsed\": \"NO\",\n \"redirectType\": \"POST\",\n \"force_recurring\": false,\n \"created_on\": 1766909155,\n \"merchantRef\": \"6950e4e3e4a1b008c2fae5c3\",\n \"merchantName\": \"rahul_test\",\n \"merchantType\": \"MERCHANT\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"NA\",\n \"quantity\": 1.0,\n \"price\": 22.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 22.0,\n \"requestAmount\": 22.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"Testing\",\n \"brand_name\": \"Testing\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"07\",\n \"amount\": 22.0,\n \"card_issuer\": \"CIAGROUP\",\n \"masked_pan\": \"55555555****4444\",\n \"card_brand\": \"MASTER\",\n \"card_issuer_country\": \"BR\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"rahul\",\n \"expiry_year\": \"30\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"183.83.53.214\",\n \"type\": \"execute\",\n \"payment_method\": \"MASTER\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"BR\",\n \"processing_time\": 1766909179,\n \"extra\": {\n \"expiry_month\": \"07\",\n \"amount\": 22.0,\n \"card_issuer\": \"CIAGROUP\",\n \"masked_pan\": \"55555555****4444\",\n \"card_brand\": \"MASTER\",\n \"card_issuer_country\": \"BR\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"rahul\",\n \"expiry_year\": \"30\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"no_mid_found\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1766909155\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1766909179\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1766909180\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1766909186\n }\n ],\n \"viewedOn\": 1766909186,\n \"is_test\": false,\n \"brand_id\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS334\",\n \"issued\": \"2025-12-28\",\n \"due\": 1766909155,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"0\",\n \"trustScore\": \"0\",\n \"extraFee\": \"0\",\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"6950e4ba5205280b71ac2010\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://google.com/\",\n \"failure_redirect\": \"https://google.com/\",\n \"pending_redirect\": \"https://google.com/\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"platform\": \"API\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/adb6e07f74ec6197ef764909736d478e/\",\n \"direct_post_url\": \"https://api.choicepay.ca/api/v1/p/6950e4e3e4a1b008c2fae5c3/\",\n \"payoutProcess\": false\n}"},{"id":"bb8043a1-64a8-41ee-8897-c51ff7889910","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/purchases/6950e4ba5205280b71ac2010/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"PurchaseId Not found.\",\n \"code\": \"transaction_error\"\n}"},{"id":"89ec26b7-642c-42f7-960e-8c426df7632a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/{Session ID}/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sun, 28 Dec 2025 08:03:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"d5308b2a-537d-466a-8273-f754ba3491b8"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Ed-N_b__1xPz7yrAt9mMc6JrgiZqMiuPi3uJbZ4AeuUKm-Ziiohlcw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=V90OEeQkl%2Fh028giW2T2qMbuNADZ5EvKMZG33harMVuXpmo%2BnNQm5JeDtH2802Oa8hw5kJG737sqfdiLVuvIq%2F5E5tHoRdK8Zj6OU6yO255A\"}]}"},{"key":"CF-RAY","value":"9b4f8ac7caf2f4ca-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Incorrect secret_key\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"7888039f-2bf0-4a8f-a6d5-956bd4374d89"},{"name":"Check Status - Payout","id":"16c35a74-3e73-4400-954f-bfba5187e149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{Session ID}/","description":"Once the SessionURL is clicked and the user has selected a payment method and click on \"Pay\" button, a purchase is created on our backend. If you call this API before that, you will get an error.
\n
This API tells you about all the details of a Payout, including its history
\nMandatory
\nyou need to pass the payoutId or session id in the API URL
\nPossible Value of Status
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","name":"Cashier APIs","type":"folder"}},"urlObject":{"path":["getpayout","{Session ID}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8110f305-ddd5-4df9-b748-85e3a231756d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/getpayout/{Session ID}/"},"status":"Accepted","code":202,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Mon, 27 Apr 2026 07:03:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"9be65213-e200-4ef2-831c-683022389e8b"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 ea9784182c7536f5ce15ec71cf0089d6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"SQqBgIYJCqc_HzF2NrYyoiCCGUdxGyPFZ3OzmUrrL-XBe56tKWTifA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=dRx0V9WF8UC%2FPmYeyh%2Fl2YI7rIhT15NcQDiRVHdKuzF4jjsVyYmbl2imFi%2FSpP4VpmIHsFmO0xzXUjyO1%2BwKeupdremHVjRNwtqENY%2FZxgVpN7KFFzAhSQDhOMdd62Anr2zN\"}]}"},{"key":"CF-RAY","value":"9f2bf84969fa9c85-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"65ffadb4c1c83822903a9205\",\n \"client\": {\n \"email\": \"customer141@email.uk\",\n \"full_name\": \"Test Person-uk\",\n \"street_address\": \"Random city address\",\n \"country\": \"SG\",\n \"city\": \"Singapore\",\n \"zip_code\": \"123456\",\n \"stateCode\": \"test\"\n },\n \"updated_on\": 1711254964,\n \"payoutMethod\": \"Payout-BANKTRANSFER\",\n \"beneficiaryDetail\":{\n \"bankName\": \"DBS Bank\", \n \"bankAccountName\": \"test test\",\n \"bankAccountCurrency\": \"SGD\",\n \"bankAccountNumber\": \"12345640\",\n \"bankCountryCode\" : \"SG\",\n \"swiftCode\": \"DBSSSGSG\",\n \"routing_param\" :\n {\n \"bankCode\": \"897678\",\n \"bankBranchCode\" : \"888\"\n \n }\n },\n \"amountUnit\": \"MAJOR\",\n \"amount\": 1000.0,\n \"errorMsg\": \"Currency Account has insufficient balance.\",\n \"purpose\": \"test payout\",\n \"created_on\": 1711254972,\n \"merchantRef\": \"65ffadb4c1c83822903a9205\",\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1711254964\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1711254972\n }\n ],\n \"currency\": \"USD\",\n \"success_callback\": \"https://success.com\",\n \"failure_callback\": \"https://failure.com\"\n}"}],"_postman_id":"16c35a74-3e73-4400-954f-bfba5187e149"}],"id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52","description":"Paysecure Cashier is a unified payment management solution that connects with leading PSP and acquirers, offering merchants one convenient access point to simplify transaction processing and enhance efficiency.
\nTo start the cashier system, a payment session is initiated—a secure, temporary environment generated by our payment gateway. This session encapsulates all transaction details and state information before the cashier loads, overseeing the complete lifecycle of a payment attempt—from initial setup to final completion—ensuring every necessary detail is managed safely and consistently.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d418f8e5-428a-4ab3-9e85-19843b35c14a","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"d030bfe6-8611-4e65-9e84-089e4613094c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"9c31c1ef-e9a4-44d8-916c-4c90e9604f52"},{"name":"User Defined Fields (UDF)","item":[],"id":"02ceacd6-cbd8-4fd7-8b2a-7552030a51b4","description":"User Defined Fields (also referred to as Merchant Defined Parameters) allow you to attach custom identifiers to transactions. These identifiers can help you map transactions to your internal systems and configure advanced routing rules.
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
Adding a User Defined Field
\n- \n
Click Add Parameters.
\n \nEnter the Parameter Name.
\n \nChoose the Value Type (Numeric, String, or Boolean).
\n \nClick Add to save.
\n \n
Here is how you can define UDFs in Paysecure's app.
\nUsing UDF in API Requests
\nOnce created, you can pass the parameter in the purchases or session API using the extraParam object in the payload, to receive the same in the API response and the following webhooks.
\"extraParam\": {\n \"userDefinedParameter\": \"value\"\n}\n\nBest Practices
\n- \n
Use consistent naming conventions for parameters to avoid confusion across integrations.
\n \nKeep the number of UDFs minimal — only add fields that provide clear value (e.g., customer segment, order type, risk score).
\n \nLeverage UDFs in rule-based routing to optimize processing flows (e.g., route high-value transactions to a specific MID).
\n \nDocument your UDFs internally so operations and support teams can easily reference them.
\n \n
Note:
This feature is enabled only for the whitelabel merchant solution. If you are using a merchant solution, please contact your Account Manager for doing these changes.
For cases where the Merchant handles the scheduling:
\nFor cases where Paysecure handles the scheduling:
\nOVERIEW
\nThe createCustomer API allows merchants to create a customer profile on Paysecure when a user visits their website, facilitating a seamless payment experience by pre-filling the customer's details, on the Paysecure Cashier.
\nThe API takes in customer information and returns a unique customerID that can be passed in purchase payload, eliminating the need for customers to manually enter their details during transactions.
\nUser Flow
\n- \n
Customer visits merchant's website: The customer selects the product or service and proceeds to checkout page.
\n \nMerchant calls the
\ncreateCustomerAPI: The merchant sends aPOSTrequest to the Paysecure API with the customer's details. \nCustomer ID generation: Paysecure processes the request and generates a unique
\ncustomerIdwhich is returned in the response. \nPayment Process: The merchant uses the
\ncustomerIdfor subsequent session creation, ensuring the customer doesn’t need to re-enter their details for future payments. \n
\n
Benefits
\n- \n
Seamless user experience: The customer does not have to enter their details manually for every purchase.
\n \nFaster Checkout: The merchant can use the
\ncustomerIdfor faster payment processing. \nData Security: Customer details are stored securely and can be reused across transactions, reducing the chances of errors.
\n \n
Implementing createCustomer on merchant site:
\nThe createCustomer can be implemented on merchant site in one of two ways, depending on merchant’s integration flow:
At Checkout:
\nWhen a customer initiates the checkout process, your system should invoke the createCustomer API, before actually starting the session.
- \n
Call
\ncreateCustomer: This API call generates a unique customer ID. \nUse of Customer ID: Pass the returned customer ID in Session API, when creating a payment session.
\n \n
Upon Customer Login:
\nAlternatively, merchants may choose to call createCustomer at the time of customer login on their site.
- \n
Persistent Customer Profiles: This approach can help build or maintain a persistent customer profile, ensuring the customer ID is available for any subsequent payment sessions without needing to call
\ncreateCustomeragain. \nIntegration Flexibility: This is useful for merchants who want to initialize customer data early in the customer journey rather than during checkout.
\n \n
The method you choose depends on your business requirements and how your system is architected. Regardless of when you call it, the resulting customer ID must be passed to the createSession API to initiate a payment session.
This endpoint makes an HTTP GET request to retrieve customer information from the Paysecure API.
\nRequest
\nThe request does not include any query parameters, but it uses a raw request body with the following parameter \"merchantCustomerId\", which will be the customer id on the merchant's side.
\nResponse
\nThe response of this request can be documented as a JSON schema.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"917da390-3ff9-462e-83c3-363f9b44a6b0","id":"917da390-3ff9-462e-83c3-363f9b44a6b0","name":"Recurring Payments","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["app","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"b0707d55-5c1a-4d50-901e-ac1581014021","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.paysecure.net/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sat, 31 Jan 2026 15:00:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"x-session-id","value":"74520247-3540-48b2-81f9-33fd50e71e01"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Set-Cookie","value":"SESSION=NDRjYjEwZGQtNTAyMy00MDA1LWFiNTUtNTBmNmY2YWY1NjZj; Path=/; Secure; HttpOnly; SameSite=Strict"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=gy0s5195rsESyn%2B0cQcmwej6qKnbNzrAcSxW%2F%2FrtkYk52a4Lipz%2FTBcpX5IjTYOHLNsLsPeT9jJFd4rUsIPUJbu4R%2B%2BcaGEmcMT6de1u%2FVA%3D\"}]}"},{"key":"CF-RAY","value":"9c6a13d27f38a3ba-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"customerId\": \"691afbc6fd96d34a8113a34d\",\n \"merchantCustomerId\": \"rahultestcustomer1@paysecure.net\",\n \"fullName\": \"Rahul Agarwal\",\n \"emailId\": \"rahul+26@paysecure.net\",\n \"dateOfBirth\": \"1994-06-03\",\n \"phoneNo\": \"+91 797639082\",\n \"brandID\": \"1d666074-39be-4b90-aec9-e9de78fbdcb9\",\n \"city\": \"Jaipur\",\n \"zipCode\": \"302018\",\n \"address\": \"House Number 53, Vaishali Nagar, Jaipur\",\n \"country\": \"IN\",\n \"stateCode\": \"RJ\",\n \"custRegDate\": \"2023-12-27\",\n \"successTrans\": 0,\n \"createdOn\": 1763376070,\n \"lastUpdated\": 0,\n \"lastActivity\": 1763376070,\n \"extraParam\": {\n \"param1\": \"value1\",\n \"param2\": \"value2\",\n \"param3\": \"value3\",\n \"param4\": \"value4\"\n }\n}"}],"_postman_id":"a2401032-1393-40ef-8351-dbd898d4b454"},{"name":"Create Session (CIT)","id":"db129eb4-636a-4ed4-819f-6eb1f6bc0dcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"brand_id_value","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"685f870cf3435a2d5b35ee08\", // mandatory\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"Product1\",\n \"price\": \"10\"\n },\n {\n \"name\": \"Product2\",\n \"price\": \"10\"\n }\n ],\n \"totalAmount\": \"21\", // optional, but if present have precedence over sum of prices.\n \"paymentMethod\": \"VISA\", //optional\n \"success_redirect\": \"https://merchant.com/success\",\n \"pending_redirect\": \"https://merchant.com/pending\",\n \"failure_redirect\": \"https://merchant.com/failure\",\n \"success_callback\": \"https://merchant.com/webhook/success\",\n \"failure_callback\": \"https://merchant.com/webhook/failure\",\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"mandate_max_amount\": \"5000\", // the mandated amount should be less than or equal to this amount.\n \"amount_variability\": \"Fixed\",\n \"start_date\": \"1598965200\", // epoch timestamp or UNIX timestamp\n \"end_date\": \"1914141600\", // epoch timestamp or UNIX timestamp\n \"frequency\": \"MONTHLY\",\n \"rule\": \"on\",\n \"value\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/createSession","description":"OVERIEW
\nThe createSession API is designed to initiate a payment session for a customer after their profile has been created via the createCustomer API. The session is automatically generated at the backend on the merchant’s checkout URL. This session allows the customer to continue with their transaction without having to manually interact with the session URL, and ensures the session remains active until the payment is completed or the session expires.
This API improves the user experience by reducing transaction failures and enhancing the overall payment process, thus reducing transaction churn rates.
\nMandatory Parameters
\nTo register a mandate, pass mandate related parameters in the Create Session API to create a mandate registration purchase. Post transaction completion, use Get Status API and Webhooks to capture mandate registration details.
\nAdditional parameters for this usecase:
\nUsage Flow
\n- \n
Customer completes the
\ncreateCustomerAPI: Once the customer is created via thecreateCustomerAPI, the merchant proceeds to call thecreateSessionAPI to generate a session. \nMerchant sends
\ncreateSessionrequest: The merchant sends aPOSTrequest to thecreateSessionAPI with the customer’scustomerIdand the merchant’sbrandId. \nSession created automatically on the checkout URL: PaySecure creates the session and associates it with the merchant’s checkout page. This session remains active on the backend, allowing the customer to continue the payment process without interruption.
\n \nCustomer proceeds to checkout: The customer is redirected to the checkout page as part of the merchant's payment flow, where the session is automatically validated. The session remains active for a set period, allowing the customer to complete the payment without needing to manually interact with the session URL.
\n \nSession Expiry: The session expires after the set expiration time (
\nexpiryOn), ensuring the payment process is completed within the defined window. Default is 15 mins from the creation time. \n
\n
Benefits
\n- \n
Seamless Checkout: The session URL is automatically generated and active at the backend, ensuring a smoother and uninterrupted customer experience.
\n \nReduced Transaction Failures: By ensuring the session remains active during the payment process, the chances of transaction failures due to session timeouts are minimized.
\n \nImproved User Experience: The customer does not need to click on a session URL or navigate away from the page, leading to faster and more secure payment processing.
\n \n
OVERIEW
\nThe create Purchase API is designed to initiate a payment for a merchant who doesn't want to use Paysecure's cashier and wants to keep everything S2S.
The merchant doesn't need to create a customer in this case and directly needs to call the purchase API and then call the S2S API after that.
\nAdditional parameters for this usecase:
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"917da390-3ff9-462e-83c3-363f9b44a6b0","id":"917da390-3ff9-462e-83c3-363f9b44a6b0","name":"Recurring Payments","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","purchases"],"host":["api","paysecure","net"],"query":[],"variable":[]}},"response":[{"id":"7624599c-5088-4af3-900e-3a657484f3b9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"rahul@gmail.com\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"stateCode\": \"LO\",\n \"street_address\": \"Flat 61 Priory Court Romford RM7 0FY\",\n \"zip_code\": \"234567\",\n \"full_name\": \"Rahul Agarwal\",\n \"phone\": \"+44 07932665877\" // optional\n },\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"price\": \"1\"\n }\n ]\n },\n \"merchantRef\": \"your-merchant-ref\", // optional\n \"paymentMethod\": \"MASTER\",\n \"brand_id\": \"your-brand-id\",\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"mandate_max_amount\": \"5000\", // Conditional\n \"amount_variability\": \"Fixed\", // optional\n \"start_date\": \"1598965200\", // optional\n \"end_date\": \"1914141600\", // optional\n \"frequency\": \"MONTHLY\", // mandatory\n \"rule\": \"on\", // optional\n \"value\": 1 // conditional\n },\n \"success_redirect\": \"https://merchant.com/success\", // mandatory\n \"pending_redirect\": \"https://merchant.com/pending\", // mandatory\n \"failure_redirect\": \"https://merchant.com/failure\", // mandatory\n \"success_callback\": \"https://merchant.com/webhook/success\", // mandatory\n \"failure_callback\": \"https://merchant.com/webhook/failure\" // mandatory\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 30 Mar 2026 12:23:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"668295f8-5770-4492-8318-01e2d1c09664"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 b4011ac432e4f034161d5cccc8a4ac80.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"46KSjvCpG3Uv-3pzVOVedkJkacP2LZAI0m9ByboJ-rzLxQkfNNycJA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=1p%2FF34n2kiKpiE2WnCntzJPGKU28mcMx4pIFZ9F6UFZqmnoSxQEqZQ44WCu6SsOg5eYfqPqYGdhXxgBbuVLNwP5Xyc2OqoL1lTauqUylCkCPuOXJ1VRrvygGOmX9Yslw6BqJ\"}]}"},{"key":"CF-RAY","value":"9e471560fd16d6d5-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"69f8d167db7ca561ab27c484\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"paysecuretest@gmail.com\",\n \"street_address\": \"Flat 61 Priory Court Romford RM7 0FY\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"LO\"\n },\n \"updated_on\": 1777914215,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1777914215,\n \"merchantRef\": \"69f8d167db7ca561ab27c484\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"product name\",\n \"quantity\": 1.0,\n \"price\": 5.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 5.0,\n \"requestAmount\": 5.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"Testing\",\n \"brand_name\": \"Testing\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1777914215\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"59c5ed48-caf9-464a-ba54-26e1e02bc1bc\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1736\",\n \"issued\": \"2026-05-04\",\n \"due\": 1777914215,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"totalRefunded\": 0.0,\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://merchant.com/success\",\n \"failure_redirect\": \"https://merchant.com/failure\",\n \"pending_redirect\": \"https://merchant.com/pending\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://merchant.com/webhook/success\",\n \"failure_callback\": \"https://merchant.com/webhook/failure\",\n \"platform\": \"API\",\n \"created_from_ip\": \"2406:b400:75:22bd:b48e:a33e:4e26:a542\",\n \"checkout_url\": \"https://api.choicepay.ca/payments/16550278d7e374e53048b72dcf253a3a/\",\n \"direct_post_url\": \"https://api.choicepay.ca/api/v1/p/69f8d167db7ca561ab27c484/\",\n \"payoutProcess\": false,\n \"payment_type\": \"mandate\",\n \"mandate\": {\n \"frequency\": \"ASPRESENTED\",\n \"rule\": \"on\",\n \"value\": null,\n \"mandate_max_amount\": null,\n \"amount_variability\": \"Variable\",\n \"end_date\": null,\n \"mandate_status\": \"CREATED\",\n \"mandate_id\": \"69f8d167db7ca561ab27c484\"\n }\n}"}],"_postman_id":"1c2b3650-3754-4c40-9708-375dfc292dc6"},{"name":"S2S API","id":"88d85203-1a5d-40f8-badb-f41bd9d22354","protocolProfileBehavior":{"disableBodyPruning":true,"disableUrlEncoding":false},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","description":"This API would be the 2nd in sequence to call if the call to /purchases/ was successful in step 1. and you want to do the transaction via Server-to-Server mode.
The request body would contain the details of the card that's to be transacted upon.
\nMandatory parameters in request body:
\nEssential parameters in request body:
\n**
Other optional parameters in request body:**
Successful Response
\nIf all the details are correct you'll get a 202 response with staus as Pending
\n{\n \"status\": \"pending\",\n \"callback_url\": \"https://paysecure.net/payment/63bd0bf80fb42a076e8a4dd1/\",\n \"method\": \"GET\"\n}\n\nIf the response code is 202, after receiving the response body, direct the customer to the callback_url provided in the response.
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"917da390-3ff9-462e-83c3-363f9b44a6b0","id":"917da390-3ff9-462e-83c3-363f9b44a6b0","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"9a8d95e9-f393-4eb2-8899-0d4c787b9fc5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","protocol":"https","host":["api","paysecure","net"],"path":["api","v1","p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Mon, 30 Mar 2026 12:29:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"013dfd43-0689-4d6b-a797-38281465a753"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3b66cea026f27925ba048cc96a0885ca.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"SWosGrWkPMrZoTyRfLd6N01fBb57k60RtzFzD-r38XQXmfTQEW_SRQ=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=qC4PItJ0vJPndQ4Ni%2F0rS%2BPlrlTkj9%2F28whoJdWsDG4oYZpOnmcmYgstZyXlRLs5CC6XI1kBR7nuEUQ6t4NoE1tnrhM8iv1IV%2BvSYTxq3AryDLbD0zZlxLVKj9jllGVm3RVN\"}]}"},{"key":"CF-RAY","value":"9e471e8bcf88824e-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"http://18.214.100.20/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"88d85203-1a5d-40f8-badb-f41bd9d22354"},{"name":"Get Mandate","id":"ef48e986-6884-41eb-8f8c-b047f5c94c76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"},{"key":"BrandId","value":"your-brand-value","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/mandate/{mandate_id or session_id}","description":"This endpoint will be used to get all the details of a particular mandate. You can search for a particular mandate id or for a particular session id.
\nResponse parameters:
\n- \n
totalDeductedAmount
\n
This is the total amount which is deducted from the user's account. \nrecurringMandateIds
\n
This object returns a list of all the MIT transactions done for the respective mandate. \nnextMandateDate
\n
This is the date when the next recurring payment will happen. \n
After the successful Mandate registration, Merchant will receive a mandate_id from Paysecure that should be stored against a customer at their end.
\nIf the merchant handles their own scheduling, then for the subsequent transactions, the merchant is supposed to pass a combination of customer_id and mandate_id to do a debit. This API will perform a transaction with a PSP based on the mandate_id passed in the request.
\nIf Paysecure handles the scheduling for the merchant on their behalf, then this API is not for them. The MIT transactions will be handled by Paysecure from our side.
\nNote:
Recurring payments should only be done if the mandate registration has been successful and the mandate is ACTIVE.
Required for cases where the Paysecure is handling the scheduling of recurring payments. Use this API to revoke/cancel an ACTIVE mandate.
\nNote:
Revoking a mandate should be done at the same instance this API is called. The mandate status should be updated to “REVOKED” at the same instant.
Required for cases where the Paysecure is handling the scheduling of recurring payments. Use this API to pause an ACTIVE mandate.
\nAdditional parameters for this usecase:
\nNote:
For pausing a mandate you need to keep the exact timestamp in mind.
If a recurring payment is scheduled between the pause_start_date and pause_end_date then it will not be executed.
This endpoint will be used to list all the mandates for a particular customer of a merchant.
\nResponse parameters:
\n- \n
totalDeductedAmount
\n
This is the total amount which is deducted from the user's account. \nrecurringMandateIds
\n
This object returns a list of all the MIT transactions done for the respective mandate. \nnextMandateDate
\n
This is the date when the next recurring payment will happen. \n
This API tells you about all the details of a recurring payment which occurred
\nMandatory
\nyou need to pass the PurchaseID in the API URL
Possible Value of Status
\nResponse Examples
\nIn the response examples you can see instances of both Paid and Error Status purchases.
Error Details
\nIf there are any issues on the Purchase you can get more details from the transaction_data.attempts.error attribute of the response object
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"917da390-3ff9-462e-83c3-363f9b44a6b0","id":"917da390-3ff9-462e-83c3-363f9b44a6b0","name":"Recurring Payments","type":"folder"}},"urlObject":{"path":["purchases","{purchaseId}",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"72a38101-17c7-4be3-9287-aaba49f32fff","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"url":"https://api.paysecure.net/api/v1/purchases/{purchaseId}/"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sun, 01 Feb 2026 07:59:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"e222737a-b9e9-4562-94de-5b80b056c180"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f89daa99b6a349030b23247a4977cb5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"eUcDXjdNU1qDjwPQst7oM9Kbi8qYyd8sncr30-6kphukYSEGv-qwUg=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=i8qaRQprp0TLqlSo5At%2FjpQANnSZgP8iEeVFnMasIN8xyAN2mdqYXVqP3dXt2AbZRL8fj6SRWa%2BFA1dybSS8ebE5scTH8BsB6Ubx8ppJSxc%3D\"}]}"},{"key":"CF-RAY","value":"9c6fe9092c493ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"6973ad04fa54ee2cf14f438c\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"sl68792.bravo@bravapay.com\",\n \"phone\": \"0557719399\",\n \"full_name\": \"Test user\",\n \"date_of_birth\": \"2004-07-12\",\n \"street_address\": \"10 New Burlington StreetApt. 214\",\n \"country\": \"CA\",\n \"city\": \"London\",\n \"zip_code\": \"W1S 3BE\",\n \"cc\": [],\n \"bcc\": [],\n \"tax_number\": \"+447755564318\",\n \"bankAccountNumber\": \"1345789678\",\n \"stateCode\": \"QLD\"\n },\n \"updated_on\": 1769188614,\n \"type\": \"purchase\",\n \"paymentMethod\": \"VISA\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"ERROR_PARSING_GROUP_ID\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1769188612,\n \"merchantRef\": \"6973ad04fa54ee2cf14f438c\",\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"zenith\",\n \"brand_name\": \"zenith\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"01\",\n \"amount\": 10.0,\n \"card_issuer\": \"VISION BANK\",\n \"masked_pan\": \"42222222*2222\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"SA\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"fgjhknms\",\n \"expiry_year\": \"29\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"49.36.232.107\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"VISA\",\n \"processing_time\": 1769188612,\n \"extra\": {\n \"amount\": 10.0,\n \"masked_pan\": \"VISA\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"VISA\",\n \"cardholder_name\": \"Test user\"\n },\n \"error\": {\n \"message\": \"This customer can not be processed !\",\n \"code\": \"transaction_error\"\n }\n },\n {\n \"client_ip\": \"\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": false,\n \"country\": \"SA\",\n \"processing_time\": 1769188613,\n \"extra\": {\n \"expiry_month\": \"01\",\n \"amount\": 10.0,\n \"card_issuer\": \"VISION BANK\",\n \"masked_pan\": \"42222222*2222\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"SA\",\n \"card_type\": \"DEBIT\",\n \"cardholder_name\": \"fgjhknms\",\n \"expiry_year\": \"29\"\n },\n \"error\": {\n \"message\": \"ERROR_PARSING_GROUP_ID\",\n \"code\": \"transaction_error\"\n }\n }\n ]\n },\n \"status\": \"ERROR\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769188612\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1769188612\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1769188613\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1769188613\n },\n {\n \"status\": \"error\",\n \"timestamp\": 1769188614\n },\n {\n \"status\": \"viewed\",\n \"timestamp\": 1770016552\n }\n ],\n \"viewedOn\": 1770016552,\n \"is_test\": false,\n \"brand_id\": \"555c458b-e737-4905-adb2-2451d37cbb6e\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": false,\n \"reference_generated\": \"PS1841\",\n \"issued\": \"2026-01-23\",\n \"due\": 1769188612,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0.0,\n \"success_redirect\": \"https://staging.paysecure.net/getResponse.jsp?issucces=true\",\n \"failure_redirect\": \"https://staging.paysecure.net/getResponse.jsp?issucces=false\",\n \"pending_redirect\": \"https://staging.paysecure.net/getResponse.jsp?issucces=pending \",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://www.google.com/\",\n \"failure_callback\": \"https://staging.paysecure.net/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"49.36.232.107\",\n \"checkout_url\": \"https://test4.paymentsclub.net/payments/a28ed9974a22a4cbd5f2f49cc26cc334/\",\n \"direct_post_url\": \"https://test4.paymentsclub.net/api/v1/p/6973ad04fa54ee2cf14f438c/\",\n \"payoutProcess\": false,\n \"payment_type\": \"internal recurring\",\n \"mandate_id\": \"696bc39a7bc779fac5201357\"\n}"}],"_postman_id":"1deb53b7-79f5-4db6-a48e-10e85940596a"}],"id":"1dbf7322-e009-4884-b0bf-459b3a88883c","_postman_id":"1dbf7322-e009-4884-b0bf-459b3a88883c","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"917da390-3ff9-462e-83c3-363f9b44a6b0","id":"917da390-3ff9-462e-83c3-363f9b44a6b0","name":"Recurring Payments","type":"folder"}}}],"id":"917da390-3ff9-462e-83c3-363f9b44a6b0","description":"Overview
\nRecurring Payments allow merchants to automatically charge customers at predefined or flexible intervals without requiring the customer to re-enter payment details each time.
\nA Mandate represents the customer’s authorization that links their payment method to the merchant for future recurring charges. Once created, this mandate is used as a secure reference for all upcoming payments.
\nInstead of processing every transaction as a one-time payment, merchants rely on mandates to execute recurring debits in a frictionless and compliant manner.
\nThe recurring payments may be initiated using Paysecure APIs as fixed/ non-fixed intervals based on your business use case.
\nThe Paysecure Subscription module (also known as Mandates) enables merchants to automate recurring billing for products and services. Unlike standard one-off transactions, this feature creates a persistent link between the merchant and the customer's payment method, allowing for future charges without requiring the customer to be present or re-enter their details.
\nThis system is built around two fundamental transaction types that define the lifecycle of a subscription:
\n1. Mandate Registration (CIT)
\nThe Customer Initiated Transaction (CIT) represents the initial setup of the recurring payment mandate, during which the customer is actively present on the merchant’s website or application (in-session flow).
\nIn this flow, the merchant collects and submits the customer’s basic details along with the mandate configuration, including registration information, payment amount (fixed or variable, as applicable), and the scheduling frequency for recurring debits.
\nAs part of the setup process, the customer must explicitly provide consent for the mandate. To authenticate and activate the mandate, the customer also completes a one-time payment using the selected payment method. Once this payment is successful, the mandate is registered and becomes eligible for future automated recurring transactions as per the defined schedule.
\nPurpose:
\n- \n
Capture customer payment details
\n \nAuthenticate the transaction (typically via 3D Secure)
\n \nCollect customer consent for recurring billing
\n \n
Outcome:
\n- \n
A unique mandate_id is generated
\n \nThis mandate acts as a secure token for all future charges
\n \n
Use Case:
\nThe customer signs up for a subscription and completes the first payment
\n2. Recurring Payments (MIT)
\nThe Merchant Initiated Transaction (MIT) represents the execution phase of the recurring payment lifecycle. In this stage, payments are automatically triggered by the merchant’s system or through Paysecure’s built-in scheduler without requiring the customer to be actively present (off-session flow).
\nOnce a mandate is successfully registered, merchants can initiate recurring debits as per the defined schedule and payment terms. These transactions are processed seamlessly using the customer’s authorized payment method.
\nThe Paysecure Mandate module provides the following benefits:
\n- \n
Prebuilt support for a complete mandate registration experience using cards as the payment method
\n \nFlexible mandate setup to match different business models and customer requirements
\n \nSimplified execution of recurring payments through the Paysecure Dashboard with minimal operational effort
\n \nBuilt-in analytics and reporting tools to monitor mandate sign-ups, payment performance, and renewals
\n \n
Purpose:
\n- \n
- Debit the customer according to the defined schedule or usage \n
Mechanism:
\n- \n
Merchant (or Paysecure scheduler) sends payment requests using the mandate_id
\n \nNo card details are required again
\n \nUsually bypasses 3D Secure
\n \n
Use Case:
\nMonthly subscription renewal payment.
\nKey Capabilities
\n- \n
Flexible Scheduling: Define rigid schedules (Daily, Weekly, Monthly, Yearly) or use \"As Presented\" for irregular billing intervals.
\n \nAmount Variability: Support for Fixed amounts (e.g., $10/month license) or Variable amounts (e.g., utility bills where the cost changes based on usage).
\n \nSmart Management:
\n- \n
Merchant Managed: You track the dates and trigger the API call when payment is due.
\n \nPaysecure Managed: You define the rules (start date, end date, frequency), and Paysecure handles the execution logic.
\n \n
\nAnalytics & Operations: Includes a dedicated dashboard for monitoring signup performance, renewal success rates, and managing cancellations.
\n \n
There are 2 ways in which subscriptions are handled at Paysecure’s end:
\nMerchant Managed Scheduling
\nAfter successfully registering the mandate, the merchant creates a subscription linked to the customer’s mandate. Based on the defined billing cycle and business logic, the merchant then triggers the Recurring Payments API according to their own payment schedule to execute automated debits.
\nThis approach allows merchants to maintain full control over when and how recurring charges are initiated.
\n- \n
Merchant tracks payment due dates
\n \nMerchant triggers recurring API calls manually
\n \n
Best for:
\nCustom billing logic or internal scheduling systems.
\nPaysecure Managed Scheduling
\nIn this model, the merchant creates a subscription within the Paysecure system and submits the recurring payment schedule, including billing frequency and timing. Based on the provided configuration, Paysecure automatically manages the execution of recurring transactions as per the defined schedule.
\nThis removes the need for merchants to manually trigger each payment, ensuring consistent and timely debits while maintaining a fully automated recurring billing process
\n- \n
Merchant defines payment rules (start date, frequency, end date)
\n \nPaysecure automatically executes recurring charges
\n \n
Best for:
\nStandard subscription models with minimal operational overhead.
\nPrerequisites
\nBefore starting the mandate integration, merchants must ensure that the required configurations are enabled both at the PSP level and within the Paysecure system.
\nMandate Enablement at PSP Level
\nMerchants must enable mandate-related features on their respective PSP (Payment Service Provider) dashboard. This ensures that the PSP supports recurring and mandate-based transactions.
\nConfiguration on the Paysecure Dashboard
\n- \n
For whitelabel merchants or those using Paysecure’s whitelabel solution, the mandate support toggle must be enabled within the MID settings of the PSP configuration. This allows Paysecure to recognize and route mandate transactions correctly.
\n \nFor merchants directly onboarded with Paysecure, this configuration is managed by the Paysecure team. Merchants should coordinate with their account manager to ensure mandate enablement is completed.
\n \n
Fetches a paginated list of transactions. This endpoint is optimized for high-volume retrieval and returns a summary view of each transaction (ID and Status).
\nImportant Path Params to consider:
\n","urlObject":{"protocol":"https","path":["api","v1","external","transactions","list"],"host":["api","paysecure","net"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"transaction_id","value":"69d4ba22465443878a0045ba"},{"key":"start_date","value":"2025-10-29%2000%3A00%3A00%20+05%3A30"},{"key":"end_date","value":"2026-04-23%2000%3A00%3A00%20+05%3A30"},{"key":"last_updated_start","value":"2026-01-07%2016%3A12%3A00%20+05%3A30"},{"key":"last_updated_end","value":"2026-12-07%2016%3A12%3A00%20+05%3A30"},{"key":"customer_id","value":"NA"},{"key":"status","value":"paid"},{"key":"currency","value":"USD"},{"key":"is_sandbox","value":"true"}],"variable":[]}},"response":[{"id":"976d30b9-b7cb-4348-95b8-7c0711f09d41","name":"Success","originalRequest":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer Token"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/transactions/list?page_no=1&page_size=10&start_date=2025-10-29%2000%3A00%3A00%20+05%3A30&end_date=2026-04-23%2000%3A00%3A00%20+05%3A30&last_updated_start=2026-01-07%2016%3A12%3A00%20+05%3A30&last_updated_end=2026-12-07%2016%3A12%3A00%20+05%3A30&customer_id=NA&status=paid¤cy=USD&is_sandbox=true","protocol":"https","host":["api","paysecure","net"],"path":["api","v1","external","transactions","list"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"transaction_id","value":"69d4ba22465443878a0045ba","disabled":true},{"key":"start_date","value":"2025-10-29%2000%3A00%3A00%20+05%3A30"},{"key":"end_date","value":"2026-04-23%2000%3A00%3A00%20+05%3A30"},{"key":"last_updated_start","value":"2026-01-07%2016%3A12%3A00%20+05%3A30"},{"key":"last_updated_end","value":"2026-12-07%2016%3A12%3A00%20+05%3A30"},{"key":"customer_id","value":"NA"},{"key":"status","value":"paid"},{"key":"currency","value":"USD"},{"key":"is_sandbox","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sun, 19 Apr 2026 14:11:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"c2111eb2-6314-4f0b-b546-4ae3ee123a44"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 6a91ddfdf36644f1344da228258d9082.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"lKDk7cJHKNy2cOdf_AWXk3GlUJdWC5slaGWaVfgUf1Fn0XXm7T7D7Q=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=YLhXcnCfKpMy2KQEcmek7bxnkI2lT3%2F5IQ8opo9ZpZ4E852qZoWIFsjJ%2BcmGZfTO7S1rWYnB3uzuGwMYwevQ%2F47w%2Bm6u51jrIfjuG3TDh08KGeWKRbR92ItXRYPoh1CgVmja\"}]}"},{"key":"CF-RAY","value":"9eec7f31f973c9b7-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"content\": [\n {\n \"transaction_id\": \"69e2146828bea6ca2e31bc85\",\n \"status\": \"paid\"\n },\n {\n \"transaction_id\": \"69e20fd928bea6ca2e31b17c\",\n \"status\": \"paid\"\n }\n ],\n \"currentPage\": 1,\n \"pageSize\": 2,\n \"totalElements\": 95,\n \"totalPages\": 48,\n \"first\": true,\n \"last\": false,\n \"hasNext\": true,\n \"hasPrevious\": false\n }\n}"}],"_postman_id":"87d72b7e-f6ae-47fb-9b03-f24074c7cbfe"},{"name":"Get Detailed Transaction Details","id":"fc665062-e61c-4a2f-89bb-a9e2a5abdd2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer Token"}],"url":"https://api.paysecure.net/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c?page_no=1&page_size=10&include_subtransactions=true","description":"Retrieves the complete details for a specific transaction. This includes customer info, payment method details, bank response codes, and hierarchy metadata (parent/child transactions).
\nAdditional query parameters for this usecase:
\n","urlObject":{"protocol":"https","path":["api","v1","external","transactions","data","69e20fd928bea6ca2e31b17c"],"host":["api","paysecure","net"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"include_subtransactions","value":"true"}],"variable":[]}},"response":[{"id":"447e5918-db1a-4ea8-b1b8-cceb196a8098","name":"Success","originalRequest":{"method":"GET","header":[{"key":"BrandId","value":"your-brand-id"},{"key":"Authorization","value":"Bearer Token"}],"url":{"raw":"https://api.paysecure.net/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c?page_no=1&page_size=10&include_subtransactions=true","protocol":"https","host":["api","paysecure","net"],"path":["api","v1","external","transactions","data","69e20fd928bea6ca2e31b17c"],"query":[{"key":"page_no","value":"1"},{"key":"page_size","value":"10"},{"key":"include_subtransactions","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Sun, 19 Apr 2026 14:13:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3d9fb1d1-b30f-4c3e-a76f-6956e3731ad3"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 64d4305f6a0418824e90908ac490184e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"COt7k0tEcVGSOSy8pTkHoOqGoG1lSgC9qz8baoKbgmPkAh5dq0GNjQ=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=hn0q1Q9Cqa9onXwzy%2F1Qeq8u4RTGt3q%2BZNFW29weO%2BOmtABh6y8XLnAH9%2FytCQEEOmNzdnvM0oPcQruiJvYqQQShCKOndiMKUnEksUPM9I9UMph4qP7s1ognTK%2BBhheXvIwO\"}]}"},{"key":"CF-RAY","value":"9eec821e0f4b172c-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"transaction_id\": \"69e20fd928bea6ca2e31b17c\",\n \"merchant_reference\": \"69e20fd928bea6ca2e31b17c\",\n \"customer_id\": \"NA\",\n \"amount\": 1.0,\n \"currency\": \"USD\",\n \"status\": \"paid\",\n \"session_id\": \"\",\n \"email\": \"aryangupta+3265@paysecure.dev\",\n \"merchant_name\": \"prithvimerch\",\n \"payment_method\": \"MASTER\",\n \"payment_flow\": \"payform\",\n \"issuing_bank\": \"PUBLIC BANK BERHAD\",\n \"created_at\": \"2026-04-17T10:47:53Z\",\n \"error_reason\": \"Transaction succeeded-APPROVED\",\n \"last_updated_at\": \"2026-04-17T10:49:14Z\",\n \"transaction_type\": \"parent\",\n \"fees\": [\n {\n \"type\": \"mdr\",\n \"amount\": 0.00,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"decline_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"transaction_fee\",\n \"amount\": 0.1,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"fraud_refund_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"refund_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"chargeback_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n {\n \"type\": \"extra_fee\",\n \"amount\": 0,\n \"currency\": \"USD\"\n }\n ],\n \"metadata\": {\n \"has_subtransactions\": false,\n \"total_subtransactions\": 0,\n \"transaction_hierarchy_level\": \"parent\"\n }\n }\n}"}],"_postman_id":"fc665062-e61c-4a2f-89bb-a9e2a5abdd2a"}],"id":"83a51b51-cb44-486b-ac06-f4b5dcd9a9e3","description":"Overview
\nThe Transaction Reporting APIs allow merchants to retrieve detailed logs of their payment activity programmatically. This is useful for:
\n- \n
Reconciliation: Matching Paysecure records with your internal order system.
\n \nAudit Trails: Tracking the status history of specific transactions.
\n \nData Export: Pulling transaction data into your own analytics tools.
\n \n
There are two primary endpoints:
\n- \n
List Transactions: Retrieves a paginated list of all transactions for a specific Brand ID.
\n \nGet Transaction Details: Retrieves the full data payload for a single transaction ID, including metadata and sub-transaction details.
\n \n
Before you can use network tokenisation in your payment flow, the feature must be enabled and configured on your merchant account. This section walks through the setup steps in the Paysecure Dashboard.
\nEnabling Network Tokenisation
\nNetwork tokenisation requires activation at the merchant level. Follow these steps in the Paysecure Dashboard:
\n- \n
Log in to your Paysecure merchant account.
\n \nNavigate to Merchant Details → Allowed Services.
\n \nEnable “Allow Network Token” to activate tokenisation for your account.
\n \n
Admin Activation Required
Network tokenisation must first be enabled at the platform level by your Paysecure account administrator. If you do not see the “Allow Network Token” option in your dashboard, contact your Paysecure account manager to request activation.
Paysecure Token Service Setup
\nAfter enabling network tokenisation, configure the Paysecure Token Service with your merchant details:
\n- \n
In the Paysecure Dashboard, navigate to Global Settings → Paysecure Token Service.
\n \nFill in all the required fields accurately.
\n \nEnter your Category Code — this represents your merchant business type code (MCC).
\n \nClick Save.
\n \nAfter saving, verify that the status shows as Pending (visible in the top-right corner of the page).
\n \nThe status will automatically update to Active or Error once your token profile is created.
\n \n
Status Update Timing: The status update from Pending to Active may take up to 1 hour. Do not attempt to use tokenisation APIs until the status shows Active. If the status changes to Error, contact your Paysecure account manager for resolution.
\nStatus Values
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d1edbbc3-7922-454b-9ddc-d07082c1f170","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"973ce7ac-782a-45bc-af35-063df0343ef3","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"c0aea73a-98f3-498c-9356-4fc5fd71cdf0"},{"name":"APIs","item":[{"name":"List Saved Cards","id":"d4aa47d0-af57-44e6-a8c1-ea8a7ca6fbae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.paysecure.net/api/v1/listSavedCards","description":"List Saved Cards
\nRetrieve all saved card tokens for a given customer. Returns the last 4 digits of each card and its associated token_reference.
Use this API to display saved cards to the customer for selection before initiating a payment via the S2S API.
\nQuery Parameters
\nResponse Fields
\nNotes
\n- \n
The
\ntoken_referencedoes not expire. It remains valid as long as the saved card has not been deleted. \nShow saved cards to the customer using
\ncard_last_fouralongside a card brand icon (Visa / Mastercard). \nThe
\ntoken_referenceshould only be stored and used server-side. \n
Display Tip
\nShow saved cards using cardlast4 alongside a card brand icon (Visa / Mastercard).
The token_reference should only be stored and used server-side.
Purchase
\nInitiate a payment transaction. This is the standard Paysecure Purchase API.
\nWhen a customer completes the purchase on the Paysecure checkout page and opts to save their card, Paysecure provisions a network token in the background and generates a token_reference linked to the customer.
Mandatory Parameters
\nOptional Parameters
\nKey Response Fields
\nNetwork Tokenisation & Card Saving
\nWhen the customer completes payment via checkout_url and opts to save their card, Paysecure provisions a network token. The token_reference is then available via the List Saved Cards API.
S2S Payment
\nProcess a payment using a saved card's token_reference. Paysecure resolves the token reference to the underlying network token and processes the payment securely. If the selected MID does not accept tokens, Paysecure automatically falls back to the card number.
S2S Input Scenarios
\nThe S2S API accepts different input types depending on the scenario:
\nRequest Body
\nToken Reference in Response
\n- \n
Scenario 1 (New card via S2S):
\ntoken_referencereturned in Check Status and Webhook. \nScenario 2 (Existing
\ntoken_reference):token_referencereturned in response and Webhook. \n
Important Notes
\n- \n
CVC is required even when using a
\ntoken_reference. \nAll browser fields are required for 3D Secure authentication.
\n \nResponse follows the standard Paysecure payment response format.
\n \n
Must be \"true\" for server-to-server requests.
\n","type":"text/plain"},"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"fb376bbd-42a2-49bd-ac9a-44abd3b10ebd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Token_reference\": \"token_7178aa7208614544a285656da38ae5ac\",\n \"cvc\": \"791\",\n \"remember_card\": \"off\",\n \"remote_ip\": \"157.38.242.7\",\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\n \"accept_header\": \"text/html\",\n \"language\": \"en-US\",\n \"java_enabled\": false,\n \"javascript_enabled\": true,\n \"color_depth\": 24,\n \"utc_offset\": 0,\n \"screen_width\": 1920,\n \"screen_height\": 1080\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/api/v1/p/6980e509b5e99e61f3bd4ccf/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["api","v1","p","6980e509b5e99e61f3bd4ccf",""],"query":[{"key":"s2s","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"http://18.214.100.20/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"}],"_postman_id":"f3dd39dd-f0a6-498d-ada5-455b0eadec8b"},{"name":"Delete Token","id":"c00406a7-2363-497a-a8f9-e24ff49ece25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{APIKey}}","type":"text"}],"url":"https://api.paysecure.net/api/v1/tokens/v1/deleteToken/{{token_reference}}","description":"Delete Token
\nPermanently delete a saved card and deactivate the associated network token. This action is irreversible.
\nPath Parameters
\nImportant Notes
\n- \n
Deleting a token is permanent. The
\ntoken_referencecan no longer be used for payments. \nThe associated network token is deactivated with the card network.
\n \nIf the customer wants to pay with this card again, they will need to re-enter their card details.
\n \n
When to Delete
\n- \n
Customer explicitly requests removal of their saved card.
\n \nGDPR or data retention compliance when a customer closes their account.
\n \nConsider implementing a \"Remove Card\" option in your account management UI.
\n \n
Overview
\nThe Original Credit Transaction (OCT), commonly referred to as Push to Card, enables merchants to facilitate near-instantaneous fund transfers directly to a customer’s eligible Visa or Mastercard debit or credit card. Unlike traditional refund processes that can only return funds from a previous purchase, OCT allows for independent disbursements of funds to a cardholder's account.
\nThis feature is designed for high-velocity industries that require frictionless, real-time payouts, such as:
\n- \n
Gaming & Betting: Real-time withdrawal of player winnings.
\n \nMarketplaces: Payouts to sellers or service providers.
\n \nCorporate Disbursements: Instant insurance claims, rebates, or compensation payments.
\n \nMerchant Settlements: Faster access to processed funds for sub-merchants.
\n \n
By utilizing the Paysecure /payout API with the PAYOUT-CARDS method, you benefit from a unified orchestration layer that handles the complexities of card network routing, ensuring high success rates and global reach while maintaining the same security standards as your standard payment integrations.
\n
Integration Steps
\n- \n
Enable OCT: Ensure \"Push to Card\" permissions are enabled for your merchant account in the Paysecure Merchant Portal.
\n \nCollect Card Details: Use a secure method to collect the recipient's card number and expiry date or can you Paysecure's cashier to do that.
\n \nExecute Payout: Call the
\n/payoutendpoint with the OCT-specific payout method. \nHandle Webhooks: Listen for the
\npaidorfailureevents to update your internal records. \n
Mandatory parameters in the request body:
\nNote:
\nIf the merchant is not PCI DSS compliant then they will need to use our cashier and we will show the user all the saved cards for him/her. Based on the card chosen, Paysecure will pick up the token_reference from our Back end.
\nIf the merchant is PCI DSS compliant then they can use the payout API and send the token reference as shown above.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9eaccd60-5727-4f43-bcc2-6a0579b1d5dc","id":"9eaccd60-5727-4f43-bcc2-6a0579b1d5dc","name":"APIs","type":"folder"}},"urlObject":{"path":["payout",""],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8ec5cdbc-8d83-4d22-9b76-fee002dea3c6","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client\": {\n \"email\": \"rahul@gmail.com\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Rahul Jain\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"purpose\": \"Testing cards payout\",\n \"currency\": \"GBP\",\n \"merchantRef\": \"YOUR ORDER ID\", // optional\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amount\": 100.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\",\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/payout/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Fri, 13 Mar 2026 00:01:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"3ef27476-f274-4f6a-bb18-4c37e01d6dc2"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 05a63efd5ebb043211ccf075f3a8aa68.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"Iw6KuTkxZqm0RH8GJOXAh7uLEPJ6wj8OJbaFWdN_qDx31b5TSinnIA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=g%2FW8jRMDFXKvTeXNugr1sgR4%2FoTXfyEHsscr3hqeIr2aPhFEVlSs%2FGiTjFw09%2BReVDjxT2esg2Wg0fdBf4oD3snlEv4p1JkITe2l7oLC%2Bkg%3D\"}]}"},{"key":"CF-RAY","value":"9db6c366997196a2-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"payoutId\": \"6977137755e0628e3600c562\",\n \"client\": {\n \"email\": \"rahul@gmail.com\",\n \"country\": \"GB\",\n \"city\": \"London\",\n \"stateCode\": \"QLD\",\n \"full_name\": \"Rahul Jain\",\n \"street_address\": \"10 New Burlington Street Apt. 214\",\n \"zip_code\": \"W1S 3BE\",\n \"phone\": \"+44 9876543210\",\n \"gender\": \"M\",\n \"date_of_birth\": \"1970-07-10\"\n },\n \"updated_on\": 1769411447,\n \"extraParam\": {\n \"token_reference\": \"token_ref\"\n },\n \"payoutMethod\": \"PAYOUT-CARDS\",\n \"amountUnit\": \"MAJOR\",\n \"amount\": 100.0,\n \"errorMsg\": \"\",\n \"purpose\": \"Testing cards payout\",\n \"created_on\": 1769411447,\n \"merchantRef\": \"YOUR ORDER ID\",\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"payout_in_process\",\n \"timestamp\": 1769411447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1769411447\n },\n\n ],\n \"currency\": \"GBP\",\n \"extraFee\": \"0\",\n \"paymentOn\": 0,\n \"checkout_url\": \"https://test4.paymentsclub.net/payout/092e59f94279a3742fa3715fe9a2112a/\",\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"pending_redirect\": \"https://your.pending.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"success_callback\": \"https://your.success.callback.com\",\n \"failure_callback\": \"https://your.failure.callback.com\"\n \"redirectType\": \"POST\",\n \"sessionId\": \"\",\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"trxMethod\": \"CARDS\",\n \"success_callback\": \"\",\n \"failure_callback\": \"\"\n}"}],"_postman_id":"5dce8bfc-1152-4e7a-8fa1-4e0686d873fe"}],"id":"9eaccd60-5727-4f43-bcc2-6a0579b1d5dc","description":"Network tokenisation in Paysecure uses four APIs. Together they cover the complete flow: retrieving saved cards, initiating a purchase (with card saving), processing payments with saved tokens, and deleting tokens.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7cae9127-6d7b-4189-81bd-bf69ccd9e2f8","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"cd17c780-b9c3-43a7-960e-dc8516f9c15c","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"9eaccd60-5727-4f43-bcc2-6a0579b1d5dc"},{"name":"FAQs","item":[],"id":"c0435364-8906-401c-997c-b63043d2476d","description":"Q1: Do I need to change my existing integration to use network tokenisation?
No. If you already use the Paysecure Purchase API and the S2S API with token_reference, your integration is already compatible. You just need to enable and configure network tokenisation in your Dashboard (see Section 3).
Q2: What is a token_reference?
A token_reference (e.g., token_7178aa7208614544a285656da38aefac) is Paysecure’s internal identifier for a saved card. You use it to charge the saved card or delete it. It is not the card number or the network token — Paysecure manages those internally.
Q3: Does the token_reference expire?
No. The token_reference does not expire. It remains valid as long as the saved card has not been deleted.
Q4: What happens when a customer’s card expires or is replaced?
\nThe card network automatically updates the data linked to the token. Your token_reference stays the same, and payments continue to work without action from you or the customer.
\nQ5: Is CVC required even when using a token_reference?
Yes. CVC is required even when a token_reference is provided. This is needed for 3D Secure authentication on customer-initiated transactions.
Q6: What if a card doesn’t support network tokenisation?
Paysecure handles this automatically. If a card is not eligible, or if the selected MID does not accept tokens, Paysecure falls back to the card number. The API response and flow remain the same.
Q7: How long does the token service setup take?
After saving your configuration in Dashboard → Global Settings → Paysecure Token Service, the status changes to Pending. It may take up to 1 hour to update to Active. Do not use tokenisation APIs until the status is Active.
Q8: Are email addresses case-sensitive for token lookup?
Yes. Email addresses are case-sensitive. Ensure consistent formatting (always lowercase) when creating and retrieving tokens to avoid duplicate or missing entries.
Q9: How do I delete a saved card?
Use the Delete Token API (DELETE /tokens/v1/deleteToken/{token_reference}). This permanently removes the card and deactivates the network token.
Q10: Is there an additional cost?
Pricing details are communicated by your Paysecure account manager. Some card networks offer reduced interchange fees for tokenised transactions, which may offset service costs.
Overview
\nPaysecure supports Network Tokenisation to help merchants process card payments with improved security, higher authorisation rates, and seamless card lifecycle management.
\nNetwork tokenisation works entirely behind the scenes. When a cardholder saves their card during a purchase, Paysecure securely provisions a network token and returns a token_reference. You use this reference for all future payments — you never handle actual card numbers or network tokens directly.
Benefits
\n- \n
Higher Approval Rates — Payments made with network tokens are recognised as more secure by issuers.
\n \nAutomatic Card Updates — Card replacements are handled silently by the card network.
\n \nStronger Security — Each token is merchant-specific and protected by a per-transaction cryptogram.
\n \nReduced PCI Burden — Store
\ntoken_referenceinstead of card numbers. \nZero Integration Overhead — Your existing API integration works as-is.
\n \n
API Flow
\nNetwork tokenisation is fully managed by Paysecure. The integration follows the standard Paysecure payment APIs:
\nThe Merchant Flow
\n- \n
Call the List Saved Cards API to check if the customer has saved cards
\n \nIf no saved cards exist, initiate a new payment via the Purchase + S2S API
\n
→ If the merchant opts to save the customer card, Paysecure provisions a network token
→ Customer completes payment
→ A token_reference is generated and linked to the customer and card \nFor returning customers with saved cards:
\n
→ Display saved cards using cardlast4 from List Saved Cards
→ Customer selects a card and provides CVC
→ Submit token_reference + CVC via the purchase + S2S API \nTo remove a saved card, call the Delete Token API.
\n \n
Network tokenisation happens behind the scenes with no additional API calls and no changes to your existing flow.
\n- \n
List Saved Cards — Check if the customer has saved cards
\n \nPurchase — Initiate a new payment (customer can save card during checkout)
\n \nS2S Payment — Charge a saved card using
\ntoken_reference\nDelete Token — Remove a saved card permanently
\n \n
Key Takeaway
\nYou never see or handle the actual network token. Paysecure abstracts it entirely behind the token_reference. Your integration stays simple while your customers get the security and reliability benefits of network tokenisation.
\nEnvironments
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"87fd9e61-4d7e-447a-8bd6-a24d7ef07461","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"52da2e30-185b-41f9-8291-66c6291f395e","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"be48a6aa-d0a0-4506-af8d-67662cbf10c1"},{"name":"Pre Authorization","item":[{"name":"Prerequisites","item":[],"id":"2683726c-8a68-4bb9-a9a0-af0c985d4439","description":"Before integrating the pre-authorisation flow, ensure you have the following:
\n2.1 Account Setup
\n2.2 Environments
\n2.3 Authentication
\nAll API requests must include your API key in the request header.
Paysecure uses bearer token authentication.
Authorization: Bearer {your_api_key}
\nContent-Type: application/json
\nImportant: Never expose your API key in client-side code or public repositories. All API calls must be made server-to-server.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"23e5caae-c7a0-4d04-8c2a-926ce2d256b8","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"7afafd55-891a-45c0-a494-cea843b03742","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"2683726c-8a68-4bb9-a9a0-af0c985d4439"},{"name":"Payment Flow Overview","item":[],"id":"8cf39b20-9a88-4c08-a6db-4f33b9d1742e","description":"The pre-authorisation and capture flow involves three distinct stages. Below is a high-level summary of each path the transaction can follow after authorisation.
\n3.1 Flow Summary
\nStep 1 - The merchant sends a pre-authorisation request to reserve funds on the customer’s card. If successful, the transaction enters an AUTHORISED state.
\nStep 2a (Capture Path) - The merchant sends a capture request for the full or partial authorised amount. On success, the transaction moves to CAPTURED and funds are settled.
\nStep 2b (Void Path) - If the merchant no longer needs to collect the payment, they send a void request. The hold is released and the transaction moves to VOIDED.
\n3.2 State Transition Diagram
\nThe following diagram describes all possible states:
\nℹ️ Note
\nOnce a transaction is PAID or VOIDED, it cannot be reversed through this flow. Use the Refund API for post-capture reversals.
\n3.3 Authorisation Validity Periods
\nCard networks enforce maximum hold periods. If you do not capture within the validity window, the authorisation expires automatically and funds are released.
\n⚠️ Best Practice
\nCapture as soon as the order is ready to ship or the service is delivered. Delaying capture increases the risk of authorisation expiry and declines.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1bbbaf8b-2f97-4320-8115-6ed4546a7e7a","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"6d329421-4b0f-4e2f-a280-15a39ee00819","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"8cf39b20-9a88-4c08-a6db-4f33b9d1742e"},{"name":"APIs","item":[{"name":"Purchase","id":"3cfc6863-5331-4b97-bd2a-5e4146fc3455","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@paysecure.net\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"+91 9999999999\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\r\n \"skip_capture\": true,\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases","description":"Use this endpoint to authorise a payment without capturing it. This places a temporary hold on the customer’s funds for the specified amount.
\nTo Initiate a payment, the very first call to make is /purchases with the required data in the request body.
To generate a Purchase, you are required to provide the Brand ID (in the request body) and API key (in the header) Both can be located in the Dashboard section of your merchant account login.
The request body structure is shown on the request body of the example request shown here.
\nThe following (see table below) are the mandatory parameters that are required to create a purchase request.
\nMandatory parameters in the request body:
\nAdditional parameters for this usecase:
\nEssential Optional Parameters
\nmerchantRef
\nThe merchantRef parameter, although not mandatory, is strongly advised for merchants to specify. Its inclusion offers two significant advantages for the merchant:
- \n
Prevention of Duplicate Requests: When a
\nmerchantRefis utilized, it acts as a unique identifier. This means that if a second purchase request is made using the samemerchantRef(reference number), the system will recognize it and prevent duplicate transactions from occurring. This prevents unintended or duplicate purchases. \nFacilitation of Transaction Retrieval: In situations where the response from the initial purchase request times out or the 'purchaseId' isn't received, having the
\nmerchantRefallows the merchant to retrieve detailed transaction information. This ensures they can track and access the specific purchase details related to that reference, even if the immediate response was not received. \n
However, if the merchant does not specify the 'merchantRef' parameter, the platform will automatically assign and use an internal 'purchaseId' as a reference for that transaction.
\nUpon successul create on a Purchase you'd get a \"purchaseId\" . Use this ID for the next step in Server to server call by calling p/{purchaseId}/?s2s=true .
paymentMethod
\nThe paymentMethod parameter identifies which payment solution merchant wants to use to perform a transaction. If parameter is provided, than Paysecure will perform direct payment with the selected payment method instead of loading Paysecure URL.
Errors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPossible Error Messages
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1c3ca4df-2fd4-4653-8212-3c38aaf644f6","name":"Purchase","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"client\": {\r\n \"email\": \"example@paysecure.net\",\r\n \"country\": \"IN\",\r\n \"city\": \"123\",\r\n \"stateCode\": \"ca\",\r\n \"street_address\": \"test test\",\r\n \"zip_code\": \"234567\",\r\n \"phone\": \"+91 9999999999\"\r\n },\r\n \"purchase\": {\r\n \"products\": [\r\n {\r\n \"name\": \"dk\",\r\n \"price\": \"10\"\r\n }\r\n ]\r\n },\r\n \"status\": \"created\",\r\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\r\n \"skip_capture\": true,\r\n \"merchantRef\": \"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\r\n \"success_redirect\": \"https://your.success.redirect.com\",\r\n \"pending_redirect\": \"https://your.pending.redirect.com\",\r\n \"failure_redirect\": \"https://your.failure.redirect.com\",\r\n \"success_callback\": \"https://your.success.callback.com\",\r\n \"failure_callback\": \"https://your.failure.callback.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:22:14 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseId\": \"64b032c3c6dccf7d329d9e7e\",\n \"client\": {\n \"bank_account\": \"\",\n \"bank_code\": \"\",\n \"email\": \"dev@paysecure.net\",\n \"phone\": \"\",\n \"full_name\": \"\",\n \"date_of_birth\": \"\",\n \"personal_code\": \"\",\n \"street_address\": \"test test\",\n \"country\": \"IN\",\n \"city\": \"123\",\n \"zip_code\": \"234567\",\n \"shipping_street_address\": \"\",\n \"shipping_country\": \"\",\n \"shipping_city\": \"\",\n \"shipping_zip_code\": \"\",\n \"cc\": [],\n \"bcc\": [],\n \"legal_name\": \"\",\n \"brand_name\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\",\n \"stateCode\": \"ca\"\n },\n \"updated_on\": 1689268934,\n \"type\": \"purchase\",\n \"force_recurring\": false,\n \"created_on\": 1689268934,\n \"purchase\": {\n \"currency\": \"USD\",\n \"products\": [\n {\n \"name\": \"dk\",\n \"quantity\": 1,\n \"price\": 10,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1,\n \"request_client_details\": [],\n \"timezone\": \"America/Edmonton\",\n \"email_message\": \"\"\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {\n \"bank_account\": \"\",\n \"bank_code\": \"\"\n }\n ],\n \"legal_name\": \"shoes\",\n \"brand_name\": \"shoes\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {},\n \"country\": \"\",\n \"attempts\": []\n },\n \"status\": \"CREATED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1689268934\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bd69e8a5-adcf-40de-9e43-2b87cb129a5e\",\n \"is_recurring_token\": false,\n \"reference_generated\": \"PS161\",\n \"merchantRef\":\"d9db7ec0-f94c-4a9d-8883-54c19c222d81\",\n \"issued\": \"2023-07-13\",\n \"due\": 1689268934,\n \"refund_upto\": 0,\n \"cc_descriptor\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 0,\n \"success_redirect\": \"https://your.success.redirect.com\",\n \"failure_redirect\": \"https://your.failure.redirect.com\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"\",\n \"platform\": \"API\",\n \"created_from_ip\": \"149.86.53.48\",\n \"checkout_url\": \"http://18.214.100.20/payments/64b032c3c6dccf7d329d9e7e/\",\n \"direct_post_url\": \"http://18.214.100.20/api/v1/p/64b032c3c6dccf7d329d9e7e/\"\n}"}],"_postman_id":"3cfc6863-5331-4b97-bd2a-5e4146fc3455"},{"name":"S2S","id":"d9538905-94df-4a1b-bfac-5fc10364f631","protocolProfileBehavior":{"disableBodyPruning":true,"disableUrlEncoding":false},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","description":"This API would be the 2nd in sequence to call if the call to /purchases/ was successful in step 1. and you want to do the transaction via Server-to-Server mode.
The request body would contain the details of the card that's to be transacted upon.
\nMandatory parameters in request body:
\nNote:
If you want to use token_reference for doing a card transaction, please have a look at Network Tokenisation Section.
Essential parameters in request body:
\n**
Other optional parameters in request body:**
Successful Response
\nIf all the details are correct you'll get a 202 response with staus as Pending
\n{\n \"status\": \"pending\",\n \"callback_url\": \"https://paysecure.net/payment/63bd0bf80fb42a076e8a4dd1/\",\n \"method\": \"GET\"\n}\n\nIf the response code is 202, after receiving the response body, direct the customer to the callback_url provided in the response.
\nErrors
\nIf there are any errors then it'll be in the format of :
\n{\n \"message\": \"descriptive error message\",\n \"code\": \"error_code\"\n}\n\nPlease see the Status Code section for further details.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","name":"APIs","type":"folder"}},"urlObject":{"path":["p","64bff4fff63e36669499e9c8",""],"host":["https://api.paysecure.net/api/v1"],"query":[{"key":"s2s","value":"true"}],"variable":[]}},"response":[{"id":"6a141509-8901-4324-ab0c-b62f06716981","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"411111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 Jul 2023 17:31:55 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"pending\",\n \"callback_url\": \"http://18.214.100.20/api/v1/payment/64b034ecc6dccf7d329d9eb3/\",\n \"method\": \"GET\"\n}"},{"id":"02e1a20a-605a-46d8-bf09-2417fd2fe45a","name":"Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cardholder_name\": \"dk\",\r\n \"card_number\": \"4111111111111111\",\r\n \"expires\": \"10/23\",\r\n \"cvc\": \"345\",\r\n \"remember_card\": \"on\",\r\n \"remote_ip\": \"157.38.242.7\",\r\n \"user_agent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36\",\r\n \"accept_header\": \"text/html\",\r\n \"language\": \"en-US\",\r\n \"java_enabled\": false,\r\n \"javascript_enabled\": true,\r\n \"color_depth\": 24,\r\n \"utc_offset\": 0,\r\n \"screen_width\": 1920,\r\n \"screen_height\": 1080\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.paysecure.net/api/v1/p/64bff4fff63e36669499e9c8/?s2s=true","host":["https://api.paysecure.net/api/v1"],"path":["p","64bff4fff63e36669499e9c8",""],"query":[{"key":"s2s","value":"true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 06 Jan 2026 05:57:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"cc434220-0bcd-42c7-9078-53503b81a221"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 9bce423254194c16408d5cf7234126e2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"FgTt6KEGIk0CH79DQDOvB1tYb1pGfaz0ryIVmQ0CCpDShyhsJGuAkA=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=9SnHJOEjnd1y7hArGsRLWmrk8H9ExaiR%2Fc%2BQMWhAvHlNPYCNEjS60wTjIyODXpca0ZD9%2BalkhLJ63boMGg%2B8iI6eFtXfW%2BxwGaBP1p1ZcwpA\"}]}"},{"key":"CF-RAY","value":"9b98f9f4684505e7-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization header missing\",\n \"code\": \"authentication_failed\"\n}"}],"_postman_id":"d9538905-94df-4a1b-bfac-5fc10364f631"},{"name":"Capture","id":"58359799-0077-4e5d-9d67-a1908cf26679","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture","description":"After a successful pre-authorisation, use this endpoint to capture (settle) the held funds. You may capture the full authorised amount or a partial amount.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69cd26b053d7b783ebf6b6e9","capture"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6b653ffa-4198-40f7-83fe-ad46c726500e","name":"Capture","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer Token"}],"body":{"mode":"raw","raw":"{\n \"merchant_reference\": \"64534345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.paysecure.net/api/v1/purchases/69cd26b053d7b783ebf6b6e9/capture"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:16:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"72818dba-381a-449a-8351-390453ddbf72"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3578d122de1401ebc52a7afd35dd5d0c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"zEG99N28vChcugkKEe-mJxhNgum-PAK1lcn_2mKqagcBd5deWquIjw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=EnQbeJo0VkBTF%2BqefkY%2BZ1OejkL%2BkIkR76eA5%2FtL3qaxYlOL1ehFjmSIpGl5i91OldfFB41NXeRXp3E43WxFSEhlUj7OgOqbI6eYZs%2B%2BcUBdewUDmvk46tJrDA5WO53Bib8q\"}]}"},{"key":"CF-RAY","value":"9e593e77fb953ec9-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"kailashvishnoi126741@paysecure.co\",\n \"full_name\": \"akshaya singhal\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"jaipur\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056447,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056400,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd361053d7b783ebf7324d\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056410,\n \"remote_paid_on\": 1775056410\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"223.235.99.134\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"BE\",\n \"processing_time\": 1775056410,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"ING BELGIUM, S.A.\",\n \"masked_pan\": \"46401701****6658\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"BE\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"PAID\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056400\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056410\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056424\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056428\n },\n {\n \"status\": \"capture_in_process\",\n \"timestamp\": 1775056447\n },\n {\n \"status\": \"paid\",\n \"timestamp\": 1775056447\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bab077d5-df4d-4fda-8c6c-2f78d97c9a16\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1673\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056400,\n \"refund_upto\": 1776089649,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 1775056449,\n \"receivedAmt\": 0.0,\n \"captureTxns\": [\n {\n \"captureId\": \"41e31f9f-1e98-4f4d-b48c-7d1ed488fc3f\",\n \"purchaseId\": \"69cd361053d7b783ebf7324d\",\n \"amount\": 10.0,\n \"fxAmount\": 10.0,\n \"status\": \"PAID\",\n \"pspReference\": null,\n \"merchantReference\": \"64534345\",\n \"createdAt\": 1775056447,\n \"updatedAt\": 1775056447,\n \"whiteId\": 0,\n \"fxCurrency\": \"EUR\",\n \"bankMid\": \"payneticsexternal3ds\",\n \"isTest\": false,\n \"currency\": \"EUR\",\n \"amountInUsd\": 11.85,\n \"merchantName\": \"KailashMerchant\",\n \"bankName\": \"paynatics-aft_\",\n \"bankId\": \"532\",\n \"trxMethod\": \"CARDS\",\n \"rollingReserve\": 0.0,\n \"transFees\": 0.0,\n \"mdr\": 0.0,\n \"isSettlementPending\": 0,\n \"parentId\": 0,\n \"transSettlementId\": null,\n \"errorSettlementId\": null,\n \"merchantId\": \"589\"\n }\n ],\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://google.com/getResponse.jsp?issucces=true\",\n \"failure_redirect\": \"https://google.com/getResponse.jsp?issucces=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://www.google.com/\",\n \"failure_callback\": \"https://staging.paysecure.net/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"223.235.99.134\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/47395a8217d29014a4af6b1c494ac06b/\",\n \"direct_post_url\": \"https://staging.paysecure.net/api/v1/p/69cd361053d7b783ebf7324d/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"58359799-0077-4e5d-9d67-a1908cf26679"},{"name":"Cancel","id":"d4c70e6b-b091-4043-8f21-6fe02008e9b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 309855a6e22c2bc9873f11ee5997cb3ff246a8e8ec4f009f2924ad7178b2ad7b"}],"url":"https://api.paysecure.net/api/v1/purchases/69ca76dbace4fa4413db928c/cancel","description":"Use this endpoint to cancel an authorised payment before it has been captured. Voiding releases the held funds back to the customer immediately.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","name":"APIs","type":"folder"}},"urlObject":{"path":["purchases","69ca76dbace4fa4413db928c","cancel"],"host":["https://api.paysecure.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"33055b6b-9bec-4a36-b80f-9038f2ab3090","name":"Cancel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 309855a6e22c2bc9873f11ee5997cb3ff246a8e8ec4f009f2924ad7178b2ad7b"}],"url":"https://api.paysecure.net/api/v1/purchases/69ca76dbace4fa4413db928c/cancel"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Wed, 01 Apr 2026 17:18:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"X-Frame-Options","value":"ALLOW-FROM *"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"x-session-id","value":"1c9b7d67-8dec-4e71-b35b-7952f23b67ed"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Server","value":"cloudflare"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 8bd3b44b8e417f2b75cd6e631907112a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P10"},{"key":"X-Amz-Cf-Id","value":"WSuVRaHm9E64itnjsFWAyBSPCR8YOFpZr7jY-NAhT-Ae-3_bc-hNTw=="},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=%2FOrvZsMz3WoHOQDEvKgGSADamNtnaGrILftqtr5BiqYIlUvgXZT89lPPwyXtpIDJW8BNOXjG%2FgAQmYnOUsUpQZ%2BDIVJsSDsxo4FxOEgIKcxPYcG21xgzcTNpNqbnk%2Fnw%2FEki\"}]}"},{"key":"CF-RAY","value":"9e5940bd580a07ed-IAD"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"purchaseId\": \"69cd36c353d7b783ebf743e9\",\n \"client\": {\n \"customerId\": \"NA\",\n \"email\": \"kailashvishnoi126741@paysecure.co\",\n \"full_name\": \"akshaya singhal\",\n \"date_of_birth\": \"1800-01-01\",\n \"street_address\": \"123\",\n \"country\": \"ZM\",\n \"city\": \"jaipur\",\n \"zip_code\": \"234567\",\n \"cc\": [],\n \"bcc\": [],\n \"stateCode\": \"CA\"\n },\n \"updated_on\": 1775056649,\n \"type\": \"purchase\",\n \"paymentMethod\": \"MASTER,VISA,VIRTUAL-IBAN,CRYPTO-WALLET,MAYA,GCASH,QRPH,BANKTRANSFER,NETBANKING,UPI-QR,PAYPLAY,UPI-INTENT,MOBILEMONEY,GOOGLEPAY,APPLEPAY\",\n \"amountUnit\": \"MAJOR\",\n \"errorMsg\": \"\",\n \"errorCode\": \"NA\",\n \"force_recurring\": false,\n \"created_on\": 1775056579,\n \"extraParam\": {\n \"aft\": {\n \"account_owner_address1\": \"test\",\n \"account_owner_address2\": \"test\",\n \"account_owner_street\": \"test\",\n \"account_owner_postal_code\": \"123\",\n \"account_owner_city\": \"test\",\n \"account_owner_country\": \"UK\",\n \"merchant_postal_code\": \"123\",\n \"merchant_state\": \"FRA\",\n \"acceptor_legal_name\": \"test\",\n \"sender_address\": \"test\",\n \"sender_city\": \"test\",\n \"sender_state\": \"RJ\",\n \"sender_country\": \"FRA\",\n \"sender_name\": \"test\",\n \"sender_account_number\": \"test\",\n \"recipient_name\": \"test\",\n \"bai\": \"AA\"\n }\n },\n \"merchantRef\": \"69cd36c353d7b783ebf743e9\",\n \"purchase\": {\n \"currency\": \"EUR\",\n \"products\": [\n {\n \"name\": \"gaming cards\",\n \"quantity\": 1.0,\n \"price\": 10.0,\n \"discount\": 0,\n \"tax_percent\": \"0.00\"\n }\n ],\n \"total\": 10.0,\n \"requestAmount\": 10.0,\n \"language\": \"en\",\n \"notes\": \"\",\n \"debt\": 0,\n \"total_formatted\": 1.0,\n \"taxAmount\": 0.0,\n \"taxPercent\": 0.0,\n \"request_client_details\": [],\n \"email_message\": \"\"\n },\n \"payment\": {\n \"is_outgoing\": false,\n \"payment_type\": \"PURCHASE\",\n \"amount\": 10.0,\n \"currency\": \"EUR\",\n \"net_amount\": 10.0,\n \"fee_amount\": 0.0,\n \"pending_amount\": 0.0,\n \"pending_unfreeze_on\": null,\n \"description\": \"\",\n \"paid_on\": 1775056600,\n \"remote_paid_on\": 1775056600\n },\n \"issuer_details\": {\n \"website\": \"\",\n \"legal_street_address\": \"\",\n \"legal_country\": \"\",\n \"legal_city\": \"\",\n \"legal_zip_code\": \"\",\n \"bank_accounts\": [\n {}\n ],\n \"legal_name\": \"ECOMTEST1\",\n \"brand_name\": \"ECOMTEST1\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n \"transaction_data\": {\n \"payment_method\": \"\",\n \"flow\": \"payform\",\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n },\n \"country\": \"\",\n \"attempts\": [\n {\n \"client_ip\": \"223.235.99.134\",\n \"type\": \"execute\",\n \"payment_method\": \"VISA\",\n \"flow\": \"payform\",\n \"successful\": true,\n \"country\": \"US\",\n \"processing_time\": 1775056600,\n \"extra\": {\n \"expiry_month\": \"12\",\n \"amount\": 10.0,\n \"card_issuer\": \"JPMORGAN CHASE BANK, N.A.\",\n \"masked_pan\": \"42000000****0000\",\n \"card_brand\": \"VISA\",\n \"card_issuer_country\": \"US\",\n \"card_type\": \"CREDIT\",\n \"cardholder_name\": \"Sank\",\n \"expiry_year\": \"28\"\n }\n }\n ]\n },\n \"status\": \"CANCELLED\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"timestamp\": 1775056579\n },\n {\n \"status\": \"pending_execute\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"payment_in_process\",\n \"timestamp\": 1775056600\n },\n {\n \"status\": \"3DS success\",\n \"timestamp\": 1775056607\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056611\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"preauthorized\",\n \"timestamp\": 1775056632\n },\n {\n \"status\": \"void_in_process\",\n \"timestamp\": 1775056647\n },\n {\n \"status\": \"cancelled\",\n \"timestamp\": 1775056649\n }\n ],\n \"is_test\": false,\n \"brand_id\": \"bab077d5-df4d-4fda-8c6c-2f78d97c9a16\",\n \"send_receipt\": false,\n \"is_recurring_token\": false,\n \"skip_capture\": true,\n \"reference_generated\": \"PS1675\",\n \"issued\": \"2026-04-01\",\n \"due\": 1775056579,\n \"refund_upto\": 1776089849,\n \"cc_descriptor\": \"\",\n \"fraudScore\": \"NA\",\n \"trustScore\": \"NA\",\n \"extraFee\": \"0\",\n \"pix_payload\": {},\n \"payInDetails\": {},\n \"paidOn\": 0,\n \"receivedAmt\": 0.0,\n \"taxAmount\": 0.0,\n \"surcharge\": 0.0,\n \"surchargeType\": \"\",\n \"sessionId\": \"\",\n \"refund_availability\": \"NONE\",\n \"refundable_amount\": 10.0,\n \"success_redirect\": \"https://google.com/getResponse.jsp?issucces=true\",\n \"failure_redirect\": \"https://google.com/getResponse.jsp?issucces=false\",\n \"cancel_redirect\": \"\",\n \"success_callback\": \"https://www.google.com/\",\n \"failure_callback\": \"https://staging.paysecure.net/merchant\",\n \"platform\": \"API\",\n \"created_from_ip\": \"223.235.99.134\",\n \"checkout_url\": \"https://staging.paysecure.net/payments/23182fc42998cb02b4a3e6aa5c3e26c8/\",\n \"direct_post_url\": \"https://staging.paysecure.net/api/v1/p/69cd36c353d7b783ebf743e9/\",\n \"payoutProcess\": false\n}"}],"_postman_id":"d4c70e6b-b091-4043-8f21-6fe02008e9b8"}],"id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c7d81f35-256f-42fd-b2b8-3e6335857750","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ac424d8b-56aa-4dba-97c3-8f327cbb3d52","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"c811e188-c0c5-4c14-8d2e-7dfb01ed7364","description":""},{"name":"Transaction Status Lifecycle","item":[],"id":"e369b83d-bb0e-4a63-9cf3-bdb5d9b9976a","description":"Every payment processed through the pre-authorisation flow passes through a series of statuses. Understanding these statuses is critical for building robust integrations.
\n","_postman_id":"e369b83d-bb0e-4a63-9cf3-bdb5d9b9976a"},{"name":"Best Practices","item":[],"id":"77100df5-b923-4bbc-959b-952ac1279c5d","description":"Capture Timing
\nCapture payments as soon as the goods are shipped or the service is delivered. The longer you wait, the higher the risk of authorisation expiry, customer disputes, and declined captures.
\nIdempotency
\nAlways include the X-Idempotency-Key header for all write operations (authorise, capture, void). This protects against duplicate transactions caused by network timeouts or retries.
\nWebhook-Driven Architecture
\nDo not rely solely on synchronous API responses for business logic. Implement webhook handlers to receive real-time status updates and use them as the source of truth for transaction state in your system.
\nError Handling
\nImplement retry logic with exponential backoff for 5xx errors and 429 (rate limit) responses. For 4xx errors, parse the error response body and handle each error code appropriately in your application logic.
\nPCI Compliance
\nIf you are handling raw card numbers, you must be PCI DSS Level 1 certified. Paysecure strongly recommends using tokenised payment methods to minimise your PCI scope. Use the Paysecure Cashier or client-side SDK to tokenise card details before they reach your server.
\nReconciliation
\nUse the reference field on authorise, capture, and void requests to associate Paysecure transactions with your internal order system. The balances object in every response provides a real-time breakdown for reconciliation.
\n3D Secure
\nEnable 3DS for all pre-authorisation requests where supported. This shifts fraud liability to the card issuer and reduces chargebacks. Paysecure supports 3DS 2.x with frictionless and challenge flows.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"01da4652-1268-480a-afa9-6328d93c80d3","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"4f223372-88e7-4c6b-a1af-06aa4728390a","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"77100df5-b923-4bbc-959b-952ac1279c5d"},{"name":"Frequently Asked Questions","item":[],"id":"b5110294-659a-4cde-9cc7-dd89d4f304ff","description":"Q: Can I capture more than the authorised amount?
\nA: No. The capture amount must be less than or equal to the authorised amount. If you need to charge more, you must create a new authorisation for the additional amount.
\nQ: Can I perform multiple partial captures on a single authorisation?
\nA: Yes. Paysecure supports multiple captures per authorisation. But you will need to contact the support team for enabling the same.
\nQ: What happens if I do not capture before the authorisation expires?
\nA: The authorisation automatically expires and the held funds are released back to the customer. You will receive a payment.expired webhook event. You must create a new authorisation to charge the customer.
\nQ: Can I void a payment after it has been captured?
\nA: No. Once a payment is captured, you must use the Refund API to return funds. The void endpoint only works for payments in AUTHORISED status.
\nQ: How long does a void take to reflect on the customer’s statement?
\nA: Typically, the hold is removed within 1–3 business days, depending on the issuing bank. Some banks may take up to 7 days to release the hold.
\nQ: Does the customer see the pre-authorisation on their statement?
\nA: Yes. The customer will see a pending charge for the authorised amount. This pending charge is released upon void or expiry, or replaced by the final charge upon capture.
\nQ: Can I use pre-authorisation with non-card payment methods?
\nA: Pre-authorisation is primarily supported for card payments. Support for alternative payment methods varies. Check the Paysecure payment methods documentation for details.
\nQ: Is 3D Secure required for pre-authorisations?
\nA: 3DS is not required but is strongly recommended. It reduces fraud liability and chargeback risk. Paysecure supports 3DS on all card pre-authorisation requests.
\n","_postman_id":"b5110294-659a-4cde-9cc7-dd89d4f304ff"}],"id":"e0357e93-f550-4936-9da9-b34ba8cff881","description":"Overview
\nPre-authorisation (also known as \"auth only\") is a two-step payment process where a merchant first reserves (holds) funds on a customer’s payment method without immediately capturing the amount. This allows the merchant to verify fund availability before fulfilling an order, then capture (settle) the payment at a later time — or void (cancel) the hold if the order is not fulfilled.
\nWhen to Use Pre-Authorisation
\nPre-authorisation is ideal for scenarios where the final transaction amount may change, or where goods/services are not delivered immediately. Common use cases include:
\nKey Concepts
\n","_postman_id":"e0357e93-f550-4936-9da9-b34ba8cff881"},{"name":"Get Balance API (V2) - Orchestration","item":[{"name":"Checking Balance","id":"3ee8ba05-05b3-4ca5-aa2e-f9f96049deb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Token","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance","description":"API for checking available balance
\n- \n
URL :- /getBalance/
\n \nRequestType: POST
\n \nRequest Body
\n \n
Note: Currency is not a mandatory parameter. If no parameter is specified then all respective currency balances would be provided, if any specific currency parameter is provided then only that currency balance would be provided.
\n","urlObject":{"path":["getBalance"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9bb10ce4-cea1-43ba-817d-56e1036b8e2b","name":"Checking Balance payout-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC-ETRANSFER\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC-ETRANSFER\",\n \"status\": \"success\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 803.380000\n }\n ]\n },\n {\n \"gatewayName\": \"choicepaypg\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 808.380000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 808.380000\n }\n ]\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"CAD\",\n \"balance\": 1616.760000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 1611.760000\n }\n ]\n}"},{"id":"a89a4e12-6976-4567-b11a-f3ed6edbcaf4","name":"Checking Balance partial-success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"CARDS\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"CARDS\",\n \"status\": \"partial\",\n \"gateways\": [\n {\n \"gatewayName\": \"a55Mandate\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n },\n {\n \"gatewayName\": \"bk_sbx_smilepayz_pix_payin\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"IDR\",\n \"balance\": 250000.000000\n }\n ]\n },\n {\n \"gatewayName\": \"choicepay_pg\",\n \"status\": \"success\",\n \"error\": null,\n \"balances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n },\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": [\n {\n \"currency\": \"AED\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"AUD\",\n \"balance\": 3412.000000\n },\n {\n \"currency\": \"BRL\",\n \"balance\": 100.089996\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"BXC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"CAD\",\n \"balance\": 1000.000000\n },\n {\n \"currency\": \"CDF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"COP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"DKK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EGP\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ETH\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"EUR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"GBP\",\n \"balance\": -24.327801\n },\n {\n \"currency\": \"GHS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"IDR\",\n \"balance\": 251000.000000\n },\n {\n \"currency\": \"INR\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"JPY\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"KES\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MWK\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"MXN\",\n \"balance\": -4.770000\n },\n {\n \"currency\": \"NGN\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"NZD\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"RWF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"THB\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"TZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UGX\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USD\",\n \"balance\": 167.457992\n },\n {\n \"currency\": \"USDC\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"USDT\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"UZS\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XAF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"XOF\",\n \"balance\": 0.000000\n },\n {\n \"currency\": \"ZAR\",\n \"balance\": 120.000000\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 0.000000\n }\n ]\n}"},{"id":"aba4800e-4e7b-4712-a2f0-46a6b3f33f7e","name":"Checking Balance payout-error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"paymentMethod\" : \"PAYOUT-INTERAC\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"/getBalance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentMethod\": \"PAYOUT-INTERAC\",\n \"status\": \"failed\",\n \"gateways\": [\n {\n \"gatewayName\": \"payhost\",\n \"status\": \"failed\",\n \"error\": {\n \"code\": \"error\",\n \"message\": \"Bank does not provide balance\"\n },\n \"balances\": []\n }\n ],\n \"aggregatedBalances\": []\n}"}],"_postman_id":"3ee8ba05-05b3-4ca5-aa2e-f9f96049deb0"}],"id":"2bbb6da7-34b9-43ef-a58f-bc4acab2a86f","description":"The Get Balance API (V2) provides orchestrator-level visibility into available balances across multiple payment methods and banking partners. This version enhances the existing balance API by aggregating and returning balance details for all supported payment methods associated with all the PSPs for the merchant
\nOverview
\n- \n
Purpose: Retrieve available balance information across different banks/payment methods.
\n \nScope: Orchestrator-level (not limited to a single merchant or payment method).
\n \nEnhancement over previous version:
\n- \n
Returns balances for all payment methods linked to the orchestrator.
\n \nProvides both consolidated and MID-level (Merchant ID) breakdowns.
\n \n
\n
Request Parameters
\nBehavior
\n- \n
When a valid paymentMethod is provided, the API retrieves:
\n- \n
Balance details across all associated banks/payment methods.
\n \nMID-level breakdown for each bank.
\n \nConsolidated balance per payment method.
\n \n
\nThe API is designed specifically for orchestrators and returns aggregated data across multiple merchants and banking integrations.
\n \n
Success Response
\nOn successful retrieval, the API returns:
\n- \n
Payment Method Details
\n \nList of Banks / Payment Providers
\n \nMID-Level Breakdown
\n \nConsolidated Balance
\n \n
Partial Success Response
\nA Partial Success response is returned when balance information is retrieved successfully for some payment methods or banks, while one or more fail to return balance data.
\nThis scenario typically occurs when:
\n- \n
A merchant is associated with multiple payment methods or banking partners, and
\n \nAt least one provider returns a valid balance, while others fail due to unavailability, timeout, or missing data.
\n \n
Return values-
\n- \n
Status as \"Partial\"
\n \nPayment Method Details
\n \nList of Banks / Payment Providers
\n \nMID-Level Breakdown
\n \nConsolidated Balance
\n \n
Error Handling
\nIf balance details are not found or the request cannot be processed, the API returns:
\n- \n
Appropriate status code
\n \nError message
\n \n