Overview

Retrieve information about a subscription. Subscriptions can be retrieved starting with 5 minutes after their orders are generated in the 2Checkout system.

Parameters

Overview

Use this section to handle the renewal of your subscriptions.

Overview

The United States Government has enacted a law (Internal Revenue Code Section 6050W) which requires payment processors to send an IRS the 1099-K form annually, to all US sellers starting with 2011.

The 1099-K form, Payment Card and Third Party Network Transactions is an IRS information return used to report certain payment transactions to improve voluntary tax compliance.

Read the instructions below on how to update your 2Checkout account to meet these requirements. 

Recommended resources

Availability

Form 1099-K applies to all US sellers.

2Checkout requirements

2Checkout will ask affected Sellers/Merchants to confirm and/or update their 2Checkout account by providing a tax ID number and the appropriate corresponding contact information.

Your tax ID number is one of these:

• Your Social Security Number (SSN)

• Your Employer Identification Number (EIN)

• Your Individual Tax Identification Number (ITIN)

Please use the guidelines below to determine which tax ID number to provide.

• Business Entities with an EIN

Provide your company EIN and company name.

• Sole Proprietors with an EIN

Provide your company EIN and your own name.

• Individual Sellers and Sole Proprietors without an EIN

Provide your SSN or ITIN and your own name.

2Checkout will also need affected Sellers/Merchants to confirm that their account name matches the tax ID number provided and to confirm their physical address so that if Form 1099-K is issued, we can report your information accurately to the IRS.

Updating the 2Checkout account

Follow these steps to update your 2Checkout account in order to meet the fiscal compliance requirements.

1. Log in to your Merchant Control Panel account.

2. Click the Settings tab.

3. In the Account Settings page, click on the Edit Details tab, under Account Information.

4. On the Account Information page, edit the necessary details, and confirm your account information is correct.

5. Click Update at the bottom of the page to save your new settings.

6. Confirm that the Company Name listed is correct. If your company is incorporated, make sure that the company name listed on your 2Checkout Account is exactly as it is listed on your incorporation documents. If your Company name is incorrect on this page, send an email to supportplus@2checkout.com for assistance in updating this field.

7. Confirm that the Business Office E-mail, Mailing Address, and Physical Address listed on the account are correct. Update if necessary. If the physical address listed on this page is incorrect, send an email to supportplus@2checkout.com for assistance in updating this field.

FAQs

1. How do I receive my 1099-K form?

The platform will automatically generate the PDF for the 1099-K form for all merchants. You will receive an email notification that the file was generated and you will be able to download the file from your Merchant Control Panel, under Account information → Edit account information.

Every year 2Checkout will generate a file for the IRS that will contain all your payments from the previous year.

2. What if I don’t provide my Tax ID number?

If 2Checkout is unable to verify your information because it is incorrect or incomplete, your account will be put in a Restricted status, so you will not be able to receive payouts. The restriction will end once you provide your tax ID number and corresponding contact information, and your information is verified by the IRS matching system.

If you need additional information about this law you can read more details on the IRS website.

Overview

Use the getInvoices method to extract shopper invoices from the Avangate system based on unique order references. The method returns the binary code for invoices in the PDF file format, Base64 encoded (Base64 is used to represent binary data in the ASCII string format).

getInvoices works for COMPLETE orders for which an invoice was already issued. For refunded orders, getInvoices provides two shopper invoices, one for the original order and the second for the refund, reflecting the repayment made.

In the case of cross-selling orders which contain products from different merchants, getInvoice enables you to re-send only the invoices for your own offerings.

Parameters

Request

Response

<?php
 
 
function callRPC($Request, $hostUrl, $Debug = true) {
    $curl = curl_init($hostUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($curl, CURLOPT_SSLVERSION, 0);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));
    $RequestString = json_encode($Request);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $RequestString);
 
 
    if ($Debug) {
        $RequestString;
    }
    $ResponseString = curl_exec($curl);
    if ($Debug) {
        $ResponseString;
    }
 
    if (!empty($ResponseString)) {
        $Response = json_decode($ResponseString);
        if (isset($Response->result)) {
            return $Response->result;
        }
        if (!is_null($Response->error)) {
            var_dump($Request->method, $Response->error);
        }
    } else {
        return null;
    }
}
 
$host = 'https://api.avangate.com/rpc/3.0/';
 
$merchantCode = "YOUR_MERCHANT_CODE";// your account's merchant code available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
$key = "YOUR_SECRET_KEY";// your account's secret key available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
 
$string = strlen($merchantCode) . $merchantCode . strlen(gmdate('Y-m-d H:i:s')) . gmdate('Y-m-d H:i:s');
$hash = hash_hmac('md5', $string, $key);
 
$i = 1; // counter for api calls
// call login
$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'login';
$jsonRpcRequest->params = array($merchantCode, gmdate('Y-m-d H:i:s'), $hash);
$jsonRpcRequest->id = $i++;
 
$sessionID = callRPC($jsonRpcRequest, $host);
 
var_dump($sessionID);
$Reference = '43997639';

$jsonRpcRequest = array (
'method' => 'getInvoices',
'params' => array($sessionID, $Reference),
'id' => $i++,
'jsonrpc' => '2.0');

var_dump (callRPC((Object)$jsonRpcRequest, $host, true));

Parameters

Overview

Retrieve the wire payment details that partners need to use to pay for partner invoices.

Requirements

Next, use setProforma to identify a specific partner invoice.

Parameters

Response

Request

<?php

require('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/02Authentication
require('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/Partner/00Set_partner

$proformaNumber = 'YOUR_PROFORMA_NUMBER';

try {
    $Proforma= $client->setProforma ($sessionID, $proformaNumber);
} catch (SoapFault $e) {
    echo "ProformaOutput: " . $e->getMessage();
    exit;
}
var_dump ("ProformaOutput", $Proforma);


$paymentDetails = new stdClass();
$paymentDetails->Type = 'WIRE';
$paymentDetails->Curency = 'YOUR_CURRENCY';
$paymentDetails->CustomerIP = 'CUSTOMER_IP';

try {
    $PaymentDetailsSet= $client->setPaymentDetails($sessionID, $paymentDetails);
} catch (SoapFault $e) {
    Echo "Payment: " . $e->getMessage();
    exit;
}
var_dump ("Payment", $PaymentDetailsSet);

try {
    $ProformaPay= $client->payProforma($sessionID);
} catch (SoapFault $e) {
    Echo "ProformaPaid: " . $e->getMessage();
    exit;
}
var_dump ("ProformaPaid ", $ProformaPay);

$refNo = 'YOUR_ORDER_REFNO'

try {
    $client->getWirePaymentDetails ($sessionID, $refNo);
} catch (SoapFault $e) {
    echo "Error: " . $e->getMessage();
}

Errors

Request

<?php

//The following script let's you place an new order with Credit/Debit cards as the payment method

$host   = "https://api.avangate.com";
$client = new SoapClient($host . "/soap/4.0/?wsdl", array(
    'location' => $host . "/soap/4.0/",
    "stream_context" => stream_context_create(array(
        'ssl' => array(
            'verify_peer' => false,
            'verify_peer_name' => false
        )
    ))
));
function hmac($key, $data)
{
    $b = 64; // byte length for md5
    if (strlen($key) > $b) {
        $key = pack("H*", md5($key));
    }
    
    $key    = str_pad($key, $b, chr(0x00));
    $ipad   = str_pad('', $b, chr(0x36));
    $opad   = str_pad('', $b, chr(0x5c));
    $k_ipad = $key ^ $ipad;
    $k_opad = $key ^ $opad;
    return md5($k_opad . pack("H*", md5($k_ipad . $data)));
}
$merchantCode = "YOUR_MERCHANT_CODE";// your account's merchant code available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
$key = "YOUR_SECRET_KEY";// your account's secret key available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
$now          = gmdate('Y-m-d H:i:s'); //date_default_timezone_set('UTC')
$string = strlen($merchantCode) . $merchantCode . strlen($now) . $now;
$hash   = hmac($key, $string);
try {
    $sessionID = $client->login($merchantCode, $now, $hash);
}
catch (SoapFault $e) {
    echo "Authentication: " . $e->getMessage();
    exit;
}
$Order = new stdClass();
$Order->RefNo = NULL;
$Order->Currency = 'usd';
$Order->Country = 'US';
$Order->Language = 'en';
$Order->CustomerIP = '91.220.121.21';
$Order->ExternalReference = NULL;
$Order->Source = NULL;
$Order->Affiliate = new stdClass();
$Order->Affiliate->AffiliateCode = 'Partner123'
$Order->Affiliate->AffiliateSource = 'MobilePlatform'
$Order->CustomerReference = NULL;
$Order->Items = array();
$Order->Items[0] = new stdClass();
$Order->Items[0]->Code = 'my_subscription_1';
$Order->Items[0]->Quantity = 1;
$Order->Items[0]->PriceOptions = NULL;
$Order->Items[0]->SKU = NULL;
$Order->Items[0]->Price = NULL;
$Order->Items[0]->CrossSell = NULL;
$Order->Items[0]->Trial = false;
$Order->Items[0]->AdditionalFields = NULL;
$Order->BillingDetails = new stdClass();
$Order->BillingDetails->FirstName = 'FirstName';
$Order->BillingDetails->LastName = 'LastName';
$Order->BillingDetails->CountryCode = 'us';
$Order->BillingDetails->State = 'California';
$Order->BillingDetails->City = 'LA';
$Order->BillingDetails->Address1 = 'Address example';
$Order->BillingDetails->Address2 = NULL;
$Order->BillingDetails->Zip = '90210';
$Order->BillingDetails->Email = 'customer@email.com';
$Order->BillingDetails->Phone = NULL;
$Order->BillingDetails->Company = NULL;
$Order->DeliveryDetails = NULL;
$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'PAYPAL';
$Order->PaymentDetails->Currency = 'usd';
$Order->PaymentDetails->PaymentMethod = new stdClass ();
$Order->PaymentDetails->CustomerIP = '10.10.10.10';
$Order->PaymentDetails->PaymentMethod->RecurringEnabled = true;
$Order->PaymentDetails->PaymentMethod->Email = 'email@avangate.com';
$Order->PaymentDetails->PaymentMethod->ReturnURL = 'http://YourReturnURL.com';
$Order->Promotions = NULL;
$Order->AdditionalFields = NULL;
$Order->LocalTime = NULL;
$Order->GiftDetails = NULL;
try {
    $newOrder = $client->placeOrder($sessionID, $Order);
}
catch (SoapFault $e) {
    echo "newOrder: " . $e->getMessage();
    exit;
}
var_dump("newOrder", $newOrder);

$url = $newOrder->PaymentDetails->PaymentMethod->RedirectURL;

header ("Location: $url");

In order to be compliant with the fiscal regulations in the United States, our merchants need to have the W-8/W-9 forms agreed and digitally signed.

What is the W-8 form?

The W-8 form is an Internal Revenue Service (IRS) form that is used to exempt non-US residents from submitting U.S. tax return reporting. Merchants that are registered outside the United States, but that run financial operations in US dollars are required to fill in and sign this form. These merchants (businesses or individuals) are not subjected to standard taxation practices as their investment income is not taxed.

The W-8 form is submitted by merchants only to financial companies that request it (payment processors like 2Checkout) and not directly to the IRS. Merchants that fail to submit the W-8 form can incur a 30% tax withholding and additional penalties.

Who does the W-8 form apply to?

The form applies to non-US residents, namely to foreign entities (foreign individuals or corporations) and exempt foreigners who are neither U.S. citizens nor reside in the US.

There are a variety of W-8 forms and if you are not entirely sure which one applies to you, visit the IRS website for more information.

What is the W-9 form?

The W-9 form is an Internal Revenue Service (IRS) form, also known as a Request for Taxpayer Identification Number (TIN) and Certification form, that is used solely to confirm a person’s taxpayer identification number (TIN).

Any corporation that is required to submit a 1099 form with the IRS must obtain and confirm your correct TIN to report any taxable earnings that may require you to submit a federal tax return.

The TIN holder is responsible for paying all the required taxes based on earnings reported in the provided W-9 form unless the taxpayer is subject to backup withholding. If this is the case, the W-9 form will have to include all the related details.

Who does the W-9 form apply to?

Individuals (merchants) who have US citizenship or reside in the US or entities (corporations and companies) registered in the US are required to fill in and sign this form.

Signing the W-8/W-9 forms on the 2Checkout platform

All merchants signed under Avangate Inc. or 2Checkout Inc. are required to fill in and digitally sign the W-8/W-9 forms and submit them to 2Checkout. Follow the steps below to sign the fiscal forms.

1. After the onboarding process is completed and your account is approved by the Underwriting team, you (merchant) need to fill in the fiscal compliance form that applies to you (either W-8 or W-9). If your account has not been approved yet by the Underwriting team, you will notice that your account is in RESTRICTED mode until you finalize the submission of the required fiscal forms.

This form can be filled in only by the master account that belongs to the account holder.

2. To sign the W-8/W-9 forms, log in to your master account in the cPanel and click on the Complete now link.

3. Before submitting the W-9 form, make sure that all the personal and company information you provided is correct. If you notice that some of the information is not correct, contact supportplus@2checkout.com to help you make the necessary changes. Note that any detail changes in the Control Panel (Access the user settings, Account information, Edit account information) will automatically invalidate the forms.

4. Select the I certify that I have the capacity to sign for entity identified above checkbox and then click on the Accept and submit button.

5. After submitting the form, a message will be displayed on top of the page informing you that form was successfully submitted, as shown in the image below.

6. To access your W-8/W-9 forms and to verify you have submitted them, navigate to Settings → Account information → Edit account information → IRS Forms section.

7. After submitting the fiscal compliance form, you will become fiscal compliant and your account will be displayed as ACTIVE.

FAQs

• How long will my account be Restricted with reason code 406 Fiscal Sign?

Your account will be in Restricted mode until you’ve accepted, signed and submitted the fiscal forms.

• How many notifications to sign the forms will I receive?

You will receive a notification once a week.

• What happens when the forms expire?

Your account will be put in Restricted mode with reason code 406 Fiscal Sign and the notification process will restart.

If you need additional information about this law you can read more details on the IRS website.

Overview

Place an order with catalog products defined in your Control Panel and collect the payment using iDEAL.

Requirements

One shoppers from Netherlands can purchase using iDEAL. The billing country and the order country code has to be NL.

Supported currencies

• EUR

Workflow

1. Use the getIdealIssuerBanks method for retrieving information on the Avangate list of banks that support iDEAL payments. More details about this method here.
2. Shoppers select iDEAL as payment option in the interface you provide them, and select their bank from the list.
3. Create the order object. Use IDEAL as the type of the PaymentDetails object, and include ReturnURL and CancelURL. The BankCode parameter should be added based on the bank selected by the customer, from the array obtained after calling method getIdealIssuerBanks.
4. Use the placeOrder method to send the data to Avangate.
5. Once you place the order, Avangate logs it into the system. At this point in time, the status of the order is PENDING.
6. Avangate returns an Order object as the output of the placeOrder method. 
7. Use the PaymentMethod object to create a redirect URL for the shoppers, concatenating the values of the Href and avng8apitoken parameters. Here's an example of the redirect URL:
   

   https://api.avangate.com/4.0/scripts/ideal/authorize/?avng8apitoken=f56373d92ed6b153
   

8. Customers are directed to the iDEAL payment page, where they have to confirm their payment details before finishing the ordering process.
9. Shoppers are redirected to the RedirectURL from the Order information object. In case the payment fails, shoppers are redirected to the CancelURL. 

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$Order = new stdClass();
$Order->RefNo = NULL;
$Order->Currency = 'EUR';
$Order->Country = 'NL';
$Order->Language = 'en';
$Order->CustomerIP = '91.220.121.21';
$Order->ExternalReference = NULL;
$Order->Source = NULL;
$Order->Affiliate = new stdClass();
$Order->Affiliate->AffiliateCode = 'Partner123'
$Order->Affiliate->AffiliateSource = 'MobilePlatform'
$Order->CustomerReference = NULL;
$Order->Items = array();
$Order->Items[0] = new stdClass();
$Order->Items[0]->Code = 'my_subscription_1';
$Order->Items[0]->Quantity = 1;
$Order->Items[0]->PriceOptions = NULL;
$Order->Items[0]->SKU = NULL;
$Order->Items[0]->Price = NULL;
$Order->Items[0]->CrossSell = NULL;
$Order->Items[0]->Trial = false;
$Order->Items[0]->AdditionalFields = NULL;
$Order->Items[0]->SubscriptionStartDate = NULL; //If empty or null, subscriptions become active when purchase is made.
$Order->BillingDetails = new stdClass();
$Order->BillingDetails->FirstName = 'Test Cosmin API';
$Order->BillingDetails->LastName = 'Cosmin API';
$Order->BillingDetails->CountryCode = 'NL';
$Order->BillingDetails->State = 'California';
$Order->BillingDetails->City = 'LA';
$Order->BillingDetails->Address1 = 'Address example';
$Order->BillingDetails->Address2 = NULL;
$Order->BillingDetails->Zip = '90210';
$Order->BillingDetails->Email = 'cosmin.deftu@avangate.com';
$Order->BillingDetails->Phone = NULL;
$Order->BillingDetails->Company = NULL;
$Order->DeliveryDetails = NULL;

$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'IDEAL';
$Order->PaymentDetails->Currency = 'EUR';
$Order->PaymentDetails->PaymentMethod = new stdClass ();
$Order->PaymentDetails->CustomerIP = '91.220.121.21';
$Order->PaymentDetails->PaymentMethod->ReturnURL = 'http://yourreturnurl.com';
$Order->PaymentDetails->PaymentMethod->CancelURL= 'http://yourcancelurl.com';
$Order->PaymentDetails->PaymentMethod->BankCode='RABONL2U+RAB'; // value retrieved based on the bank selected by the customer, from the array obtained after calling method getIdealIssuerBanks.

$Order->Promotions = NULL;
$Order->AdditionalFields = NULL;
$Order->LocalTime = NULL;
$Order->GiftDetails = NULL;

$jsonRpcRequest = array (
'method' => 'placeOrder',
'params' => array($sessionID, $Order),
'id' => $i++,
'jsonrpc' => '2.0'
);

$output = callRPC($jsonRpcRequest, $host);

$idealredirect = $output->PaymentDetails->PaymentMethod->Authorize->Href."/?avng8apitoken=".$output->PaymentDetails->PaymentMethod->Authorize->Params->avng8apitoken;

header('Location:' . $idealredirect);