Creditcards API

API change history

CreditCards

This service contains information on credit cards to which a logged in user has access. In the case of test users, random data is created when logging in for first time and continues to be used after that.

The information is comparable to the data which users have access to via Arion Online Banking, Arion App and Arion Bank’s B2B solutions. You can find information on the different features of each card and view transactions for each period.

/creditCards - GET

Provides an overview of credit cards. It provides information on cards where the logged-in user is a cardholder or owner of a card, provided that user is entitled to see the credit card. It shows information on cards in active use and cards in the legal collection process. It does not show amounts on cards in the legal collection process as collection costs are not included in the balance. In such cases null is returned in the field for amounts

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    The field to be searched on.

  • (optional)
    string

    The value to search the field against.

Request headers

  • (optional)
    string

    Used to send a valid subscription key.

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from IdentityServer3-sandbox. Supported grant types: Implicit.

Request body

Responses

200 OK

OK

Representations

{
  "creditCard": [
    {
      "active": true,
      "amountDue": 0.0,
      "availableBalance": 0.0,
      "balance": 0.0,
      "bankNumber": "string",
      "cardBrand": "string",
      "cardHolderKennitala": "string",
      "cardHolderName": "string",
      "cardId": 0,
      "cardNumber": "string",
      "cardOwnerKennitala": "string",
      "cardOwnerName": "string",
      "cardRole": "string",
      "cardType": "string",
      "currentYearTurnover": 0.0,
      "expiryDate": "string",
      "issueDate": "string",
      "lastYearTurnover": 0.0,
      "limit": 0.0,
      "panId": "string"
    }
  ]
}
{
  "properties": {
    "creditCard": {
      "items": {
        "properties": {
          "active": {
            "description": "Is the card active or inactive? This ascertained from status codes from card companies.",
            "type": "boolean"
          },
          "amountDue": {
            "description": "Amount due/estimated to be due in ISK",
            "type": "number"
          },
          "availableBalance": {
            "description": "Available balance in ISK",
            "type": "number"
          },
          "balance": {
            "description": "Total balance on card in ISK. Can be both + and – figure. Minus figure indicates positive balance. The figure appears as null if card is in legal collection process. ",
            "type": "number"
          },
          "bankNumber": {
            "description": "Bank branch number e.g. 0301",
            "type": "string"
          },
          "cardBrand": {
            "description": "Brand: V = Visa, M=Mastercard",
            "type": "string"
          },
          "cardHolderKennitala": {
            "description": "Kennitala of cardholder",
            "type": "string"
          },
          "cardHolderName": {
            "description": "Name of cardholder",
            "type": "string"
          },
          "cardId": {
            "description": "Unique ID of card",
            "type": "integer"
          },
          "cardNumber": {
            "description": "Formated card number e.g. 4804 28** **** 0557",
            "type": "string"
          },
          "cardOwnerKennitala": {
            "description": "Kennitala of owner/payer",
            "type": "string"
          },
          "cardOwnerName": {
            "description": "Name of cardowner/payer",
            "type": "string"
          },
          "cardRole": {
            "description": "Main card, extra card or corporate card",
            "type": "string"
          },
          "cardType": {
            "description": "Card type e.g. purchasing card, general Arion Bank card, Platinum Arion Bank card",
            "type": "string"
          },
          "currentYearTurnover": {
            "description": "Turnover in current year in ISK",
            "type": "number"
          },
          "expiryDate": {
            "description": "Card expiry date e.g. 31.05.2018",
            "type": "string"
          },
          "issueDate": {
            "description": "Card issue date, e.g. 12.01.2016",
            "type": "string"
          },
          "lastYearTurnover": {
            "description": "Last year’s turnover in ISK",
            "type": "number"
          },
          "limit": {
            "description": "Credit limit+ Extra credit limit in ISK e.g. 30,000",
            "type": "number"
          },
          "panId": {
            "description": "Unique ID of card from Issuer",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Code samples

@ECHO OFF

curl -v -X GET "https://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards?searchField={string}&searchValue={string}"
-H "Ocp-Apim-Subscription-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--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", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["searchField"] = "{string}";
            queryString["searchValue"] = "{string}";
            var uri = "https://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards?" + 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://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards");

            builder.setParameter("searchField", "{string}");
            builder.setParameter("searchValue", "{string}");

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


            // 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
            "searchField": "{string}",
            "searchValue": "{string}",
        };
      
        $.ajax({
            url: "https://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            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://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"searchField={string}",
                         @"searchValue={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:@"" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // 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://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'searchField' => '{string}',
    'searchValue' => '{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
    'Ocp-Apim-Subscription-Key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

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

try:
    conn = httplib.HTTPSConnection('arionapi-sandbox.azure-api.net')
    conn.request("GET", "/creditcards/v1/creditCards?%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': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

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

try:
    conn = http.client.HTTPSConnection('arionapi-sandbox.azure-api.net')
    conn.request("GET", "/creditcards/v1/creditCards?%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://arionapi-sandbox.azure-api.net/creditcards/v1/creditCards')

query = URI.encode_www_form({
    # Request parameters
    'searchField' => '{string}',
    'searchValue' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# 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