Skip to main content

Click to Pay Store Type

Click to Pay is an EvolutionX store type designed as a payment portal for integrated ERPs. The feature supports different remittance types and enabling the ERP capture payment details from a payer in a PCI compliant web page.

João Estima avatar
Written by João Estima
Updated over a week ago

Remittance refers to a payable document within EvolutionX. While it is not an invoice specifically, it represents a document that can be paid through the system.

1. Overview

Supported Remittance Types

  • Invoice — payment requested on invoices with an outstanding balance

  • Order — full payment (pre-payment) requested on an order placed

  • Refund — request a card for the purpose of issuing a refund or credit

  • Deposit — partial payment as a deposit on an order

  • Account — request a card for the purpose of saving it to the ERP customer account

High-Level Lifecycle

  1. The ERP creates the remittance via the EvolutionX API.

  2. The remittance request email is sent to the customer using a template tied to the remittance type.

  3. The customer opens the Click to Pay page and submits payment. The click to pay page will tokenize the card and do a pre-auth transaction if needed.

  4. A “Thank you” page confirms completion.

  5. The ERP fetches the status and transaction details and all related remittance record data via the API.

  6. The ERP takes action to record the token and finalizes a capture or follow-up sale as required by use case

Relationship Between Storefront, API, and ERP

  • ERP/External System: Uses Click to Pay via API to create remittances and fetch payment results.

  • API: Handles remittance creation, payment retrieval, and exposes endpoints for integration.

  • Storefront: Displays the Click to Pay page where the end user completes payment.

Flow summary:

ERP → API → Click to Pay page → Customer payment → ERP fetches result via API

Visual representation

2. Click to Pay on the Storefront

  • Page: Dedicated Click to Pay page (link sent via email).

  • Payment options: Configured as in standard EvolutionX payment setup.

  • Behavior:

    • Expired remittance → Expired page displayed.

    • Cancelled remittance → Cancellation page displayed.

Design and layout are handled by EvolutionX; no additional UI customization is required.

Supported Payment Methods

Credit Cards:

  • Net1 / Paya Connect

  • Nuvei

ACH:

  • Upcoming...

3. Use Case Notes & Behavioral Differences

  • Differences between remittance types are visual only (title, table).

  • ERP behavior: No native ERP integration; ERP must handle payment retrieval and processing.

  • EvolutionX responsibilities:

    • Updates initial statuses

    • Records timeline of remittance

    • Updates payment information

  • Integrator responsibilities:

    • Create remittance

    • Fetch payment data

  • Partial payments: Supported; ERP controls amount to pre-authorize.

Notification for end user

When the appropriate flag is provided during remittance creation, we will handle the notification using the email you supply.

The user’s email will be validated, and based on the email type, the corresponding template will be sent.

SMS notifications are planned for a future release.

4. Error Handling & Edge Cases

  • Expired mid-payment: Void pre-auth if cancelled.

  • Payment attempted after cancellation: Same as expired.

5. Click to Pay Email Templates

  • Each remittance type has its own template but shared variables:

{store_name} {store_url} {user_name} {remittance_expiry_date} {remittance_seller_reference} {currency_symbol} {store_address}

  • Refund emails: Display the full total of the remittance, unlike other types which show the amount due.

6. Remittance Lifecycle & Statuses

Remittance Statuses

See more in the developers documentation.

Status ID

Name

Description

Responsible Party

6

Requested

Created via API, pending user interaction

EvolutionX

1

New

User has opened the remittance

EvolutionX

2

Paid

User has submitted a payment

EvolutionX

3

Processed

ERP has accepted and saved payment

ERP

5

Cancelled

ERP has aborted the remittance

ERP

Key Points

  • Remittance is payable as soon as it is submitted.

  • Becomes ineligible for payment only if expired, cancelled or paid.

  • EvolutionX handles initial lifecycle until Paid; ERP handles cancellation or marking as Processed.

7. API – Working With Remittances

Fetching Remittances

  • Endpoints:

    • List endpoint (filter by status)

    • Fetch by buy_id or seller_reference

Filtering by Status

  • Recommended to filter all paid remittances to avoid processing duplicates.

Polling Strategy

  • Poll continuously once the remittance is opened to detect when the status changes to Paid.

  • Recommended window: during validity of the remittance, up to 30 minutes after expiration.

Post-Payment Actions

  • API consumers must update status from Paid → Processed.

Edge Cases

  • 0-value payments: Penny pre-auth + void for CVV validation.

8. Click to Pay – Integration Flow for Developers

Flow Overview (Conceptual)

Developer Notes

  • After creating remittance, start polling to detect Paid status.

  • No different integration points based on type; all remittances follow the same flow.

  • 0-value payments are handled via penny pre-auth + void.

Did this answer your question?