Paymentmethod API

API change history

This APi is used to retrieve available payment methods

get available paymentmethods as configured

Retrieve available payment methods as configured either all available or specific for a country.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    ISO2 country code i.e. 'NL'

  • (optional)
    string

    Payment method type, i.e. 'Credit Card'

Request headers

  • string

    Client specific ID, provided by ModusLink during the onboarding process

  • string

    Client specific ID, provided by ModusLink during the onboarding process

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

Request body

Responses

200 OK

OK

Representations

[
  {
    "result": "string",
    "paymentMethod": [
      {
        "type": "Visa",
        "paymentValue": "VISA",
        "payTerm": "Tokenized",
        "paymentMethod": "Credit Card",
        "ccType": "VISA"
      }
    ],
    "errorCode": "string",
    "message": [
      {
        "message": "string",
        "path": "string",
        "errorType": "string"
      }
    ]
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "result": {
        "type": "string",
        "description": "result of transaction"
      },
      "paymentMethod": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "Visa"
            },
            "paymentValue": {
              "type": "string",
              "example": "VISA"
            },
            "payTerm": {
              "type": "string",
              "example": "Tokenized"
            },
            "paymentMethod": {
              "type": "string",
              "example": "Credit Card"
            },
            "ccType": {
              "type": "string",
              "example": "VISA"
            }
          },
          "description": "the relevant payment info per payment method"
        }
      },
      "errorCode": {
        "type": "string",
        "description": "no data found"
      },
      "message": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "message": {
              "type": "string",
              "description": "A description of the error"
            },
            "path": {
              "type": "string",
              "description": "the element which has the error"
            },
            "errorType": {
              "type": "string",
              "description": "The type of error"
            }
          }
        },
        "description": "No data found error"
      }
    },
    "description": "The response when calling API"
  }
}

401 Unauthorized

Invalid authorization

Representations

{
  "result": "string",
  "paymentMethod": [
    {
      "type": "Visa",
      "paymentValue": "VISA",
      "payTerm": "Tokenized",
      "paymentMethod": "Credit Card",
      "ccType": "VISA"
    }
  ],
  "errorCode": "string",
  "message": [
    {
      "message": "string",
      "path": "string",
      "errorType": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "result": {
      "type": "string",
      "description": "result of transaction"
    },
    "paymentMethod": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "Visa"
          },
          "paymentValue": {
            "type": "string",
            "example": "VISA"
          },
          "payTerm": {
            "type": "string",
            "example": "Tokenized"
          },
          "paymentMethod": {
            "type": "string",
            "example": "Credit Card"
          },
          "ccType": {
            "type": "string",
            "example": "VISA"
          }
        },
        "description": "the relevant payment info per payment method"
      }
    },
    "errorCode": {
      "type": "string",
      "description": "no data found"
    },
    "message": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "A description of the error"
          },
          "path": {
            "type": "string",
            "description": "the element which has the error"
          },
          "errorType": {
            "type": "string",
            "description": "The type of error"
          }
        }
      },
      "description": "No data found error"
    }
  },
  "description": "The response when calling API"
}

404 Not Found

no data found

Representations

{
  "result": "string",
  "paymentMethod": [
    {
      "type": "Visa",
      "paymentValue": "VISA",
      "payTerm": "Tokenized",
      "paymentMethod": "Credit Card",
      "ccType": "VISA"
    }
  ],
  "errorCode": "string",
  "message": [
    {
      "message": "string",
      "path": "string",
      "errorType": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "result": {
      "type": "string",
      "description": "result of transaction"
    },
    "paymentMethod": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "Visa"
          },
          "paymentValue": {
            "type": "string",
            "example": "VISA"
          },
          "payTerm": {
            "type": "string",
            "example": "Tokenized"
          },
          "paymentMethod": {
            "type": "string",
            "example": "Credit Card"
          },
          "ccType": {
            "type": "string",
            "example": "VISA"
          }
        },
        "description": "the relevant payment info per payment method"
      }
    },
    "errorCode": {
      "type": "string",
      "description": "no data found"
    },
    "message": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "A description of the error"
          },
          "path": {
            "type": "string",
            "description": "the element which has the error"
          },
          "errorType": {
            "type": "string",
            "description": "The type of error"
          }
        }
      },
      "description": "No data found error"
    }
  },
  "description": "The response when calling API"
}

500 Internal Server Error

Server Error

Representations

{
  "result": "string",
  "paymentMethod": [
    {
      "type": "Visa",
      "paymentValue": "VISA",
      "payTerm": "Tokenized",
      "paymentMethod": "Credit Card",
      "ccType": "VISA"
    }
  ],
  "errorCode": "string",
  "message": [
    {
      "message": "string",
      "path": "string",
      "errorType": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "result": {
      "type": "string",
      "description": "result of transaction"
    },
    "paymentMethod": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "Visa"
          },
          "paymentValue": {
            "type": "string",
            "example": "VISA"
          },
          "payTerm": {
            "type": "string",
            "example": "Tokenized"
          },
          "paymentMethod": {
            "type": "string",
            "example": "Credit Card"
          },
          "ccType": {
            "type": "string",
            "example": "VISA"
          }
        },
        "description": "the relevant payment info per payment method"
      }
    },
    "errorCode": {
      "type": "string",
      "description": "no data found"
    },
    "message": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "A description of the error"
          },
          "path": {
            "type": "string",
            "description": "the element which has the error"
          },
          "errorType": {
            "type": "string",
            "description": "The type of error"
          }
        }
      },
      "description": "No data found error"
    }
  },
  "description": "The response when calling API"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod?country={string}&paymentMethod={string}"
-H "ClientConfigId: 114"
-H "ClientAuthKey: 43006300-9E2A-4ED5-A001-126712985994"
-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("ClientConfigId", "114");
            client.DefaultRequestHeaders.Add("ClientAuthKey", "43006300-9E2A-4ED5-A001-126712985994");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["country"] = "{string}";
            queryString["paymentMethod"] = "{string}";
            var uri = "https://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod?" + 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://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod");

            builder.setParameter("country", "{string}");
            builder.setParameter("paymentMethod", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("ClientConfigId", "114");
            request.setHeader("ClientAuthKey", "43006300-9E2A-4ED5-A001-126712985994");
            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
            "country": "{string}",
            "paymentMethod": "{string}",
        };
      
        $.ajax({
            url: "https://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("ClientConfigId","114");
                xhrObj.setRequestHeader("ClientAuthKey","43006300-9E2A-4ED5-A001-126712985994");
                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://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"country={string}",
                         @"paymentMethod={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"114" forHTTPHeaderField:@"ClientConfigId"];
    [_request setValue:@"43006300-9E2A-4ED5-A001-126712985994" forHTTPHeaderField:@"ClientAuthKey"];
    [_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://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'ClientConfigId' => '114',
    'ClientAuthKey' => '43006300-9E2A-4ED5-A001-126712985994',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'country' => '{string}',
    'paymentMethod' => '{string}',
);

$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
    'ClientConfigId': '114',
    'ClientAuthKey': '43006300-9E2A-4ED5-A001-126712985994',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'country': '{string}',
    'paymentMethod': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api-uat.moduslink.com')
    conn.request("GET", "/paymentmethodapi/v1/paymentMethod?%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
    'ClientConfigId': '114',
    'ClientAuthKey': '43006300-9E2A-4ED5-A001-126712985994',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'country': '{string}',
    'paymentMethod': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api-uat.moduslink.com')
    conn.request("GET", "/paymentmethodapi/v1/paymentMethod?%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://api-uat.moduslink.com/paymentmethodapi/v1/paymentMethod')

query = URI.encode_www_form({
    # Request parameters
    'country' => '{string}',
    'paymentMethod' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['ClientConfigId'] = '114'
# Request headers
request['ClientAuthKey'] = '43006300-9E2A-4ED5-A001-126712985994'
# 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