North America North America
Create a test account Support Login

Step 1: Create a test account

You can create test account(s) here . Please create two test accounts. Once created, please send your merchant IDs to sales.na@worldline.com . Our experts will set up your accounts correctly and walk you through how to use them. There are three (3) test merchant accounts you can set-up:

Account Type

Description

Payment Methods 
Supported

Country & Currency Supported

Channel Partner

Integrated software vendor or reseller partner.

No processing allowed.

USA – USD

Canada – CAD

Canada – USD

Sub-Merchant 

Vendors or service providers that operate under one channel partner.

Major Credit Cards (Visa, MasterCard, American Express, Discover, JCB)


Bank Transfer (US ACH and CA EFT)

Profile Sharing 

A master sub-merchant account which allows multiple sub-merchants to share the Payment profiles. 

Access and manage your test account in the web portal

Our Worldline team will connect with you to set up and walk you through your partner test account . You will have received your test merchant account credentials from our test account request page (link). Using those credentials, you may get familiar with your test merchant account within the Portal . 

 Through the Portal, you and your sub-merchants can:

 1. Generate the API access passcodes . 

2. Create additional users . 

3. Configure account settings and order settings . 

4. Process payments through the web terminal , recurring billing or batch processing . 

5. Configure & store payment credentials securely in the payment profile . 

6. View & download reports and monthly invoices .

Important information:

Channel Partner ID

Our Partner-Level Authentication Scheme enables software vendors to enhance the security of their API requests. As part of this scheme, each partner will receive a unique Channel Partner ID for every currency they process. This ID allows them to submit API requests on behalf of their sub-merchants efficiently and securely.

The Channel Partner ID functions as a non-processing account, serving as the umbrella entity for all associated sub-merchants.

Sub-merchant ID

Every sub-merchant that you onboard will be assigned a unique Sub-merchant ID. This ID designates the sub-merchant as affiliated with one of your Channel Partner IDs, which depends on the currency they operate in. This structure ensures organized management and streamlined API interactions across different currencies.

All transactions through the API require a merchant ID. It is displayed in the top right corner of the Member Area. You can locate the Merchant ID by navigating to administration > Company Info. Ensure you have this information ready when contacting our Customer Care team.

Finding API access passcodes

To initiate API calls on behalf of your merchants, you will require an API access passcode. You can generate the following API access passcodes in the portal:

API Type

Request Types

API Access Passcode

How to generate in the portal?

Payments

Payment, pre-authorization, pre-auth completions, returns, void, 3D secure payments, Get payment information

Payment

 

  1. Administration > Account Settings > Order Settings

  2. Under Payment Gateway > Security/Authentication > API access passcode

  3. Click “Generate New Code”.

  4. Click “Update” at the bottom of the page to save these changes.

Credential-on-File

First installment, subsequent installment, first recurring, subsequent recurring, subsequent customer initiated, first unscheduled, subsequent unscheduled

Reports

Merchant report, Settlement report, Statement Report, Commissions Report, Batch Payment Report, Batch Settlement Report

Reporting

  1. Administration > Account Settings > Order Settings

  2. Scroll down to the bottom of the page to find “ Reporting ”.

  3. Under API access passcode click on “Generate New Code”.

  4. Click “Update” at the bottom of the page to save these changes.

Credit Card Transaction Search

Search query

Payment Profile

Create profile, get profile, update profile, delete profile, get card/s, add card, update card, delete card 

Profile

  1. Configuration > Payment Profile Configuration .

  2. Under “Security Settings”, make sure the API access passcode option is selected and hit “Generate New Code” .

  3. Click “Update” at the bottom of the page. 

Recurring Payments

Create Recurring Payment

Modify Recurring Payment

Get Recurring Payment Account ID information

Recurring Billing

  1. Administration > Account Settings > Order Settings

  2. Scroll down to the bottom of the page to find “ Recurring Billing ”.

  3. Under API access passcode click on “Generate New Code”.

  4. Click “Update” at the bottom of the page to save these changes.

Batch Processing

Batch Payments (ACH/EFT & Credit Cards)

Batch Upload

  1. Administration > Account Settings > Order Settings

  2. Scroll down to the bottom of the page to find “ Batch File Upload ”.

  3. Under API access passcode click on “Generate New Code”.

  4. Click “Update” at the bottom of the page to save these changes.

Onboarding 

Create, retrieve, update, delete application


Create application document

Onboarding 

Please email dl-integrations.na.isv@worldline.com to request your Onboarding API token sales for the payment method you will be supporting (Credit Card, ACH or EFT)

To learn more on how to find or update your API access passcode/s, click here .