Customers

Provides methods for working with customer objects and data.

Get Payment Method IFrame (Temp User)

Get the data to display a iFrame for hosting the payment data capture form for the given store.

This will also create a temporary customer/associate account. The customer ID is returned in the response body. The Customer Id can be used to save payment method data and submit a enrollment order. The account will not be visible to other areas of the system until the submit enrollment is called. If the enrollment is never processed, then the account will automatically be removed from the system.

You can get the Request Parameters at these calls:

iframeId

Not sourced by DirectScale

storeId

Products: Get Stores

countryCode, region, and languageCode

Products: Get Regions

Try it

Request

Request URL

https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}&region={region}&languagecode={languagecode}

Request parameters

iframeid

string

The HTML tag ID of the frame to be displayed.
storeid

string

The ID of the Store to capture the payment method for.
countrycode

string

Two digit Country code.
region

string

Two digit Region/State/Province code.
languagecode

string

Two digit Language code.

Request headers

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns data for hosting an iFrame payment capture form.

Representations

application/json

{
  "CustomerId": 1999,
  "MerchantId": 99,
  "IFrameUrl": "https://client.corpadmin.directscale.com/AddCardFrameTest",
  "Height": 810,
  "Width": 530,
  "Script": "<script>/*some javascript code will be here*/</script>"
}

Code samples

@ECHO OFF

curl -v -X GET "https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('dsapi.directscale.com')
    conn.request("GET", "/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('dsapi.directscale.com')
    conn.request("GET", "/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://dsapi.directscale.com/v1/customers/temp/paymentmethods/iframe?iframeid={iframeid}&storeid={storeid}&countrycode={countrycode}®ion={region}&languagecode={languagecode}')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body