# Authentication Source: https://docs.paymentoptions.com/api-reference/en/authentication Access to the API is authenticated using **HTTP Basic Auth** ([Learn More](https://en.wikipedia.org/wiki/Basic_access_authentication)) along with the `x-api-key` header. ### **Getting Started** Authentication information will be available after the account creation. Authentication can be used in the following ways: * **Using ‘LIVE API KEY’**: The **LIVE API KEY** details are available on the website. Provide your LIVE API KEY as the Basic Auth username value. You do not need to provide a password.Payment Options Documentation * **Using Encoded ‘LIVE API KEY’**: Encode the **LIVE API KEY** by using the **ENCODE BASE64** button available on the website.Payment Options Documentation After encoding the **LIVE API KEY**, attach the string **Basic** in front of the encoded key followed by a space, and provide this value in the `Authorization` header. ```bash theme={null} curl --location --request POST '' \ --header 'Authorization: Basic ' ``` ## Authenticating API Calls To authenticate each API request, include both the Authorization and x-api-key headers. ```bash theme={null} curl --location --request POST '' \ --header 'Authorization: Basic ' \ --header 'x-api-key: ' ``` Always ensure that your **LIVE API KEY** is encoded securely and passed correctly in the headers for successful authentication. ## **API Headers** API headers provide additional metadata for each API call, including crucial information about the request and response. | **Header** | **Description** | | :------------------ | :------------------------------- | | **`x-api-key`** | Provided along with credentials. | | **`Authorization`** | Basic ``. | ### **Important Note** If using plain LIVE API KEY for the **Authorization** header, include **"Basic"** before the base64-encoded API key to authenticate requests properly. Authorization: Basic Encoded LIVE API KEY Live API Key If you need assistance or have questions regarding setting up your authentication, please [contact our support team](./support/contact) for further guidance. # Gateway Error Codes Source: https://docs.paymentoptions.com/api-reference/en/error-and-response/gatewayerrors This page provides a list of error codes returned by the gateway, along with descriptions and suggested actions. Error codes are organized by Entity Level and Product Level to help identify where the error applies. ## **Understanding Entity Level and Product Level** Entity-level rules apply to the merchant's operational region or country. These settings enforce restrictions and policies specific to geographical areas.\ **Example**: Blocking transactions originating from certain card countries or IP addresses based on merchant location. Product-level rules are specific to individual products or services within the gateway, like "Pay by Link" or "Subscription." These manage behaviors and restrictions tied to each product.\ **Example**: Setting refund velocity limits or transaction thresholds for a specific product. This distinction helps merchants and developers troubleshoot errors effectively and ensures that compliance and restrictions are properly managed across regions and products. | **Error Code** | **Response Code** | **Applied Level** | **Risk Rule** | **Error Message** | | :------------- | :---------------- | :---------------- | :--------------- | :---------------------------------- | | **ERR3001** | -8000 | Entity Level | Blacklist | Transaction is restricted | | **ERR3002** | -8001 | Entity Level | IP Address | Transaction is restricted | | **ERR3003** | -8002 | Entity Level | BIN Blocking | Transaction is restricted | | **ERR3004** | -8003 | Entity Level | PAN Blocking | Transaction is restricted | | **ERR3005** | -8004 | Entity Level | Blacklist | Transaction is restricted | | **ERR3006** | -8005 | Product Level | Threshold Amount | Amount is outside the allowed range | | **ERR3007** | -8007 | Product Level | IP Address | Transaction is restricted | | **ERR3008** | -8008 | Product Level | PAN Limit | Transaction is restricted | | **ERR3009** | -8009 / -8013 | Product Level | PAN Limit | Risk rule decline | | **ERR3010** | -8010 | Product Level | PAN Limit | Risk rule decline | | **ERR3011** | -8011 | Product Level | PAN Limit | Risk rule decline | | **ERR3012** | -8012 | Product Level | IP Limit | Risk rule decline | | **ERR3013** | -8013 | Product Level | IP Limit | Risk rule decline | | **ERR3014** | -8014 | Product Level | IP Limit | Risk rule decline | | **ERR3015** | -8015 | Product Level | IP Limit | Risk rule decline | | **ERR3016** | -8006 | Product Level | Threshold Amount | Amount is outside the allowed range | | **ERR3017** | -8017 | Product Level | IP Address | Transaction is restricted | | **ERR3018** | -8018 | Product Level | BIN | Transaction is restricted | | **ERR3019** | -8019 | Product Level | Refund Limit | Insufficient refund balance | | **ERR3020** | -8020 | Product Level | Refund Volume | Insufficient refund balance | | **VAL0035** | -1 | Product Level | | Invalid card holder name. | | **ERR0204** | -1 | Product Level | Refund Volume | Insufficient refund balance | | | | | | | ## **Additional Resources** Visit our FAQ section for answers to common questions about error codes and handling. Need further assistance? Contact our support team for help with error code troubleshooting. # HTTP Response Source: https://docs.paymentoptions.com/api-reference/en/error-and-response/httpresponse HTTP response codes provide information on the status of requests sent to the gateway. Each code indicates whether the request was successful or if there was an error, along with the nature of that error. | **HTTP Response** | **Description** | **Explanation** | | :---------------- | :---------------------------- | :----------------------------------------------------------------------------------------------- | | **200** | Request Successful | The request was successfully received and processed. | | **201** | Resource Created | A new resource has been successfully created. | | **400** | Bad Request | The server could not process the request due to a client error (e.g., malformed request syntax). | | **401** | Unauthorized | Authentication is required, or the provided credentials are invalid. | | **404** | Not Found | The requested resource could not be found on the server. | | **406** | Not Acceptable (Invalid Card) | The request’s content is not acceptable, often due to an invalid card or data format. | | **412** | Precondition Failed | The server does not meet one or more of the preconditions specified in the request. | | **500** | Server Error | An internal server error occurred. Try again later or contact support if the issue persists. | | **502** | Bad Gateway | The server, acting as a gateway, received an invalid response from an upstream server. | | **504** | Gateway Time-out | The server did not receive a timely response from an upstream server and timed out. | *** ## **Additional Resources** Visit our FAQ section for answers to common questions about HTTP response codes and troubleshooting. Need assistance? Reach out to our support team for help with HTTP response code issues. # Response Codes Source: https://docs.paymentoptions.com/api-reference/en/error-and-response/responsecodes Response codes returned by the gateway, indicating the status of the request. ## **Overview** This page provides a comprehensive list of response codes returned by the gateway, each indicating the status of a specific request. Use this guide to understand and handle each response scenario effectively. | **Response Code** | **Description** | | :---------------- | :----------------------------------------------------------------------------------------- | | **-1** | DAS Gateway Error | | **0** | Payment Successful | | **1** | Refer to card issuer OR Referred Call Authorization Center | | **2** | Refer to card issuer special condition | | **3** | Invalid merchant OR Invalid merchant or service provider | | **4** | Capture card OR Declined Retain Card | | **5** | Do not honour OR Declined | | **6** | Error | | **7** | Failed Signature | | **8** | Honour with ID OR Transaction approved with ID | | **10** | Partial Approval | | **12** | Invalid transaction | | **13** | Invalid amount OR Invalid amount (currency conversion overflow) | | **14** | Invalid card number OR Invalid account number (no such number) | | **15** | Invalid issuer | | **19** | Re-enter transaction | | **20** | ERROR OR No action taken (unable to back out prior) | | **25** | Unable to locate record in file or account | | **28** | File is temporarily unavailable | | **30** | Format error OR ERROR | | **34** | FRAUD SUSPICION | | **39** | No credit account | | **41** | Lost card OR Pickup card (lost card) | | **43** | Stolen card OR Pickup card (stolen card) | | **51** | Insufficient funds OR Insufficient funds/over credit limit | | **52** | No checking account | | **53** | No savings account | | **54** | Expired card OR Declined Expired Card | | **55** | Invalid PIN OR ERROR | | **57** | Transaction not permitted to issuer/cardholder | | **58** | Transaction not permitted to acquirer/terminal | | **59** | Suspected Fraud (Visa) | | **61** | Exceeds withdrawal amount limit | | **62** | Restricted card OR Restricted card (in Country Exclusion table) | | **63** | Unable to authorize OR ERROR | | **64** | Unable to authorize | | **65** | Exceeds withdrawal count limit OR Authentication requested | | **68** | Time out | | **70** | Contact Card Issuer | | **71** | PIN Not Changed | | **75** | Allowable number of PIN tries exceeded | | **76** | Invalid/nonexistent OR Invalid/nonexistent specified | | **77** | Invalid/nonexistent OR Invalid/nonexistent specified | | **78** | Invalid/nonexistent account specified (general) | | **79** | Already reversed (Visa) OR Lifecycle reasons (Mastercard) | | **80** | Visa transactions: credit issuer unavailable | | **82** | Negative CAM dCVV iCVV or CVV results (Visa) OR Policy reasons (Mastercard) | | **83** | STIP cannot approve (Visa) OR Fraud Security related reasons (Mastercard) | | **84** | Invalid Authorization Life Cycle | | **85** | Not declined. Valid for AVS only balance Inq OR No reason to decline a request | | **86** | Cannot Verify PIN | | **88** | Unable to authorize | | **89** | Unacceptable PIN - Transaction Declined - Retry OR Ineligible to receive | | **91** | Authorization System or issuer system inoperative | | **92** | Unable to route transaction OR Destination cannot be found for routing | | **93** | Transaction cannot be completed violation of law | | **94** | Duplicate transmission detected | | **96** | System error OR Unable to authorize | | **98** | ERROR | | **99** | ERROR | | **397** | Surcharge amount not permitted on Visa | | **398** | Surcharge not supported | | **442** | Acquirer Institution Identification Code in the request message is not registered at CAFIS | | **443** | CAFIS System Error. Try again | | **444** | The acquirer system is busy. Try again | | **445** | Acquirer system error. Try again | | **446** | The acquirer system has closed. Try again | | **447** | CAFIS System Error. Try again | | **448** | Illegal encoding format. Try again | | **449** | CAFIS System Error. Try again | | **450** | CAFIS System Error. Try again | | **451** | Advice message already received | | **452** | CAFIS detected a timeout when it sent the message to the acquirer. Try again | | **453** | CAFIS System Error. Try again | | **454** | CAFIS System Error. Try again | | **455** | CAFIS System Error. Try again | | **456** | CAFIS System Error. Try again | | **457** | CAFIS System Error. Try again | | **458** | The acquirer does not support the service | | **459** | CAFIS System Error. Try again | | **460** | CAFIS System Error. Try again | | **577** | The card is unusable | | **578** | The transaction is pending | | **579** | PIN is incorrect | | **580** | Security Code is incorrect | | **581** | Security Code is not set | | **582** | JIS2 stripe information is invalid | | **583** | The card is maxed out for the day. (insufficient funds) | | **584** | The amount exceeds the limit for the day. (insufficient funds) | | **586** | The card is invalid. (MOD 10 check failed) | | **587** | The card is invalid (lost/stolen) | | **588** | The card is invalid. (MOD 10 check failed) | | **589** | Message element Primary Account Number value is invalid (MOD 10 check failed) | | **590** | Message element Merchant Type value is invalid | | **591** | Message element Transaction Amount value is invalid | | **592** | Message element Tax and Postage value is invalid | | **593** | Bonus Count value is invalid | | **594** | Bonus Month value is invalid | | **595** | Bonus Amount value is invalid | | **596** | First Payment Month value is invalid | | **597** | Instalment Count value is invalid | | **598** | Instalment Amount value is invalid | | **599** | First Payment Amount value is invalid | | **600** | Message elements Service Code Business Code and Message Code value is invalid | | **601** | Message element Payment Division value is invalid | | **602** | Message element Inquiry Division value is invalid | | **603** | Message element Cancel Division value is invalid | | **604** | Message element Original Payment Division value is invalid | | **605** | The card is expired | | **606** | The card is not applicable to the service | | **607** | The acquirer service is completed | | **608** | The invalid card (lost/stolen) has an error | | **609** | The request message cannot be processed for some reason | | **610** | The request message for which a transaction is not supported is received | | **611** | The request message from a centre which has not made the contact | | **622** | Message element Service Code setting error | | **623** | Message element Business Code setting error | | **624** | Message element Message Code setting error | | **625** | Message element Processor Code setting error | | **626** | Message element Merchant Code setting error | | **627** | Message element Transaction Identifier setting error | | **628** | Message element Processor Transaction Date-Time setting error | | **629** | Message element Card Acceptor Terminal Identification setting error | | **630** | Message element Encryption Method Code setting error | | **631** | Message element Key Encryption Key Index in Use setting error | | **632** | Message element Processor Authentication Key Index setting error | | **633** | Message element Message Encryption Key setting error | | **634** | Message element Message Authentication Code setting error | | **635** | Message element Acquirer Institution Identification Code setting error | | **636** | Message element Primary Account Number setting error | | **637** | Message element Expiration Date setting error | | **638** | Message element Track-2 Data setting error | | **639** | Message element PIN Data setting error | | **640** | Message element Merchant Type setting error | | **641** | Message element Transaction Amount setting error | | **642** | Message element Tax and Postage setting error | | **643** | Message element Point of Service Data Code setting error | | **645** | Message element Cancel Division setting error | | **646** | Message element Original Terminal Processing Serial Number setting error | | **647** | Message element Original Payment Division setting error | | **658** | Message element Original Processor Transaction Date-Time setting error | | **659** | Message element Original Transaction Identifier setting error | | **660** | Message element Free Field setting error | | **661** | Message element Terminal Processing Serial Number setting error | | **662** | Message element Security Code setting error | | **663** | Message element Electronic Commerce Indicator setting error | | **664** | Message element XID setting error | | **665** | Message element Accountholder Authentication Value setting error | | **666** | Message element Transaction Status setting error | | **667** | Message element Message Version Number setting error | | **668** | Message element CAVV Algorithm setting error | | **669** | Message element Recurring Flag setting error | | **670** | Element Block (e.g. General Transaction Info setting error) | | **671** | Combination of message elements Service Code and Message Code setting is incorrect | | **672** | Message element Processor Authentication Key Index setting error | | **673** | There is more than one original transaction to reverse. Unable to reverse the transaction | | **674** | Combination of message elements Processor Code and Merchant Code setting is incorrect | | **675** | Global GEAR System Error. Try Again | | **676** | Global GEAR System Error. Transaction result is unclear | | **677** | Global GEAR System Error. Transaction result is unclear | | **678** | Global GEAR System Error. Try Again | | **679** | Global GEAR System Error. Transaction result is unclear | | **680** | Global GEAR System Error. Transaction result is unclear | | **681** | Global GEAR System Error. Try Again | | **682** | Global GEAR System Error. Transaction result is unclear | | **683** | Global GEAR System Error. Transaction result is unclear | | **694** | Global GEAR System Error. Transaction result is unclear | | **695** | Global GEAR System Error. Transaction result is unclear | | **696** | Global GEAR System Error. Transaction result is unclear | | **697** | Global GEAR System Error. Transaction result is unclear | | **698** | Global GEAR System Error. Transaction result is unclear | | **699** | Global GEAR System Error. Transaction result is unclear | | **700** | Global GEAR System Error. Transaction result is unclear | | **701** | Global GEAR System Error. Transaction result is unclear | | **702** | Global GEAR System Error. Transaction result is unclear | | **703** | Global GEAR System Error. Try Again | | **704** | Global GEAR System Error. Transaction result is unclear | | **705** | Global GEAR System Error. Try Again | | **828** | Unable to authorize | | **831** | Cash service not available | | **832** | Cash back request exceeds issuer limit | | **833** | Resubmitted transaction over max days limit | | **835** | Decline CVV2 failure | | **836** | Transaction amount greater than preauthorized | | **902** | Invalid biller information | | **905** | Unable to authorize | | **906** | Unable to authorize | | **937** | Card Authentication failed | | **972** | Stop Payment Order | | **973** | Revocation of Authorization Order | | **975** | Revocation of All Authorizations Order | | **1044** | Approval keep first check | | **1045** | Check OK no conversion | | **1046** | Invalid RTTN | | **1047** | Amount greater than limit | | **1048** | Unpaid items failed NEG | | **1049** | Duplicate check number | | **1050** | MICR error | | **1051** | Too many checks | | **1198** | Forward to issuer | | **1201** | Forward to issuer | | **1263** | Unable to authorize | | **1295** | Unknown | *** ## **Additional Resources** Visit our FAQ section for answers to common questions about response codes and troubleshooting. Need assistance? Reach out to our support team for help with response code issues. # Hosted Payment Page Source: https://docs.paymentoptions.com/api-reference/en/hpp/generate-link api-reference/en/open-api-config/hpp/generate-link.json POST /api/v1/server-to-server-interface/hpp/generate/link Generate a link to open the Hosted Payment Page (HPP) for capturing transactions. ### Key Points * If the payload is pre-filled with data (e.g., amount, currency, customer details, return\_url, payment method), these details will be reflected on the HPP, providing a streamlined user experience. * If the payload lacks certain data, the customer will need to manually enter the missing information on the HPP. * Ensure that the necessary headers and authentication details are included to successfully generate the HPP link. ## Flow diagram Flow diagram image ## ApplePay & GooglePay When a merchant is configured for Apple Pay and Google Pay, the Hosted Payment Page (HPP) will display buttons for Google Pay and Apple Pay, allowing customers to complete payments through these methods ### Key Points Merchant Configuration The Merchant ID for either Apple Pay or Google Pay must be included in the HPP payload when making a request to generate the payment link. These payment options will automatically appear on the HPP if the merchant is properly configured for them. Payment Buttons The HPP will dynamically display Google Pay and Apple Pay buttons based on the availability and configuration of the merchant’s account. Customers can seamlessly use either method to complete the transaction directly from the HPP. If both Apple Pay and Google Pay are configured for the same merchant (i.e., same DAS MID), you can control button priority by including the following optional parameter in the HPP payload: When set to true, this will prioritize displaying Google Pay on the payment interface. If omitted, the default prioritization will apply based on device and browser compatibility. ## Api Parameters # Tokenization Source: https://docs.paymentoptions.com/api-reference/en/hpp/generate-link-tokenization api-reference/en/open-api-config/hpp/generate-link-token.json POST /api/v1/server-to-server-interface/hpp/generate/link Generate a link to open the Hosted Payment Page (HPP) for capturing transactions. ### Key Points * If the payload is pre-filled with data (e.g., amount, currency, customer details, return\_url, payment method), these details will be reflected on the HPP, providing a streamlined user experience. * If the payload lacks certain data, the customer will need to manually enter the missing information on the HPP. * Ensure that the necessary headers and authentication details are included to successfully generate the HPP link. ## Flow diagram Flow diagram image ### Notes `store_payment_method`: Must be set to `true` in the payload to store the card token for future use. ```json Request Example theme={null} { "payment_method": { "type": "scheme", "store_payment_method": true } ``` Setting `store_payment_method` to `true` ensures that the card token is stored for future transactions without needing to re-enter card details. ```json Response Example theme={null} { "transaction_details": { "id": "", "ref": , "timestamp": "yyyy-mm-ddThh:mm:ss.000Z", "merchant_txn_ref": "", "stored_payment_method_id": "094db781-fabc-4c6d-8fcd-18bee06a527a" } } ``` The `stored_payment_method_id` can be used in the Use of Card Token API for future transactions without needing to re-enter card details. ## Api Parameters # Introduction Source: https://docs.paymentoptions.com/api-reference/en/introduction Welcome to the **Payment Options Gateway API Documentation**. This API enables users to integrate payment processing capabilities into their applications, ensuring secure, reliable, and efficient handling of transactions. Designed using the RESTful architectural style, it provides flexibility, scalability, and simplicity in communication with Payment Options Gateway systems. ### **REST Architectural Style** This API follows the [REST](https://en.wikipedia.org/wiki/REST)ful architectural principles, Each request contains all the information needed to process it, ensuring scalability. * **HTTP Methods**: Retrieve data from the server Create a resource on the server * **Resource-Oriented URLs**: Ensures clear and structured request handling. ### **HTTP Response Codes** [HTTP response codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) indicate the status of each request: * **200–299**: Successful responses. * **400–499**: Client error responses. * **500–599**: Server error responses. ### **Base URL** All API requests are encrypted and transmitted securely over HTTPS. * **LIVE URL**: [https://api.paymentoptions.com](https://api.paymentoptions.com) * **DEV URL**: [https://api-dev.paymentoptions.com](https://api-dev.paymentoptions.com) * **Secure Communication**: Ensures sensitive data remains protected. ### **Best Practices for API Integration** Follow these guidelines to ensure a smooth integration experience: * **HTTP Client Compatibility**: Use clients that support RESTful APIs and authentication features. * **Understand HTTP Methods**: Familiarize yourself with standard HTTP methods (GET, POST) to interact correctly. * **Handle Response Codes**: Implement logic for various HTTP response codes to manage errors and debug effectively. Refer to the links provided for further reading and best practices on RESTful APIs. # Merchant Details Source: https://docs.paymentoptions.com/api-reference/en/merchant-details The Merchant Detail Page on the Payment Options Gateway contains all the essential information required to configure API payloads for transaction processing. This includes unique identifiers, currency preferences, scheme types, transaction types, and other critical details. Understanding these parameters helps ensure that transactions are processed accurately and securely. ## **Purpose** The **Merchant Detail Page** centralizes all the necessary configuration details for building API payloads, allowing merchants to interact with the Payment Options Gateway seamlessly. By accessing these details, developers can configure payloads that align with merchant-specific settings, enhancing compatibility and reducing transaction errors. Product Information ## **Key Information Available on the Merchant Detail Page** The Merchant Detail Page provides the following key information, each essential for proper API configuration: ### **Merchant ID** * The **Merchant ID** is a unique identifier assigned to each merchant. * **Required for API Payloads**: This ID must be included in API requests, as it identifies the merchant's account within the Payment Options Gateway. * **Consistency**: Ensures transactions are attributed to the correct merchant account, facilitating accurate processing and reporting. ### **Processing Currency** * Defines the currency in which the merchant processes transactions. * **Currency Support**: The processing currency must align with the merchant's regional and operational requirements. * **Examples**: JPY (Japanese Yen), USD (U.S. Dollar), PHP (Philippine Peso). * **Configuration**: Configuring the correct currency is crucial for ensuring that customers are charged accurately, and it impacts currency conversion for international transactions. ### **Scheme Type** * The payment schemes (e.g., **Visa**, **MasterCard**) configured for the merchant account. * **Scheme Configuration**: Determines the types of cards accepted by the merchant, impacting the scope of customer payments. * **Usage**: This setting should align with the merchant's target audience and preferred card networks. ## **Transaction Type** The Merchant Detail Page also specifies transaction types that determine how payments are processed: A security protocol for online transactions that requires additional customer verification. Recommended for enhanced security, it helps prevent fraud, especially in high-risk transactions. Standard transactions that do not require 3DS verification. Commonly used for lower-risk transactions or where 3DS is not mandatory. For scheduled, automatic transactions such as subscriptions. The API triggers these transactions based on a predefined schedule, eliminating the need for manual customer input. Secure transactions using a stored token instead of raw card details, allowing card-on-file payments while maintaining PCI compliance. Ideal for repeat customers or memberships. ## **Other Crucial Information** In addition to the above key details, the Merchant Detail Page also provides other configuration information critical for the merchant's operational needs: ### **Merchant's Payment Configurations** * Details specific payment settings that affect how transactions are processed. * **Configuration Options**: These may include options like default settlement times, preferred authorization settings, and other merchant-specific transaction preferences. ### **Supported Payment Methods** * **Available Payment Methods**: The page lists all supported payment methods for the merchant, such as: * **Apple Pay** * **Google Pay** * **GCash** * **Multi-Channel Support**: Having multiple payment methods ensures customers can use their preferred payment channel, increasing conversion rates. ### **Limits and Restrictions** * Defines transaction limits and processing restrictions for the merchant. * **Transaction Limits**: The maximum amount that can be processed in a single transaction or daily limits. * **Restrictions**: May include geographical restrictions, maximum transaction frequencies, and card type limitations, ensuring compliance with regional or operational rules. ## **Using Merchant Details for API Payload Configuration** By accessing and correctly implementing these details, merchants and developers can build accurate and efficient API payloads. This allows for: * **Improved Transaction Accuracy**: Ensures all transactions are routed and processed with the correct configurations. * **Enhanced Security and Compliance**: Transaction types like 3DS and tokenization add layers of security to reduce fraud and comply with regulatory standards. * **Customizable Customer Experience**: Supporting various payment methods and adhering to merchant-specific configurations improves the customer experience and encourages higher conversion rates. For a comprehensive guide on merchant operations and configurations, you can download our Merchant User Guide. If you need assistance or have questions regarding document submission, please contact our support team for further guidance. # 3D Secure Integration Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/3dsecure api-reference/en/open-api-config/server-to-server/purchase.json POST /api/v1/server-to-server-interface/paymentv2 Comprehensive guide to integrating 3D Secure authentication for enhanced transaction security. ## **Integration Steps** ### **Step 1: Send a 3D Request** To initiate the 3D Secure authentication, send a server-to-server request to the 3D Secure endpoint. *** ### **Step 2: Use the Redirect URL** Use the `redirect_url` from the response to open the 3D Secure page in the browser. *** ### **Step 3: After Completing the 3D Secure Authentication** After the cardholder completes the authentication, the issuer will approve or reject the request. Based on the outcome, the customer will be redirected to either a `success_url` or a `decline_url` that you provide. Redirects the customer to the specified page if the 3DS authentication is successful. Redirects the customer if the authentication is declined or fails. *** ### **Step 4: Webhook Notification** In addition to the redirect response, the gateway will send a Webhook notification to your specified `webhook_url` to confirm the status of the transaction. This ensures the transaction result is reliably communicated, even if the customer does not return to your website after the 3DS process. #### **Webhook Sample Response** ```json theme={null} { "success": true, "status_code": 200, "is_live": false, "transaction_type": "CAPTURE", "gateway_response": { "version": "1", "type": "INFO", "message": "Payment Successful.", "code": "INFO0000" }, "merchant_details": { "legal_name": "", "mid": "DASMID", "merchant_txn_ref": "" }, "payment_details": { "amount": , "response_code": 0, "auth_code": null, "currency": "", "payment_method": "", "scheme": "VISA", "card": { "name": "", "number": "", "exp_month": "MM", "exp_year": "YY" }, "additional_data": { "payment_data_source": { "type": "card" } } }, "transaction_details": { "id": "", "ref": , "timestamp": "YYYY-MM-DDTHH:MM:SS.000Z", "merchant_txn_ref": "" }, "risk-details": {} } ``` *** ### **Step 5: Get the 3D Secure Transaction status** #### **Request Attributes** ```curl theme={null} curl --location '/api/v1/server-to-server-interface/transaction/status/' \ --header 'Authorization: Basic ' \ --header 'x-api-key: ' \ --header 'Content-Type: application/json' ``` #### **Response Attributes** ```json theme={null} { "success": true, "status_code": 200, "is_live": false, "transaction_type": "CAPTURE", "gateway_response": { "version": "1", "type": "INFO", "message": "Payment Successful.", "code": "INFO0000" }, "merchant_details": { "legal_name": "", "mid": "", "merchant_txn_ref": "" }, "payment_details": { "amount": , "response_code": 0, "responseDescription": "The transaction was completed successfully.", "auth_code": null, "currency": "", "payment_method": null, "scheme": "", "card": { "name": "", "number": "", "exp_month": "MM", "exp_year": "YY" }, "additional_data": { "payment_data_source": { "type": "card" } } }, "transaction_details": { "id": "", "ref": , "timestamp": "YYYY-MM-DDTHH:MM:SS.000Z", "billing_details": { "billing_address": { "country": "", "email": "", "address1": "", "phone_number": "", "city": "", "state": "", "postal_code": "" }, "shipping_address": { "country": "", "email": "", "address1": "", "phone_number": "", "city": "", "state": "", "postal_code": "" } } }, "risk_details": { "risk_score": null } } ``` *** ## Request Attributes # Authorization API (v1) Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/authorization api-reference/en/open-api-config/server-to-server/authorization.json POST /api/v1/server-to-server-interface/authorization Authorize a payment by securing funds for a transaction without capturing them immediately. Notice: Authorization API (v1) is scheduled for deprecation. [Use v2](/api-reference/en/server-to-server/authorizationv2) for future integrations. ### Key Points * The Authorization API secures the specified amount on the customer's payment method, but the funds are not transferred until a capture is performed. * **Capture**: Finalizes the transaction by transferring the authorized funds from the customer’s account. * **Void**: Cancels the authorization, releasing the held funds back to the customer. * Use cases for this API include scenarios where the exact final amount may vary, such as hotel bookings, car rentals, or pre-order situations. ## Flow diagram Flow diagram image ## Api Parameters # Authorization API (v2) Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/authorizationv2 api-reference/en/open-api-config/server-to-server/authorizationv2.json POST /api/v1/server-to-server-interface/authorizationv2 Authorize a payment by securing funds for a transaction without capturing them immediately. ### Key Points * The Authorization API secures the specified amount on the customer's payment method, but the funds are not transferred until a capture is performed. * **Capture**: Finalizes the transaction by transferring the authorized funds from the customer’s account. * **Void**: Cancels the authorization, releasing the held funds back to the customer. * Use cases for this API include scenarios where the exact final amount may vary, such as hotel bookings, car rentals, or pre-order situations. ## Flow diagram Flow diagram image ## Api Parameters # Capture API Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/capture api-reference/en/open-api-config/server-to-server/capture.json POST /api/v1/server-to-server-interface/capture The Capture API is used to finalize a payment by transferring the funds that were previously authorised via the Authorsation API. ### Key Points * The Capture API completes the payment process by moving the authorized funds from the customer’s account to the merchant’s account. * This API is typically used after an authorisation when the final amount is confirmed, such as after goods are shipped or services are provided. * Only the amount that was previously authorised can be captured. If the capture is for a lesser amount, the remaining funds will be released. ## Flow diagram Flow diagram image ## Api Parameters # Purchase API (v1) Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/purchase api-reference/en/open-api-config/server-to-server/purchase.json POST /api/v1/server-to-server-interface/payment The API captured amount immediately after authorization. Notice: Purchase API (v1) is scheduled for deprecation. [Use v2](/api-reference/en/server-to-server/purchasev2) for future integrations. ## Key Points * The Purchase API processes and completes payments instantly by capturing and authorizing funds at the same time. * This API is ideal for transactions where the amount is fixed, and the payment must be finalized instantly, such as online retail purchases or digital goods sales. * After a successful purchase, the transaction can be refunded if necessary, allowing the merchant to return the funds to the customer. ## Flow diagram Flow diagram image ## Api Parameters # Purchase API (v2) Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/purchasev2 api-reference/en/open-api-config/server-to-server/purchasev2.json POST /api/v1/server-to-server-interface/paymentv2 The API captured amount immediately after authorization. ## Key Points * The Purchase API processes and completes payments instantly by capturing and authorizing funds at the same time. * This API is ideal for transactions where the amount is fixed, and the payment must be finalized instantly, such as online retail purchases or digital goods sales. * After a successful purchase, the transaction can be refunded if necessary, allowing the merchant to return the funds to the customer. ## Flow diagram Flow diagram image ## Api Parameters # Refund API Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/refund api-reference/en/open-api-config/server-to-server/refund.json POST /api/v1/server-to-server-interface/refund The Refund API is used to return funds to the customer after a successful purchase or capture transaction. Note: Refunds are not supported for the following payment methods: PayPay, Pay-Easy, and Konbini. ### Key Points * The Refund API allows the merchant to reverse a transaction, sending the funds back to the customer’s payment method. * This API is typically used in scenarios such as order cancellations, product returns, or when a customer disputes a charge. * Refunds can be partial or full, depending on the amount specified in the refund request. If a partial amount is refunded, the remaining balance of the original transaction is still valid. ## Flow diagram Flow diagram image ## Api Parameters # Transaction Status API Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/transaction-status api-reference/en/open-api-config/server-to-server/transaction-status.json GET /api/v1/server-to-server-interface/transaction/status/{transactionId} The Transaction Status API is used to retrieve the current status of a specific transaction, including pre-authorization, capture, refund, or void transactions. ### Key Points * The transactionId is required to query the status of the specific transaction. * The API will return detailed information about the transaction, including its current status and any relevant error codes or messages. * This API is essential for tracking and managing transaction lifecycles, ensuring that transactions are completed successfully or identifying any issues that require attention. ## Api Parameters # Void Authorization API Source: https://docs.paymentoptions.com/api-reference/en/server-to-server/void-authorization api-reference/en/open-api-config/server-to-server/void-authorization.json POST /api/v1/server-to-server-interface/void The Void Authorization API is used to cancel a previously authorized payment before the funds are captured, releasing the hold on the customer’s account. ### Key Points * The Void Authorization API is crucial when a decision is made not to proceed with a transaction that has been authorised but not yet captured. * Once the authorization is voided, the funds that were held on the customer’s account are released, making them available to the customer again. * This API is typically used in scenarios where an order is cancelled before fulfilment or if there’s a change in transaction details requiring re-authorisation. ## Flow diagram Flow diagram image ## Api Parameters # Cancel Subscription API Source: https://docs.paymentoptions.com/api-reference/en/subscription/cancel-subscription api-reference/en/open-api-config/subscription/cancel-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/cancel The Cancel Subscription API allows merchants to permanently stop a customers subscription, preventing any future billing cycles and services. ### Key Points ### Cancel a Subscription * This API cancels a subscription, stopping all future billing and services for the customer. Once cancelled, the subscription cannot be resumed. * Canceling a subscription typically reflects the customer's request to terminate the service or end the billing agreement. ### Subscription Status * After cancellation, the subscription status changes to cancelled. * The cancellation becomes effective immediately, and no further billing cycles will be processed. ### Required Parameters * **Subscription ID:** The unique identifier of the subscription to be resumed. ## Flow diagram Flow diagram image ## Api Parameters # Create Subscription API Source: https://docs.paymentoptions.com/api-reference/en/subscription/create-subscription api-reference/en/open-api-config/subscription/create-subscription.json POST /api/v1/server-to-server-interface/subscription/payment The Create Subscription API allows merchants to set up recurring billing for customers, offering flexible plans with various billing intervals, trials, and discounts. ### Request Example of Subscription Creation ```json theme={null} "subscription": { "plan_name": "", "plan_desc": "", "cycle_type": "", "subscription_end_type": "CYCLE", "cycle_interval": , "max_cycle_count": , "has_trial_period": , "trial_period_duration_type": "DAYS", "trial_period_duration": , "has_discount": , "discount_percentage": , "discount_duration": } ``` ### Key Points ### Subscription Creation * This API enables the setup of subscription plans, allowing for automatic recurring payments. It supports various billing cycles and flexible configurations such as discounts and trial periods. ### Subscription Configuration * Merchants can define custom plans, including: Plan Name and Description. * Cycle Type: Billing can be based on days, weeks, months, etc. * Cycle Interval: Defines the frequency of billing (e.g., every 2 days, every month). * Max Cycle Count: Sets the maximum number of billing cycles. * Trial Period: Option to offer a trial period before the subscription starts. * Discounts: Ability to apply discounts for a set number of billing cycles. ## Flow diagram Flow diagram image ## Api Parameters # Pause Subscription API Source: https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription api-reference/en/open-api-config/subscription/pause-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/pause The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed. ## Key Points ### Pause a Subscription * Merchants can use this API to pause a subscription, which stops future billing for the customer until the subscription is resumed. * During the paused period, the subscription remains active but will not trigger billing or provide services unless resumed. ### Subscription Status * The subscription will change to paused status in the system. * No billing cycles will be processed while the subscription is paused, but the merchant retains control over when to resume the subscription. ### Required Parameters * Subscription ID: The unique identifier of the subscription to be paused. ## Flow diagram Flow diagram image ## Api Parameters # Resume Subscription API Source: https://docs.paymentoptions.com/api-reference/en/subscription/resume-subscription api-reference/en/open-api-config/subscription/resume-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/resume The Resume Subscription API allows merchants to reactivate a previously paused subscription, resuming the billing cycle and associated services for the customer. ### Key Points ### Resume a Subscription * Merchants can use this API to resume a subscription that was previously paused, restoring regular billing and service. * Once resumed, the subscription will return to its active status, and future billing cycles will proceed as originally scheduled. ### Billing Cycle and Status * The subscription will be reinstated to the active status, and billing will pick up from where it left off. If the next billing cycle is due, it will be processed automatically. * Any discounts or trial periods configured in the original subscription will continue as initially set. ### Required Parameters * Subscription ID: The unique identifier of the subscription to be resumed. ## Flow diagram Flow diagram image ## Api Parameters # Subscription Details API Source: https://docs.paymentoptions.com/api-reference/en/subscription/subscription-details api-reference/en/open-api-config/subscription/subscription-details.json GET /api/v1/server-to-server-interface/subscription/{subscription_id} The Subscription Details API is used to retrieve detailed information about a specific subscription, including its current status, billing history, and upcoming payments. ### Key Points ### Retrieve Detailed Subscription Data: * This API provides comprehensive information on an individual subscription, such as: * Subscription ID * Plan Name and Description * Status (active, expired, cancelled) * Start Date, End Date, and Next Billing Date * Cycle Interval (e.g., monthly, every 2 days) * Trial Period and Discount Information * Billing History: Details of past payments, including amounts and dates ### Subscription ID * The Subscription ID must be provided in the URL to retrieve the details of a specific subscription. # Subscription List API Source: https://docs.paymentoptions.com/api-reference/en/subscription/subscription-list api-reference/en/open-api-config/subscription/subscription-list.json GET /api/v1/server-to-server-interface/subscription/list The Subscription List API allows merchants to retrieve a list of all active, cancelled, or expired subscriptions, providing an overview of their customers subscription statuses. ### Notes There is no request payload required for this API. Simply ensure that the correct authentication details (API key, etc.) are included in the request headers. | **Header** | **Description** | | :-------------- | :----------------------------------------------------------------------------------------- | | `x-api-key` | Provided along with credentials. | | `Authorization` | Live API Key obtained from merchant details on PO Gateway. | | `Content-Type` | Indicates that all response attributes will be in JSON format (set to `application/json`). | ### Key Points ### Retrieve Subscription Data * The Subscription List API helps merchants track the status of all subscriptions plans, including active, cancelled, or expired subscriptions. ### Subscription Data - Each subscription record includes * Subscription ID * Plan Name and Description * Current Status (active, expired, or canceled) * Start Date and End Date * Cycle Interval and Next Billing Date * Trial and Discount Information (if applicable). # Generate Token API Source: https://docs.paymentoptions.com/api-reference/en/tokenization/generate-token api-reference/en/open-api-config/tokenization/generate-token.json POST /api/v1/server-to-server-interface/payment The Generate Card Token API is used to tokenize sensitive card information during the Purchase or Authorization process, allowing secure transactions without exposing the actual card details. ### Key Points * Tokenising a card allows for repeated transactions without needing to re-enter the card details, improving both security and user experience. * The generated token can be used for both Purchase and Authorization transactions, providing flexibility for different types of payments. * Important parameters typically include: Card Number, Expiry Date, CVV, Customer Information. ## Flow diagram Flow diagram image ### Notes `store_payment_method`: Must be set to `true` in the payload to store the card token for future use. ```json Request Example theme={null} { "payment_method": { "type": "scheme", "store_payment_method": true } ``` Setting `store_payment_method` to `true` ensures that the card token is stored for future transactions without needing to re-enter card details. ```json Response Example theme={null} { "transaction_details": { "id": "", "ref": , "timestamp": "yyyy-mm-ddThh:mm:ss.000Z", "merchant_txn_ref": "", "stored_payment_method_id": "094db781-fabc-4c6d-8fcd-18bee06a527a" } } ``` The `stored_payment_method_id` can be used in the Use of Card Token API for future transactions without needing to re-enter card details. ## Api Parameters # Use Token API Source: https://docs.paymentoptions.com/api-reference/en/tokenization/use-token api-reference/en/open-api-config/tokenization/use-token.json POST /api/v1/server-to-server-interface/payment The Card Token is used to securely complete a Purchase or Authorization transaction without needing to re-enter sensitive card details. This tokenised approach improves security and user experience. ### Key Points * Once a card token is generated, it can be used to execute Purchase or Authorization transactions. * The card token replaces the need for actual card details, ensuring that sensitive data is never exposed during the transaction. * This method is commonly used for: One-click payments, Recurring transactions (e.g., subscriptions), Stored customer payment details. ## Flow diagram Flow diagram image ## Api Parameters ### Card Token Use the `stored_payment_method_id` (generated during token creation) in the payload to complete the transaction. ```json Request Example theme={null} "payment_method":{ "type":"scheme", "stored_payment_method_id": "094db781-fabc-4c6d-8fcd-18bee06a527a" }, ``` The `stored_payment_method_id` is the token generated from the card tokenization process and is used to securely complete subsequent transactions. # E-Wallet Source: https://docs.paymentoptions.com/api-reference/en/wallet/wallet api-reference/en/open-api-config/wallet/e-wallet.json POST /api/v1/server-to-server-interface/hpp/generate/link When a merchant is configured for e.g GCash, the Hosted Payment Page (HPP) can generate an E-Wallet link that allows customers to complete their transaction using the GCash payment method. ### Key Points Merchant Configuration * The **Merchant ID** for GCash must be included in the payload along with the specific `payment_method` type set to `gcash`. * If the merchant is configured for GCash, the HPP will generate an E-Wallet payment link to enable customers to pay via GCash. [See all supported E-Wallets...](/documentation/paymentmethods/ewallets) E-Wallet Link * The HPP will display an option for customers to pay via GCash or generate an E-Wallet link for the customer to use. * This ensures a smooth process for customers using their GCash E-Wallet to complete transactions. # Webhook Handler Source: https://docs.paymentoptions.com/api-reference/en/webhook-handler Webhooks enable real-time notifications from the Payment Options Gateway API, allowing your application to automatically respond to events such as completed payments, failed transactions, or refunds. By setting up a webhook handler, you can receive these notifications directly and act on them instantly. ## **Purpose of Webhooks** Webhooks provide a mechanism for **event-driven** notifications, allowing you to integrate with Payment Options Gateway and receive updates as they happen. Instead of polling the API for transaction status or other updates, your server receives data automatically when certain events occur. *** ## **Configuring the Webhook URL** To receive webhook notifications, specify your webhook URL in the API request payload using the `return_url` parameter. This includes URLs for handling various outcomes, such as success, decline, and cancellation. ### **Example: Adding the Webhook URL in the Payload** In the request payload, define the URLs as follows: ```json theme={null} "return_url": { "webhook_url": "< Webhook url >", "success_url": "http://www.successurl.com/", "decline_url": "http://www.declineurl.com/", "cancel_url": "http://cancelurl.com/" } ``` ## **Webhook URL Parameters** Define the following URLs within the `return_url` parameter in your API payload: * **webhook\_url**: The URL where webhook events will be sent. * **success\_url**: The URL customers are redirected to after a successful transaction. * **decline\_url**: The URL customers are redirected to if their transaction is declined. * **cancel\_url**: The URL customers are redirected to if they cancel the transaction. ## **Setting Up Your Webhook Handler** To start receiving webhooks from PO Gateway, follow these steps: Specify the URL on your server where you want to receive webhook events. This URL should be publicly accessible over HTTPS for security. Include your webhook URL in the `return_url` parameter as shown in the example above. Ensure that it’s properly registered in the API request payload for each transaction. Use a **secret key** or **signature verification** to authenticate incoming webhook requests. This helps ensure the requests originate from PO Gateway and have not been tampered with. Write a function in your server-side application to process the incoming webhook payload. This function should parse the JSON payload, validate the signature (if provided), and respond with a 200 OK status to acknowledge receipt. Use the sandbox environment or test mode to simulate webhook events and ensure your webhook handler works as expected before going live. # Onboarding Checklist Source: https://docs.paymentoptions.com/documentation/checklist To successfully create a merchant account with Payment Options, you will need to provide certain documents based on your business type. Please use the checklist below to ensure all necessary documents are prepared and submitted during the onboarding process. ## **Checklist of Required Documents** Here's a detailed list of documents that you'll need to provide, categorized by business type. Make sure to gather all relevant documents to avoid delays during the onboarding process. * **Name** * **Personal Address** * **Date of Birth** * **Face Image** * **Gender** * **ID CARD**: Passport, My Number, or Driver's License * **Name** * **Personal Address** * **Date of Birth** * **Face Image** * **Gender** * **ID CARD**: Passport, My Number, or Driver's License * **Email Address** * **Phone Number** * **Business Certificate**: Proof of business registration. * **ID Card** * **Screenshot of Bank Account Details**: Must include bank account number and name. * **Business Address**: If using a rental address, provide proof of rental. * **Website URL** * **Email Address** * **Phone Number** * **Company History**: Full business background and relevant matters. * **ID Card for Boss and UBO**: Identification details as mentioned for Business Owners. * **Screenshot of Bank Account Details**: Must include bank account number and name. * **Shareholder Registry** * **Proof of Business Address** * **Website URL** * **Email Address** * **Phone Number** ## **Final Steps** Please ensure that all required documents are submitted during the account creation process to avoid delays. Once you've gathered all the necessary documents, you can proceed to the [Create an Account](https://me.paymentoptions.com/onboarding/sign-up) form. If you need assistance or have questions regarding document submission, please [contact our support team](./support/contact) for further guidance. # Create An Account Source: https://docs.paymentoptions.com/documentation/createaccount Welcome to the Payment Options account creation page! This platform is designed to provide merchants with an intuitive and secure process for setting up their accounts. Whether you are a small business owner or a large-scale enterprise the account creation process ensures a smooth and hassle-free onboarding experience tailored to your needs. ## **Why Choose Payment Options?** Our system combines ease of use, security, and versatility to make your registration process seamless. **1. Localization** * Description: Provide the ability for users to choose their preferred language (English or Japanese) during the onboarding process. * Implementation Details: * Display a language selection option at the beginning of the onboarding process. * Ensure all steps, forms, and notifications are fully translated into the selected language. * Provide an option to switch the language at any point without losing progress. **2. Merchant Account & Password Creation** * Description: Allow users to create a secure merchant account with a unique username and password. * Implementation Details: * Username: Ensure the username is unique and validate it for format and length. * Password: Enforce strong password policies (e.g., minimum 8 characters, at least one uppercase letter, one number, and one special character). **3. Email Verification through OTP** * Description: Ensure the user’s email is valid by sending a one-time password (OTP) for verification. * Implementation Details: * Send a unique OTP to the email provided during registration. * Allow the user to input the OTP into a verification field. **4. Session Management** * Users are allowed to log off and continue the registration process at a later time. * Implementation Details: * Store progress in real-time and allowing users to resume from where they left off. * Implement a secure authentication mechanism for re-login. * Provide a session timeout for inactive users to enhance security. **5. Terms of Usage** * Require users to review and accept the Privacy Policy, Terms and Conditions. * Implementation Details : * Present the Terms & Conditions in a scrollable, easy-to-read format. * Include a mandatory checkbox to indicate acceptance. **6. Pending Application Deletion** * Description: Remove incomplete applications that do not meet requirements within 7 days. * Implementation Details: * Automate deletion of data after 7 days if no action is taken. **7. Interactive Website Tour** * Provided a guided tutorial for new users to understand system features. * Implementation Details: * Implemented an interactive tour with tooltips and highlights for key features. * Offer an option to skip the tour at any time. **8. Password Management** * Allow users to change or reset their password. * Implementation Details : * The user has a feature to change his password any time. * Provided a Forgot Password option with email-based recovery. **9. Account Approval Notification** * Notify merchants on their primary contact email once their application is approved and a Merchant product has been created in DAS system. * Implementation Details: * Send an approval email with the Secret API Key securely embedded. # **Create an Account - Onboarding Steps** To successfully create your merchant account with Payment Options, please follow the detailed steps below. Our onboarding process is designed to be simple, intuitive, and efficient, offering the flexibility to self-onboard or work with a sales ([sales@paymentoptions.com.sg](mailto:sales@paymentoptions.com.sg)) representative if needed. By following these steps, you will be able to set up your account, verify your details, and start using Payment Options seamlessly. Before beginning the registration process, it’s important to ensure you have all the necessary documents prepared. This checklist includes: * **Business Documentation**: Business license, registration certificate, and tax identification number. * **Stakeholder Details**: Information about business owners and shareholders. * **Payment Information**: Bank account details for payouts. * **Contact Information**: Valid email address and phone number for communication. Having these documents ready will make the onboarding process faster and more efficient. Self Onboarding Process ## **Onboarding Steps** You can choose to meet with a sales representative to guide you through the process or self-onboard using the [online onboarding form](https://me.paymentoptions.com/onboarding/sign-up). Start by setting up your merchant account. You will be asked to provide a secure password and verify your email through OTP. Once verified, you can proceed with the registration process. In this section, enter key details about your business, including business name, address, and type of business. This information helps us understand your business structure. Please note that documents proving **Company Registration**, **Business Certificate**, **Certificate of Incorporation**, **Share Register**, and **Proof of Address** are required for this step. Provide details about the main stakeholders in your business. This may include the business owner, partners, or other key individuals involved in operations. * **Verify Your Identity**: To complete KYC (Know Your Customer), verify your identity through our secure identity verification process. This step is essential for compliance. Please refer to the [Onboarding Checklist](./checklist) section to ensure you have all the necessary documents ready for verification. Enter your payout details to ensure seamless processing of funds. This includes providing your bank account information or other payment options for receiving payouts. Please note that a **Bank Statement** or **Statement of Account** (dated within the last 3 months) is required for this step. Select the payment acceptance you want to enable for your business. You will need to provide a description of your products, processing website URL, and the countries where you plan to accept payments. Review all the information provided to ensure accuracy. Accept the Terms & Conditions to complete your application. If not accepted within 7 days, the application will be flagged for deletion. Once all steps are completed, you will receive an email notification regarding the status of your application. Upon approval and MID creation, a Secret API Key will be sent to you via email for secure integration. Click here to create an account and start using Payment Options. If you need assistance or have questions regarding document submission, please [contact our support team](./support/contact) for further guidance. # Glossary Source: https://docs.paymentoptions.com/documentation/glossary This glossary provides definitions for common terms and concepts used throughout the Payment Options platform. Refer to this page for quick explanations to help you better understand the onboarding, payment, and security processes. ### **3D Secure (3DS)** A security protocol that requires additional verification during online transactions to prevent fraud and confirm the cardholder's identity. 3DS may prompt the customer to authenticate using OTP, fingerprint, or other methods. ### **API (Application Programming Interface)** A set of functions and protocols that allows different software applications to communicate with each other. APIs enable merchants to integrate Payment Options with their own systems. ### **Authorization** A transaction type where the payment gateway checks if the cardholder has sufficient funds before processing the payment. It temporarily holds the funds until the merchant captures or completes the transaction. ### **Capture** The process of completing an authorized transaction, moving funds from the cardholder's account to the merchant's account. ### **DAS Gateway** A structured system for managing payments, transactions, and account settings. It includes parts like DASPOS (account management), DASFINANCE (financial reporting), and DASDOC (documentation and guides). ### **E-Wallet** A digital wallet that allows customers to store payment information and make online payments securely. Supported e-wallets include Google Pay, Apple Pay, PayPay, and GCash. ### **Hosted Payment Page (HPP)** A secure, customizable payment page hosted by Payment Options that allows customers to enter their payment information directly, ensuring PCI compliance. ### **Issuer** The financial institution that issues the cardholder’s payment card. The issuer is responsible for approving or denying transactions. ### **KYC (Know Your Customer)** A verification process required by financial institutions to identify and verify the identity of customers. KYC is used to prevent fraud and ensure compliance with regulations. ### **Merchant** An individual or entity that sells goods or services and uses the Payment Options platform to process payments. ### **OTP (One-Time Password)** A temporary, unique password sent to a user for authentication. OTPs are commonly used for email verification and secure access. ### **Partner** An organization or individual registered on the Payment Options platform with the ability to onboard merchants and manage transactions on their behalf. ### **Payment by Link (PBL)** A feature that allows merchants to generate and send a payment link to customers. Customers can use this link to securely complete the transaction online. ### **PCI DSS (Payment Card Industry Data Security Standard)** A set of security standards established to protect card information during and after transactions. Compliance with PCI DSS ensures that merchants handle payment data securely. ### **Referral Code** A unique code assigned to partners that allows them to refer merchants to the Payment Options platform. This code tracks successful onboarding through referrals. ### **Reseller** A type of partner account that allows individuals or businesses to onboard merchants on behalf of Payment Options, often including additional account management features. ### **Tokenization** A security feature that replaces sensitive card details with a unique token. This token can be used in place of card data during transactions, reducing the risk of data breaches. ### **Transaction Status** The current state of a transaction, which can be authorized, captured, refunded, or voided. Merchants can check transaction status via the API or gateway dashboard. ### **UBO (Ultimate Beneficial Owner)** The person who ultimately owns or controls a business. This individual is often subject to KYC verification. ### **Virtual Terminal** An online interface that allows merchants to manually enter card details to process payments. Virtual terminals are useful for in-person or phone transactions. ### **Webhook** A tool used by the Payment Options API to send real-time notifications to merchants about specific events, such as transaction updates or payment confirmations. *** This glossary provides a quick reference for key terms within Payment Options. For further clarification on specific terms, please refer to the relevant sections in the documentation or contact support. # Introduction Source: https://docs.paymentoptions.com/documentation/introduction Welcome to the Payment Options API Documentation! Our platform provides a powerful, secure, and highly adaptable solution for integrating payment capabilities into your application or website. Our APIs designed to cater to the diverse needs of merchants, developers, and partners. it empowers businesses to seamlessly process transactions while ensuring an exceptional user experience. With our APIs, you gain access to a wide range of features, including support for multiple payment methods, scalability to handle high transaction volumes, and robust security measures that comply with industry standards. Whether you're a merchant looking to expand your payment options, a developer seeking straightforward integration tools or a partner aiming to enhance your service offerings to your clients, our platform is designed to meet your requirements. Let's start with our documentation to discover how our API can streamline your payment processes, accelerate your development workflow, and provide a secure integration for your business transactions. ## Why Use the Payment Options API? Accept a wide range of payment methods, including cards, e-wallets, and local payment options. Our API ensures transactions are protected with 3DS, secure tokenization, and compliance with the latest PCI DSS standards. We support multi-currency transactions, allowing businesses to accept payments from around the world. Our APIs can be tailored to fit your business needs, whether it's through the use of a hosted payment page or deep integration into your system. ## Getting Started To begin using the Payment Options API, we recommend starting with the following steps: Integration with PaymentOptions APIs can commence as soon as your account is approved. The process includes four key steps: * Sign Up : Create a PaymentOptions account. * Obtain API Keys: Retrieve your API keys to enable PaymentOptions to authenticate your integration’s API requests. * Integrate and Test : Enter your API keys into the PaymentOptions API references and interact with the PaymentOptions API. * Verify Integration : Send an API request to ensure everything is functioning correctly. 1. **Create an Account**: * Sign Up as a Merchant: Begin by registering on our platform to gain access to our payment services. * Once registered, you will receive credentials to access the API and dashboard tools tailored to your needs. 2. **Review the Onboarding Checklist**: * Prepare Your System: Verify that your platform meets all technical and compliance requirements for live transactions. * The checklist includes key steps like configuring your API keys, setting up webhooks, and ensuring proper testing of your payment flow. * Address any prerequisites, such as security configurations or system dependencies, before proceeding to integration. 3. **Explore the API**: * Postman Collections: Access our pre-built Postman collections to experiment with sample API requests and responses. * Learn how to authenticate, handle payment workflows and manage errors using clear documentation and API collections. ### Interactive Features Test API requests and see responses directly from the documentation. Use ready-to-use code examples in Python, JavaScript, PHP, and more. ### Next Steps * [Create An Account](./createaccount): Head over to get started with Payment Options. * [Onboarding Checklist](./checklist): Review the checklist before going live. * [API References](/api-reference/en/introduction): Explore detailed integration information. # Overview Source: https://docs.paymentoptions.com/documentation/overview The Payment Options API is a interface that enables merchants, developers, and payment service providers to integrate and manage various payment methods into their platforms seamlessly. It is typically used in e-commerce and digital services to enhance user experiences by providing multiple payment options. Payment Options Documentation ### What You'll Find in This Documentation This documentation is organized into well-structured sections designed to guide you through the integration and usage of our payment gateway quickly and efficiently. Each section includes: * **Detailed Guides**: Step-by-step instructions to help you understand integration process. * **Code Examples**: Ready-to-use code snippets in multiple programming languages for a smoother development experience. * **Interactive Features**: Postman collections to test and understand functionality in real-time. Whether you are a beginner or an experienced developer, this documentation is crafted to provide all the resources and insights you need for a successful integration. ### Documentation Overview Guides for account creation, onboarding, and go-live readiness. Learn how to implement online payments, Pay By Link, QR code payments, virtual terminal usage, subscription management, and more. Detailed information on the payment methods our gateway supports, including card schemes, e-wallets, and secure payments. Technical documentation for each API, including request/response formats and code samples for common use cases like authorization, capture, refunds, and tokenization. Troubleshooting section for error responses and HTTP status codes. Stay up to date with new features, enhancements, and updates. Access our comprehensive user guides, FAQs, and contact our support team for further assistance. ### Key Features **Multiple Payment Methods**: We are offering to our Merchants/customers a seamless checkout experience with a variety of payment options: * Card Payments: Accept major credit and debit cards with ease. * Pay By Link: Generate secure, shareable payment links for instant payments. * QR Code Payments: Enable fast, contactless payments through QR codes. * Digital Wallets: Support for popular wallets like Apple Pay and Google Pay for added convenience. * Subscriptions: Effortlessly manage recurring billing for subscription-based services. **Scalability**: Our API is capable of handling high transaction volumes without compromising performance: * Ideal for start-ups to enterprise-level businesses. * Built to adapt to your business's expanding needs with no downtime. **Security**: * 3D Secure (3DS): Enhanced protection for online card transactions. * PCI DSS 4.0 Compliance: Adherence to the latest Payment Card Industry standards to safeguard sensitive data. * Real-time fraud detection and prevention tools like fraud wall to protect against threats. **Developer-Friendly**: Simplify the integration process with: * Comprehensive and well-documented API References for quick implementation. * Pre-built Postman Collections to test and deploy API endpoints effortlessly. * Sample code snippets in multiple programming languages to minimize development time. * Active Business support and community forums for seamless troubleshooting. # Create Partner Account Source: https://docs.paymentoptions.com/documentation/partner/createpartner To create a partner account with Payment Options, follow these steps to ensure a smooth onboarding experience. As a partner, you will be able to manage your account, onboard merchants on your behalf, and more. Refer to the checklist below to ensure all necessary details are provided during the onboarding process ## **Features** **1. Localization** * Description: Provide the ability for partners to select their preferred language (English or Japanese) during the onboarding process. * Implementation Details: * Display a language selection option at the beginning of the onboarding process. * Ensure all steps, forms, and notifications are fully translated into the selected language. * Allow partners to switch the language at any time without losing progress. **2. Partner Account & Password Creation** * Description: Enable partners to create a secure account with a unique username and password. * Implementation Details: * Username: Ensure the username is unique and validate it for format and length. * Password: Enforce strong password policies (e.g., minimum 12 characters, at least one uppercase letter, one number, and one special character). **3. Email Verification through OTP** * Description: Ensure the user’s email is valid by sending a one-time password (OTP) for verification. * Implementation Details: * Send a unique OTP to the email provided during registration. * Allow the user to input the OTP into a verification field. **4. Session Management** * Enable partners to log off and resume the registration process later. * Implementation Details: * Store progress in real-time and allowing users to resume from where they left off. * Implement a secure authentication mechanism for re-login. * Provide a session timeout for inactive users to enhance security. **5. Terms of Usage** * Require partners to accept the Terms and Conditions and Privacy Policy. * Implementation Details : * Present the Terms & Conditions in a scrollable, easy-to-read format. * Include a mandatory checkbox to indicate acceptance. **6. Pending Application Deletion** * Description: Automatically delete incomplete partner applications after 7 days of inactivity. * Implementation Details: * Automate deletion of data after 7 days if no action is taken. **7. Interactive Website Tour** * Offer a guided tutorial to familiarize new partners with system features. * Implementation Details: * Implemented an interactive tour with tooltips and highlights for key features. * Offer an option to skip the tour at any time. **8. Password Management** * Enable partners to change or reset their password at any time. * Implementation Details : * The user has a feature to change his password any time. * Provided a Forgot Password option with email-based recovery. **9. Account Approval Notification** * Notify partners once their application is approved, including their Partner ID and relevant credentials. * Implementation Details: * Send an approval email with the Secret API Key securely embedded. Self Onboarding Process ## **Steps to Create a Partner Account** Follow these steps to complete your partner account setup: Begin by meeting with a sales representative or self-onboard through the online portal. Set up your account with a unique username and password. You’ll receive an OTP to verify your email address. Provide essential details about your business, including name, address, and any relevant industry information. Please note that documents proving **Company Registration**, **Certificate of Incorporation**, **Share Register**, or **Proof of Address** are required for this step. Add information about key stakeholders, including IDs and roles within the business. * **Verify Your Identity**: To complete KYC (Know Your Customer), verify your identity through our secure identity verification process. This step is essential for compliance. Please refer to the [Partner Onboarding Checklist](./partnerchecklist) section to ensure you have all the necessary documents ready for verification. Enter your payout details to ensure seamless processing of funds. This includes providing your bank account information or other payment options for receiving payouts. Please note that a **Bank Statement** or **Statement of Account** (dated within the last 3 months) is required for this step. Review all entered information, agree to the Terms of Usage, and submit your application. *** ## **Final Steps** Please ensure all required information is provided and documents are submitted accordingly. After your application has been reviewed and approved, you will receive an email notification with a referral code and further instructions. Click here to create an account and start using Payment Options. If you need assistance or have questions regarding document submission, please [contact our support team](./support/contact) for further guidance. # Partner Onboarding Checklist Source: https://docs.paymentoptions.com/documentation/partner/partnerchecklist To successfully create a partner account with Payment Options, you will need to provide certain documents based on your business type. Use the checklist below to ensure all necessary documents are prepared and submitted during the onboarding process. ## **Checklist of Required Documents** Here's a detailed list of documents required, categorized by business type. Gathering all relevant documents beforehand will help avoid delays during the onboarding process. * **ID Card** * **Bank statement (latest 3 months) Partner (Entity)** * **Email Address** * **Phone Number** * **Business Registration Document** * **History of All Matters(only Japan)** * **ID Card of Directors(s) and UBO (Ultimate Beneficial Owner)** * **Bank statement (latest 3 months) Partner (Sole Proprietor)** * **Shareholder Registry** * **Proof of Address** * **Website URL** * **Email Address** * **Phone Number** * **Business Registration Document** * **ID Card** * **Bank statement** * **Proof of Address (If there is registered office)** * **Email Address** * **Phone Number** ## **Final Steps** Please ensure that all required documents are submitted during the account creation process to avoid delays. Once you've gathered all the necessary documents, you can proceed to [Create An Account](https://me.paymentoptions.com/onboarding/sign-up). If you need assistance or have questions regarding document submission, please [contact our support team](./support/contact) for further guidance. # Apple Pay Source: https://docs.paymentoptions.com/documentation/paymentmethods/applepay Apple Pay allows customers to complete purchases quickly and securely using cards stored in their Apple Wallet. Once enabled for a merchant, our Hosted Payment Page (HPP) dynamically displays the Apple Pay button when accessed on a supported Apple device or browser (e.g., Safari on iOS/macOS). ## Overview Apple Pay offers a seamless and secure checkout experience using Face ID, Touch ID, or device passcode. Customers can complete payments without entering card details, helping increase conversion rates and reduce cart abandonment. *** ## How It Works When a customer clicks the **Apple Pay** button on the Hosted Payment Page (HPP), the flow is as follows: 1. The **Apple Pay payment sheet** is displayed with their default or selected card. 2. The customer confirms the payment using biometrics or passcode. 3. Apple returns a **secure, encrypted token**. 4. The HPP submits the token to the PO Gateway. 5. PO processes the token via the configured acquirer and returns the result. > Apple Pay ensures PCI compliance by handling all sensitive payment data securely on the user's device. *** ## Web Payment Flow Figure 1 – Apple Pay Web Payment Flow **Figure 1.** A typical Apple Pay flow on our Hosted Payment Page *** ## Supported Devices & Browsers The Apple Pay button will only appear on the Hosted Payment Page (HPP) when all of the following conditions are met: * The merchant is enabled for Apple Pay in their configuration. * The customer is using a supported Apple device and browser, including: * iPhone, iPad, or Mac * Safari browser * Apple Wallet with at least one eligible payment card > Note: If any of these conditions are not met, the Apple Pay button will not be displayed. *** ## Key Points ### Merchant Configuration * Merchant must be **enabled for Apple Pay**. * The **Merchant ID (DASMID)** must be passed in the Hosted Payment Page (HPP) payload. * Once configured, the **Apple Pay button** appears automatically for eligible customers. ### Button Logic * The Hosted Payment Page (HPP) dynamically checks if the customer is on a supported device/browser. * If all conditions are met, the Apple Pay button is displayed. If not, the button remains hidden. *** ## Try It Out: Hosted Payment Page with Apple Pay Test how Apple Pay behaves within our Hosted Payment Page (HPP) by accessing the live demo endpoint below: [**Try the Hosted Payment Page Endpoint**](/api-reference/en/hpp/generate-link) *** ## Notes * No frontend Apple Pay code is needed — the Hosted Payment Page (HPP) manages display and integration automatically. * Apple Pay only appears if the device supports it and Apple Wallet is configured. * This method is **PCI-light** and secure by default. *** ## Related Links * [Apple Pay Developer Overview](https://developer.apple.com/apple-pay/) * [Hosted Payment Page Overview](/documentation/payments/onlinepayment) * [Payments Section](/documentation/payments/paymentintro) *** Need assistance enabling Apple Pay? Reach out to your account manager or Contact [Support](/support/contact). # Card Schemes Source: https://docs.paymentoptions.com/documentation/paymentmethods/cardschemes This section provides an overview of the credit card schemes supported by our payment gateway. Understanding the various card schemes is essential for merchants as they integrate with our API and seek to accommodate diverse customer payment preferences. ## **Supported Card Schemes** Our payment gateway supports a variety of major credit card schemes to ensure a seamless payment experience for your customers. For information on Apple Pay and Google Pay, please refer to the **E-Wallets** section. | Card Scheme | Description | Supported Regions | | :------------------- | :------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------- | | **Visa** | One of the largest credit card networks globally, widely accepted for online and in-store transactions. | Worldwide | | **MasterCard** | Another leading global card scheme known for its secure payment processing and wide acceptance. | Worldwide | | **American Express** | Known for its premium services and rewards programs, often used for high-value transactions. | Worldwide, but with more limited acceptance in some regions | | | | | | **JCB** | A Japan-based card scheme popular in Asia, particularly in Japan, with growing acceptance worldwide. | Asia-Pacific and select global markets | ## **Upcoming Card Schemes** We’re expanding our supported card schemes to offer even more payment options for your customers. Below are the upcoming schemes we are integrating into our platform. | Card Scheme | Description | Supported Regions | | :-------------- | :---------------------------------------------------------------------------------------------- | :-------------------------------------------------------------- | | **Diners Club** | Known for its travel and entertainment benefits, accepted at select merchants. | Limited acceptance, primarily in the U.S. and certain countries | | **Discover** | A U.S.-based card scheme that offers cash-back rewards and is gaining international acceptance. | Primarily in the U.S., expanding globally | *** ### **Merchant Eligibility for Card Schemes and E-Wallets** Merchants’ access to specific card schemes and e-wallets varies based on their account setup and region. To view your eligible payment options: * **Product Details**: Check the **product details** section for a detailed view of the supported card schemes and e-wallets specific to your region and business type. > You may refer to the screenshots provided for further guidance on navigating these sections in your account. *** ## **Key Features of Supported Card Schemes** All supported card schemes comply with PCI DSS (Payment Card Industry Data Security Standard) to ensure secure transaction processing. Our payment gateway supports various transaction types, including: * **Authorizations** * **Captures** * **Refunds** * **Chargebacks** Transactions can be processed in multiple currencies depending on the card scheme and regional regulations. ## **Implementation Notes** * **Identify Card Scheme**: Ensure that your integration correctly identifies the card scheme being used by the customer to facilitate proper transaction processing. * **Use Appropriate API Endpoints**: Utilize the appropriate API endpoints for each card scheme as detailed in the API documentation. * **Additional Requirements or Fees**: Be aware of any additional requirements or fees associated with specific card schemes, such as AMEX’s higher transaction fees. Some card schemes may have specific compliance or fee requirements. Always refer to the latest documentation for updated information. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Currency Source: https://docs.paymentoptions.com/documentation/paymentmethods/currency This section outlines the currencies supported by our payment gateway, enabling merchants to effectively process transactions in their target markets. Understanding the available currency options is crucial for optimizing the customer payment experience. ## **Supported Currencies** Our payment gateway supports multiple currencies across different markets, helping merchants accommodate customers’ preferences and expand their reach. Below is a list of the supported markets and their corresponding currencies: | Market | Supported Currencies | | :------------ | :----------------------------------------------------------------------------------- | | **Japan** | JPY (Japanese Yen), USD (U.S. Dollar) | | **Hong Kong** | HKD (Hong Kong Dollar), PHP (Philippine Peso), JPY (Japanese Yen), USD (U.S. Dollar) | ## **Currency Details**

Description: The official currency of Japan, widely used for transactions within the country.

Usage: Suitable for merchants operating primarily in Japan.

Description: The primary currency of the United States, commonly accepted internationally.

Usage: Useful for merchants looking to attract customers who prefer to pay in U.S. dollars, particularly in Japan.

Description: The official currency of Hong Kong, a major financial hub in Asia, known for its stability and widespread acceptance.

Usage: Suitable for merchants operating in Hong Kong or targeting customers who prefer transactions in the local currency.

Description: The official currency of the Philippines, gaining importance in Hong Kong's diverse market.

Usage: Ideal for merchants targeting the Filipino community or conducting business in Hong Kong.

## **Implementation Notes** * **Currency Selection**: Ensure that your integration allows customers to select their preferred currency during the checkout process. * **Currency Conversion**: Be aware of any conversion fees that may apply if the transaction involves currency conversion. * **Compliance**: Ensure compliance with local regulations regarding currency transactions in each market. Currency conversion fees may vary by region and payment method. Be sure to check for any specific requirements or fees for each currency. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Supported E-Wallets Source: https://docs.paymentoptions.com/documentation/paymentmethods/ewallets E-wallets provide a convenient and secure way for customers to make payments, enhancing the overall shopping experience. This section offers an overview of the e-wallets supported by our payment gateway, helping merchants expand their payment options. Our payment gateway currently supports the following e-wallets, enabling seamless transactions for your customers. ### **Currently Supported E-Wallets** | E-Wallet | Description | | :-------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------- | | **[Google Pay](/documentation/paymentmethods/googlepay)** | A digital wallet platform that allows users to make payments using their Android devices, supporting various payment methods. | | **[Apple Pay](/documentation/paymentmethods/applepay)** | A mobile payment and digital wallet service by Apple, enabling users to make secure payments in stores, apps, and on the web. | | **PayPay** | A popular Japanese e-wallet service that allows users to make payments easily and earn rewards through various promotions. | | **GCash** | A leading e-wallet in the Philippines, enabling users to pay bills, shop online, and transfer money seamlessly. | | **PayEasy** | A convenient online payment method in Japan that allows users to pay at ATMs, online banking, or convenience stores. | | **Konbini** | A Japanese payment system that lets users pay for online purchases at convenience stores, ensuring quick and easy access. | ## **Implementation Notes** * **Integration**: Refer to the specific API documentation for integrating each e-wallet into your checkout process. * **Customer Experience**: Highlight the available e-wallet options at checkout to improve the user experience and encourage e-wallet usage. * **Testing**: Use the testing environment to simulate transactions with supported e-wallets before going live, ensuring a smooth customer experience. Remember to verify that your integration aligns with the specific guidelines and user flows of each e-wallet for optimal performance. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Google Pay Source: https://docs.paymentoptions.com/documentation/paymentmethods/googlepay Google Pay allows customers to complete transactions quickly using their saved credit or debit cards, bank accounts, or other payment methods stored in their Google Account. When enabled, our Hosted Payment Page (HPP) dynamically displays the **Google Pay** button, providing a smooth, one-click checkout experience. ## Overview The **Google Pay API** enables fast, secure checkout and provides access to hundreds of millions of cards saved in Google Accounts worldwide. Once a merchant is configured for Google Pay, the Hosted Payment Page (HPP) will automatically show the Google Pay button when the customer is using a supported device and browser (e.g., Chrome with Google Pay enabled). *** ## How It Works When a customer clicks the **Google Pay** button on the Hosted Payment Page (HPP), the following flow occurs: 1. The **Google Pay payment sheet** opens and displays the customer’s saved payment methods. 2. The customer a preferred payment method (e.g., card) and confirms the payment. 3. Google Pay generates and returns a **secure token** that represents the selected payment details. 4. The Hosted Payment Page (HPP) forwards this token to PO payment gateway for processing. 5. The transaction is completed through the configured acquirer, and the customer is redirected to the appropriate success or failure page, based on your integration settings. *** ## Web Payment Flow Figure 1 – Web payment flow **Figure 1**: Web payment flow for Google Pay transactions initiated via Hosted Payment Page. *** ## Supported Devices & Browsers Google Pay will only appear on the Hosted Payment Page (HPP) if the following conditions are met: * The merchant account supports Google Pay. * The user is using a compatible device: * Android device with Google Wallet and Chrome browser. * Desktop Chrome browser with Google Account and saved cards. * The user has at least one eligible card saved in Google Wallet. *** ## Key Points ### Merchant Configuration * The merchant must be **configured for Google Pay**. * The **Merchant ID (DASMID)** must be included in the Hosted Payment Page (HPP) payload. * If the configuration is correct, the **Google Pay button** appears automatically. ### Payment Button Logic * Google Pay will only be shown if: * The merchant account supports Google Pay. * The user is using a compatible browser (Chrome). * The user has Google Pay configured with eligible cards. *** ### Test the Hosted Payment Page with Google Pay You can test a Google Pay Hosted Payment Page (HPP) integration by trying out our API endpoint here: [**Try the Hosted Payment Page Endpoint**](/api-reference/en/hpp/generate-link) *** ## Notes * No additional development is needed if using the Hosted Payment Page — Google Pay is automatically handled and tokenized securely. * This approach keeps you PCI-light, meaning your system avoids directly handling sensitive card data — simplifying compliance with PCI DSS requirements. * If a customer is not eligible for Google Pay (unsupported browser or no saved cards), the button will **not appear**. *** ## Related Links * [Google Pay Developer Overview](https://developers.google.com/pay/api/web/overview) * [Hosted Payment Page Overview](/documentation/payments/onlinepayment) * [Payments Section](/documentation/payments/paymentintro) *** Need help enabling Google Pay? Contact [Support](/support/contact) or reach out to your account manager. # Secure Payment Source: https://docs.paymentoptions.com/documentation/paymentmethods/securepayment The Secure Payment section provides guidelines on ensuring a safe and trustworthy payment experience for your customers. By following best practices in security, merchants can protect sensitive data, minimize fraud risks, and comply with industry regulations ## **Key Security Features** Enhance security with 3DS authentication, which adds an extra layer of protection for online transactions. Replace sensitive card details with unique tokens to reduce the risk of data theft during transactions. Our gateway complies with PCI DSS (Payment Card Industry Data Security Standard), ensuring secure processing and storage of payment information. *** ## **3D Secure (3DS) Authentication** 3DS (3D Secure) authentication is a security protocol that protects merchants and customers by requiring additional verification during online payments. This process is commonly used to prevent fraud and validate the cardholder's identity. Secure Payment When a customer initiates a transaction, 3DS triggers a verification step with the card issuer. Depending on the level of risk, the customer may be required to authenticate using a password, OTP, fingerprint, or face recognition. This extra step helps confirm the identity of the cardholder, providing added security. Explore the 3D Secure Integration process and steps and try it out. ### **Benefits of 3DS** * **Reduced Fraud**: 3DS helps reduce fraudulent transactions by requiring additional verification. * **Liability Shift**: Successful 3DS authentication can shift liability for fraud-related chargebacks from the merchant to the card issuer. * **Improved Customer Confidence**: The added security layer gives customers confidence when shopping online. ## **Data Protection and Tokenization** **Tokenization** replaces sensitive card data with unique tokens that can only be used within our secure environment. This method ensures that customer card details are never exposed during payment processing. ### **Why Tokenization Matters** * **Enhanced Security**: Sensitive data is replaced with a token, which reduces the risk of data theft. * **Regulatory Compliance**: Tokenization helps merchants meet data protection regulations by securing payment information. * **Improved User Experience**: Tokenization allows customers to save their payment information for future transactions safely. ## **Compliance with PCI DSS** Our payment gateway complies with PCI DSS standards, which define strict security requirements for storing, processing, and transmitting payment information. Compliance with these standards ensures that our platform provides a secure environment for all transactions. All payment data is encrypted both in transit and at rest to protect against unauthorized access. Only authorized personnel have access to sensitive payment data, minimizing the risk of data breaches. Our systems undergo regular security audits to identify and mitigate potential vulnerabilities. ## **Best Practices for Secure Payments** * **Encourage 3DS Authentication**: Enable 3DS for high-risk transactions to enhance security. * **Review Transaction Logs**: Regularly monitor transaction logs to identify any suspicious activity. * **Educate Customers**: Encourage customers to keep their payment details safe and be vigilant against phishing attempts. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Test Cards Source: https://docs.paymentoptions.com/documentation/paymentmethods/testcards This document provides a list of test credit card details that merchants can use to simulate transactions while integrating with the payment gateway API. These test cards help ensure that your payment processing system functions correctly without real transactions. ## **Important Note** These test card details are only for testing purposes and cannot be used for actual transactions. Always ensure you are in the development environment before using these cards. For additional scenarios, please reach out our [Support Team](/support/contact). ## **Test Card Details** Below are the test card numbers for simulating different transaction scenarios: | Scenario | Description | Card Values | | :--------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------- | | **Successful frictionless 3DS** - Authorized Payment | Issuer assessment resulted in a frictionless 3DS authentication | **Visa**:4000000000001000
**Mastercard**:5200000000001005
**AMEX**: 340000000001007 | | **Successful 3DS challenge** - Authorized Payment | Issuer prompts a challenge in authentication, customer responds successfully | **Visa**:4000000000001091
**Mastercard**:5200000000001096
**AMEX**:340000000001098 | | **Failed frictionless 3DS authentication** | Issuer failed the 3DS authentication without offering a challenge | **Visa**:4000000000001018
**Mastercard**:5200000000001013
**AMEX**:340000000001015 | | **Failed challenged 3DS authentication** | Issuer prompts a challenge in authentication, customer responds with incorrect details (e.g., OTP, fingerprint) | **Visa**:4000000000001109
**Mastercard**:5200000000001104
**AMEX**:340000000001106 | | **Refused Payment** | The issuer refused the payment, if 3DS is used it’s frictionless | **Visa**:4000000000001042
**Mastercard**:5200000000001047
**AMEX**:340000000001049 | For all the test cards listed above: * Visa and Mastercard : Use any three-digit CVV. * American Express : Use any four-digit CVV. * Expiry Date : Any future date is valid.\ These test cards are designed to simulate successful transactions. ## **Usage Instructions** 1. **Integrate the Payment Gateway API**: Follow the integration guidelines in the payment gateway API documentation. 2. **Use Test Card Details**: Replace the card details in your API requests with the test card numbers provided above. You may use any CVC value (e.g., 100). 3. **Simulate Transactions**: Use the test cards to simulate various transaction scenarios (e.g., successful payments, declined transactions) to validate your integration. ## **Additional Testing Scenarios** * **Successful Payment**: Use any valid card number from the table above to simulate a successful transaction. * **Declined Payment**: Use a card number specifically designated for declined payments. * **Expired Card**: Enter an expired date (e.g., 01/20) to test how your integration handles expired cards. Testing with various scenarios helps ensure that your integration handles all possible outcomes effectively. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Online Payment Source: https://docs.paymentoptions.com/documentation/payments/onlinepayment Welcome to the Online Payment section, your gateway to seamlessly accepting payments through multiple channels. Whether you are integrating a simple Hosted Payment Page, leveraging APIs for custom solutions, or using website plugins for effortless setup, this section offers step-by-step guidance tailored to your needs. From detailed instructions on integration to tips for optimizing payment flows, you'll find everything you need to get started and succeed in managing online transactions effortlessly. Let us help you create a secure, reliable, and user-friendly payment environment for your customers! ## **Accepting Payments** Payment Options offers a flexible and secure way to accept online payments. With multiple integration methods, you can easily choose the one that best suits your business: Online payment * **Hosted Payment Page (HPP)**: A quick and secure way to accept payments without handling sensitive data directly. * **APIs**: For businesses that require deeper integration, our APIs for purchase and authorization give you complete control over the payment flow. * **Website Plugins**: Ready-to-use plugins designed for popular eCommerce platforms, making it easy to start accepting payments on your website. ## **Hosted Payment Page (HPP)** Our **Hosted Payment Page** provides a secure and customizable checkout experience. This method allows you to redirect customers to a hosted page where they can enter their payment details, ensuring PCI compliance and data security. Hosted Payment Page Log in to your account to set up and customize your Hosted Payment Page. You can generate a unique HPP link directly from your product (HPP) to integrate into your website or app. * PCI compliance is managed on your behalf. * Customizable to align with your brand. * Quick setup, minimal development required. Access the [Generate HPP Link Endpoint](/api-reference/en/hpp/generate-link) to try out creating your own HPP link. Use the HPP link to direct customers to a secure page for entering payment information. This method is ideal for businesses looking to reduce PCI compliance overhead. ## **APIs for Online Payment** For full control over your payment process, use our APIs to integrate directly with your website or application. You can integrate directly with our **PURCHASE** and **AUTHORIZATION** APIs. These APIs provide flexibility in managing transactions and allow you to create custom payment experiences. Payment API ### **PURCHASE API** * **Purpose**: The PURCHASE API is used to initiate a one-time payment. * **Features**: Supports various payment methods, including card and digital wallets. * **Endpoint**: See the [Purchase API Documentation](/api-reference/en/server-to-server/purchase) for setup and usage guidelines. ### **AUTHORIZATION API** * **Purpose**\*: The AUTHORIZATION API is used to place a hold on a specified amount without capturing it immediately, commonly used for pre-authorizations. * **Features**: Allows you to authorize funds and capture them at a later time. * **Endpoint**: Find details in the [Authorization API Documentation](/api-reference/en/server-to-server/authorization) for implementation instructions. Tip: Use the PURCHASE API for direct payments and the AUTHORIZATION API for holding funds, such as in hotel reservations or car rentals. ## **Website Plugins (Ecommerce Websites)** For businesses using popular e-commerce platforms, we offer plugins that simplify online payment integration without extensive development. These plugins are available for platforms like: Integrate payments seamlessly into your WooCommerce store with minimal setup. Add secure payment processing to your Magento 2 website with our plugin. Get started quickly with OpenCart, adding secure payments to your e-commerce store. Each plugin includes setup instructions and is optimized for a smooth and secure payment experience. Contact our support team if you need assistance with installation. ## **Next Steps** By using our online payment solutions, you can integrate flexible and secure payment options into your business. Select the option that best aligns with your requirements, whether it's a simple hosted payment page, an e-commerce plugin, or a fully customized API integration. Ready to start accepting online payments? Choose one of the methods above based on your business needs and integration capabilities. For additional information on setup or troubleshooting, please reach out to [Our Support Team](/support/contact) # Pay By Link Source: https://docs.paymentoptions.com/documentation/payments/paybylink The Pay by Link feature allows businesses to generate secure payment links and share them via email, SMS, or chat. It is an efficient solution for collecting payments without the need for a complete online storefront. ## **How Pay by Link Works** **Generate Link:** Add items in the card and create a unique payment link in the gateway with transaction details like amount and currency. **Share with Customers:** Send the link via email, SMS, or messaging platforms. **Secure Payment:** Customers complete the transaction on the HPP page. **Payment Invoice:** Send payment completion invoice to the cardholder after successful completion of the payment. Pay by Link ## **Benefits** works for any business type/domain. Simple setup and seamless payment experience. Links directly redirect user to hosted payment page. Collect payments in minutes with minimal effort. ## **Getting Started with Pay by Link** * Merchants log into the payment gateway and create a unique payment link. * Customize the link with transaction details such as: * Enter Payment amount. * Select currency. * Mention expiration date or validity period. The generated payment link is shared with customers through various channels, including: * Email: Attach the link with invoices or messages. * SMS: Send directly to the customers phone. * Chat Platforms: Share on WhatsApp, social media messengers, or other communication tools. Customers click the link, which redirects them to Hosted Payment Page (HPP). * On the payment page, card holder enter their payment details (e.g., card information or digital wallet credentials). * Customer Completes the Payment * Payments are processed securely in real time. * Once the payment is processed, both the merchant and the customer receive a confirmation. * Merchants can track the status of the payment through their gateway dashboard. Customize each link with a link name, an expiry date and item details for a better user experience. ## **How Customers Use Pay by Link** * Customers receive a secure payment link shared by the merchant via email, SMS, or chat platforms like WhatsApp. * The link includes transaction details such as the amount, due date, and purpose of payment. * Customers click on the shared link, which redirects them to a hosted payment page. * On the payment page, customers can review the transaction amount and other details to ensure accuracy. * Customers input their payment details, such as: * Credit or debit card information. * Digital wallet credentials. * Address * Valid Email * Once the information is entered, customers confirm and submit the payment. * The payment is processed securely in real time. * Upon successful payment, customers receive a confirmation message and payment completion invoice on the provided email. For detailed information about all merchant features and functionalities, you can download our comprehensive Merchant User Guide. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Introduction to Payments Source: https://docs.paymentoptions.com/documentation/payments/paymentintro Learn how the card payment process works and how our platform simplifies it. If you're new to the payments industry, this guide will give you a clear understanding of how card transactions work and how our platform fits into the process. We’ll walk through key participants, explain how payments and settlements flow, and show how we support merchants at every step. ## What You’ll Learn * [Key Participants in the Card Payments Ecosystem](#key-participants) * [How Card Payments Work – From Initiation to Authorization](#payment-flow) * [Settlement – How Merchants Receive Their Funds](#settlement-flow) * [Our Role – What We Offer and How We Simplify Payments](#our-role-as-a-payment-facilitator) *** ## Key Participants Before we get into the technical details, every card transaction involves a few core participants: The individual who owns a payment card and uses it to make purchases online or in person. They initiate the payment process. The business or service provider that sells goods or services and accepts payments through our gateway. The technology platform that securely transmits transaction data between the merchant, acquirer, card scheme, and issuer. It acts as a bridge in the online payment process. The financial institution or processor that enables merchants to accept card payments and routes transactions to the appropriate card schemes. The global network (e.g., Visa, Mastercard) that facilitates communication and transaction processing between issuers and acquirers. The bank or financial institution that issues the payment card to the cardholder and authorizes transactions on their behalf. > These participants are connected through defined relationships. The issuer gives cards to customers. The acquirer allows merchants to accept card payments. Card schemes ensure secure communication between all parties. Key Participants Want a quick refresher on these roles? Check out our [Glossary](/documentation/glossary) for definitions and industry terms. *** ## Our Role as a Payment Facilitator We act as a **payment facilitator**, meaning we streamline the payment process by providing merchants with a single point of integration and managing the end-to-end transaction lifecycle. This includes: Merchants connect directly to our platform using our Hosted Payment Page, REST APIs, or ready-made plugins for platforms like WooCommerce and Magento. No need to integrate with third-party gateways or processors. We take care of the entire transaction flow, including customer authentication, payment authorization, and securely routing transactions to the appropriate card networks and acquirers. Once a transaction is authorized, we handle the communication with the acquiring banks to ensure funds are settled correctly and efficiently into the merchant's account. Our platform includes advanced security features such as 3D Secure authentication, customizable risk rules, and real-time fraud detection to protect both merchants and cardholders. > Merchants don't need to integrate with third-party gateways or processors — our platform handles everything from transaction initiation to settlement. *** ## Payment Flow Let’s look at a typical payment flow when a customer makes a purchase using a card. This process includes authentication (if required), authorization, and confirmation of payment. Payment Flow You can integrate this flow using our: * **Hosted Payment Page (HPP)** * **Server-to-Server APIs** * **Plugin-based integrations** (WooCommerce, Magento, OpenCart) For a complete overview, please visit our [Online Payment](/documentation/payments/onlinepayment) section. A typical payment journey with our platform: 1. Customer selects a product or service. 2. Merchant initiates the payment using our API or Hosted Payment Page. 3. We securely receive and validate the card details. 4. We route the transaction to the appropriate acquirer via the card network. 5. The issuer checks and authorizes the transaction. 6. The result is returned back to the merchant through us in real time. Each of these methods ensures secure transmission of card data, 3D Secure support, and real-time feedback for transaction approvals or declines. *** ## Settlement Flow Once a transaction is successfully authorized, the merchant needs to receive the funds. Here's how the settlement process works through our platform: Settlement Flow 1. We batch captured transactions and send them to the acquirer. 2. The acquirer clears them through the card network. 3. The issuer releases the funds to the acquirer. 4. The acquirer settles the net amount to us. 5. We disburse the merchant’s payout to their registered bank account, minus applicable fees. *** ## Our Offerings We offer a wide range of tools, products, and integration methods to support your payment needs: ### Integration Methods * **Hosted Payment Page** – Launch payments with zero coding * **Tokenization** – Save card data securely for future use * **API Integration** – Full flexibility via REST APIs * **Subscription Payments** – Automate recurring billing * **Pay By Link** – Generate secure, one-time payment URLs * **QR Code Payment** – Let customers pay by scanning a code * **Scheduler** – Schedule payments in advance * **Digital Wallets** – Accept Apple Pay, Google Pay, and more ### Tools for Merchants & Partners * **Transaction** – Track, refund, or cancel payments * **Statements** – View/Download settlement statements and reconcile your payouts * **Dispute Management** – Monitor and respond to chargebacks and customer disputes * **Partner Tools** – Manage multiple merchant accounts under a single partner *** ## What’s Next? Ready to get started? Here’s what you can do next: * [Create an Account](/documentation/createaccount) * [Explore Our APIs](/api-reference/en/introduction) * [Set Up Your First Payment](/api-reference/en/server-to-server/purchase) Still have questions? Visit our [FAQs](/support/faqs) or reach out via [Contact Support](/support/contact). # QR Code Payment Source: https://docs.paymentoptions.com/documentation/payments/qrcode QR Payment payment method where customers can initiate transactions by scanning a QR code with their smartphone. It provides a fast, secure, and contactless way to process payments, making it increasingly popular in retail, services, and other industries. This is ideal for businesses that operate across different terminals, locations, or stations, providing a simple way for customers to initiate payments by scanning a QR code. The QR Code Payment feature allows you to generate unique QR codes for each of your terminals in your store, enabling fast and convenient payments. ## **How QR Code Payment Works** When you sign up for the QR Pay product, each terminal in your store is assigned a unique QR code. The terminal ID ensures accurate tracking of payments and enhances convenience for both you and your customers. QR Payment ## **Benefits of QR Code Payment** Customers can easily make payments by simply scanning a QR code, streamlining the payment process. Display QR codes at multiple terminals, locations, or stations to accommodate customers wherever they are. Scanning the QR code directs customers to a secure Hosted Payment Page, ensuring data protection and compliance. ## **Steps to Use QR Code Payment** * Every terminal in your store generates a unique QR code. * This code is specific to each terminal, ensuring that transactions are accurately linked to the correct point of sale. * The QR code is displayed at the terminal digitally on a screen ( or printed ). * Customers use their smartphone to scan the QR code. * Once the QR code is scanned, it redirects the customer to a secure Hosted Payment Page (HPP). * The HPP is pre-configured with the terminal's details and transaction parameters. * On the Hosted Payment Page, the customer enters their payment details securely. * Once the payment is processed, the customer receive payment confirmation. * The transaction is recorded for that specific terminal. ## **Best Practices for QR Code Payment** * **Display QR Codes Clearly**: Place the QR codes at accessible and visible points near each terminal. * **Regularly Check QR Code Status**: Ensure that the QR codes are active and linked to the correct terminal ID. * **Provide Payment Instructions**: Display a simple message or visual explaining how to scan and pay using the QR code. ## **Next Steps** To start using QR Code Payment, log in to your account and access your unique terminal QR codes. Display these codes at your operating locations, and your customers will be ready to make secure payments with a simple scan. For detailed information about all merchant features and functionalities, you can download our comprehensive Merchant User Guide. If you need assistance or have questions regarding document submission, please [contact our support team](./support/contact) for further guidance. # Scheduler Source: https://docs.paymentoptions.com/documentation/payments/scheduler The Scheduler feature within the DAS Gateway allows merchants to manage appointments, onboard team members, and set up recurring services for customers. Whether you’re managing a small business or multiple service locations, Scheduler provides a centralized way to handle your booking needs ## **Getting Started** Scheduler ### **Access Requirements** * **Login Access**: Existing PO merchants can use their Gateway credentials to access Scheduler, while new Scheduler users can set up credentials during account creation. Visit [DAS Scheduler Login](https://scheduler.paymentoptions.com/login). ## **Setting Up Scheduler** When logging in for the first time, new users will encounter a setup wizard to guide them through initial configurations: Configure your business hours to define when appointments can be booked. Create categories for services and add specific service details, such as name, duration, and pricing. Add team members to the Scheduler and assign specific services to each member. Once team members and services are configured, Scheduler will display available appointment times based on business hours. **Minimum Requirements**: Ensure at least one service and one team member are onboarded to begin using Scheduler for bookings. ## **Using Scheduler for Appointments** ### **Booking an Appointment** To create an appointment: 1. **Customer Details**: Enter customer information, including name, email, and phone number. 2. **Service Selection**: Choose from available services based on customer needs. 3. **Schedule Time**: Check team availability and select a suitable time. 4. **Assign Team Member**: Choose the team member responsible for the service. 5. **Finalize Booking**: Save the appointment to confirm. You can add specific notes or instructions for each booking under "Booking Comment" if customers have special requests. ### **Managing Appointments** * **Modify**: Edit appointment details, including service, time, and assigned team member. * **Cancel**: Remove an appointment if the customer requests cancellation or rescheduling. * **View Details**: Access a full summary of each booking, including customer info and service specifics. ## **Payment Options for Scheduler** **For Existing PO Merchants**: Scheduler allows you to collect payments directly from customers by redirecting them to the payment page post-booking. * **Send Payment Link**: Share a unique payment link with customers via email, allowing them to complete the payment online through a secure Hosted Payment Page (HPP). * **QR Code Payment**: Display a QR code for customers preferring to pay in person. When scanned, the QR code opens the payment page on the customer’s device. ## **Best Practices for Using Scheduler** * **Regularly Update Service Catalog**: Keep your service list updated to reflect any changes in offerings. * **Review Availability**: Confirm that team members and services are assigned correctly to ensure accurate appointment scheduling. * **Encourage Payment Completion**: Use payment links or QR codes to streamline the payment process, especially for upfront payments. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Subscription Source: https://docs.paymentoptions.com/documentation/payments/subscription The Subscription product enables seamless recurring payments through the gateway, offering a centralized solution to create, assign, and manage subscription plans efficiently. Merchants can set up multiple plans with customizable billing intervals and pricing catering to various customer needs and share subscription links through channels like email or WhatsApp. Customers can easily subscribe via a secure Hosted Payment Page (HPP) link which simplifies the process by allowing them to review plan details, enter payment information and automate future payments. This streamlined approach ensures efficient subscription management, enhances customer convenience and payment statuses, making it an ideal solution for businesses with recurring revenue models. ## **How Subscription Works** With the Subscription product, you can create and manage multiple subscription plans, each with its own settings for recurring billing. Once a plan is created, you can send a link to your customer, allowing them to subscribe and enter their payment information. Subscription Flow ## **Features of Subscription** Automate payments on a regular schedule with our recurring billing feature. Create and manage as many subscription plans as you need, each with unique settings. Share an HPP link, enabling customers to subscribe to plans directly and securely. ## **Subscription Parameters** Here are the parameters you can use to configure and customize subscription plans: ```json theme={null} { "subscription": { "plan_name": "", "plan_desc": "", "cycle_type": "", "subscription_end_type": "CYCLE", "cycle_interval": , "max_cycle_count": , "has_trial_period": , "trial_period_duration_type": "DAYS", "trial_period_duration": , "has_discount": , "discount_percentage": , "discount_duration": } } ``` ## **Key Parameters** Here are the essential parameters for configuring your subscription plans: * **`plan_name`**: Name of the subscription plan. * **`plan_desc`**: Description of the subscription plan. * **`cycle_type`**: Frequency of recurrence (e.g., DAYS, WEEKLY or MONTHLY). * **`cycle_interval`**: Specifies how often the billing cycle repeats. * **`max_cycle_count`**: Maximum number of cycles for the subscription. * **`has_trial_period`**: Indicates if a trial period is included. * **`trial_period_duration_type`**: Unit for the trial period duration (e.g., DAYS). * **`trial_period_duration`**: Length of the trial period. * **`has_discount`**: Specifies whether a discount applies. * **`discount_percentage`**: Discount percentage on the subscription price. * **`discount_duration`**: Length of time the discount is applied. ## **To configure recurring payments** * Login to DASGateway and click on the Merchant detail screen. Navigate to your product list and select the Subscription product from the added product list. Within the Subscription Product, create a new subscription plan by specifying details such as the plan name, billing frequency, and payment amount. Once a subscription plan is created, subscription plans will appear in your list of available plan list. You can review, update, or duplicate plans as necessary. To start a subscription, select a plan and assign it to a customer. Specify the link expiry date and plan start date, then click the submit button. A unique enrollment link will be generated. Share the generated (HPP) link with the customer. They can use the link to review the plan, enter payment information, and complete enrollment. Once the customer subscribes, their details are saved in the subscriber management section. You can access and update subscriber information as required. ## **Pause, Cancel, and Resume Active Subscription** Managing Active Subscriptions: Pause, Cancel, and Resume **1. Pause Subscription** Purpose: This will temporarily stop the subscription without permanently canceling it. Steps: * Click on the subscriber management section. * Select the active subscription you wish to pause. * Click the "Pause" option and confirm the action. Impact: * No further charges will be made while the subscription is paused. * The subscription can be resumed at any time by the merchant or user. **2. Cancel Subscription** Purpose: It will permanently stop the subscription and prevent any future billing. Steps: * Go to the subscriber management section. * Choose the subscription to be canceled. * Click the Cancel button and confirm the action. Impact: * The subscription is terminated immediately, or based on the end-of-billing-cycle option if supported. * Customers will no longer receive services under the canceled subscription. **3. Resume Subscription** Purpose: This will reactivate a paused subscription to continue billing and service. Process : * Locate the paused subscription in the subscriber management section. * Select the "Resume" option and confirm the action. Impact: * Billing resumes according to the original subscription terms. * Services are resumed for the customer. ## **Best Practices for Subscription Management** * **Create Distinct Plan Names**: Use clear and specific names for subscription plans to make management easier. * **Set Appropriate Billing Intervals**: Ensure the billing frequency and amount match customer expectations to reduce churn. * **Review Subscriber Details Regularly**: Keep subscriber information updated and review subscription statuses periodically. ## **Next Steps** To start managing subscriptions, log in to your account and access the Subscription product. For further assistance or support, feel free to contact our team. For detailed information about all merchant features and functionalities, you can download our comprehensive Merchant User Guide. If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Merchant Settlement Source: https://docs.paymentoptions.com/documentation/settlement/merchantsettlement Understand how Payment Options handles merchant settlements and how to interpret your settlement reports. # Settlement Process & Processing Summary In the world of payments, **settlement** is the final and most crucial step. It’s the process where the merchant receives the actual funds from the card transactions processed via Payment Options. This page outlines how settlements work on our platform and explains the key metrics used in your merchant settlement reports. *** ## Payment Options Settlement Process Payment Options manages payment processing across multiple **acquirers** and **payment methods**, ensuring that merchants get paid efficiently and securely. ### Step-by-Step Breakdown ### 1. **Transaction Initiation** * A customer initiates a payment on the merchant’s website or app. * Payment Options securely routes this transaction to the appropriate acquirer based on configuration. * The acquirer **authorizes** the transaction after validating the card and available funds. * If the authorization is successful, the transaction is tagged as **"Authorized"**. * Depending on the merchant’s settings: * **Purchase (Auto Capture)**: Payment Options automatically captures the amount. * **Manual Capture**: The merchant captures the amount after fulfilling the service or product. * Only **captured** transactions are considered eligible for settlement. Transaction Lifecycle Flow ### 2. **Settlement** * Payment Options initiates the settlement process: * Reconciles incoming settlement data from the acquirer with internal transaction records. * Deducts the **Merchant Discount Rate (MDR)** and any applicable fees. * Transfers the **net amount** to the merchant’s designated bank account as per the scheduled Payout Date. * Merchants receive a **Settlement Report** on their defined cycle: * **Daily** * **Weekly** * **Monthly** Statement Flow ### 3. **Merchant Payout** * After reconciliation and fund transfer initiation, the final amount is credited to the merchant’s bank account. * Settlement timelines may vary, depending on acquirer and settlement agreement. Reporting Metrics Logic Flow *** ## Processing Summary Definitions These definitions help merchants interpret the figures shown in their **settlement reports**. ### 1. **Purchase / Capture Sales Amount** **Definition**: Total transaction amount where the payment was successfully captured. **Includes**: * Transactions where: * `transaction_type = PURCHASE` and `transaction_status = Captured` * OR * `transaction_type = CAPTURE` and `transaction_status = Captured` *** ### 2. **Refund Amount** **Definition**: The total amount refunded to customers. **Includes**: * Transactions where: * `transaction_type = REFUND` and `transaction_status = Refunded` *** ### 3. **Successful Transaction Count** **Definition**: Total number of successfully processed transactions. **Includes**: * Transactions where: * `transaction_type = PURCHASE` and `transaction_status IN (Captured, Authorised)` * PLUS * `transaction_type = AUTHORISATION` and `transaction_status = Authorised` *** ### 4. **Declined Transaction Count** **Definition**: Count of all transactions that were not successful (i.e., declined or failed during processing). **Includes**: * Transactions where: * `transaction_type = PURCHASE` and `transaction_status = NOT SUCCESSFUL` * PLUS * `transaction_type = AUTHORISATION` and `transaction_status = NOT SUCCESSFUL` *** ### 5. **Refund Fee Count** **Definition**: Number of successful refund transactions. **Includes**: * Transactions where: * `transaction_type = REFUND` and `transaction_status = Refunded` *** ## Why This Matters Understanding how settlement works ensures better **cash flow visibility** and allows your finance team to reconcile reports accurately. Our reports are designed to reflect the **real-time financial health** of your transactions — showing not only what was processed but also what was **paid out**. *** # API DOCs Update log Source: https://docs.paymentoptions.com/releases/apiupdate Detailed log of API endpoint updates, new features, and improvements. ## **Overview** The API Update Logs page documents changes, improvements, and updates specifically to the Payment Options API endpoints. This log helps developers stay informed about new endpoints, enhanced functionality, and modifications to existing API behaviors, ensuring smooth integration and usage. *** ### **API Version History** #### Key Updates * Introduced **Purchase API (v2)** and **Authorization API (v2)** for improved structure and future scalability. * Enhanced support for evolving integration needs and upcoming compliance standards. > **Notice**:\ > **Purchase API (v1)** and **Authorization API (v1)** are scheduled for deprecation.\ > Please migrate to v2 for all future integrations. #### Key Features * Core API endpoints for fundamental payment processing functionality. * Initial support for essential payment methods (e.g., credit card transactions). * Basic authentication setup, including security protocols to safeguard API access. * Standard error handling with HTTP response codes for reliable troubleshooting. *** ## **Future Updates** Each new version will be added as a separate accordion section here, highlighting key improvements and endpoint-specific changes to help developers stay updated and adapt to new features seamlessly. *** ## **Additional Resources** Overview of all recent system revisions and enhancements, beyond API-specific changes. Summarized release notes, with feature additions and bug fixes for each version of the gateway. This page will be continuously updated to reflect the latest changes to API endpoints, new functionality, and improvements. For a broader view of system changes, visit the **Revision & Enhancement** and **Gateway Release Notes** sections. # Gateway Release Notes Source: https://docs.paymentoptions.com/releases/releasenotes List of all releases with links to detailed notes for each version. ## **Overview** This page provides a quick summary of each release, highlighting major updates and new features. For detailed release information, click on a specific version to view the complete release notes. *** ## **Release History**
### Features & Enhancements * **Google Pay 3DS Support** for SCA/PSD2 compliance. * **Traditional Chinese Language Support** across V3 Gateway and Hosted Payment Page (HPP). * **Real-Time Refund Status Synchronisation** for supported acquirers. * **Maximum Transaction Amount Limit** introduced as an additional transaction safeguard. * **Extended Public Key Support:** Merchants can now submit **encrypted card details** using the Extended Public Key mechanism instead of sending **raw card data** in payment requests. ### DASPAY Readiness * **DASPAY readiness has been completed**, including APIs, merchant configurations, payment flows, and Catalog capabilities. * **Merchant-Level Tax & Service Charge Configuration** for Catalog Cart. ### Fixes & Improvements * Fixed timeout issues affecting **Transaction Search and Preset Filters**. * Fixed an issue when filtering transactions by **QR Product Type**. * Fixed an issue where **Chargeback Email Notifications** were not delivered to updated email addresses. * Corrected **Issuing Country** information displayed in Transaction Reports. * Updated the **Phone Number** field on Hosted Payment Page (HPP) to support a maximum of **11 digits, depending on the applicable country code**.
### Features or Enhancements Related to Merchants & Partners #### Transaction & Reporting Enhancements * New Feature: **View Exact Fee Deductions Within Transaction Details**\ Allows users to easily view fee deductions directly within transaction details. * Enhanced transaction download experience with improved report usability * Retain previously used values in transaction download parameters for quicker report generation * Added card details such as **Issuing Bank**, **Issuing Country**, and **BIN** in Transaction Reports * Added **Schedule Name** prefix in transaction download files * Improved Merchant View screen with **Advanced Filter** support * Enhanced Business Location filtering with entity country support * Display pricing and RR balance information within Merchant View * Added **Customer Service Number** under Product Details #### Disputes & Operations * New Feature: **Custom Preference Lists for Dispute Management**\ Allows users to create and manage personalized preference lists for dispute handling. * Improved webhook responses by including **Service** information for selected payment methods * Enhanced release tour integration with notification support #### Onboarding & Access * New Feature: **Traditional Chinese Language Support in V3 Self-Onboarding**\ Added Traditional Chinese language support to improve onboarding accessibility for more users. #### Critical Fixes & Stability Improvements * Fixed payment issues affecting some iOS Chrome users * Fixed duplicate transactions appearing in scheduled transaction reports * Fixed refund notifications being triggered for unsuccessful refund transactions
### Features or Enhancements Related to Merchants & Partners * New Feature: **Preset Filters on Transaction List**\ Allows users to quickly apply commonly used filters to find transactions faster. * New Feature: **Improved Transaction Download**\ Enhances transaction download performance, allowing reports to be generated more efficiently. * New Feature: **Transaction Report Preferences**\ Allows users to customize which fields are included when downloading transaction reports. * New Feature: **Release Tour for New Features & Enhancements**\ Introduces a guided tour highlighting new features and improvements available in the system. * New Feature: **Card Scheme Information for Apple Pay & Google Pay**\ Displays the card brand (such as Visa or Mastercard) and related information for successful Apple Pay and Google Pay transactions. * New Feature: **Staff Access Role for Merchants (DASPay Integration)**\ Allows merchants to create staff users with limited access to help manage operations. ### Minor Enhancements * Added **thousand separators** to amounts displayed in Transaction Summary statistics for improved readability * Enhanced summary statistics to reflect filters applied on the transaction list * Updated **Integration Method** filter to allow single selection for easier filtering * Added **Payment Type** and **Card Scheme** options to advanced transaction filters * Removed expiry date requirement for **ID documents** during merchant self-onboarding * Improved **currency selection** based on the selected entity during self-onboarding * Improved flexibility of **statement preference settings**
### Features or Enhancements Related to Merchants & Partners * New Feature: **DASPAY Device Management**\ Enables onboarded merchants to manage their registered devices directly within the system. ### Minor Enhancements * Increased file upload limit from **3 to 5** in Self On-boarding * Updated **Contains** operator logic in Next Gen Filter to support comma-separated strings * Display **Merchant Catalog** tab for merchants subscribed to DASPay product * Added **default product image** when no image is uploaded in Merchant Catalog * Added dropdown filter values for **Food Size** and **Portion Size** in Merchant Catalog * Display a **default image** on Edit Product screen when no image was uploaded during creation * Updated **Lost Funds date** to reflect the case creation date for Chargeback
### Features or Enhancements Related to Merchants & Partners * New Feature: **Tokenization Implementation** for AsiaBill Acquirer * New Feature: **SubURL added to Sub-Merchant Information** in Payment Requests for Worldpay Integration ### Minor Enhancements * Discontinue the **V2 (legacy) screens** from V3 Gateway * Include **updated webhook URL** in previous comments * Update **translation** on Merchant Details tab * Remove **Scroll Bar** on Merchant Settings tab * Add **‘Not Submitted’ Status** in filter on Merchant/Partner under Sales Lead * Preference (column) now only gets added after clicking **Apply button** * Minor update in **Transaction Count Download** * Identify **Payment Type and Schemes** on Transaction Details page * UI modifications on **Refund Percentage** screen * Interface improvement for **Release Notes / Change Log** * Add **‘Food Type’ and ‘Portion Size’** fields on Add Product screen in Merchant Catalog * Document type update in **Self On-boarding** * Add **Refund Balance Summary** under Merchant Details ### Major Enhancements * Merchant Settlement Statement: Implementation of **Bi-Monthly Statement Cycle** ### Performance Improvements * Improved **Statement List** performance by moving data formatting from DB to UI * Improved **Transaction List** performance when using Advanced Filters
### Features or Enhancements Related to Merchants & Partners * New Integration: **Cybersource Acquirer** (3DS & Non-3DS) * New Integration: **YOQO Acquirer** (3DS) * New Integration: **Google Pay** * New Feature: **Stats Tiles** (Total Sales, Total Refund, Approval Ratio) added as Quick Stats on Transaction UI * New Feature: **Browser Information** now displayed on Transaction Detail screen * New Feature: **Merchant Settings** tab added to Merchant Details * New Feature: **IP Whitelisting Configuration & Webhook URL Configuration** in Merchant Settings * New Feature: **Merchant Catalogue** tab added to Merchant Details ### Minor Enhancements * Standardized terminology from **Login/Logout** to **Sign In/Sign Out** across DAS Gateway * Added **Logical Operator (AND/OR)** in Next Gen Filter between conditions * Added **Email Notifications** for Primary Contact (Merchant) under User Settings * Display **Merchant ID** field in User Profile and Merchant screen for Merchant Users * Allow **currency selection for Aggregation** under User Profile * Display **Acquirer MID** on Product Details page for Merchant login * Added **Payment Type** (Card Payment or APM) separated from Scheme * Transaction Download updated to accommodate **Payment Type** * Display all logged cases in **Chargeback History** for a Transaction in Chargeback UI * JP Translation: Billing Cycle value on Subscription HPP * JP Translation: Billing Cycle value in Subscription Email ### Chargeback Enhancements * Renamed **Amount** field to **Dispute Amount** for Chargeback Case * Unified all Chargeback notifications to a **single email template** * Highlight indicator dot only for stages where user is present in Chargeback History * Email notifications sent to Merchant for **any edits to existing Chargebacks** * Support reopening/closure of a Chargeback (via Edit) in Case Discussion * UI updates on Transaction Details screen related to Chargeback * Display **System\_User** for automated updates in Chargeback cases * Removed **‘Internal Dispute’** from Chargeback case type list * Added internal **‘Case Created’** stage in Chargeback Case Discussion
### Features or Enhancements Related to Merchants & Partners * External users (Merchant/Partner) support enabled * New Integration: **Cybersource Acquirer** (3DS & Non-3DS) * New Integration: **YOQO Acquirer** (3DS) ### Minor Enhancements * Auto-populate **City** & **Address** based on postcode during Onboarding * Password Policy: Enforced **minimum 14-character** requirement * Amount formatting: Added **currency symbol prefix** across DAS Gateway * Transaction List: Added **Acquirer** & **Acquirer MID** columns for Merchant login * Transaction List: Added **Integration Type** field and column * Transaction Download Report: Included **Integration Type** * Gateway: Updated **Gateway Response** message formatting * Gateway (Asiabill): Mapped **Response Code** to **Acquirer Message** * Product Page: Renamed **Connection Methods** field to **Integration Type** * HPP Page (EN/JP): Improved **Expiry Date** field (manual input + dropdown) * Chargeback: Included **JP Sales Team** in notifications for JP merchants * Chargeback: Added new **Case Type** – *Evidence under Review* * DAS Gateway: Unified field name **Reason Description** across all screens * Chargeback Email: Standardized **subject line** across all notifications * Chargeback Report: Added **Merchant Account (English)** parameter * Chargeback: Removed *Sent to Acquirer* option for **Auto Representment** case * Chargeback: Added **email notifications** for *Evidence under Review* case * Statements UI: Added **Deselect All** button for selected statements * Partner View: Renamed **Reseller** tab to **Partner** for partner user accounts
### Features & Enhancements Related to Merchants & Partners * eKYC for Reseller Stakeholders * Multiple statements download in DAS Gateway * User preference for transaction & statement list columns * Custom date-time format across DAS Gateway * File type preference (Excel/CSV) for transaction & chargeback downloads * Smart copy on key fields * Export to Excel on Public Holiday UI * Block refund (condition-based) * Payment intermediate interface for seamless Merchant integration ### UI & UX Enhancements * Redesigned: * Merchant View Page * Partner Details Page * Improved: * Alignment for Integration Method on Transaction List UI * Statement & Transaction Screens for better visibility * Chargeback Notification Email content * Merchant View list tooltips for product count * Adjusted column widths across DAS Gateway * Added: * Acquirer details on Product View, Product Info, and Drawers * Dropdown for IsWhitelisted filter in Statement Transactions * Transaction ID column in Transaction List & Advanced Filters * Tooltip for failed transactions (Response Code & Gateway Response) * Removed: * Excessive whitespace on Transaction List UI * Decimal places for JPY currency on Statement UI * Updated Password Policy to comply with PCI Guidelines ### Minor Enhancements * Unified field names (Subsidiary/Entity/Country) across Gateway * Improved Self Onboarding: Data saving via Step buttons * Prevented product display for pending DASMID on Merchant Page * Limited multiple statement downloads * Standardized Chargeback Email content * Added Billing Dates & Next Billing Date for Subscription (HPP) * Added Comment function for Subscription (HPP) * Japanese Translation for Self Onboarding Final Step Page ### Production Defect Fixes * Fixed: * Transaction download failure for external users * Dispute email missing currency in amount field * UI issues on HPP Page (IBEC) * Multiple email notifications on successful payment refresh
### Features or Enhancements Related to Merchants & Partners * e-KYC Integration on auto onboarding * Updated Links: Implemented across the Gateway for easier navigation * Improved Loading Screens * New Payment Integrations: PayPay, Pay-easy, and Konbini (New APM options for JP region) * UI Improvements: * Default column selections in various interfaces * Terms & Conditions updated ### Minor Fixes and Enhancements * Updated Error Descriptions * Miscellaneous: Improved navigation, sub-user settings, and email notifications ### Defect Fixes * Resolved the issue of multiple webhooks being sent for a single transaction * Resolved problems preventing resellers from viewing their approved merchants * Fixed problems with transaction responses, including Google Pay and chargeback errors * Resolved an issue where certain transactions returned inconsistent response codes
### Features or Enhancements Related to Merchants & Partners * HPP Page Updates * Added new fields for enhanced cardholder input * Included accessibility options for better usability * Enhanced support for memo text input * Pay by Link enhancements: Added a link name column within the transaction lists and reports for easier identification * Subscription Notifications: Enhancement to remove time zone offset from start date, end date, and link expiry date from subscription email notification ### Minor Fixes and Enhancements * Password Management: Users will now be required to reset passwords every 90 days * Transaction Management: Improved filtering and sorting for transactions, and added new notifications for expired passwords on the gateway * Legacy Screen Notices: Added messages to inform users when they are on outdated screens in the system * Referrals: Added a referral count to the Partner list
This Release Notes section will continue to grow as new versions of the gateway are released. Bookmark this page to stay up-to-date with the latest improvements and features. # Revision & Enhancement Source: https://docs.paymentoptions.com/releases/revisions Log of all significant revisions and enhancements to the product. ## **Overview** The Revision & Enhancement log records major updates, feature improvements, and optimizations made to the system. This format allows users to easily view the latest changes, with each version stored in an expandable section. *** ### **Revisions by Version** #### Updates & Changes | **Change** | **Description** | | :----------------------------------- | :----------------------------------------------------------------------------------------------------------- | | **Refund API – E-Wallet Limitation** | Refunds are **not supported** for transactions made using **PayPay, Pay-Easy, and Konbini** payment methods. | **Note:** This update is a **documentation clarification** and does not introduce any functional API changes. #### Updates & Changes | **Change** | **Description** | | :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **DEV API Base URL Update** | The **DEV environment** API base URL has been changed from `https://api-dev.paymentoptions.com/api/v1` to `https://api-dev.paymentoptions.com`. All DEV API endpoints in the documentation have been updated accordingly. | **Note:** This update only affects the DEV environment. Please update any development or staging integrations to use the new base URL. #### New Enhancements | **Feature** | **Description** | | :----------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Gateway Error Codes Update** | Updated and refined **Gateway Error Codes** in documentation to include detailed response codes, messages, and applied levels for better clarity and troubleshooting. | #### New Enhancements | **Feature** | **Description** | | :------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **E-Wallets Section Expanded** | Added **Apple Pay** and **Google Pay** under the `Documentation → Payment Methods → E-Wallets` section. [View Section](/documentation/paymentmethods/ewallets) | | **Supported E-Wallets Updated** | Moved **PayPay**, **Gcash**, **PayEasy**, and **Konbini** from the upcoming list to the official list of supported e-wallets. | | **HPP API Update** | Updated the `Hosted Payment Page` API reference with configuration for **Apple Pay** and **Google Pay** button priority. [View API](/api-reference/en/hpp/generate-link) | | **Tokenization Flow Updated** | Replaced the **Generate Token API** flow diagram with a new version to better explain token handling and reassure merchants that card details are not stored. | #### New Enhancements | **Feature** | **Description** | | :---------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **New Documentation Section** | Added a new page under `Documentation → Settlement` titled **"Merchant Settlement"**.
This page explains how Payment Options handles merchant settlements, outlines the full settlement process, and defines key reporting metrics. [View Page](/documentation/settlement/merchantsettlement) |
#### New Enhancements | **Feature** | **Description** | | :---------------------- | :--------------------------------------------------------------------------------------------- | | **API Response Update** | Added the `merchant_ip` field under **device\_details** in the API response, where applicable. | #### New Enhancements | **Feature** | **Description** | | :--------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Introduction to Payments** | Added a new section under `Documentation → Payments` titled "Introduction to Payments" which includes:
- Key Participants in the Card Payments Ecosystem
- How Card Payments Work – From Initiation to Authorization
- Settlement – How Merchants Receive Their Funds
- Our Role – What We Offer and How We Simplify Payments. [View Section](/documentation/payments/paymentintro) | | **API Navigation Update** | Added **Purchase API (V2)** and **Authorisation API (V2)** under the **Server To Server** section in the API Reference. |
#### New Enhancements | **Feature** | **Description** | | :---------------------- | :------------------------------------------------------------------- | | **Language Navigation** | Minor updates on the language navigation for better user experience. | #### New Enhancements | **Feature** | **Description** | | :------------------- | :------------------------------------------------------------------------ | | **JP Documentation** | Implemented the Japanese version of the documentation. | | **API Endpoints** | Minor updates on creating submenu of API Endpoints for better navigation. | #### New Enhancements | **Feature** | **Description** | | :----------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | | **API Reference** | Added the 3D Secure Integration API to the Server-to-Server API Reference. | | **API Endpoints** | Updated the order of Authorization and Body attributes to align with the cURL payload. | | **Gateway Error Codes** | Reviewed and updated error messages in the Error and Response sections of the API Reference. | | **Gateway Release Note** | Updated the Release History for Gateway Release Notes. Included features and enhancements related to Merchants and Partners in Release 21. | #### Highlights * **Platform Migration**: Moved to the Mintlify platform with a refreshed interface, interactive features, and AI-powered search. * **Expanded Payment Methods**: Added support for new e-wallets like Apple Pay and Google Pay. * **Enhanced Security & Compliance**: PCI DSS 4.0 compliance, new 3DS protocols, and additional data security measures. * **Localization & Accessibility**: Launched Japanese language support, with potential for further localization. #### Additional Improvements | **Feature** | **Description** | | :--------------------------------------- | :------------------------------------------------------------------------------------------------------------ | | **AI-Powered Search** | New intelligent search function to improve navigation and help users find content quickly. | | **User Interface Enhancements** | Improved navigation with categorized sections and direct access to FAQs and guides. | | **Diagrams, Flowcharts & Process Flows** | Added visual aids, including flowcharts and process flows, to illustrate key integrations and configurations. | | **Gateway Access Links** | Provided direct links to gateway features and tools for easy integration and account management. | | **Performance Optimizations** | Improved API response times to handle high traffic volumes. | *** ## **Additional Resources** Detailed logs of API-specific updates, new endpoints, and code examples. Recent release notes, highlighting new features, bug fixes, and other updates on the gateway. This log will be continuously updated as the Payment Options Gateway evolves. For a closer look at specific updates, refer to **Gateway Release Notes** and **API Update Logs**. Visual aids such as diagrams, flowcharts, and process flows are integrated throughout the documentation to simplify understanding of complex setups and integrations. # AI Chatbot Source: https://docs.paymentoptions.com/support/aichat Learn how to use the integrated AI chatbot and search feature to get real-time assistance with Gateway documentation and troubleshooting. Our integrated **AI Chatbot** is designed to provide real-time assistance and quick answers to your questions while navigating the Gateway documentation. Powered by advanced AI technology, this tool helps you find relevant information, troubleshooting tips, and usage instructions without having to search manually. ### **Why Use the AI Chatbot?** * **Instant Answers**: Receive quick responses to common questions, helping you save time and stay focused. * **Search Documentation**: The chatbot is directly integrated with our documentation, making it easy to pull up guides, API references, and troubleshooting articles. * **24/7 Assistance**: Access the AI chatbot anytime for around-the-clock support, without waiting for a support representative. * **Troubleshooting Help**: Get suggestions for resolving common issues as you work through different aspects of the Gateway. ### **How to Access the AI Chatbot** To start using the AI chatbot: 1. **Use the Search Bar**: At the top of any page in our documentation, enter your question or keyword into the search bar. 2. **Instant Suggestions**: As you type, the AI chatbot will provide suggested articles and answers, helping you find relevant information faster. 3. **Explore Results**: Click on a suggestion or press **Enter** to view detailed responses and related documentation that address your query. The AI Chatbot is designed for informational and troubleshooting assistance. For more complex issues or account-specific help, please [contact our support team](./support/contact). ## **Tips for Effective Use** * **Be Specific**: For the best results, ask specific questions (e.g., "How do I set up a Subscription product?" rather than "Setup help"). * **Explore Suggestions**: The chatbot often provides links to relevant documentation. Click these links to explore the full guides. * **Try Multiple Queries**: If the first response isn’t helpful, try rephrasing your question or breaking it into smaller parts. *** ## **What Can the AI Chatbot Help With?** Find guides on using Gateway features, setting up products, and navigating your account. Access API references, endpoint details, and authentication methods directly within the chat. Get solutions to common issues, including payment errors, account access, and integration challenges. Discover tips and best practices for maximizing the functionality of the Gateway. *** ## **Need Further Assistance?** For complex or account-specific issues, please [reach out to our support team](./support/contact). Our team is ready to assist with any questions the AI chatbot can’t address. # Contact Support Source: https://docs.paymentoptions.com/support/contact Reach out to our support team for assistance with Gateway-related issues or questions. Our support team is here to help with any questions or issues you may encounter while using the Gateway. Whether you need technical assistance, have account-related inquiries, or want guidance on using specific features, we’re here to assist you. ## **When to Contact Support** If you’re new to the Gateway, we recommend reviewing the [Onboarding Checklist](/documentation/checklist) first. If you still have questions, contact us for personalized help. For API errors, payment processing issues, or plugin installation problems, please reach out to our support team. You can also check our [FAQs & Troubleshooting](./faqs) for quick solutions. For inquiries related to billing, account upgrades, or changes, contact support, and we’ll guide you through the necessary steps. ## **How to Reach Us** For detailed inquiries or when you need to share documentation, please email us at **[support@paymentoptions.com](mailto:support@paymentoptions.com)**. We aim to respond within 1-2 business days. Use the **AI Chatbot** available in the search bar for instant answers to common questions. For real-time support with a representative, our live chat is available during business hours. # FAQs & Troubleshooting Source: https://docs.paymentoptions.com/support/faqs Frequently asked questions and troubleshooting guide for merchants using the Gateway. Welcome to the **FAQs & Troubleshooting** section. Here, you’ll find answers to commonly asked questions, along with solutions for common issues you might encounter while using the Gateway. This section is designed to help you get the most out of our products and resolve issues quickly. ## **Frequently Asked Questions** Visit our [Create an Account](/documentation/createaccount) page for step-by-step instructions on setting up your merchant account. For a full list of required documents, see our [Onboarding Checklist](/documentation/checklist). Once your account is set up, navigate to the **Products** tab and select the products you want to enable. Each product guide provides further details. A Payment MID (Merchant Identification Number) is a unique identifier assigned to a business by Payment Options. This number is used to track and authenticate transactions made by the merchant, ensuring that payments are processed and settled to the correct business account. An acquirer (also called an acquiring bank, acquiring financial institution, or merchant bank) is a financial institution or payment processor that partners with merchants to enable them to accept credit card, debit card, and other electronic payments. The acquirer provides the merchant with a merchant account and facilitates the authorization, processing, and settlement of transactions between the merchant and the customer's bank (the issuer). Customers that will use Payment Options as their payment gateway are merchants. Customers that onboard other merchants onto the Payment Options gateway services are partners. An API (Application Programming Interface) is a set of rules, protocols, and tools that allows different software applications to communicate and interact with each other. It defines the methods and data formats that applications can use to request and exchange information. For more information, [Click here](https://en.wikipedia.org/wiki/API). An issuer is a bank or financial institution that provides credit cards, debit cards, or other payment cards to consumers (cardholders). The issuer is responsible for approving the cardholder's application, managing their account, and making sure the funds are available for purchases or withdrawals. Dasgateway is the name of our payment gateway platform. To access Dasgateway, please log in to your merchant or partner account [here](https://me.paymentoptions.com/login). A payment gateway is a service that authorizes and processes payments for online and in-store transactions. It securely transfers payment information between the customer, merchant, and bank. The payment gateway encrypts sensitive payment information, verifies transaction details, and communicates with the bank to authorize the payment. It then returns the status of the transaction (approved/declined). Our payment gateway supports various payment methods, including credit/debit cards, digital wallets, and alternative payment methods like Google Pay, Apple Pay, and PayPay. For more information, please refer to the [payment methods](/documentation/paymentmethods/cardschemes) segment. Yes, our payment gateway uses industry-standard security protocols such as SSL encryption, tokenization, and PCI-DSS compliance to ensure that your transactions are safe and secure. You can integrate our payment gateway using our API or pre-built plugins for popular platforms such as WooCommerce, OpenCart, and Magento. We provide detailed documentation and developer support for the integration process in our [guide](/support/merchantguide) section. The setup fees may vary depending on the plan you choose. Please refer to our [pricing page](https://www.paymentoptions.com/ja/pricing/) for detailed information about our fee structure and subscription plans. Most transactions are processed in real-time, meaning payments are authorized and confirmed instantly. If a payment fails, the payment gateway will notify both the customer and the merchant. The customer can attempt to re-enter payment details or use a different payment method. Yes, our payment gateway supports recurring billing and subscription payments. You can set up automated payments for your customers based on your subscription model. For more information, please refer to the [Subscription](/api-reference/en/subscription/create-subscription) page. Yes, depending on your needs, our payment gateway supports international payments. It allows you to accept payments in multiple currencies and from different countries. Please [contact support](/support/contact) for more information on the availability of multiple currencies on your account. We charge transaction fees, which vary depending on the volume of payments processed and the payment methods used. Please refer to our [pricing page](https://www.paymentoptions.com/ja/pricing/) for a breakdown of fees. You can access your transaction history through the merchant dashboard, where you can see details of all successful, pending, and failed transactions. Our [support](/support/contact) team is available via email, and phone. We also have a comprehensive help center with troubleshooting guides, FAQs, and tutorials. Yes, our payment gateway allows you to issue refunds directly from the merchant dashboard for both full and partial refunds. We use advanced fraud protection tools and 3D Secure authentication to help prevent unauthorized transactions. You will also receive alerts in case of any suspicious activity. Yes, you can customize the look and feel of the payment form to match your brand’s identity using our API. PCI (Payment Card Industry) compliance is a set of security standards to ensure the secure handling of cardholder data. Our payment gateway is PCI-DSS compliant, so you don’t need to worry about it, but we recommend that you follow best practices for your business as well. Yes, our payment gateway is fully compatible with mobile apps, however we do not provide SDKs for development. You can update your payment settings, bank details, and account information by contacting our [support](/support/contact) team. Yes, we do have a sub user feature, please contact the [support](/support/contact) team to set up your new sub user. Yes, please contact the [support](/support/contact) team as we offer a sandbox or test environment where you can simulate payments and ensure that everything works correctly before you start processing live transactions. Our Gateway supports multiple payment methods, including credit cards, e-wallets, QR codes, and more. Check the [Supported Card Schemes](/documentation/paymentmethods/cardschemes) and [E-Wallets](/documentation/paymentmethods/ewallets) sections for details. 3D Secure is enabled at the product level. Visit the **Secure Payment** section to understand how to configure 3DS for enhanced transaction security. Yes, our Gateway supports multiple currencies. For a list of supported currencies, refer to the [Currency Guide](/documentation/paymentmethods/currency). A chargeback is a process in which a credit card or debit card transaction is reversed by the cardholder's bank (the issuer) after a customer disputes a charge. Essentially, a chargeback allows the customer to get their money back if they believe a transaction was fraudulent, erroneous, or otherwise problematic. A refund is the return of money to a customer after they have paid for goods or services, typically because the customer is dissatisfied with the purchase or because there was an issue with the product or service. A refund is a voluntary action by the merchant (or seller), unlike a chargeback, which is initiated by the customer through their bank. You can generate HPP links directly from the HPP product dashboard. For details, see the [HPP Guide](/api-reference/en/hpp/generate-link). Our API uses HTTP Basic Authentication with an API key in the `Authorization` header. Refer to the [API Authentication](/api-reference/en/authentication) page for details. Plugins for platforms like WooCommerce, Magento, and OpenCart are available on our [Website Plugins](/support/plugins-woocommerce) page. The API supports JPY, PHP, USD. Please refer to the [Currencies](/documentation/paymentmethods/currency) section in the documentation for a complete list. Please refer to the [changelog](/logs/apiupdate). Yes, please refer to the [webhook handler](/api-reference/en/webhook-handler) page. Weekly Statements: Weekly statements cover the period from Monday to Sunday and are released on the following Monday of the next week. Monthly Statements: Monthly statements cover the period from the 1st to the end of the month and are released on the second Monday of the following month. Note: If the scheduled Monday falls on a holiday, statements will be released on the next business day. Yes, you may see it in real time on your [Dasgateway](https://me.paymentoptions.com/login) page. On the Transaction page, press the "Additional column" button on the top left and select the fields you wish to be added. Please reach out to your sales representitive, or if you have any additional questions or concerns, please contact our [customer support team](/support/contact). We are happy to assist you with the account termination process. Please note: Once your account is terminated, all data associated with it may be permanently deleted, and you will no longer have access to any services associated with your account. Please refer to: [Generate HPP](/api-reference/en/hpp/generate-link) *** ## **Troubleshooting Guide** This section addresses common issues users encounter. If you’re experiencing a specific problem, review the solutions below. Go to the login page and click **Forgot Password**. Follow the instructions to reset your password via email. Double-check your username and password. Ensure you’re using the correct credentials associated with your account. If the issue persists, contact support. This error occurs when the cardholder's account has insufficient funds. Ask the customer to try another card or contact their bank. Ensure the customer has completed the 3D Secure authentication step. For more on 3DS, see the [Secure Payment](/documentation/paymentmethods/securepayment) page. Review the [Response Codes](/api-reference/en/error-and-reponse/responsecodes) page for information on decline codes. Contact support if the issue is unresolved. This error indicates incorrect API credentials. Verify the `Authorization` header in your request and ensure your API key is correctly formatted. Ensure you’re using the correct plugin version for your e-commerce platform. Follow the instructions in the relevant [Installation Guide](/support/plugins-woocommerce). Make sure the webhook URL is publicly accessible and registered correctly in the API payload. Refer to [Webhook Handler Setup](/api-reference/en/webhook-handler) for configuration steps. *** ## **Need More Help?** If you need further assistance, please [reach out to our support team](/support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # Magento 2 Source: https://docs.paymentoptions.com/support/plugins-magento Integration Guide for Magento 2 Magento 2 * **Description**: Seamlessly connect the Gateway with Magento 2. ## **Install Extension** Download the latest Source code zip file from the Payment Options GitHub ( Use the download Link : [https://github.com/paymentoptions/magento2-extension](https://github.com/paymentoptions/magento2-extension) ). Extract the magento2-extension.zip. Place the extracted files into `app/code/Agtech/Paymentoptions/` folder under Magento root path Check your Magento Mode: Run `php bin/magento deploy:mode:show` to find your mode If your Magento mode is "production", please run the below commands: * `php bin/magento cache:clean` * `php bin/magento cache:flush` * `php bin/magento setup:upgrade` * `php bin/magento setup:di:compile` * `php bin/magento setup:static-content:deploy` If your Magento mode is "default" (or) "developer", please run the below commands: * `php bin/magento setup:upgrade` * `php bin/magento setup:di:compile` * `php bin/magento setup:static-content:deploy -f` ## **Configure Extension** Log in to your Magento Store Backend Choose Stores on the Admin sidebar to the left. Now go to Settings > Configuration. In the Configuration page, click on Sales on the left and choose Payment Methods On the Payment Methods page, navigate to “Payment Options” Payment Section. * Enabled - select yes to enable the “Payment Options” Payment Method * Mode - select sandbox or live mode * Title - This title will show under the payment methods section on the checkout page of Magento * Access Token - Enter Your `Secret Key` received from Payment Options. * Merchant ID - Enter Your `Merchant ID` received from Payment Options. * Debug - select yes to enable the debug, this will log Payment Options API calls under var/log/debug.log file * Countries - Allow all countries or select specific countries to access this payment method Click Save Config. Refresh Magento Cache. Refresh image ## **Front View** It will show on the checkout page under the payment Methods section Select “Payment Options” payment option: It will show like below: Front View Click on “Place Order” Button: It will redirect you on payment page Front View Make payment using any of the options provided above. After making a successful payment, it will redirect to the success page. Front View ### Admin View Admin View image If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # OpenCart Source: https://docs.paymentoptions.com/support/plugins-opencart Installation Guide for Opencart 3.0.x.x – 3.1.x.x Opencart * **Description**: Enable Gateway payments for OpenCart. ## **Mandatory requirements to be in the machine while installation** * PHP version 5.6+ * cURL * OpenSSL * Opencart 3.0.x.x or 3.1.x.x * Installation can be done only through the cPanel/FTP/Admin Panel. This module may not support one-page checkout template ## **SME Dasgateway payment module installation** Module Installation can be done through * FTP Server/cPanel OR * Admin Panel ## **Module installation through FTP Server/cPanel** Install Opencart 3.0.x.x or above on your server Download the latest Source code zip file from the Payment Options GitHub ( Use the download Link : [https://github.com/paymentoptions/opencart-extension](https://github.com/paymentoptions/opencart-extension) ) Unzip “dasgatewayqr\_oc\_payment\_module\_3-0-x.ocmod.zip” Upload the ‘admin’ and ‘catalogue’ folders into your Opencart route directory through the FTP client ## **Module Installation through Admin Panel** Login to the admin panel with credentials Download the latest binary zip file from the Payment Options GitHub ( Use the download Link : [https://github.com/paymentoptions/opencart-extension/releases](https://github.com/paymentoptions/opencart-extension/releases) ) Unzip “dasgatewayqr\_oc\_payment\_module\_3-0-x.ocmod.zip” unzip image Go to your Opencart store admin using username and password, click on the extension option under the Extension menu and select the Payments option from the dropdown list at the top of the screen extention image Under the Payment List, you will find the “SME Dasgateway” Payment option Install the “SME Dasgateway” Payment module by clicking the “+” option extention image From the list select the SME category extention image After completing the installation, click the edit button to open the “SME Dasgateway” configuration page Access Token - Enter Your `Secret API Key` received from Payment Options Merchant ID - Enter Your `Merchant ID` received from Payment Options Toggle Live or Test to select the processing environment Set sort order and enable the module to enable the payment option on the Payment Page extention image If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing. # WooCommerce Source: https://docs.paymentoptions.com/support/plugins-woocommerce Installation Guide for WooCommerce WooCommerce * **Description**: Accept secure payments in your WooCommerce store. ## **Steps for Manual Installation** First, you need to [download the plugin from the source](https://github.com/Kavi-PO/woocommerce-plugin.git) (which will be a zip file). Next, you need to go to the WordPress admin area and visit Plugins » Add New page. After that, click on the 'Upload Plugin' button on top of the page. This will reveal the plugin upload form. Here you need to click on the 'Choose File' button and select the plugin file you downloaded earlier to your computer. After you have selected the file, you need to click on the 'Install Now' button. WordPress will now upload the plugin file from your computer and install it for you. You will see a success message like this after the installation is finished. Once installed, you need to click on the Activate Plugin link to start using the plugin. After activation, you need to enable plugin & configure payment options like Merchant ID, API key provided by payment options. After configured, click the 'Save' button. ## **Screenshots** ### Backend Backend image Backend image Backend image ### Frontend Frontend image If you need further assistance, please [reach out to our support team](./support/contact). Our team is here to help you troubleshoot and resolve any issues you may be experiencing.