Overview

Direct Payments allow your platform to submit a complete transaction to the gateway in a single request.

Your server is responsible for:

• Collecting card data using Embedded Tokenization
• Providing the transaction amount (AMT)
• Assigning a unique reference (REF)
• Sending the request to the gateway

The gateway returns a response immediately and the transaction is completed in a single request/response cycle. No transaction state is stored between requests.

Direct Payments are also used for:

• Refunds
• Subsequent charges using previously Tokenized Card Data
• Charges using tokens obtained from a Redirect Payment

CustomerPay with Direct Payments

When a merchant is enabled for CustomerPay, the USERFEE must be calculated before submitting the sale transaction.

The flow depends on whether you already have card data.

Scenario 1: Collecting Card Data (Embedded Tokenization)

If you are collecting card data at checkout:

1. Call GetAPIKey and include AMT in the request
2. The gateway returns USERFEE and a One-Time Token (OTT)
3. Submit the Direct Payment Sale request and include:
   1. AMT
   2. USERFEE (returned from GetAPIKey)
   3. OTT

This ensures the correct fee is displayed and charged to the cardholder.

Learn more

Scenario 2: Using Existing Tokenized Card Data

If you already have tokenized card data (no card entry at checkout), you must calculate the USERFEE explicitly.

Step 1: Check UserFee

Send a request to the Check UserFee API

Required fields:

• TERMID
• PASS
• AMT
• TYPE=Z
• SUBTYPE=UF

Optional:

• PLATFEE (if platform fees apply)

Step 2: Gateway Response

The gateway returns:

• USERFEE – calculated fee amount
• CODE / TEXT – request status

Step 3: Display at Checkout

Display the returned USERFEE to the customer before confirming payment.

Step 4: Submit Sale Transaction

Submit a Direct Payment Sale request including:

• TERMID
• PASS
• AMT
• REF
• TOKEN or OTT
• USERFEE

Optional fields such as customer name, email, and invoice number may also be included.