linked2pay

https://test.linked2pay.com/l2p/static/API/
Admin
linked2pay is a payments processing platform offering WebService APIs for direct ACH and credit card...
Tokens:45,322
Snippets:146
Trust Score:7.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Submit Widget Request in PHP

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Provides a complete example of initializing a SOAP client, constructing the authentication and request objects, and calling the submitWidgetRequest method.

```PHP
define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');

$client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT, 'trace' => 1, 'exceptions' => 0));

$auth = new StdClass();
$auth->login = "client1";
$auth->AuthenticationMethod = "KEY";
$auth->password = "0123456789ABCDEF";

$l2pWidgetRequest = new StdClass();
$l2pWidgetRequest->status = 0;
$l2pWidgetRequest->headerId = 71;
$l2pWidgetRequest->widgetId = 0;
$l2pWidgetRequest->lookup1 = '8058860687';
$l2pWidgetRequest->lookup2 = '11111';
$l2pWidgetRequest->description = 'Richard Submission';
$l2pWidgetRequest->startDate = '06/08/2012';
$l2pWidgetRequest->amount = 500.00;

$params = new StdClass();
$params->auth = $auth;
$params->request = $l2pWidgetRequest;

$result = $client->submitWidgetRequest($params);
```

--------------------------------

### Submit Debit Request by Email Template using C#

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

This C# code snippet illustrates how to set up and send a debit request using the Linked2Pay API. It includes the necessary setup for authentication, including generating a fingerprint, and populating the debit request object with contact and company details. Note that the provided snippet is incomplete and requires further implementation for a full functional example.

```csharp
// Web Reference has been added as:
// reference name: L2PReportPaymentWebService
// URL: http://test.transmodus.net/jcx/soa/test/wsdl/L2PPaymentWebService.wsdl
// More on adding service references see: 
// http://msdn.microsoft.com/en-us/library/bb628649.aspx
// http://msdn.microsoft.com/en-us/library/bb628652.aspx

using System;
using L2PPaymentSampleApplication.L2PPaymentWebService;

namespace L2PPaymentSampleApplication
{
  class Program
  {
    static void Main(string[] args)
    {
      L2PPaymentWebServiceService l2pPaymentWebService = 
             	  new L2PPaymentWebServiceService(); ;

      L2PPaymentWebService.L2PAuthenticationData auth = 
             	  new L2PPaymentWebService.L2PAuthenticationData();
      l2pPaymentWebService.Url = 
            	  "http://www.linked2pay.com/l2p/ws/L2PPaymentWebService";
      L2PPaymentWebServiceService l2pPaymentWebService = 
             	  new L2PPaymentWebServiceService();

      auth.login = "mikel1";
      // auth.AuthenticationMethod = "KEY";
      // password = "0123456789ABCDEF";
      L2PReportWebService.fingerprintBlock fingerprintBlock = 
            	  new L2PReportWebService.fingerprintBlock();
      FingerprintGenerator fingerprintGenerator = 
            	  new FingerprintGenerator();
      fingerprintBlock.sequence = 
            	  fingerprintGenerator.GetSuquenceNumber();
      fingerprintBlock.fingerprint = 
                                 fingerprintGenerator.GenerateFingerPrint(
                                    (int)fingerprintBlock.sequence,
                                    fingerprintBlock.timesatmp.ToString(),
                                    "0123456789ABCDEF", auth.login);
      auth.fingerprint = fingerprintBlock;

      l2pDebitRequestByTemplate.contactId = 0;
      l2pDebitRequestByTemplate.companyName = "My Company";
      l2pDebitRequestByTemplate.firstName = "Don";
      l2pDebitRequestByTemplate.lastName = "Smith";
      l2pDebitRequestByTemplate.email = "vserpik@transmodus.net";;

```

--------------------------------

### GET /l2p/request-status

Source: https://test.linked2pay.com/l2p/static/API/reporting.html

Retrieves the mapping of L2P request status codes to their human-readable descriptions.

```APIDOC
## GET /l2p/request-status

### Description
Returns an array of objects containing L2P request status information, mapping integer status codes to their current state.

### Method
GET

### Endpoint
/l2p/request-status

### Parameters
None

### Response
#### Success Response (200)
- **status_code** (integer) - The unique identifier for the request status.
- **status_name** (string) - The descriptive name of the status.

#### Response Example
[
  {"instance": 0, "status": "Pending", "description": "Request has been made"},
  {"instance": 1, "status": "Active", "description": "Email has been sent out"},
  {"instance": 11, "status": "Paid CC", "description": "Credit card transaction has been processed"}
]
```

--------------------------------

### Create L2P Widget Header via PHP

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Illustrates the creation of a new widget header by configuring a SOAP client and passing authentication credentials along with label parameters to the createWidgetHeader method.

```php
define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
$client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT, 'trace' => 1, 'exceptions' => 0));
$auth = new StdClass();
$auth->login = "client1";
$auth->password = "client1";
$params = new StdClass();
$params->auth = $auth;
$params->label1 = isset($_GET['label1']) ? $_GET['label1'] : 'Richard Account';
$params->label2 = isset($_GET['label2']) ? $_GET['label2'] : 'Richard Zip';
$result = $client->createWidgetHeader($params);
print $result->createWidgetHeaderReturn;
```

--------------------------------

### History Lookup API

Source: https://test.linked2pay.com/l2p/static/API/direct_payment.html

Allows you to search for transaction history based on specified criteria. You can define the starting transaction and the total number of transactions to retrieve.

```APIDOC
## POST /websites/test_linked2pay_l2p_static_api/history

### Description
Retrieves transaction history based on specified search criteria.

### Method
POST

### Endpoint
/websites/test_linked2pay_l2p_static_api/history

### Parameters
#### Request Body
- **First** (string) - Optional - Allows you to set the number of the transaction you want to start your search from.
- **NumberOfTransactions** (string) - Optional - Allows you to set the total number of transactions you want search for.

### Request Example
```json
{
  "First": "10",
  "NumberOfTransactions": "50"
}
```

### Response
#### Success Response (200)
- **RspCode** (int) - Response code.
- **RspText** (string) - Response description.
- **ErrorCode** (string) - Error Code.
- **ErrorMsg** (string) - Error Message.
- **Rows** (L2pHistoryResponse) - Transaction Request Details.

#### Response Example
```json
{
  "RspCode": 0,
  "RspText": "Success",
  "ErrorCode": "",
  "ErrorMsg": "",
  "Rows": [
    {
      "AuthCode": "AUTH123",
      "AuthAmt": "100.00",
      "BalanceAmt": "0.00",
      "RefId": "REF456"
    }
  ]
}
```
```

--------------------------------

### Submit Debit Request by Template in C#

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

Demonstrates how to initialize a debit request using a predefined template. It sets the phone, amount, and email template fields before submitting the request via the L2PPaymentWebService.

```C#
l2pDebitRequestByTemplate.phone = "111-111-11111";
l2pDebitRequestByTemplate.amount = 8.50;
l2pDebitRequestByTemplate.emailTemplate = "Rent Payment";
L2PPaymentWebService.L2PDebitResponse l2pDebitResponse =
   l2pPaymentWebService.submitDebitRequestByTemplate(auth,
                           	l2pDebitRequestByTemplate);

Console.WriteLine("Error code: " + l2pDebitResponse.errorCode);
Console.WriteLine("Contact ID: " + l2pDebitResponse.l2pContactId);
Console.WriteLine("Request ID: " + l2pDebitResponse.l2pRequestId);
```

--------------------------------

### Submit Credit Request via Linked2Pay API

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

Demonstrates how to initialize a credit request, authenticate the session, and submit the transaction to the Linked2Pay web service. Includes logic for displaying results in a web interface for PHP and console output for C#.

```php
$l2pCreditRequest->emailMessage = 'Be nice';

$params = new StdClass();
$params->auth = $auth;
$params->request = $l2pCreditRequest;

$result = $client->submitCreditRequest($params);

function print_results($obj) {
	foreach ($obj as $k => $v) {
		print $k.' -- <b>'.$v.'</b><br />'."\n";
	}
}
```

```csharp
L2PPaymentWebServiceService l2pPaymentWebService = new L2PPaymentWebServiceService();
l2pPaymentWebService.Url = "http://www.linked2pay.com/l2p/ws/L2PPaymentWebService";

L2PAuthenticationData auth = new L2PAuthenticationData();
auth.login = "mikel1";

L2PCreditRequest l2pCreditRequest = new L2PCreditRequest();
l2pCreditRequest.emailMessage = "Be nice";

L2PCreditResponse l2pCreditResponse = l2pPaymentWebService.submitCreditRequest(auth, l2pCreditRequest);
Console.WriteLine("Contact ID: " + l2pCreditResponse.l2pContactId);
```

--------------------------------

### Create Widget Header with L2PWidgetWebService (PHP)

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Creates a widget header, which defines up to two lookup fields for identifying L2P requests. These fields and their labels are displayed on the online form and referenced in subsequent L2P requests. Requires authentication data and labels for the lookup fields.

```php
<?php
 define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
 define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
 define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
 // SOAP client
 $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT,

```

--------------------------------

### Iterate and display L2PPaymentStatus records

Source: https://test.linked2pay.com/l2p/static/API/reporting.html

Demonstrates how to iterate through an array of L2PPaymentStatus objects retrieved from the L2PReportWebService and output the payment details to the console.

```csharp
if (l2pPaymentStatusArr != null)
{
  for (int j = 0; j < l2pPaymentStatusArr.Length; j++)
  {
    L2PReportWebService.L2PPaymentStatus l2pPaymentStatus = l2pPaymentStatusArr[j];

    Console.WriteLine(l2pRequestStatus.requestId);
    Console.WriteLine(l2pPaymentStatus.paymtId);
    Console.WriteLine(l2pPaymentStatus.paidAmount);
    Console.WriteLine(l2pPaymentStatus.paymentMethod);
    Console.WriteLine(l2pPaymentStatus.submissionDate);
    Console.WriteLine(l2pPaymentStatus.creditCardType);
    Console.WriteLine(l2pPaymentStatus.creditCardNumber);
    Console.WriteLine(l2pPaymentStatus.cardHolder);
    Console.WriteLine(l2pPaymentStatus.expirationMonth);
    Console.WriteLine(l2pPaymentStatus.expirationYear);
    Console.WriteLine(l2pPaymentStatus.achRequestId);
    Console.WriteLine(l2pPaymentStatus.routeNumber);
    Console.WriteLine(l2pPaymentStatus.accountNumber);
    Console.WriteLine(l2pPaymentStatus.accountType);
    Console.WriteLine(l2pPaymentStatus.depositType);
    Console.WriteLine(l2pPaymentStatus.achSubmissionDate);
    Console.WriteLine(l2pPaymentStatus.achEffectiveDate);
  }
}
```

--------------------------------

### Email Payments API - Intro

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

Introduction to the L2P Email Payment Web Service, detailing its capabilities for submitting debit and credit payment requests, including recurring payments, convenience fees, and secure attachments.

```APIDOC
## Email Payments Intro

### Description
The L2P Email Payment Web Service provides a set of methods for submitting debit and credit payment requests. It supports advanced features such as recurring payments, convenience fees, virtual attachments, and password protection for attachments.

### Method
N/A (This section is introductory)

### Endpoint
N/A (This section is introductory)

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Getting Started
1. Review this documentation.
2. Download the L2P Payment Webservice Sample Application.
3. Download the WSDL file for testing.
4. Register clients on www.linked2pay.com for production access.
5. For API information, email supportteam@linked2pay.com.

### REST Web Service
For JSON-oriented REST Web Service features, click here to try (no account registration needed).
```

--------------------------------

### Lookup Widget Requests using PHP

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

This PHP code demonstrates how to call the lookupWidgetRequest method of the L2PWidgetWebService. It sets up the SOAP client, authentication, and lookup parameters, then processes the returned widget requests. Ensure the print_results function is defined elsewhere to display the output.

```php
<?php
define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
 // SOAP client
 $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT,
                          'trace' => 1, 'exceptions' => 0));
 // Authentication object
 $auth = new StdClass();
 $auth->login = "mikel1";
 $auth->AuthenticationMethod = "KEY";
 $auth->password = "0123456789ABCDEF";
  // these parameters are specific to what function is being called
 $params = new StdClass();
 $params->auth = $auth;
 $params->lookup1 = isset($_GET['lookup1']) ? $_GET['lookup2'] : 
                                                 '0000000001';
 $params->lookup2 = isset($_GET['lookup1']) ? $_GET['lookup2'] : 
                                                 '66666';
 $result = $client->lookupWidgetRequest($params);
?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html>
 <head>
     <title>L2P Lookup Widget Request</title>
 </head>
 <body>
     <div>
         <p>Response:</p>
         <div>
             <?php
             if(is_array($result->lookupWidgetRequestReturn->L2PWidgetRequest)) {
                 foreach ($result->lookupWidgetRequestReturn->L2PWidgetRequest as $obj) {
                     print_results($obj);
                     print '<hr />' . "\n";
                 }
             } else {
                 print_results($result->lookupWidgetRequestReturn->L2PWidgetRequest);
             }
             ?>
         </div>
     </div>
 </body>
 </html>
```

--------------------------------

### Submit Credit Request using PHP

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

This PHP code snippet demonstrates how to submit a credit request using the L2PPaymentWebService. It includes setting up the SOAP client, authentication details, and the credit request parameters. The method initiates a debit from the client's account and a credit to the contact's account, sending an email notification with a payment link.

```php
<?php
 define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
 define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PPaymentWebService');
 define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PPaymentWebService.wsdl');

 // SOAP client to be used on pages
 $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT,
                                 'trace' => 1, 'exceptions' => 0));

 // Authentication object to be used on pages
 $auth = new StdClass();
 $auth->login = "mikel1";
 $auth->AuthenticationMethod = "KEY";
 $auth->password = "0123456789ABCDEF";

 $l2pCreditRequest = new StdClass();
 $l2pCreditRequest->contactId = 0;
 $l2pCreditRequest->companyName = 'My Company';
 $l2pCreditRequest->firstName = 'Don';
 $l2pCreditRequest->lastName = 'Smith';
 $l2pCreditRequest->email = 'vserpik@transmodus.net';
 $l2pCreditRequest->cc = '';
 $l2pCreditRequest->bcc = '';
 $l2pCreditRequest->phone = '111-111-11111';
 $l2pCreditRequest->amount = 1234.12;
 $l2pCreditRequest->invoices = '7777';
 $l2pCreditRequest->address1 = '123 Main St.';
 $l2pCreditRequest->address2 = '';
 $l2pCreditRequest->city = 'Oxnard';
 $l2pCreditRequest->state = 'CA';
 $l2pCreditRequest->zip = '12345';
 $l2pCreditRequest->glBank = 'Chase';
 $l2pCreditRequest->glExpense = 'E123';
 $l2pCreditRequest->glDesc = 'Nice gloves';

```

--------------------------------

### Lookup Widgets using PHP SOAP Client

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

This PHP code snippet demonstrates how to retrieve a list of all widgets created by a specific client using the L2P API's lookupWidget method. It initializes a SOAP client, sets up authentication, and calls the lookupWidget function. The response is then iterated to display widget details.

```php
<?php
 define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
 define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService'); 
 define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
 // SOAP client
 $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT, 
                                        'trace' => 1, 'exceptions' => 0));
 // Authentication object
 $auth = new StdClass();
 $auth->login = "mikel1";
 $auth->AuthenticationMethod = "KEY";
 $auth->password = "0123456789ABCDEF";
 // these parameters are specific to what function is being called
 $params = new StdClass();
 $params->auth = $auth;
 $result = $client->lookupWidget($params);
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <title>L2P Lookup Widget</title>
</head>
<body>
    <div>
        <p>Response:</p>
        <div>
            <?php
            // Assuming print_results function is defined elsewhere to handle L2PWidget objects
            if(is_array($result->lookupWidgetReturn->L2PWidget)) {
                foreach ($result->lookupWidgetReturn->L2PWidget as $obj) {
                    print_results($obj);
                    print '<hr />'."\n";
                }
            } else {
                print_results($result->lookupWidgetReturn->L2PWidget);
            }
            ?>
        </div>
    </div>
</body>
</html>

```

--------------------------------

### L2PWidgetWebService - Lookup Widgets

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Lists all widgets created by a particular client.

```APIDOC
## POST /services/L2PWidgetWebService

### Description
This method lists all widgets created by a particular client.

### Method
POST

### Endpoint
/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object that contains authentication information based on user's choice of authentication method.

### Response
#### Success Response (200)
Returns a list of widgets created by the client.

#### Response Example
```json
{
  "lookupWidgetReturn": [
    {
      "widgetId": "WIDGET001",
      "name": "Default Widget"
    },
    {
      "widgetId": "WIDGET002",
      "name": "Custom Widget"
    }
  ]
}
```
```

--------------------------------

### Submit Widget Attachment in PHP

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Demonstrates how to use the submitWidgetAttachment method via a SOAP client. It includes a file upload form and processes the attachment submission using the L2P client.

```PHP
$result = $client->submitWidgetAttachment($params);
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<body>
    <?php if(isset($_POST['submit'])) { ?>
        <p>Response:</p>
        <div><?php print $result->submitWidgetAttachmentReturn; ?></div>
    <?php } else { ?>
        <form action="<?php echo $_SERVER['PHP_SELF']; ?>" method="post" enctype="multipart/form-data">
            <input type="file" name="userUpload" />
            <input type="submit" name="submit" value="Upload File" />
        </form>
    <?php } ?>
</body>
</html>
```

--------------------------------

### Find Widget Request using PHP SOAP Client

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

This snippet demonstrates how to use a PHP SOAP client to call the findWidgetRequest method of the L2P API. It includes setting up the SOAP client, authentication credentials, and request parameters. The result is then processed and displayed.

```php
<?php
 define('L2P_WSDL', 'path/to/L2PWidgetWebService.wsdl'); // Replace with actual WSDL path
 define('L2P_ENDPOINT', 'http://your.l2p.endpoint.com'); // Replace with actual endpoint

 // SOAP client
 $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT,
                                 'trace' => 1, 'exceptions' => 0));
 // Authentication object
 $auth = new StdClass();
 $auth->login = "mikel1";
 $auth->AuthenticationMethod = "KEY";
 $auth->password = "0123456789ABCDEF";
 // These parameters are specific to what function is being called
 $params = new StdClass();
 $params->auth = $auth;
 $params->dataId = isset($_GET['dataId']) ? $_GET['dataId'] : 73;
 $result = $client->findWidgetRequest($params);
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
    <title>L2P Find Widget Request</title>
  </head>
  <body>
    <div>
        <p>Response:</p>
        <div>
            <?php
                foreach ($result->findWidgetRequestReturn as $k => $v)
                    print $k.' -- <b>'.$v.'</b><br />'."\n";
            ?>
        </div>
    </div>
  </body>
</html>

```

--------------------------------

### Lookup Widget Headers using PHP SOAP Client

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

This code snippet shows how to use a PHP SOAP client to call the lookupWidgetHeader method of the L2P API. It covers the initialization of the SOAP client, setting up authentication credentials, and making the API call. The response, containing header attributes, is intended to be processed further.

```php
<?php
 define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
 define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
 define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
 // SOAP client
 $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT, 
                            'trace' => 1, 'exceptions' => 0));
 // Authentication object
 $auth = new StdClass();
 $auth->login = "mikel1";
 $auth->AuthenticationMethod = "KEY";
 $auth->password = "0123456789ABCDEF";
 // these parameters are specific to what function is being called
 $params = new StdClass();
 $params->auth = $auth;
 $result = $client->lookupWidgetHeader($params);
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <title>L2P Lookup Header</title>
</head>
<body>
    <div>
        <p>Response:</p>
        <div>
            <?php
            // The processing of $result->lookupWidgetHeaderReturn->L2PHeader would go here.
            // For example, iterating through headers or checking status.
            // print_r($result->lookupWidgetHeaderReturn->L2PHeader);
            ?>
        </div>
    </div>
</body>
</html>

```

--------------------------------

### L2PWidgetWebService - Create Widget Header

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Creates a widget header, which defines up to two lookup fields for identifying widget requests. These fields and their labels are configured upfront and referenced in subsequent L2P requests.

```APIDOC
## POST /services/L2PWidgetWebService

### Description
Create widget header. Each widget request includes up to two (2) lookup fields. These are fields that the client can use to identify each request. For example, a client can specify “Account” or “Zip code”. To define what lookup fields are used for a particular L2P request and display the meaningful labels on the online form, the client has to create widget header upfront and reference this header in the L2P request.

### Method
POST

### Endpoint
/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object that contains authentication information based on user's choice of authentication method.
- **label1** (string) - Required - Lookup field label 1
- **label2** (string) - Optional - Lookup field label 2

### Response
#### Success Response (200)
Numeric value (int) that represents return code (0 is successful execution, otherwise the number represents an error code).

### Response Example
```json
{
  "createWidgetHeaderReturn": 0
}
```
```

--------------------------------

### POST lookupWidgetHeader

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Lists all headers created by a particular client. This is used to retrieve configuration attributes for widget headers.

```APIDOC
## POST lookupWidgetHeader

### Description
Retrieves a list of all headers created by the client. The returned L2PHeader object contains status information or error codes if negative.

### Method
POST (SOAP)

### Endpoint
http://test.transmodus.net/jcx/soa/test/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object containing authentication credentials.

### Response
#### Success Response (200)
- **L2PHeader** (L2PHeader) - Data object containing header attributes and status.

### Response Example
{
  "lookupWidgetHeaderReturn": {
    "L2PHeader": { "headerId": "H1", "status": "0" }
  }
}
```

--------------------------------

### L2PWidgetWebService - Submit Widget Request

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Creates an L2P widget request.

```APIDOC
## POST /services/L2PWidgetWebService

### Description
Create L2P widget request.

### Method
POST

### Endpoint
/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object that contains authentication information based on user's choice of authentication method.
- **headerId** (string) - Required - The ID of the widget header to use for this request.
- **lookupField1Value** (string) - Optional - The value for lookup field 1.
- **lookupField2Value** (string) - Optional - The value for lookup field 2.

### Response
#### Success Response (200)
Returns the ID of the created widget request.

#### Response Example
```json
{
  "submitWidgetRequestReturn": "12345"
}
```
```

--------------------------------

### Submit Debit Request using C#

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

This C# code snippet demonstrates how to submit a debit request using the Linked2Pay SOAP API. It shows how to instantiate the service client, set up authentication with a fingerprint, define the debit request parameters, and process the response including error codes and contact/request IDs.

```csharp
// Web Reference has been added as:
// reference name: L2PReportPaymentWebService
// URL: http://test.transmodus.net/jcx/soa/test/wsdl/L2PPaymentWebService.wsdl
// More on adding service references see: 
// http://msdn.microsoft.com/en-us/library/bb628649.aspx
// http://msdn.microsoft.com/en-us/library/bb628652.aspx

using System;
using L2PPaymentSampleApplication.L2PPaymentWebService;

namespace L2PPaymentSampleApplication
{
  class Program
  {
    static void Main(string[] args)
    {
      L2PPaymentWebServiceService l2pPaymentWebService = 
             	  new L2PPaymentWebServiceService(); ;

      L2PPaymentWebService.L2PAuthenticationData auth = 
              	  new L2PPaymentWebService.L2PAuthenticationData();
      l2pPaymentWebService.Url = 
            	  "http://www.linked2pay.com/l2p/ws/L2PPaymentWebService";
      L2PPaymentWebServiceService l2pPaymentWebService = 
               	  new L2PPaymentWebServiceService();

      auth.login = "mikel1";
      // auth.AuthenticationMethod = "KEY";
      // password = "0123456789ABCDEF";
      L2PReportWebService.fingerprintBlock fingerprintBlock = 
             	  new L2PReportWebService.fingerprintBlock();
      FingerprintGenerator fingerprintGenerator = 
                    	  new FingerprintGenerator();
      fingerprintBlock.sequence = 
                    	  fingerprintGenerator.GetSuquenceNumber();
      fingerprintBlock.fingerprint = 
                    	  fingerprintGenerator.GenerateFingerPrint(
                                (int)fingerprintBlock.sequence, 
                                fingerprintBlock.timesatmp.ToString(), 
                                "0123456789ABCDEF", auth.login);
      auth.fingerprint = fingerprintBlock;

      l2pDebitRequest.contactId = 0;
      l2pDebitRequest.companyName = "My Company";
      l2pDebitRequest.firstName = "Don";
      l2pDebitRequest.lastName = "Smith";
      l2pDebitRequest.email = "vserpik@transmodus.net";;
      l2pDebitRequest.phone = "111-111-11111";
      l2pDebitRequest.amount = 10.50;
      l2pDebitRequest.emailSubject = "PHP Submit Debit Request Test";
      l2pDebitRequest.emailBody = "Click here to pay: [URL]";
      L2PPaymentWebService.L2PDebitResponse l2pDebitResponse = 
          l2pPaymentWebService.submitDebitRequest(auth, l2pDebitRequest);

      Console.WriteLine("Error code: " + l2pDebitResponse.errorCode);
      Console.WriteLine("Contact ID: " + l2pDebitResponse.l2pContactId);
      Console.WriteLine("Request ID: " + l2pDebitResponse.l2pRequestId);

    }
  }
}
						
```

--------------------------------

### Create Widget Header API

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

This method allows you to create a new L2P widget header with specified labels and authentication.

```APIDOC
## POST /createWidgetHeader

### Description
This method allows you to create a new L2P widget header with specified labels and authentication.

### Method
POST

### Endpoint
/createWidgetHeader

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object that contains authentication information based on user's choice of authentication method.
- **label1** (string) - Required - The first label for the widget header.
- **label2** (string) - Required - The second label for the widget header.

### Request Example
```php
<?php
define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
 // SOAP client
$client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT,
                                 'trace' => 1, 'exceptions' => 0));
 // Authentication object
$auth = new StdClass();
$auth->login = "client1";
$auth->password = "client1";
 // These parameters are specific to what function is being called
$params = new StdClass();
$params->auth = $auth;
$params->label1 = isset($_GET['label1']) ? $_GET['label1'] : 
                                             'Richard Account';
$params->label2 = isset($_GET['label2']) ? $_GET['label2'] : 
                                             'Richard Zip';
$result = $client->createWidgetHeader($params);
?>
```

### Response
#### Success Response (200)
- **createWidgetHeaderReturn** (string) - The return value from the createWidgetHeader operation.

#### Response Example
```html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <title>L2P Create Widget Header</title>
</head>
<body>
    <div>
        <p>Response:</p>
        <div>
            <?php print $result->createWidgetHeaderReturn; ?>
        </div>
    </div>
</body>
</html>
```
```

--------------------------------

### POST /submitWidgetRequest

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Creates a new L2P widget request by providing authentication data and request attributes.

```APIDOC
## POST /submitWidgetRequest

### Description
Creates an L2P widget request using the provided authentication credentials and request object.

### Method
POST

### Endpoint
/services/L2PWidgetWebService/submitWidgetRequest

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Authentication information object.
- **request** (L2PWidgetRequest) - Required - Data object containing widget request attributes.

### Request Example
{
  "auth": {
    "login": "client1",
    "AuthenticationMethod": "KEY",
    "password": "0123456789ABCDEF"
  },
  "request": {
    "status": 0,
    "headerId": 71,
    "widgetId": 0,
    "lookup1": "8058860687",
    "amount": 500.00
  }
}

### Response
#### Success Response (200)
- **submitWidgetRequestReturn** (int) - Numeric return code (0 for success, otherwise error code).

#### Response Example
{
  "submitWidgetRequestReturn": 0
}
```

--------------------------------

### POST lookupWidget

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Lists all widgets created by a particular client. The widgets are generated via the L2P portal and can be integrated into client websites.

```APIDOC
## POST lookupWidget

### Description
This method retrieves a list of all widgets associated with the authenticated client account.

### Method
POST (SOAP)

### Endpoint
http://test.transmodus.net/jcx/soa/test/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object containing login, AuthenticationMethod, and password.

### Response
#### Success Response (200)
- **L2PWidget** (L2PWidget) - Data object including header attributes.

### Response Example
{
  "lookupWidgetReturn": {
    "L2PWidget": { "id": "123", "status": "active" }
  }
}
```

--------------------------------

### L2PWidgetWebService - Lookup Widget Headers

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Lists all headers created by a particular client. This is used in conjunction with the createWidgetHeader method.

```APIDOC
## POST /services/L2PWidgetWebService

### Description
This method lists all headers created by a particular client (see createWidgetHeader method).

### Method
POST

### Endpoint
/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object that contains authentication information based on user's choice of authentication method.

### Response
#### Success Response (200)
Returns a list of widget headers created by the client.

#### Response Example
```json
{
  "lookupWidgetHeaderReturn": [
    {
      "headerId": "HEADER001",
      "label1": "Account Number",
      "label2": "Invoice ID"
    }
  ]
}
```
```

--------------------------------

### Authenticate Client with L2PWidgetWebService (PHP)

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Authenticates a client using KEY or FINGERPRINT authentication. Requires registration with Linked2Pay. The method returns an email length, status code, and user ID. Authentication is typically handled implicitly with other L2P web service calls.

```php
<?php
define('L2P_SERVICE_PATH','http://test.transmodus.net/jcx/soa/test/');
define('L2P_ENDPOINT',L2P_SERVICE_PATH.'services/L2PWidgetWebService');
define('L2P_WSDL',L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
// SOAP client
$client = new soapclient(L2P_WSDL,
array('location' => L2P_ENDPOINT, 'trace' => 1, 'exceptions' => 0));
// Authentication object
$auth = new StdClass();
$auth->login = "mikel1";
$auth->AuthenticationMethod = "KEY";
$auth->password = "0123456789ABCDEF";
// These parameters are specific to what function is being called
$params = new StdClass();
$params->auth = $auth;
$result = $client->authenticate($params);
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
  <title>L2P Authentication Request</title> 
</head>
<body>
  <div>
    <p>Response:</p>
    <div>
      <?php print $result->authenticateReturn; ?>
    </div>
  </div>
</body>
</html>
```

--------------------------------

### Submit Widget Attachment using PHP

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

This PHP code illustrates how to upload a document as an attachment to an L2P widget request using the submitWidgetAttachment method. It handles file uploads, base64 encoding, and constructs the necessary authentication and attachment objects for the SOAP request. The return value is a numeric code indicating success or failure.

```php
<?php

 if(isset($_POST['submit']))
 {
   define('L2P_SERVICE_PATH', 'http://test.transmodus.net/jcx/soa/test/');
   define('L2P_ENDPOINT', L2P_SERVICE_PATH.'services/L2PWidgetWebService');
   define('L2P_WSDL', L2P_SERVICE_PATH.'wsdl/L2PWidgetWebService.wsdl');
   // SOAP client
   $client = new soapclient(L2P_WSDL, array('location' => L2P_ENDPOINT,
   'trace' => 1, 'exceptions' => 0));
   // Authentication object
   $auth = new StdClass();
   $auth->login = "client1";
   $auth->AuthenticationMethod = "KEY";
   $auth->password = "0123456789ABCDEF";
   $attachment = new StdClass();
   $attachment->fileName = $_FILES['userUpload']['name'];
   $attachment->filePassword = 'stephen';
   $attachment->passwordHint = 'name';
   $attachment->dataId = isset($_POST['dataId']) ? $_POST['dataId'] : 73;
   $attachmentData = file_get_contents($_FILES['userUpload']['tmp_name']);
   $encodedData = base64_encode($attachmentData);
   // These parameters are specific to what function is being called
   $params = new StdClass();
   $params->auth = $auth;
   $params->attachment = $attachment;
   $params->attachmentData = $encodedData;

```

--------------------------------

### L2PWidgetWebService - Lookup Widget Requests

Source: https://test.linked2pay.com/l2p/static/API/online_forms.html

Lists all L2P requests created by a particular client that match specific values in the lookup fields.

```APIDOC
## POST /services/L2PWidgetWebService

### Description
This method lists all L2P requests created by a particular client which have specific particular values in the lookup fields.

### Method
POST

### Endpoint
/services/L2PWidgetWebService

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Required - Data object that contains authentication information based on user's choice of authentication method.
- **lookupField1Value** (string) - Optional - The value to search for in lookup field 1.
- **lookupField2Value** (string) - Optional - The value to search for in lookup field 2.

### Response
#### Success Response (200)
Returns a list of L2P widget requests matching the specified lookup field values.

#### Response Example
```json
{
  "lookupWidgetRequestReturn": [
    {
      "requestId": "12345",
      "lookupField1": "Account123",
      "lookupField2": "INV987"
    }
  ]
}
```
```

--------------------------------

### submitFollowUpRequest

Source: https://test.linked2pay.com/l2p/static/API/direct_payment.html

Submits a follow-up request for an ACH or Credit Card transaction against a specified customer profile. Requires prior customer boarding.

```APIDOC
## POST /websites/test_linked2pay_l2p_static_api/submitFollowUpRequest

### Description
This method submits the followUpRequest parameter, and will initiate an ACH or Credit Card Transaction against the Customer Reference ID profile you specify. To use this method a customer and their payment information must first be boarded through the 'Board Customer' method in the achRequest method, manualCreditRequest method, or the creditSwipeRequest method.

### Method
POST

### Endpoint
/websites/test_linked2pay_l2p_static_api/submitFollowUpRequest

### Parameters
#### Request Body
- **auth** (L2PAuthenticationData) - Input - Data object that contains authentication information based on user's choice of authentication method.
- **followUpRequest** (L2pFollowUpReqType) - Input - Represents an ACH or Credit Card transaction that will be processed against the Customer Reference ID profile you specify.

### Response
#### Success Response (200)
- **RspCode** (int) - Response code.
- **ErrorCode** (int) - Error Code.
- **RspText** (string) - Response description.
- **ErrorMsg** (string) - Error Message Description.
- **AuthCode** (string) - Authorization Code. A unique identification number assigned to each of your linked2pay Transaction Requests
- **AuthAmt** (amtType) - Total Amount paid for your request. This only applies to Credit Card Transactions.
- **BalanceAmt** (amtType) - (Optional) Remaining balance on card (applies to EBT Transactions only).
- **Refid** (string) - Unique Reference Identification Number assigned to your customer.

#### Response Example
{
  "RspCode": 0,
  "ErrorCode": 0,
  "RspText": "Success",
  "ErrorMsg": "",
  "AuthCode": "AUTH12345",
  "AuthAmt": "100.00",
  "BalanceAmt": null,
  "Refid": "CUSTREF67890"
}
```

--------------------------------

### Generate Fingerprint and Submit Attachment Request

Source: https://test.linked2pay.com/l2p/static/API/email_payments.html

This snippet shows how to generate a security fingerprint using FingerprintGenerator, prepare an attachment by reading a file and encoding it to Base64, and finally submit the attachment request via the L2PPaymentWebService. It utilizes complex types like fingerprintBlock and L2PRequestAttachment.

```csharp
FingerprintGenerator fingerprintGenerator = 
	          new FingerprintGenerator();
fingerprintBlock.sequence =
         	  fingerprintGenerator.GetSuquenceNumber();
fingerprintBlock.fingerprint =
         	  fingerprintGenerator.GenerateFingerPrint(
                    (int)fingerprintBlock.sequence,
                    fingerprintBlock.timesatmp.ToString(),
                    "0123456789ABCDEF", auth.login);
      auth.fingerprint = fingerprintBlock;

      L2PPaymentWebService.L2PRequestAttachment l2pRequestAttachment =
         	  new L2PPaymentWebService.L2PRequestAttachment();

      l2pRequestAttachment.requestId = 16648;
      l2pRequestAttachment.fileName = "test.pdf";
      l2pRequestAttachment.filePassword = "stephen";
      ll2pRequestAttachment.passwordHint = "name";

      // Read attachment file and base-64 encode it.
      FileStream fs = null;
      BinaryReader br = null;
      fs = new FileStream(l2pRequestAttachment.fileName,
              	  FileMode.Open, FileAccess.Read);
      br = new BinaryReader(fs);
      byte[] bArray = new byte[br.BaseStream.Length];
      bArray = br.ReadBytes(Convert.ToInt32(br.BaseStream.Length));
      br.Close();

      String s64 = Convert.ToBase64String(bArray);
      byte[] attachmentData = System.Text.Encoding.UTF8.GetBytes(s64);

      L2PPaymentWebService.L2PAttachmentResponse l2pAttachmentResponse = 
	          l2pPaymentWebService.submitRequestAttachment(auth, 
                       l2pRequestAttachment, attachmentData);
      Console.WriteLine("Error code: " + l2pAttachmentResponse .errorCode);

    }
  }
}
```
Tokens:
Raw