MerchantE API Docs

Hosted Payments Page

Secure, PCI-compliant payment pages hosted by MerchantE

MerchantE's Hosted Payments Page allows merchants to integrate a secure payment checkout experience into their e-commerce websites. Customers can checkout as guests, create payment accounts, or log in to make a payment.

Getting Started

Basic requirements to begin integration:

  • Web Hosting
    Merchant must have a publicly available website. The Cascading Style Sheet and company logo are hosted by the merchant.
  • HTML or plain text editor
    Form elements need to be added to existing or new HTML pages.
  • Merchant Account
    Required to begin processing live transactions.
  • Submit Final Amount Only
    ME Hosted Checkout will only process the amount sent in the payment_amount field. Shipping charges, local tax, etc. will need to be accommodated before the transaction is submitted.

Transaction Flow

  1. 1
    Customer Checkout
    Customer is on merchant's e-Commerce website and clicks Checkout
  2. 2
    Redirect to Hosted Page
    Customer is redirected to MerchantE Hosted Payment Page
  3. 3
    Payment Submission
    Customer enters payment details and submits payment
  4. 4
    Approval Response
    If approved: Customer is presented with payment receipt and has the option to return to merchant's website
  5. 5
    Decline Response
    If declined: Customer is presented with generic payment decline and advised to reach out to issuer for more details

Integration Steps

1

Obtain Profile ID

Get your profile ID once the merchant account setup has been completed

2

Update HTML Pages

Modify or create HTML pages with 'buy now' or 'checkout' links or images

3

Insert Payment Form

Insert Payment Page URL form in HTML

4

Test Integration

If necessary, test the form by processing a sale. Ensure that both response URLs function properly.

Security Settings

Advanced Integration Options

These settings are intended for advanced integrations of ME Hosted Checkout, and will require a server-side programming language to implement properly, such as PHP, JSP, ASP, etc.

Security Code
MD5 hash validation using Profile Key + Security Code + Transaction Amount. When enabled, requests without valid transaction_key will be redirected to cancel_url with resp_text=invalid_tran_key.
HTTP Authentication
Optional Resp HTTP Username and Password for response URL callbacks using standard HTTP authentication (BASIC + Base64 encoded username:password).

API Reference

POST/checkout/sign-in

Initiate Hosted Payment Page Checkout

Redirects customer to MerchantE Hosted Payment Page for checkout. The customer will be presented with options to checkout as guest, create a payment account, or log in to existing payment account.

POST/webhooks/response-credit-card

Credit Card Transaction Response (Webhook)

HTTP POST callback sent to merchant's configured response_url after a credit card transaction has been processed.

POST/webhooks/response-ach

ACH Transaction Response (Webhook)

HTTP POST callback sent to merchant's configured response_url after an ACH transaction has been processed.

Need Help?

Contact MerchantE Support for assistance with integration, testing, or troubleshooting.

Visit Knowledge Base